Custom channels rules

The custom_channels_rules object describes the sending rules for a single custom channel in the virtual sender. Requests and responses use an array of such objects.

JSON

JSON

{
    "id": 10001,
    "sid": "custom_channel_sid",
    "rules": [
        {
            "type": "default",
            "value": "",
            "senders": [
                {
                    "from_name": "Example",
                    "sender_id": 798,
                    "percent": 100
                }
            ]
        }
    ]
}

XML

<xml>
  <id>10001</id>
  <sid>custom_channel_sid</sid>
  <rules array='true'>
    <type>default</type>
    <value></value>
    <senders array='true'>
      <from_name>Example</from_name>
      <sender_id>798</sender_id>
      <percent>100</percent>
    </senders>
  </rules>
</xml>

Description

Parameter	Type	Example	Description
id	int	10001	Numeric ID of the custom channel
sid	string	"custom_channel_sid"	String identifier (SID) of the custom channel
rules	JSON array	[]	Rules for the custom channel — each element has the same structure as the Email rule object and SMS rule object