sms
List carrier registrations
AuthorizationBearer <token>
API key authentication - use your Zernio API key as a Bearer token
In: header
Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sms.listSmsRegistrations();console.log(data);{
"registrations": [
{
"id": "string",
"registrationType": "standard_10dlc",
"displayName": "string",
"status": "pending",
"brandStatus": "string",
"campaignStatus": "string",
"brandId": "string",
"campaignId": "string",
"declineReason": "string",
"phoneNumbers": [
"string"
],
"awaitingOtp": true,
"trustScore": 0,
"throughput": {
"label": "string",
"smsPerMinute": 0,
"smsPerDay": 0
}
}
]
}{
"error": "Unauthorized"
}List SMS opt-outs GET
The recipients who opted out of SMS (replied STOP) across your numbers, most recent first. Compliance surface: you must be able to see and export your opt-out list. Read-only: a recipient is re-subscribed only by replying START. Pass `format=csv` to download a CSV instead of JSON.
Get a carrier registration GET
Poll this for approval progress after starting a registration.