Send RCS with resending by SMS

Example of request to send RCS message with text, image, button and resend the message by SMS in case of failure to deliver.

URI: /api/json.php

All requests to API are sent in JSON format using the POST method.

Header parameters

Requests must contain header Content-Type: application/json, otherwise, the request will be considered invalid even if it has valid JSON.

Request parameters

authstringrequired Your API key, which can be obtained in your personal cabinet

datalist[object]required List of objects with request parameters typestringrequired Request type idnumberrequired Unique message identifier in the client system phonenumberrequired Phone number of the recipient of the message sms_signaturestringrequired Signature in the message sms_messagestringrequired Message text to be sent via SMS rcs_signaturestringrequired Signature in the message rcs_messagestringrequired Message text to be sent via SMS rcs_imagestringrequired Link to the image to be sent in the message rcs_linkstringrequired Link that will be followed after pressing the button rcs_buttonstringrequired Caption to be displayed on the button rcs_lifetimenumber RCS message lifetime in seconds Minimum value: 60 seconds Default: 2 days (172800 seconds) short_linkboolean Shorter and track links hookstring URL address of the script where the message delivery status will be sent

Request example

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "rcs+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Message text to be sent via SMS",
            "rcs_signature": "RCSTest",
            "rcs_message": "Message text to be sent via RCS",
            "rcs_image": "https://url.com/storage/images/image.png",
            "rcs_link": "https://redirect.url",
            "rcs_button": "Button caption",
            "rcs_lifetime": 172800,
            "short_link": true,
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

Response parameters

successinteger Result of request execution

errorstring Error text, returned if success=false

datalist[object] List of objects with the results of request execution successboolean Request execution result returned in the data packet errorstring Error text, returned if data.success=false dataobject Request execution result idnumber Unique message identifier in the client system msg_idnumber Message identifier assigned by the gateway datanumber Description partsnumber Number of messages used to send the specified text

Response examples

Successful

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "id": 100500,
                "msg_id": 123456789,
                "data": 1,
                "parts": 1
            }
        }
    ]
}

Access denied

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}

Error in Alpha-name

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": false,
            "error": "Error in Alpha-name",
            "data": {
                "id": 100500
            }
        }
    ]
}