Custom card - Placeholders
- Last updated on June 21, 2024 at 7:04 PM
You can use placeholders in the Hook URL, headers and body of the request. The following placeholders are available:
| Variable | Description |
| {{calling_phone_number}} | The calling phone number (available for voiceand sms/whatsapp conversations)* |
| {{called_phone_number}} | The called phone number (available for voiceand sms/whatsapp conversations)* |
| {{customer_phone_number}} | The customer's phone number (available for voiceand sms/whatsapp conversations)* |
| {{agent_phone_number}} | The agent's phone number (available for voiceand sms/whatsapp conversations)* |
| {{a_phone_number}} | Caller’s phone number (originating number, and for non-voice channels, the requester's phone number if known)* |
| {{b_phone_number}} | The destination's number (typical your organization number) (available for voiceand sms/whatsapp conversations)* |
| {{widget_id}} | The Dixa chat Widget ID* (available only for the legacy Dixa Chat - does not work with the replacement, Dixa Messenger) |
| {{facebook_page_id}} | The Facebook Page ID (available on Facebook conversations)* |
| {{sending_email}} | The sending email (available for email/contactform conversations)* |
| {{receiving_email}} | The receiving email (available for email/contactform conversations)* |
| {{agent_email}} | The assigned agent's email (does not give you the currently logged in agent)* |
| {{customer_email}} | The customer's email (available for email/contact form/chat/messenger conversations)* |
| {{a_email}} | The sender's email address (for non-email address based channels, the requester's email if known)* |
| {{b_email}} | The receiver’s email address (available for email conversations)* |
| {{csid}} | The conversation id in Dixa |
| {{customer_external_id}} | The external id of a customer (available for all conversations, if external Id was provided programatically for the requester) |
(*) Variables which have any invalid URL characters (eg. @ in email or + in phone number already encoded for
query string parameters (as an example
`?email={{a_email}}) if you use it in the hook URL. Being compliant with RFC 3986 encoding should not be applied if variable is a part of a path (as an example /test/{{a_email}}).If the Hook URL contains any static query parameters, their values must be encoded with URL encoding. | |
voicein the above table means channels using Dixa telephony, such as callbacks, voicemail and inbound/outbound phone calls.