Skip to main content
GET
iMessage availability
Check whether a phone number can receive iMessages. Requires authentication. Make sure to encode phone numer in query param.

Parameters

Responses

  • 200: Availability retrieved successfully (proxied from the Messages server)
  • 400: Invalid or missing phoneNumber
  • 500: Failed to check iMessage availability

Authorizations

X-API-Key
string
header
required

Provide your generated API Key.

Query Parameters

phoneNumber
string
required

Phone number in E.164 format (e.g., +1234567890)

Pattern: ^\+?[1-9]\d{1,14}$

Response

Availability retrieved successfully