Get newsletter messages

get https://gate.whapi.cloud/newsletters/{NewsletterID}/messages

The method returns the history of WhatsApp Channel messages

Responses

Response body

object

messages

array of objects

Messages

object

string

required

Message ID

type

string

required

Defaults to text

Message type

text image video gif audio voice short document documentWithCaption link_preview location live_location contact contact_list sticker system call unknown action group_invite newsletter_invite admin_invite product catalog interactive reply poll hsm order story event buttons list pin

subtype

string

Message subtype

chat_id

string

required

Chat ID

chat_name

string

Chat name

from

string

WhatsApp ID of the sender

from_me

boolean

required

Is message from me

from_name

string

Pushname of the sender

source

string

Defaults to text

Message source

web mobile api system business_api unknown

timestamp

number

required

Message timestamp

device_id

number

Device ID, if the message was not sent through the app

status

string

Message ack status

failed pending sent delivered read played deleted

text

object

image

object

video

object

short

object

gif

object

audio

object

voice

object

document

object

link_preview

object

If 'body' contains a link, this props can be used to create custom preview link

sticker

object

location

object

live_location

object

contact

object

contact_list

object

interactive

object

poll

object

hsm

object

system

object

order

object

group_invite

object

If 'body' contains a link, this props can be used to create custom preview link

newsletter_invite

object

If 'body' contains a link, this props can be used to create custom preview link

admin_invite

object

product

object

catalog

object

If 'body' contains a link, this props can be used to create custom preview link

product_items

object

action

object

context

object

event

object

list

object

buttons

object

reactions

array of objects

Reactions for message

reactions

object

string

Reaction ID

emoji

string

required

Reaction text

group_key

string

Reaction group key

number

Reaction timestamp

unread

boolean

Is reaction unread

count

number

Reaction count

labels

array of objects

Labels associated with message

labels

object

string

required

Label ID

name

string

required

Label name

color

string

required

Label color

salmon lightskyblue gold plum silver mediumturquoise violet goldenrod cornflowerblue greenyellow cyan lightpink mediumaquamarine orangered deepskyblue limegreen darkorange lightsteelblue mediumpurple rebeccapurple

count

int32

≥ 0

Number of objects associated with this label

count

int32

Defaults to 100

Count of requested messages

total

int32

Total number of returned messages

offset

int32

Defaults to 0

Offset of requested messages

first

int32

The index of the first message

last

int32

The index of the last message

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://gate.whapi.cloud/newsletters//messages?count=100' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Wrong request parameters

404Specified newsletter not found

500Internal Error