Single Number Capability Check

The Single Number Capability Check API allows you to check the RCS capability of a single phone number, indicating whether the device supports RCS messaging features.

API Request to Check RCS Capability for Single Number

To check RCS capability for single number, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/lookup/<deviceAddress> with the following request method: 

The following is the request format to check RCS capability for single number: 

curl --location 'https://<api_domain>/v1/<sid>/rcs/lookup/<deviceAddress>'  \ 
--header 'Accept: <content-type>'   
--header 'api-key: <api-key>'

The following is the sample request that describes how to check RCS capability for single number:

curl --location '[https://rcs-api.na.kaleyra.io/v1/XXXXX6913850XXXX/rcs/lookup/+170XXXXXXXX'\   
--header 'Accept: application/json'   
--header 'api-key: XXXXX3b8497f58a94e84b671aca43XXXX'

Following is the list of attributes to be used in the payload to check single number capability:

Sample Success Response

The following is the sample success response:

{
    "code": "RCS702",
    "message": "Device Lookup successful",
    "data": {
        "deviceAddress": "1XXXXXXXXXX",
        "carrierId": "AT&T",
        "carrierStatus": "ACTIVE",
        "rcsEnabled": true
    },
    "error": {}
}
 

Response Fields

The following table outlines the key fields returned in the API response. Each field provides specific information about the queried device(s), including carrier details, RCS capability, and message metadata. These fields help in interpreting the results and making informed decisions for message delivery and targeting.