Messaging · SMS

Pre-check a carrier registration

Pre-checks a carrier registration without changing anything.

POSThttps://api.pozy.ai/v1/sms/registrations/preflight
preflightSmsRegistration

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

  • registrationTypestringrequired

    One of standard_10dlc, sole_prop_10dlc.

  • phoneNumbersarray of string
  • brandobjectrequired
  • campaignobjectrequired
  • messagingBrandNamestring

    2 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": {}
}'

Response

200 on success

  • composedobject
    • brandobject
    • campaignobject
  • advisoriesarray of object
    • fieldstring

      Can be null.

    • codestring

      Can be null.

    • concernstring
    • severitystring

      One of block, warn.

  • verdictstring

    One 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:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in SMS