Skip to main content

Message

Message Object​

FieldTypeDescription
createdAtstringDate of conversation creation (ISO 8601 formatted)
uuidstringUnique identifier of the message
textstringText of the message
statusstringStatus of the message (sent, received or note)
channelstringChannel of the message (whatsapp, telegram, ...)
fromstringSender of the message
tostringReceiver of the message
senderobjectWho sent the message, see Sender Object

Sender Object​

The sender object tells who wrote or sent the message. It is present on every message returned by GET /contacts/:uuid/messages and by the message_created webhook.

FieldTypeDescription
typestringThe kind of sender, one of the values listed below
userobject | nullThe team member behind the message (uuid, name and email), or null when there is no team member
typeMeaning
contactThe contact sent the message.
agentA team member sent the reply or wrote the internal note. user is that team member. For a message sent from another app connected to the same number (for example the WhatsApp Business app), user is the team member assigned to the conversation at that time.
apiThe message was sent with POST /messages/send. user is the team member passed as assigned_user, and null when no assigned_user was passed.
botA Callbell bot sent the message, including AI agent steps of a bot.
automationAn automatic message sent by Callbell: away, closing and automatic routing messages, and scheduled reminders.
broadcastThe message was sent as part of a broadcast.
ai_agentMeta's Business AI agent replied on the WhatsApp number.
systemCallbell generated the message, for example a note recording that a conversation was assigned or closed.
unknownCallbell did not record who sent the message, which is the case for some messages created before this field existed.

user is null for every type other than agent and api. It is also null when the team member has since been deleted, for outbound messages imported from the WhatsApp Business app history, and for api messages sent on behalf of the account owner.

sender.json
{
"type": "agent",
"user": {
"uuid": "8a1f3c0e2b7d4e5f9a6b1c2d3e4f5a6b",
"name": "John Doe",
"email": "john.doe@example.com"
}
}