Get message

get https://gate.whapi.cloud/messages/{MessageID}

The method returns a message from any chat by message id.

Responses

Response body

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

body

string

required

Message text

buttons

array of objects

buttons

object

type

string

required

Type of button

quick_reply call copy url

title

string

required

Button text

string

required

Button ID

copy_code

string

Button code for copy type

phone_number

string

Button phone number for call type

url

string

Button url for url type

merchant_url

string

Button merchant_url for url type

sections

array of objects

Section of the message

sections

object

title

string

Title of the section

rows

array of objects

Rows of the section

rows

object

title

string

Title of the row

description

string

Description of the row

string

Row ID

product_items

array of objects

Product items of the section

product_items

object

catalog_id

string

Catalog ID

product_id

string

Product ID

button

string

Button text for list of message

view_once

boolean

Is view once

image

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

caption

string

Optional. Text caption under the media.

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

width

int32

Width of the media in pixels

height

int32

Height of the media in pixels

buttons

array of objects

buttons

object

type

string

required

Type of button

quick_reply call copy url

title

string

required

Button text

string

required

Button ID

copy_code

string

Button code for copy type

phone_number

string

Button phone number for call type

url

string

Button url for url type

merchant_url

string

Button merchant_url for url type

view_once

boolean

Is view once

video

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

caption

string

Optional. Text caption under the media.

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

width

int32

Width of the media in pixels

height

int32

Height of the media in pixels

seconds

int32

Optional. For video files, this field indicates the duration of the video file in seconds.

autoplay

boolean

Optional. If the media is a GIF, this field indicates whether the GIF should be played automatically when the message is received.

buttons

array of objects

buttons

object

type

string

required

Type of button

quick_reply call copy url

title

string

required

Button text

string

required

Button ID

copy_code

string

Button code for copy type

phone_number

string

Button phone number for call type

url

string

Button url for url type

merchant_url

string

Button merchant_url for url type

view_once

boolean

Is view once

short

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

caption

string

Optional. Text caption under the media.

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

width

int32

Width of the media in pixels

height

int32

Height of the media in pixels

seconds

int32

Optional. For video files, this field indicates the duration of the video file in seconds.

autoplay

boolean

Optional. If the media is a GIF, this field indicates whether the GIF should be played automatically when the message is received.

buttons

array of objects

buttons

object

type

string

required

Type of button

quick_reply call copy url

title

string

required

Button text

string

required

Button ID

copy_code

string

Button code for copy type

phone_number

string

Button phone number for call type

url

string

Button url for url type

merchant_url

string

Button merchant_url for url type

view_once

boolean

Is view once

gif

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

caption

string

Optional. Text caption under the media.

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

width

int32

Width of the media in pixels

height

int32

Height of the media in pixels

seconds

int32

Optional. For video files, this field indicates the duration of the video file in seconds.

autoplay

boolean

Optional. If the media is a GIF, this field indicates whether the GIF should be played automatically when the message is received.

buttons

array of objects

buttons

object

type

string

required

Type of button

quick_reply call copy url

title

string

required

Button text

string

required

Button ID

copy_code

string

Button code for copy type

phone_number

string

Button phone number for call type

url

string

Button url for url type

merchant_url

string

Button merchant_url for url type

view_once

boolean

Is view once

audio

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

seconds

int32

Optional. For audio files, this field indicates the duration of the audio file in seconds.

recording_time

number

≥ 0

Defaults to 0

Time in seconds to simulate recording voice

view_once

boolean

Is view once

voice

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

seconds

int32

Optional. For audio files, this field indicates the duration of the audio file in seconds.

recording_time

number

≥ 0

Defaults to 0

Time in seconds to simulate recording voice

view_once

boolean

Is view once

document

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

caption

string

Optional. Text caption under the document.

filename

string

Optional. File name

page_count

integer

Optional. Number of pages

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

buttons

array of objects

buttons

object

type

string

required

Type of button

quick_reply call copy url

title

string

required

Button text

string

required

Button ID

copy_code

string

Button code for copy type

phone_number

string

Button phone number for call type

url

string

