דלג לתוכן הראשי
A cheat sheet for the values you’ll meet across requests, responses and webhook payloads. Each object and endpoint page also repeats the values it uses, so you don’t have to come back here - but this is the complete picture.

Chat status

Appears as: chat.status, newChatStatus (system messages), template chatStatus, replyAction.chatStatus, and the statuses[] filter of Search Chats (which takes the names, not the numbers).
ValueNameMeaning
0BOTHandled by the bot
1PENDINGWaiting for a human agent
2ASSIGNEDTaken by an agent (shown as “Taken” in Texter)
3RESOLVEDConversation finished
4BULKCreated/affected by a bulk send

Message status

Appears as: message.status, statusHistory[].status, and messageStatus in the Message Status Changed webhook.
ValueMeaning
0Sent - sent from the platform
1Accepted - accepted by the provider (e.g. Meta received it)
2Delivered - delivered to the recipient’s device
3Seen - read/opened by the recipient (blue ticks)
4Failed - failed to deliver (e.g. invalid number)
5Channel Failed - system/channel level failure
6Deleted - message was deleted

Channels

channelInfo.name, channel query filters, quick-reply targets, problem channel: whatsapp · messenger · instagram · website_chat · email · sms

Message content types

message.type and the type of Send a Message to Chat bodies:
TypeDirectionContent field
textbothtext
mediabothmedia[]
contactsbothcontacts[]
locationbothlocation
buttonsoutgoingtext + buttons[]
listoutgoingtext + list
postbackincomingpostback (the button/row the contact chose)
specialbothspecial (channel-specific, e.g. template sends)

Media types

media[].mediaType: image · video · document · audio · sticker (Sending supports image, video, document, audio; sticker appears on received messages.)

Template localization status

provider_template.localizations[].status:
StatusMeaning
REQUESTEDSubmitted, waiting for WhatsApp
SUBMIT_FAILEDSubmission to WhatsApp failed
PENDINGUnder WhatsApp review
APPROVEDApproved - can be sent
REJECTEDRejected by WhatsApp (see rejectionReason)
DELETION_PENDINGDeletion requested, not yet final
DELETEDDeleted at WhatsApp
SUBMITTEDAccepted for processing

Template category

provider_template.category: MARKETING · UTILITY - WhatsApp may recategorize on approval.

Quick reply display position

display.position: top · main

Scenario run step types

steps[].type in Scenario Runs: event · loader · condition · action · loop

Identifier cheat sheet

Which ID goes where - the most common source of confusion:
IdentifierLooks likeWhere you get itWhere you use it
Chat ID (chat._id)67bf11038b24880cc966f799Search ChatsPath of all /chats/{chatId} and /messages/*/{chatId} endpoints; quick-reply target[].id
Contact ID (channelInfo.id)972521234567Chat/message objectsto when sending templates
Account ID (channelInfo.accountId)972586640430Chat/message objects, Texter settingsfrom, template paths /whatsapp/templates/{accountId}, filters
Provider message ID (message.channelInfo.id)wamid.HBgMOTcy...Message objects, webhook externalIdcontext when replying to a message
Message ID (message._id)69062b15962e17ab3033f886Message objectsbeforeId pagination cursor
File ID (media[].fileId)6900c1eac29d42708adac92fMessage media itemsGenerate Public Media URL, re-sending media
Bot session ID (botState.id)64-char hexChat botState / previousBotSessionbotSessionId filter of Get Messages
Template name (template.name)bulk_marketing_272List All TemplatestemplateName when sending, template paths
Label ID (label.id)hot_leadList All Labelschat.labels, label filters, label management
Scenario ID (scenario._id)6970b3c1d2e3f40123456789List All SubscriptionsSubscription manage endpoints
Agent UID4d170fc7-5cd6-...chat.agent.uid, Chat Taken payloadsagentUid in Assign Chat
Department IDcustomer_serviceTexter settingsdepartmentId, template departments[]