Skip to main content
GET
A message

Authorizations

Authorization
string
header
required

Your API key, e.g. gr_live_…

Path Parameters

id
string
required

The id.

Response

The message.

id
string
to
string | null

The customer's phone; null when they shared none (see customer).

customer
object

Who the customer is. phone can be null: a customer who uses a WhatsApp username may not share their number. user_id is WhatsApp's business-scoped user ID (for example "IN.13491208655302741918").

country
string | null
type
string
category
string | null
campaign_id
string | null

The campaign it belongs to; null when it is not a campaign message.

campaign_reference
string | null

That campaign's reference.

text
string | null

The words that were sent (a template with its values put in).

media
object | null

The file that was sent: id (for GET /v1/media/{id}), type and mime_type; null when none.

status
enum<string>
Available options:
accepted,
sent,
delivered,
read,
failed
reason
string | null
failure
object | null
price
string | null
charged
string | null
currency
string
reference
string | null
created_at
string | null
accepted_at
string | null
delivered_at
string | null
read_at
string | null
failed_at
string | null
timeline
object[]