Button url for url type

merchant_url

string

Button merchant_url for url type

view_once

boolean

Is view once

link_preview

object

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

body

string

required

Message text

url

string

URL of the link

string

Media ID

link

string

Optional. Link to media

sha256

string

Checksum

catalog_id

string

Contact ID

newsletter_id

string

Newsletter ID

invite_code

string

Invite code

title

string

required

Title of the link

description

string

Description of the link

canonical

string

Canonical URL of the link (for example, if the link is shortened)

preview

string

Base64 encoded image for mini version link preview. In JPEG format

view_once

boolean

Is view once

sticker

object

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

animated

boolean

Optional. For stickers, this field indicates whether the sticker is animated.

width

int32

Width of the media in pixels

height

int32

Height of the media in pixels

preview

string

Optional. Base64 encoded preview of the media. In PNG format.

view_once

boolean

Is view once

location

object

latitude

double

required

Latitude of location being sent

longitude

double

required

Longitude of location being sent

address

string

Address of the location

name

string

Name of the location

url

string

URL for the website where the user downloaded the location information

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

accuracy

int32

Accuracy of the location in meters

speed

int32

Speed of the location in meters per second

degrees

int32

Degrees clockwise from true north

comment

string

Optional. Comment for the location

view_once

boolean

Is view once

live_location

object

latitude

double

required

Latitude of live location being sent

longitude

double

required

Longitude of live location being sent

accuracy

int32

Accuracy of the live location in meters

speed

int32

Speed of the live location in meters per second

degrees

int32

Degrees clockwise from true north

caption

string

Optional. Text caption under the live location

sequence_number

int64

Optional. Sequence number of the live location for event tracking

time_offset

number

Optional. Time offset of the live location

preview

string

Optional. Base64 encoded preview of the media. In JPEG format.

view_once

boolean

Is view once

contact

object

name

string

Name of contact

vcard

string

Vcard of contact

view_once

boolean

Is view once

contact_list

object

list

array of objects

list

object

name

string

Name of contact

vcard

string

Vcard of contact

view_once

boolean

Is view once

interactive

object

header

object

Header of interactive

body

object

Body of interactive

footer

object

Footer of interactive

action

object

required

type

string

Defaults to button

Interactive type

list button product

string

required

Media ID

link

string

Optional. Link to media

mime_type

string

required

Mime type of media

file_size

int64

required

File size in bytes

file_name

string

Optional. File name

sha256

string

Checksum

timestamp

number

Created at

view_once

boolean

Is view once

poll

object

title

string

required

Title of poll

options

array of strings

required

length between 2 and 12

Options of poll

options*

vote_limit

integer

Number of selectable options in poll (1 - can choose only one option, 0 - any number of options)

total

integer

Total count of selected options

results

array of objects

results

object

string

required

option ID

name

string

required

option name

count

integer

required

Number of votes for this option

voters

array of strings

required

List of users who voted for this option

voters*

view_once

boolean

Is view once

hsm

object

header

object

Header

body

string

Message text

footer

string

Message footer

buttons

array of objects

Buttons

buttons

object

string

ID of the button

type

string

Type of button

simple reply url phone_number copy_code

text

string

Button text

url

string

URL

phone_number

string

Phone number

copy_code

string

Code

system

object

body

string

Message body

order

object

order_id

string

Order ID

seller

string

Seller ID (Contact ID)

title

string

Order title

text

string

Order message text

token

string

Base64 secret token

item_count

number

Total products count

currency

string

Currency

USD EUR AED AFN ALL AMD ANG AOA ARS AUD AWG AZN BAM BBD BDT BGN BHD BIF BMD BND BOB BRL BSD BTN BWP BYN BZD CAD CDF CHF CLP CNY COP CRC CUP CVE CZK DJF DKK DOP DZD EGP ERN ETB FJD FKP GBP GEL GGP GHS GIP GMD GNF GTQ GYD HKD HNL HRK HTG HUF IDR ILS IMP INR IQD IRR ISK JEP JMD JOD JPY KES KGS KHR KMF KPW KRW KWD KYD KZT LAK LBP LKR LRD LSL LYD MAD MDL MGA MKD MMK MNT MOP MRU MUR MVR MWK MXN MYR MZN NAD NGN NIO NOK NPR NZD OMR PAB PEN PGK PHP PKR PLN PYG QAR RON RSD RUB RWF SAR SBD SCR SDG SEK SGD SHP SLL SOS SRD SSP STN SVC SYP SZL THB TJS TMT TND TOP TRY TTD TWD TZS UAH UGX UYU UZS VEF VND VUV WST XAF XCD XOF XPF YER ZAR ZMW ZWL

