Messaging · iMessage
Fetches iMessage sender status.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
senderIdrequired | string |
Example
curl -X GET "https://api.pozy.ai/v1/imessage/senders/68ef6f94df13738fb25f1e94" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/imessage/senders/68ef6f94df13738fb25f1e94", {
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.get(
"https://api.pozy.ai/v1/imessage/senders/68ef6f94df13738fb25f1e94",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleansenderobject13 child fields
idstringkindstringOne of
phone,email.regionstringOne of
US,GB. Can be null.handlestringCan be null.
optInLinkstringCan be null.
statusstringOne of
ordering,awaiting_payment,activating,active,suspended,canceled,failed.priceCentsintegerproviderstringprofileIdstringdisplayNamestringCan be null.
failureReasonstringCan be null.
accountIdstringCan be null.
createdAtstring (date-time)
healthobjectCan be null.
imessagestringOne of
active,degradation,outage.whatsappstringOne of
active,degradation,outage.
imessageLinkstringCan be null.
200 response
{
"success": true,
"sender": {
"id": "6bfebd43ddc270f6d2c56fc5",
"kind": "phone",
"region": "US",
"handle": "acme",
"optInLink": "string",
"status": "ordering",
"priceCents": 1,
"provider": "string",
"profileId": "6a0b6573846efc28aaa9a3ff",
"displayName": "Acme",
"failureReason": "string",
"accountId": "696e0b682d0a31188e7a2ba9",
"createdAt": "2026-10-02T09:00:00.000Z"
},
"health": {
"imessage": "active",
"whatsapp": "active"
},
"imessageLink": "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 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 iMessage
GETList iMessage sendersPOSTRegister an iMessage senderGETList iMessage sender ordersPOSTOrder a new iMessage senderPATCHUpdate an iMessage senderDELCancel an iMessage senderGETList iMessage audienceGETList iMessage sandbox contactsPOSTAdd an iMessage sandbox contactDELRemove an iMessage sandbox contactPOSTSubscribe or opt out an iMessage contactPOSTCreate a tracked iMessage opt-in linkGETList instantly available iMessage numbersPOSTReserve an available iMessage numberPOSTStart an iMessage group chatGETGet an iMessage groupPATCHRename an iMessage group or change its photoPOSTAdd a participant to an iMessage groupDELRemove a participant from an iMessage group