SMS channel properties

There are SMS channel-specific properties that can be used when making calls to the Conversation API. These properties can be listed under channel_properties in the message request.

For example, below is the code for adding the channel specific property SMS_SENDER to a Conversation API call:

Copy
Copied
{
  "app_id": "{{APP_ID}}",
  "recipient": {
    "contact_id": "{{CONTACT_ID}}"
  },
  "message": {
    "text_message": {
      "text": "Text message from Sinch Conversation API."
    }
  },
  "channel_priority_order": ["SMS"],
  "channel_properties": {
    "SMS_SENDER": "mysender"
  }
}

As another example, below is the code for adding the channel specific property SMS_MAX_NUMBER_OF_MESSAGE_PARTS to a Conversation API call:

Copy
Copied
{
  "app_id": "{{APP_ID}}",
  "recipient": {
    "contact_id": "{{CONTACT_ID}}"
  },
  "message": {
    "text_message": {
      "text": "Text message from Sinch Conversation API."
    }
  },
  "channel_priority_order": ["SMS"],
  "channel_properties": {
    "SMS_MAX_NUMBER_OF_MESSAGE_PARTS": "3"
  }
}

The relevant SMS channel properties are detailed in the table below:

Property name Property value
SMS_FLASH_MESSAGE Whether this is a flash SMS message. Flash SMS messages are shown on screen without user interaction while not saving the message to the inbox. Possible values are true and false. The default is false.
SMS_SENDER Optional, the sender to use when sending a message on SMS channel. Can be a valid MSISDN, short code, or alphanumeric sender. If the sender is rejected by the underlying SMS channel, you get the error information in the delivery report.
SMS_MAX_NUMBER_OF_MESSAGE_PARTS Optional, message will be dispatched only if it can be sent in a number of SMS messages equal to or less than the number set in this property.
Was this page helpful?