Read SMS carrier

GET

/smscarriers/{carrier}

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

OperationId:ReadSmsCarrier

Returns one SMS carrier, builtin or custom. The name is matched exactly, including case.

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.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query Params

Responses

🟢200OK

application/json

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

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Custom carrier

{
    "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:50

Create custom SMS carrier

Update SMS carrier