Chatapps Outbound API
string · requiredstring · requiredstring · requiredinteger · requiredstring · requiredstring · enumstring · uri
Schemas
OutboundChatappRequestBody
api_keyMember API key
api_secretMember API secret
toReceiver phone number in international format (E.164)
Example: 66812345678
template_idID of the approved WhatsApp template to use
Example: 123
channel_nameChannel name configured for the member
Example: default
Dynamic field values to be inserted into the template
callback_methodHTTP method for delivery report callback
Enum values:
GET
POST
Example: POST
callback_urlCallback URL for delivery reports
Example: https://example.com/dlr
TemplateContent
Dynamic field values to be inserted into the template
headerHeader dynamic field values (or media URL for media templates)
messageBody message dynamic field values
footerFooter dynamic field values
Template button content
OutboundChatappsResponse
template_nametemplate_typeremaining_balanceobject
Map of wallet id to amount used
Example: {"12":0.05}
total_messageMemberCreditWallet
idcredit_availablecredit_purchasedis_expiretypeexpire_dateWhatsappListTemplate
idtemplate_nametemplate_typetemplate_languagemessagemessage_dynamic_fieldsheaderheader_typeheader_media_typeheader_dynamic_fieldsfootercontent_exampleExample content for the template (object/array/null depending on template)