RCS Capability Lookup API

Understand how you can use RCS capability lookup API v1 for verifying the RCS device capability.

📘

Please Note

The RCS channel is supported via Webex Connect RCS Capability Lookup API v1.

The API endpoint for it is: [https://{YourRegion}.webexconnect.io/v1/rcs/capabilities].

Please modify YourRegion in the URL to reflect your tenant’s region. See Know your endpoint page.

Refer to our Postman Collection for trying various types of RCS messages supported by Webex Connect.

Request Body to Verify RCS device capability Using RCS Capability Lookup API

{
    "msisdn": [
        "{{msisdn}}" //Mandatory. E.164 format required/recommended.
    ],
    "appId": "{{rcsAppId}}" //Mandatory. 
}
ParametersTypeMandatoryDescription
msisdnstringyesPhone number, i.e., msisdn to which the RCS messages have to be sent in E.164 format e.g., +44XXXXXXXXXX

Note: If the "+E.164" format is enabled for your tenant, all the numbers in the 'to' field should follow the "+E.164" format.
This format displays the number with a '+' followed by the country code and the phone number.
+E.164 format does not apply to the numbers in the 'from' field.
appIdstringyesUnique ID of RCS asset that is set up in Webex Connectplatform.

Sample Response Body

[
    {
        "resolveTimestamp": "2024-11-06T16:15:46.799+05:30",
        "capabilities": [
            "ACTION_CREATE_CALENDAR_EVENT",
            "ACTION_DIAL",
            "ACTION_OPEN_URL",
            "ACTION_SHARE_LOCATION",
            "ACTION_VIEW_LOCATION",
            "CHAT",
            "FILE_TRANSFER",
            "PAYMENTS_V1",
            "REVOCATION",
            "RICHCARD_CAROUSEL",
            "RICHCARD_STANDALONE"
        ],
        "carrierCode": 106,
        "serviceProvider": "GOOGLE",
        "id": "pyf65kz2fve2zirchgqkosyt3m",
        "msisdn": "+91987XXXX123",
        "enabled": true,
        "timestamp": "2024-11-06T16:15:46.799+05:30"
    }
]
Status code- 400 - Bad Request

[
    {
        "code": "7104",
        "message": "Invalid app ID"
    }
]
Response ParameterTypeDescription
resolveTimestampstringThe timestamp of the response received.
capabilitiesstringAn array listing the user's device's capabilities.
ACTION_CREATE_CALENDAR_EVENTstringAction to create a calendar event.
ACTION_DIALstringAction to dial a number.
ACTION_OPEN_URLstringAction to open a URL in a browser.
ACTION_SHARE_LOCATIONstringAction to share a location.
ACTION_VIEW_LOCATIONstringAction to view a location in a map app.
CHATstring
FILE_TRANSFERstring
REVOCATIONstringIf the user supports revocation, the agent can revoke a message it sent before the RBM platform delivers the message.
RICHCARD_CAROUSELstringCarousel of rich cards.
RICHCARD_STANDALONEstringStandalone rich cards.
carrierCodeintCarrier code of the msisdns being requested.
serviceProviderstringMessaging service provider.
idstringCapability request id.
msisdnstringMSISDN in "E164" format.The device's phone number, to which the capability request was sent.
enabledbooleanIndicates If RCS is enabled for the device.
timestampstringThe timestamp of the capability request sent.