Check RCS capability

client.capability.checkRCS(, ?): HandleCheckResponse { address, available }

POST/v3/capability/check_rcs

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

ParametersExpand Collapse

body: CapabilityCheckRCSParams { address, from }

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.

ReturnsExpand Collapse

HandleCheckResponse { address, available }

address: string

The recipient address that was checked

available: boolean

Whether the recipient supports the checked messaging service

Check RCS capability

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);

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

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource"
  },
  "success": false
}

{
  "error": {
    "status": 429,
    "code": 1007,
    "message": "Rate limited. Try again in 45 seconds.",
    "retry_after": 45
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}

{
  "error": {
    "status": 503,
    "code": 4004,
    "message": "RCS capability check is temporarily unavailable."
  },
  "success": false
}

Returns Examples

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

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource"
  },
  "success": false
}

{
  "error": {
    "status": 429,
    "code": 1007,
    "message": "Rate limited. Try again in 45 seconds.",
    "retry_after": 45
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error"
  },
  "success": false
}

{
  "error": {
    "status": 503,
    "code": 4004,
    "message": "RCS capability check is temporarily unavailable."
  },
  "success": false
}