Zernio
Zernio
API Reference

SMS

Messaging

Send an SMS/MMSPOSTLook up carrier + line typeGETList SMS opt-outsGET

Number Setup

Enable SMS on a numberPOSTDisable SMS on a numberDELETEAdd number to SMS registrationPOST

Registrations

List carrier registrationsGETPre-check a carrier registrationPOSTStart a carrier registrationPOSTGet a carrier registrationGETCreate a registration share linkPOSTDeactivate a brand/campaign registrationDELETE

Registration Review

Appeal a rejected campaignPOSTReply to a change requestPOSTUpload opt-in form proof for an appealPOSTUpload opt-in form proofPOSTRe-send the sole-prop OTPPOSTSubmit the sole-prop OTPPOST

Sender IDs

List alphanumeric sender IDsGETCreate an alphanumeric sender IDPOSTDelete an alphanumeric sender IDDELETERequest a higher sender ID daily limitPOST
Dashboard
llms.txtOpenAPI
OverviewPlatformsAPI ReferenceResources
SMS

Enable SMS on a number

Turns on SMS for one of your numbers. The number's real carrier capability is checked first: some number types can't do SMS at all (smsCapable: false), and a number still provisioning at the carrier returns notReady: true (try again once provisioning finishes).

US numbers additionally need a carrier registration before messages deliver; the response tells you which path applies:

  • alreadyRegistered: true: a prior registration still covers this number; SMS was reactivated.
  • reusable set: you have an approved registration this number can join in one click via POST /v1/phone-numbers/{id}/sms/reuse-registration (no new brand/campaign, no extra carrier fee).
  • needsRegistration: true and no reusable: start one via POST /v1/sms/registrations.

Idempotent: re-running re-attempts any carrier-side setup that failed.

POST
/v1/phone-numbers/{id}/sms

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Path Parameters

id*string

Phone number record ID (from GET /v1/phone-numbers).

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.enableSmsOnNumber({  path: {    id: 'abc123',  },});console.log(data);
{  "enabled": true,  "id": "string",  "phoneNumber": "string",  "isActive": true,  "country": "string",  "smsCapable": true,  "mmsCapable": true,  "domesticOnly": true,  "notReady": true,  "needsRegistration": true,  "alreadyRegistered": true,  "registrationStatus": "pending",  "reusable": {    "registrationId": "string",    "status": "string"  },  "message": "string"}
Was this page helpful?

List SMS opt-outs

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.

Disable SMS on a number

Turns off SMS for the number (deactivates its SMS account). The carrier registration is untouched, so re-enabling later reactivates it, with no re-registration.