RCS Bots REST API
RCS Bots REST API for SMSGatewayCenter APIs
RCS Bots REST API
Use the Bots REST API to list RCS bots available to your account. This endpoint accepts GET requests and returns JSON.
API Endpoint
https://unify.smsgateway.center/rest/rcs/v1/botsLegacy alias without v1 in the path is also supported: /rest/rcs/bots
Authentication
Send your account userid with either password as a request parameter, or your account API key in the apikey request header. userid is required in both cases. Password is not required when the apikey header is used. RCS product and RCS API access must be enabled on your account. Do not publish live usernames or passwords.
| Parameter | Required | Description | Example/Value |
|---|---|---|---|
| Authentication | |||
| userid | Yes | Your SMSGatewayCenter account username. Required even when the apikey header is used. | YourUsername |
| password | Yes* | Your account password. Not required when the apikey header is used. | ********** |
| output | Yes | Response format. Must be json. | json |
| action | Optional | Defaults to list. Only list is supported in v1. | list |
Sample Request (cURL)
curl --location 'https://unify.smsgateway.center/rest/rcs/v1/bots?userid=YourUsername&password=xxxxx&output=json&action=list'
Sample Request - API Key Header (cURL)
curl --location --get 'https://unify.smsgateway.center/rest/rcs/v1/bots' \
--header 'apikey: YourApiKey' \
--data-urlencode 'userid=YourUsername' \
--data-urlencode 'output=json' \
--data-urlencode 'action=list'
Sample Success Response
{
"status": "success",
"botsList": [
{
"botId": 3,
"name": "YourBot",
"status": 1,
"logoUrl": "https://example.com/bots/logo.png",
"isSandbox": 0
}
],
"totalRecords": 1,
"page": 1,
"limit": 1,
"fromDate": "",
"toDate": "",
"statusCode": "200",
"reason": "success"
}
Sample Error Response
{
"status": "error",
"botsList": [],
"statusCode": "403",
"reason": "RCS API access is not enabled for this account."
}
Notes
- Only active bots (
status=1) are returned. - Use
botIdfrom this list in Send RCS and Template APIs. isSandboxof1means the bot is a sandbox bot.
Testimonials
