API Access
This API is currently in beta and only available to select clients.
Prerequisites
RCS chatbot needs to be created on all operators in geography before RCS messages or capabilities API can be used can be sent This setup takes at least 7 days after submission on the UI under the apps section of imiconnect |
|---|
Headers
Authentication
You will need to pass the service key in the header of the API.
Request Header | Description |
|---|---|
Content-Type | application/json |
key | Service key available within the API settings in a service |
Body Parameters
Parameter | Type | Mandatory | Description |
|---|---|---|---|
msisdn | JSONArray | yes | MSISDN in E164 format |
appId | string | yes | appId of the RCS chatbot from UI |
forceRefresh | boolean | no | true/false Does a live lookup on carrier instead of imi cache |
carrierId | string | no | if you already know the carrier of the end customer, you can pass this as an optional parameter. increases the throughput of RCS outbound messages for list of carrierIds, check here |