Skip to main content
GET
/
imessage
/
availability
iMessage availability
curl --request GET \
  --url https://api.arnio.co/api/v1/imessage/availability \
  --header 'X-API-Key: <api-key>'
{
  "status": 200,
  "message": "Success",
  "data": {
    "available": true
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.arnio.co/llms.txt

Use this file to discover all available pages before exploring further.

Check whether a phone number can receive iMessages. Requires authentication. Make sure to encode phone numer in query param.

​
Parameters

NameInTypeRequiredDescription
phoneNumberquerystring✅Phone number in international (E.164) format, e.g. +1234567890

​
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