Skip to main content
POST
/
v1
/
sms
/
routing
/
plans
/
{plan}
/
simulate
/
segments
cURL
curl --request POST \
  --url https://api.comm.com/api/v1/sms/routing/plans/{plan}/simulate/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter_segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "counter": 1,
  "segment_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'
{
  "data": [
    {
      "contacts_count": 123,
      "resource": {
        "to_send": true,
        "fail_reason": "No route found",
        "status": {},
        "selected_method": {},
        "selected_action": {},
        "selected_rule_id": "<string>",
        "selected_route": "<string>",
        "costs": {
          "cost_platform_customer": 123,
          "cost_route_vendor": 123,
          "cost_route_seller": 0,
          "cost_platform_seller": 0,
          "sms_route_rate_id": "<string>"
        }
      },
      "country_ids": [
        "<string>"
      ],
      "network_ids": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
plan
string<uuid>
required

The plan ID

Body

application/json
​
filter_segment_id
string<uuid> | null
​
counter
integer
Required range: x >= 0
​
segment_ids
string<uuid>[]

Response

​
data
SimulateResponseData · object[]
required