Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

messageId
string
required

Unique identifier for a WhatsApp Message. Format: msg_wa_[test_]{ksuid}

Pattern: ^msg_wa_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

WhatsApp message details

id
string
required

Unique identifier for a WhatsApp Message. Format: msg_wa_[test_]{ksuid}

Pattern: ^msg_wa_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

whatsappPhoneNumberId
string
required
displayPhoneNumber
string | null
required
fromPhoneNumber
string
required
toPhoneNumber
string
required
type
enum<string>
required
Available options:
text,
image,
video,
audio,
document,
location,
contacts,
template,
interactive,
reaction,
sticker,
button,
order,
system,
pin,
unknown
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND
contactName
string | null
required
textBody
string | null
required
mediaUrl
string | null
required
mediaMimeType
string | null
required
mediaFilename
string | null
required
mediaCaption
string | null
required
mediaFileSize
number | null
required
mediaSha256
string | null
required
isVoiceNote
boolean | null
required
isAnimatedSticker
boolean | null
required
locationLatitude
string | null
required
locationLongitude
string | null
required
locationName
string | null
required
locationAddress
string | null
required
reactionEmoji
string | null
required
reactionMessageId
string | null
required
buttonText
string | null
required
buttonPayload
string | null
required
replyToMessageId
string | null
required
isForwarded
boolean
required
isFrequentlyForwarded
boolean
required
hasReferral
boolean
required
queuedAt
string<date-time> | null
required
sentAt
string<date-time> | null
required
deliveredAt
string<date-time> | null
required
readAt
string<date-time> | null
required
failedAt
string<date-time> | null
required
errorCode
string | null
required
errorMessage
string | null
required
errorTitle
string | null
required
errorDetails
string | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
recipients
object[]
required
referral
object | null
required
order
object | null
required
conversationWindow
object | null
required
contactsData
any
templateData
any
interactiveData
any
systemData
any