# Capability

## Check iMessage capability

`client.capability.checkiMessage(CapabilityCheckiMessageParamsbody, RequestOptionsoptions?): HandleCheckResponse`

**post** `/v3/capability/check_imessage`

Check whether a recipient address (phone number or email) is reachable via iMessage.

### Parameters

- `body: CapabilityCheckiMessageParams`

  - `address: string`

    The recipient phone number or email address to check

  - `from?: string`

    Optional sender phone number. If omitted, an available phone from your pool is used automatically.

### Returns

- `HandleCheckResponse`

  - `address: string`

    The recipient address that was checked

  - `available: boolean`

    Whether the recipient supports the checked messaging service

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const handleCheckResponse = await client.capability.checkiMessage({ address: '+15551234567' });

console.log(handleCheckResponse.address);
```

#### Response

```json
{
  "address": "+15551234567",
  "available": true
}
```

## Check RCS capability

`client.capability.checkRCS(CapabilityCheckRCSParamsbody, RequestOptionsoptions?): HandleCheckResponse`

**post** `/v3/capability/check_rcs`

Check whether a recipient address (phone number) supports RCS messaging.

### Parameters

- `body: CapabilityCheckRCSParams`

  - `address: string`

    The recipient phone number or email address to check

  - `from?: string`

    Optional sender phone number. If omitted, an available phone from your pool is used automatically.

### Returns

- `HandleCheckResponse`

  - `address: string`

    The recipient address that was checked

  - `available: boolean`

    Whether the recipient supports the checked messaging service

### Example

```typescript
import LinqAPIV3 from '@linqapp/sdk';

const client = new LinqAPIV3({
  apiKey: process.env['LINQ_API_V3_API_KEY'], // This is the default and can be omitted
});

const handleCheckResponse = await client.capability.checkRCS({ address: '+15551234567' });

console.log(handleCheckResponse.address);
```

#### Response

```json
{
  "address": "+15551234567",
  "available": true
}
```

## Domain Types

### Handle Check

- `HandleCheck`

  - `address: string`

    The recipient phone number or email address to check

  - `from?: string`

    Optional sender phone number. If omitted, an available phone from your pool is used automatically.

### Handle Check Response

- `HandleCheckResponse`

  - `address: string`

    The recipient address that was checked

  - `available: boolean`

    Whether the recipient supports the checked messaging service