SendMessagingMessageRequest - SodiumHQ API Schema

Properties

Name	Type	Description
channel	enum	Sms WhatsApp
Sms WhatsApp
body	string	The text: required unless a template is sent, and empty when one is. At most 1,600 characters for SMS and 4,000 for WhatsApp.
The text: required unless a template is sent, and empty when one is. At most 1,600 characters for SMS and 4,000 for WhatsApp.
contentSid	string	WhatsApp only: the template to send (HX followed by 32 hex digits, from the WhatsApp templates list). A template may be sent at any time; free text only within 24 hours of the recipient's last WhatsApp message.
WhatsApp only: the template to send (HX followed by 32 hex digits, from the WhatsApp templates list). A template may be sent at any time; free text only within 24 hours of the recipient's last WhatsApp message.
contentVariables	object	The template's variables by name (`{"1": "Friday"}`); any left out take the template's defaults. Only with `contentSid`.
The template's variables by name (`{"1": "Friday"}`); any left out take the template's defaults. Only with `contentSid`.
templateCode	string	A practice text template's code (from the templates list): its body is rendered on the server for this recipient with the client's details as they are now, and sent as free text, so on WhatsApp only within the 24-hour window. The template must allow the channel.
A practice text template's code (from the templates list): its body is rendered on the server for this recipient with the client's details as they are now, and sent as free text, so on WhatsApp only within the 24-hour window. The template must allow the channel.

JSON Example

{
  "channel": "Sms",
  "body": "string",
  "contentSid": "string",
  "contentVariables": {},
  "templateCode": "string"
}

Used By Operations

POST Send Messaging Conversation Message
/tenants/{tenant}/messaging/conversations/{code}/messages