Download OpenAPI specification:Download

Capabilities

The capabilities endpoint enables you to check the RCS capabilities of a handset for a given MSISDN.

Get MSISDN capabilities

The capability check endpoint allows you to check the specific RCS capabilities for a given MSISDN.

NOTE:
The RCS capability check is in beta and may return incorrect results under certain circumstances. For further information, please contact your Sinch account manager.

Request
Security:
BearerAuth
path Parameters
sender-id
required
string (SenderId)

The Sender ID.

Example: AbcdEFGhijKlmnoP
query Parameters
msisdn
required
string <MSISDN> (MSISDN) [ 9 .. 17 ] characters ^(?:00|\+|)[1-9][0-9]{8,16}$

The the handset phone number in E.164 format.

Responses
200

Successfully queried the API

Response Schema: application/json
at
required
string <RFC3339 UTC "Zulu">

Timestamp When the response was generated

msisdn
required
string <MSISDN> [ 9 .. 17 ] characters ^(?:00|\+|)[1-9][0-9]{8,16}$

Phone number that the capability set belongs to

mcc
required
string (MobileCountryCode) ^[0-9]{3}$

Mobile country code for phone number, must be 3 digits

mnc
required
string (MobileNetworkCode) [ 2 .. 3 ] characters ^[0-9]{2,3}$

Mobile network code for the phone number, must be 2 or 3 digits

capabilities
required
Array of strings

The set of possible MaaP capabilities

Items Enum: "chat" "fileTransfer" "videoCall" "geolocationPush" "callComposer" "chatBotCommunication"
rcs_enabled
required
boolean

Whether or not the Sinch API can send RCS messages to this device

404

The device does not exist or is not RCS capable

451

Capability lookup not allowed

500

The system was unable to process the request

504

We could not fetch the capabilities of the device in a timely manner.

get/{sender-id}/capabilities
Request samples
curl -i -X GET \
  'https://us.rcs.api.sinch.com/rcs/v1/{sender-id}/capabilities?msisdn=stringstr' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
application/json
{
  • "at": "string",
  • "msisdn": "stringstr",
  • "mcc": "string",
  • "mnc": "str",
  • "capabilities": [
    • "chat"
    ],
  • "rcs_enabled": true
}