Getting started with an RCS Channel

This article details the steps required to set up an RCS channel for use with the Sinch Conversation API.

Prerequisites

Before you can set up an RCS channel on the Conversation API, you need to do the following:

General requirements

Note

If you have already completed the Conversation API Getting started steps, you can skip this section.

Sign up for the Sinch Customer Dashboard.
Get access to the Conversation API.
Create your app.
Create your access key. Any API calls you make will require authentication information provided by your access key.

Refer to the Conversation API Getting started section for more information on any of these steps.

RCS Requirements

To start using RCS through the Conversation API, you must gain access to a Sinch RCS Sender Agent (or RCS Agent). Reach out to your account manager for more information on gaining access to the a Sinch RCS Sender Agent.

Warning

Both Conversation API and Sinch RCS API are regional. Your Conversation API App must be created in the same region that your RCS Agent is provisioned. If your Conversation API App is created in a different region than the RCS Agent is provisioned, the RCS channel will report errors and you won't receive your delivery receipts.

Configuring the Conversation API and RCS integration.

You can enable the RCS integration for your Conversation API app using either the Sinch Customer Dashboard or the API.

Enabling the RCS integration using the Sinch Customer Dashboard

When enabling the RCS channel through the Sinch Customer Dashboard, select your app and click SET UP CHANNEL next to the relevant RCS channel. Then, select your configured Sender Identity from the drop-down box and confirm the integration.

You must also configure at least one Conversation API webhook which will trigger POST callbacks to the given URL. For more information on how to do this using the Customer Dashboard, see How to add a webhook to a Conversation API app.

Enabling the RCS integration using the API

To setup the RCS integration programmatically, use the following snippet to configure the channel credentials for the app with the RCS channel:

Copy

Copied

{
  "channel_credentials": [
    {
      "channel": "RCS",
      "static_bearer": {
        "claimed_identity": "{{RCS_AGENT_ID}}",
        "token": "{{RCS_BEARER_TOKEN}}"
      }
    }
  ]
}

Replace {{RCS_AGENT_ID}} with your Sinch RCS Sender Agent ID and {{RCS_BEARER_TOKEN}} with the Agent's access token.

You must also configure at least one Conversation API webhook which will trigger POST callbacks to the callback URL. For more information on how to do this programmatically, click here.

Next steps

After configuring the channel, you need to set the channel priority in your app. Then, it's time to send your first message.

You must know your contact's channel/idenity pair or contact_id prior to sending a message. To get a list of any existing contact_id values, you can make a GET request to the contact webhook. For more information, see the API reference.

If you already know how to set channel priority, or your channel priority is already established, you can begin sending and receiving messages in your preferred language: