Get Outbound SMS Rates

This request returns a list of outbound SMS rates for a partner.

get	/sms/rates/outbound/{sub_type}

Sample

A sample GET request to get outbound SMS rates for the selected subtype for a partner:

curl -X GET \
'https://api.carrierx.com/core/v2/sms/rates/outbound/toll?limit=1' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with a list of outbound SMS rates for a partner:

{
    "active": "yes",
    "count": 1,
    "effective_date": "2023-10-20T00:00:00.000Z",
    "has_more": true,
    "items": [
        {
            "country_code": "CZE",
            "country_name": "Czech Republic",
            "mcc": 230,
            "mnc": 4,
            "network": null,
            "operator": null,
            "price": "0.08533"
        }
    ],
    "limit": 1,
    "offset": 0,
    "pagination": {
        "next": "https://api.carrierx.com/core/v2/sms/rates/outbound/toll?limit=1&offset=1"
    },
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "rates_plan": {
        "name": "sms_retail_rates-2023-10-20",
        "rates_plan_sid": "832d7042-2f40-4a5a-b508-ff4d2a988d7a"
    },
    "total": 1778
}

This request is enabled for Pagination, Result Filtering, and Field Filtering.

Required Scopes

To get information about outbound SMS rates, the partner must have one of the following scopes enabled:

• sms.manage
• sms.read

Path Arguments

Parameter	Data Type	Description
sub_type required	string	The message rate assignment subtype. Values accepted in this field are:

• short_code
• toll
• toll_free