Messaging · iMessage

List instantly available iMessage numbers

Returns instantly available iMessage numbers.

GEThttps://api.pozy.ai/v1/imessage/senders/available-numbers
listImessageAvailableNumbers

Guide: iMessage

Request

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

Query parameters

NameTypeNotes
regionstringOne of US, GB

Example

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

Response

200 on success

  • numbersarray of object
    • idstring
    • phonestring
    • regionstring
    • locationstring
  • regionstring

    Can be null.

200 response
{
  "numbers": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "phone": "+14155550123",
      "region": "string",
      "location": "string"
    }
  ],
  "region": "string"
}

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 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 iMessage