> ## 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.

# iMessage Availability

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

### Parameters

| Name        | In    | Type   | Required | Description                                                      |
| ----------- | ----- | ------ | -------- | ---------------------------------------------------------------- |
| phoneNumber | query | string | ✅        | 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


## OpenAPI

````yaml get /imessage/availability
openapi: 3.0.3
info:
  title: Messages API
  version: 1.0.0
  description: >-
    API for sending messages, uploading media, fetching messages, and handling
    Arnio's webhooks.
servers:
  - url: https://api.arnio.co/api/v1
security: []
paths:
  /imessage/availability:
    get:
      tags:
        - Messages
      summary: iMessage availability
      parameters:
        - name: phoneNumber
          in: query
          required: true
          schema:
            type: string
            pattern: ^\+?[1-9]\d{1,14}$
          description: Phone number in E.164 format (e.g., +1234567890)
      responses:
        '200':
          description: Availability retrieved successfully
          content:
            application/json:
              example:
                status: 200
                message: Success
                data:
                  available: true
        '400':
          description: Invalid or missing phoneNumber
          content:
            application/json:
              example:
                success: false
                message: Validation error
                errors:
                  phoneNumber:
                    - >-
                      Phone number must be a valid international format (e.g.,
                      +1234567890)
        '500':
          description: Failed to check iMessage availability
          content:
            application/json:
              example:
                success: false
                error: Failed to check iMessage availability
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Provide your generated API Key.

````