Skip to main content

Message

idstringrequired
Example: msg_abc123xyz
conversation_idstringrequired
Example: conv_xyz123
contact_idstring
Example: cnt_1a2b3c4d5e6f
channelstring

Possible values: [whatsapp, instagram, sms, email]

message_typestring

Possible values: [text, template, image, document]

contentstringrequired
Example: Hello! How can we help?
statusstring

Possible values: [sent, delivered, read, failed]

sent_bystring

Possible values: [user, contact, system]

sender object
idstring
namestring
sent_atstring<date-time>
delivered_atstring<date-time>nullable
read_atstring<date-time>nullable
errorstringnullable
Message
{
"id": "msg_abc123xyz",
"conversation_id": "conv_xyz123",
"contact_id": "cnt_1a2b3c4d5e6f",
"channel": "whatsapp",
"message_type": "text",
"content": "Hello! How can we help?",
"status": "sent",
"sent_by": "user",
"sender": {
"id": "string",
"name": "string"
},
"sent_at": "2024-07-29T15:51:28.071Z",
"delivered_at": "2024-07-29T15:51:28.071Z",
"read_at": "2024-07-29T15:51:28.071Z",
"error": "string"
}