Get a carrier registration
Poll this for approval progress after starting a registration.
API key authentication - use your Zernio API key as a Bearer token
In: header
Path Parameters
Response Body
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sms.getSmsRegistration({ path: { id: 'abc123', },});console.log(data);{
"id": "string",
"registrationType": "standard_10dlc",
"status": "pending",
"brandStatus": "string",
"campaignStatus": "string",
"declineReason": "string",
"phoneNumbers": [
"string"
],
"awaitingOtp": true,
"campaignContent": {
"messageFlow": "string",
"sample1": "string",
"sample2": "string"
}
}{
"error": "string",
"type": "invalid_request_error",
"code": "string",
"param": "string",
"platform": "string",
"platformError": {},
"details": {}
}{
"error": "Unauthorized"
}Create an alphanumeric sender ID POST
Registers an alphanumeric sender ID (e.g. `ZERNIO`) — a branded `from` for one-way international SMS. No phone number purchase or carrier registration is needed; once created, pass it as `from` on `POST /v1/sms/messages`. Constraints: 3-11 characters (letters, digits, spaces; at least one letter). Sends cannot reach the US, Canada, or Puerto Rico, are text-only, and recipients cannot reply. Sender IDs that impersonate well-known brands or institutions are rejected. Names are not exclusive: the same sender ID can be registered by any number of workspaces. Creating the same sender ID again is a no-op (re-activates it after a delete).
Delete an alphanumeric sender ID DELETE
Deactivates the sender ID so it can no longer send. Re-creating the same sender ID via `POST /v1/sms/sender-ids` re-activates it.