Messaging · SMS
Enables SMS on a number.
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
Path parameters
| Name | Type | Notes |
|---|---|---|
idrequired | string |
Example
curl -X POST "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/sms" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/sms", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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/phone-numbers/6bfebd43ddc270f6d2c56fc5/sms",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
enabledbooleanidstringphoneNumberstringisActivebooleancountrystringsmsCapablebooleanCan be null.
mmsCapablebooleandomesticOnlybooleannotReadybooleanneedsRegistrationbooleanalreadyRegisteredbooleanregistrationStatusstringOne of
pending,approved,rejected. Can be null.reusableobjectCan be null.
registrationIdstringstatusstring
messagestring
200 response
{
"enabled": true,
"id": "6bfebd43ddc270f6d2c56fc5",
"phoneNumber": "+14155550123",
"isActive": true,
"country": "US",
"smsCapable": true,
"mmsCapable": true,
"domesticOnly": true,
"notReady": true,
"needsRegistration": true,
"alreadyRegistered": true,
"registrationStatus": "pending",
"reusable": {
"registrationId": "63860e5807731168163e54f0",
"status": "active"
},
"message": "Hello from Pozy"
}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. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 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 registrationPOSTPre-check 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 linkDELDisable SMS on a numberPOSTAdd number to SMS registration