total_price

number

Total order price

status

string

Order status

new accepted canceled

preview

string

Order preview base64 image JPEG

group_invite

object

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

body

string

required

Message text

url

string

URL of the link

string

Media ID

link

string

Optional. Link to media

sha256

string

Checksum

catalog_id

string

Contact ID

newsletter_id

string

Newsletter ID

invite_code

string

Invite code

title

string

required

Title of the link

description

string

Description of the link

canonical

string

Canonical URL of the link (for example, if the link is shortened)

preview

string

Base64 encoded image for mini version link preview. In JPEG format

view_once

boolean

Is view once

newsletter_invite

object

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

body

string

required

Message text

url

string

URL of the link

string

Media ID

link

string

Optional. Link to media

sha256

string

Checksum

catalog_id

string

Contact ID

newsletter_id

string

Newsletter ID

invite_code

string

Invite code

title

string

required

Title of the link

description

string

Description of the link

canonical

string

Canonical URL of the link (for example, if the link is shortened)

preview

string

Base64 encoded image for mini version link preview. In JPEG format

view_once

boolean

Is view once

admin_invite

object

body

string

required

Message text

newsletter_id

string

required

Newsletter ID

newsletter_name

string

required

Newsletter name

expiration

number

required

Expiration timestamp of the invitation

preview

string

Base64 encoded newsletter preview image. In JPEG format

product

object

catalog_id

string

Catalog ID

product_id

string

Product ID

catalog

object

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

body

string

required

Message text

url

string

URL of the link

string

Media ID

link

string

Optional. Link to media

sha256

string

Checksum

catalog_id

string

Contact ID

newsletter_id

string

Newsletter ID

invite_code

string

Invite code

title

string

required

Title of the link

description

string

Description of the link

canonical

string

Canonical URL of the link (for example, if the link is shortened)

preview

string

Base64 encoded image for mini version link preview. In JPEG format

view_once

boolean

Is view once

product_items

object

type

string

Type of interactive

list buttons

action

object

target

string

Target message ID or chat ID

type

string

required

Type of action

edited edit delete reaction ephemeral vote comment event_response

emoji

string

Action emoji for reaction

ephemeral

integer

Ephemeral message duration

edited_type

string

Defaults to text

Message type

edited_content

object

votes

array of strings

List of poll options

votes

comment

string

Comment

event_response

object

context

object

forwarded

boolean

Is forwarding message

forwarding_score

int32

Count fo forwarding message

mentions

array of strings

The numbers of the mentioned users

mentions

object

Advertisement message from META-business

conversion

object

Message conversion data

quoted_id

string

ID of quoted message

quoted_type

string

Defaults to text

Message type

quoted_content

object

quoted_author

string

Whatsapp ID of quoted message author

ephemeral

integer

Ephemeral message duration

event

object

is_canceled

boolean

True if event is canceled

name

string

Event name

description

string

Event description

join_link

string

Join link

start

integer

Chat timestamp

responses

array of objects

Event responses

responses

object

participant

string

Contact ID

response

string

Response

UNKNOWN GOING NOT_GOING

timestamp

integer

Response timestamp

list

object

header

string

body

string

label

string

footer

string

sections

array of objects

sections

object

title

string

rows

array of objects

rows

object

string

title

string

description

string

buttons

object

text

string

footer

string

buttons

array of objects

buttons

object

string

text

string

type

string

UNKNOWN RESPONSE NATIVE_FLOW

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

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://gate.whapi.cloud/messages/ \
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 message not found

500Internal Error