Bulk Number Capability  Check

The Bulk Number Capability Check API allows querying multiple mobile numbers in a single request to retrieve their RCS support status, carrier information, and activity status. This is ideal for batch processing and campaign targeting.

API Request to Check RCS Capability for Bulk Numbers

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

The following is the request format to check RCS capability for bulk numbers: 

curl --location 'https://<api_domain>/v1/<sid>/rcs/lookup'\
--header 'Content-Type:<Content-Type>' \ 
--header 'api-key: <api-key>' \ 
--data {  
    "deviceAddresses": ["<deviceAddresses>”]  
}  

The following is a sample request that describes how to check RCS capability for bulk numbers:

curl --location 'https://rcs-api.na.kaleyra.io/v1/XXXXX6913850XXXX/rcs/lookup'\
--header 'Content-Type: application/json' \ 
--header 'api-key:XXXXX3b8497f58a94e84b671aca43XXXX' \ 
--data ' {
    "deviceAddresses": [
        "+1XXXXXXX985",
        "+1XXXXXXX986"
    ]
}' 

Following is the list of attributes to be used in the payload to check bulk numbers capability:

Sample Success Response

The following is the sample success response:

{ 
    "devices": [ 
        { 
            "deviceAddress": "+1XXXXXXX985", 
            "carrierId": "Google", 
            "carrierStatus": "ACTIVE", 
            "rcsEnabled": true 
        }, 
        { 
            "deviceAddress": "+1XXXXXXX986", 
            "carrierId": "Google", 
            "carrierStatus": "ACTIVE", 
            "rcsEnabled": false 
        } 
    ] 
} 

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.