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

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

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

Name	In	Type	Required	Description
phoneNumber	query	string	✅	Phone number in international (E.164) format, e.g. `+1234567890`

X-API-Key

string

header

required

Provide your generated API Key.

phoneNumber

string

required

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

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

Availability retrieved successfully