SMSBOX - RCS API Documentation (2.1.0)
Changelog
| Version | Date | Changes |
|---|---|---|
| 2.1.0 | 01/24/2025 | ⚓ Change syntax for recipients parameter, add the validity parameter and webhook documentation for RCS API. |
| 2.0.0 | 10/22/2024 | 📲 Add the SMSBOX Documentation for the RCS product. |
Send text message
Authorizations:
ApiKey
path Parameters
| agentId required | string RBM Agent ID |
Request Body schema: application/jsonrequired
| recipients required | Array of strings <= 5000 items |
| contentMessage required | |
| validity | int Number of minutes you want your message to remain valid |
Responses
Request samples
- Payload
- cURL
- Python
- JavaScript
- PHP
Content type
application/json
{- "recipients": [
- "+336XXXXXXXX"
], - "contentMessage": { },
- "validity": 720
}Response samples
- 202
- 400
- 403
- 404
- 405
- 503
- 509
Content type
application/json
{- "response": {
- "response_code": "202",
- "response_desc": "Request successfully queued."
}, - "details": "Request accepted for processing.",
- "reference": "XXXXXXXXXXXXXX",
- "recipients": [
- {
- "submitted": "+33xxxxxxxxx",
- "rewrited": "33xxxxxxxxx",
- "state": "ACCEPTED",
- "reason_code": "PROCESSING"
}
]
}Revoke a message
Authorizations:
ApiKey
path Parameters
| agentId required | string RBM Agent ID |
Request Body schema: application/jsonrequired
| recipients required | Array of strings <= 5000 items |
| reference required | string Value: "XXXXXXXXXXXX" |
Responses
Request samples
- Payload
- cURL
- Python
- JavaScript
- PHP
Content type
application/json
{- "recipients": [
- "string"
], - "reference": "XXXXXXXXXXXX"
}Response samples
- 202
- 400
- 403
- 404
- 405
- 503
- 509
Content type
application/json
{- "response": {
- "response_code": "202",
- "response_desc": "Request successfully queued."
}, - "details": "Request accepted for processing.",
- "reference": "XXXXXXXXXXXXXX",
- "recipients": [
- {
- "submitted": "+33xxxxxxxxx",
- "rewrited": "33xxxxxxxxx",
- "state": "ACCEPTED",
- "reason_code": "PROCESSING"
}
]
}Add Tester
Authorizations:
ApiKey
path Parameters
| agentId required | string RBM Agent ID |
Request Body schema: application/jsonrequired
| recipients required | Array of strings <= 10 items |
Responses
Request samples
- Payload
- cURL
- Python
- JavaScript
- PHP
Content type
application/json
{- "recipients": [
- "string"
]
}Response samples
- 200
- 400
- 403
- 404
- 405
- 503
- 509
Content type
application/json
{- "response": {
- "response_code": "200",
- "response_desc": "Request successfully processed."
}, - "details": "Request processed but no recipient to add.",
- "recipients": [
- {
- "submitted": "+33xxxxxxxxx",
- "rewrited": "33xxxxxxxxx",
- "state": "DELETED",
- "reason_code": "ALREADY_ADDED"
}
]
}Perform a check
Authorizations:
ApiKey
path Parameters
| agentId required | string RBM Agent ID |
Request Body schema: application/jsonrequired
| recipients required | Array of strings <= 500 items |
Responses
Request samples
- Payload
- cURL
- Python
- JavaScript
- PHP
Content type
application/json
{- "recipients": [
- "string"
]
}Response samples
- 200
- 400
- 403
- 404
- 405
- 503
- 509
Content type
application/json
{- "response": {
- "response_code": "200",
- "response_desc": "Request successfully processed."
}, - "recipients": [
- {
- "submitted": "+33xxxxxxxxx",
- "rewrited": "33xxxxxxxxx",
- "state": "SUCCESS",
- "reason_code": "REACHABLE",
- "capabilities": [
- "chatBotCommunication",
- "RICHCARD_STANDALONE"
]
}
]
}Send read event
Authorizations:
ApiKey
path Parameters
| agentId required | string RBM Agent ID |
Request Body schema: application/jsonrequired
| recipients required | Array of strings <= 1 items |
| event required |
Responses
Request samples
- Payload
Content type
application/json
{- "recipients": [
- "string"
], - "event": "READ"
}Response samples
- 202
- 400
- 404
- 405
- 503
- 509
Content type
application/json
{- "response": {
- "response_code": "202",
- "response_desc": "Request successfully queued."
}, - "details": "Request accepted for processing.",
- "reference": "XXXXXXXXXXXXXX",
- "recipients": [
- {
- "submitted": "+33xxxxxxxxx",
- "rewrited": "33xxxxxxxxx",
- "state": "ACCEPTED",
- "reason_code": "PROCESSING"
}
]
}Text Webhook
Request Body schema: application/json
object | |
| requestType | string Type of the request Value: "incoming_message_text" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "type": "text",
- "text": "hello smsbox!"
}, - "requestType": "incoming_message_text",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}Event Webhook
Request Body schema: application/json
object | |
| requestType | string Type of the request Value: "incoming_event" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "type": "event",
- "eventType": "IS_TYPING"
}, - "requestType": "incoming_event",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}Reply Webhook
Request Body schema: application/json
object | |
| requestType | string Type of the request Value: "incoming_message_reply" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "type": "reply",
- "text": "See offer",
- "postbackData": "example-of-posbackData"
}, - "requestType": "incoming_message_reply",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}Action Webhook
Request Body schema: application/json
object | |
| requestType | string Type of the request Value: "incoming_message_action" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "type": "action",
- "text": "open this url",
- "postbackData": "data_url_link-1"
}, - "requestType": "incoming_message_action",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}Message status Webhook
Request Body schema: application/json
object | |
| reference | string Message identifier |
| requestType | string Type of the request Value: "status_update" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "type": "event",
- "eventType": "READ"
}, - "reference": "XXXXXXXXXXXX",
- "requestType": "status_update",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}Document Webhook
Request Body schema: application/json
object | |
| requestType | string Type of the request Value: "incoming_message_file" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
Content type
application/json
{- "data": {
- "type": "file",
- "payload": {
- "mimeType": "image/jpeg",
- "fileSizeBytes": 205487,
- "fileName": "example.jpg",
- "fileUri": "url_of_the_file"
}
}, - "requestType": "incoming_message_file",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}Location Webhook
Request Body schema: application/json
object | |
| requestType | string Type of the request Value: "incoming_message_location" |
| agentId | string RBM Agent identifier |
| agentName | string RBM Agent name |
| clientId | integer SMSBOX user account id |
| msisdn | string User phone number |
| requestProd | string Channel Value: "RCS" |
| requestSubProd | string Enum: "rcs" "rcslike" Subchannel |
| requestDate | string <datetime> Datetime of the request |
| requestUUID | string <uuid> Unique ID of the request |
Responses
Request samples
- Payload
- cURL
- Python
- JavaScript
- PHP
Content type
application/json
{- "data": {
- "type": "location",
- "latitude": 42.08761,
- "longitude": 6.0755356
}, - "requestType": "incoming_message_location",
- "agentId": "XXXXXXXXXXXXXX",
- "agentName": "SMSBOX",
- "clientId": 12123,
- "msisdn": "+336XXXXXXXX",
- "requestProd": "RCS",
- "requestSubProd": "rcs",
- "requestDate": "2024-06-01T14:00:00+02:00",
- "requestUUID": "XXXXXXXXX"
}