Messaging · iMessage

List iMessage senders

Returns iMessage senders.

GEThttps://api.pozy.ai/v1/imessage/senders

listImessageSenders

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Authentication

Example

curl -X GET "https://api.pozy.ai/v1/imessage/senders" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/imessage/senders", {
  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",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

sendersarray of object
9 child fields
- idstring
- platformstring
  One of imessage.
- senderstring
- optInLinkstring
  Can be null.
- displayNamestring
- profileIdstring
  Can be null.
- providerstring
- senderVerifiedboolean
- isActiveboolean

200 response

{
  "senders": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "platform": "imessage",
      "sender": "string",
      "optInLink": "string",
      "displayName": "Acme",
      "profileId": "6a0b6573846efc28aaa9a3ff",
      "provider": "string",
      "senderVerified": true,
      "isActive": 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 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 iMessage

POSTRegister an iMessage sender GETList iMessage sender orders POSTOrder a new iMessage sender GETGet iMessage sender status PATCHUpdate an iMessage sender DELCancel an iMessage sender GETList iMessage audience GETList iMessage sandbox contacts POSTAdd an iMessage sandbox contact DELRemove an iMessage sandbox contact POSTSubscribe or opt out an iMessage contact POSTCreate a tracked iMessage opt-in link GETList instantly available iMessage numbers POSTReserve an available iMessage number POSTStart an iMessage group chat GETGet an iMessage group PATCHRename an iMessage group or change its photo POSTAdd a participant to an iMessage group DELRemove a participant from an iMessage group