Get RCS functionality

Retrieve the RCS functionality of a phone number. For example checks if a phone number can receive RCS message and if it can receive RCS carousels.

Headers

PINNACLE-API-KeystringRequired

Query parameters

phoneNumberstringOptionalformat: "^\+\d{11}$"

The phone number to check for RCS functionality. Should be in E.164 format (i.e. +12345678901).

Response

Successfully retrieved RCS functionality
is_enabledboolean
Indicates if RCS is enabled.
standalone_rich_cardboolean
Indicates if standalone rich cards are supported.
carousel_rich_cardboolean
Indicates if carousel rich cards are supported.
create_calendar_event_actionboolean
Indicates if buttons to create a calendar event are supported.
dial_actionboolean
Indicates if dial buttons are supported.
open_url_actionboolean
Indicates if open URL buttons are supported.
share_location_actionboolean
Indicates if share location buttons are supported.
view_location_actionboolean
Indicates if view location buttons are supported.

Errors