Skip to main content
GET
/
v1
/
organization
/
whatsapp
/
messages
/
{messageId}
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/whatsapp/messages/{messageId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "whatsappPhoneNumberId": "<string>",
  "displayPhoneNumber": "<string>",
  "fromPhoneNumber": "<string>",
  "toPhoneNumber": "<string>",
  "type": "text",
  "direction": "INBOUND",
  "contactName": "<string>",
  "textBody": "<string>",
  "mediaUrl": "<string>",
  "mediaMimeType": "<string>",
  "mediaFilename": "<string>",
  "mediaCaption": "<string>",
  "mediaFileSize": 123,
  "mediaSha256": "<string>",
  "isVoiceNote": true,
  "isAnimatedSticker": true,
  "locationLatitude": "<string>",
  "locationLongitude": "<string>",
  "locationName": "<string>",
  "locationAddress": "<string>",
  "reactionEmoji": "<string>",
  "reactionMessageId": "<string>",
  "buttonText": "<string>",
  "buttonPayload": "<string>",
  "replyToMessageId": "<string>",
  "isForwarded": true,
  "isFrequentlyForwarded": true,
  "hasReferral": true,
  "queuedAt": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z",
  "deliveredAt": "2023-11-07T05:31:56Z",
  "readAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z",
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "errorTitle": "<string>",
  "errorDetails": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "recipients": [
    {
      "id": "<string>",
      "phoneNumber": "<string>",
      "status": "QUEUED",
      "queuedAt": "2023-11-07T05:31:56Z",
      "sentAt": "2023-11-07T05:31:56Z",
      "deliveredAt": "2023-11-07T05:31:56Z",
      "readAt": "2023-11-07T05:31:56Z",
      "failedAt": "2023-11-07T05:31:56Z",
      "errorCode": "<string>",
      "errorMessage": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "referral": {
    "id": "<string>",
    "sourceUrl": "<string>",
    "sourceId": "<string>",
    "sourceType": "<string>",
    "headline": "<string>",
    "body": "<string>",
    "mediaType": "<string>",
    "imageUrl": "<string>",
    "videoUrl": "<string>",
    "thumbnailUrl": "<string>",
    "ctwaClid": "<string>",
    "welcomeMessage": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "order": {
    "id": "<string>",
    "catalogId": "<string>",
    "orderText": "<string>",
    "totalItems": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "items": [
      {
        "id": "<string>",
        "productRetailerId": "<string>",
        "quantity": 123,
        "itemPrice": "<string>",
        "currency": "<string>"
      }
    ]
  },
  "conversationWindow": {
    "id": "<string>",
    "originType": "<string>",
    "pricingBillable": true,
    "pricingModel": "<string>",
    "pricingCategory": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z"
  },
  "contactsData": "<unknown>",
  "templateData": "<unknown>",
  "interactiveData": "<unknown>",
  "systemData": "<unknown>"
}

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}

Example:

"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

WhatsApp message details

id
string
required

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

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
required
order
object
required
conversationWindow
object
required
contactsData
any
templateData
any
interactiveData
any
systemData
any