Messaging · SMS
Pre-checks a carrier registration without changing anything.
POST
https://api.pozy.ai/v1/sms/registrations/preflightpreflightSmsRegistration
Guides: US 10DLC registration, SMS
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
registrationTypestringrequiredOne of
standard_10dlc,sole_prop_10dlc.phoneNumbersarray of stringbrandobjectrequiredcampaignobjectrequiredmessagingBrandNamestring2 to 60 characters.
Example
curl -X POST "https://api.pozy.ai/v1/sms/registrations/preflight" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"registrationType": "standard_10dlc",
"brand": {},
"campaign": {}
}'const res = await fetch("https://api.pozy.ai/v1/sms/registrations/preflight", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
registrationType: "standard_10dlc",
brand: {},
campaign: {}
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/sms/registrations/preflight",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"registrationType": "standard_10dlc",
"brand": {},
"campaign": {},
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
composedobjectbrandobjectcampaignobject
advisoriesarray of objectfieldstringCan be null.
codestringCan be null.
concernstringseveritystringOne of
block,warn.
verdictstringOne of
pass,warn,fail,unreviewed.aiUnavailableboolean
200 response
{
"composed": {
"brand": {},
"campaign": {}
},
"advisories": [
{
"field": "string",
"code": "string",
"concern": "string",
"severity": "block"
}
],
"verdict": "pass",
"aiUnavailable": true
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.
More in SMS
POSTSend an SMS/MMSGETLook up carrier + line typeGETList SMS opt-outsGETList alphanumeric sender IDsPOSTCreate an alphanumeric sender IDPOSTRequest a higher sender ID daily limitDELDelete an alphanumeric sender IDGETList carrier registrationsPOSTStart a carrier registrationGETGet a carrier registrationDELDeactivate a brand/campaign registrationPOSTSubmit the sole-prop OTPPOSTRe-send the sole-prop OTPPOSTAppeal a rejected campaignPOSTReply to a change requestPOSTUpload opt-in form proofPOSTUpload opt-in form proof for an appealPOSTCreate a registration share linkPOSTEnable SMS on a numberDELDisable SMS on a numberPOSTAdd number to SMS registration