Messaging · iMessage

Reserve an available iMessage number

Reserves an available iMessage number.

POSThttps://api.pozy.ai/v1/imessage/senders/available-numbers/{numberId}/reserve

reserveImessageAvailableNumber

Request

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

Path parameters

Name	Type	Notes
`numberId`required	string

Example

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

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

Response

200 on success

successboolean
numberIdstring
expiresInSecondsinteger

200 response

{
  "success": true,
  "numberId": "6b7945542dc9bbde362239b3",
  "expiresInSeconds": 1
}

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 iMessage

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