List SMS carriers

GET

/smscarriers

Last modified:2026-10-08 21:47:46

OperationId:ListSmsCarriers

Returns the platform's SMS carriers: the builtin carriers (bandwidth, onvoy, inteliquent, messagemedia, impact, brightlink, thinq, voipinno, and teli) followed by the custom carriers. Takes no filters and is not paged.

Super User and Super User Read Only get every carrier in full. auth and every value in custom-outbound-json-fields are masked: the first 2 and last 2 characters, with asterisks between; a value of 8 characters or fewer is all asterisks. A Super User can send include-secret=yes to read them whole; the read is recorded, and any other scope that sends it gets 403. Every other scope that can read carriers, Basic User included, gets the portal view: enabled carriers only, each reduced to carrier, mms-capable, and group-mms-capable.

mms-capable and group-mms-capable come from the platform's MMS carrier lists, not from the carrier record.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

The carriers: full objects for Super User and Super User Read Only, the portal view for every other scope.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/smscarriers?include-secret=yes' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Super User

[
    {
        "carrier": "bandwidth",
        "type": "builtin",
        "enabled": true,
        "mms-capable": true,
        "group-mms-capable": true
    },
    {
        "carrier": "onvoy",
        "type": "builtin",
        "enabled": false,
        "mms-capable": false,
        "group-mms-capable": false
    },
    {
        "carrier": "acme-sms",
        "type": "custom",
        "enabled": true,
        "mms-capable": false,
        "group-mms-capable": false,
        "auth": "ab****************************yz",
        "auth-type": "Bearer Token",
        "url": "https://sms.example.com/v1/messages",
        "inbound-to": "to",
        "inbound-from": "from",
        "inbound-text": "text",
        "outbound-from": "from",
        "outbound-to": "to",
        "outbound-text": "text",
        "json-encode": true,
        "content-type": "application/json",
        "outbound-include-auth-header": true,
        "set-http-header": true
    }
]

Modified at 2026-10-08 21:47:46

Delete network test report across domains

Create custom SMS carrier