Send a RCS

To simplify job creation, Docoon REST API provides to you a specific resource per media. For RCS jobs only the resource is called “RCSJobs”.

We will review how to send quickly a RCS with one recipient or many recipients. We will also review the RCS advanced parameters and the text personnalisation of the message.

When the RCS job request is accepted, you will get a jobNumber, it means a job was accepted and was put in the appropriate queue (depending on your priority defined in your contract), we will send the message to each recipient as soon as possible depending of the current traffic.

When the job is finished, you will be able to check the transmission status of each recipient, check “Get transmission reports” easy worflow for more information.

Send RCS request informations

Name: /RCSJobs
Type: POST

Headers:

Parameters list:

Structure details of AdhocRecipients

This Object is used to list your recipient in the “AdhocRecipients”

Send Basic RCS

{
    "JobType": "RCS", 
    "RcsMessage": 
    {
        "Type": 1,
        "Name": "rcsMessage.json",
        "Hosted": false,
        "Content":      "ewogICAgInRleHRfbWVzc2FnZSI6IHsKICAgICAgInRleHQiOiAiVGhpcyBpcyBhIHRleHQgbWVzc2FnZS4iCgl9Cn0="
    },
    "TrackingId": "Send Basic RCS", 
    "AdhocRecipients": [ { "Name": "Dupont", "Address": "00337xxxxxx" } ] 
}

RCS advanced parameters description

In addition to the parameters presented above, there are advanced parameters allowing to configure specific parameters to RCS sending (sender address, content encoding, shorturl activation, …).

Use advanced parameters

{
    "JobType": "RCS", 
    "RcsMessage": 
    {
        "Type": 1,
        "Name": "rcsMessage.json",
        "Hosted": false,
        "Content":   "ewogICAgInRleHRfbWVzc2FnZSI6IHsKICAgICAgInRleHQiOiAiVGhpcyBpcyBhIHRleHQgbWVzc2FnZS4iCgl9Cn0="
    },
    "TrackingId": "Send RCS with advanced parameters", 
    "Parameter": { "Media": 7 },
    "AdhocRecipients": [ { "Name": "Dupont", "Address": "00337xxxxxx" } ] 
}

Send a RCS using a file list

You can also use a file list for your recipient. You will have to replace the “AdhocRecipients” list by a “Lists” of File Reference (see the structure below). List format accepted : .xlsx, .xls, .csv, .tab.

By Default, the phone number should be in the first column of the first (and only) sheets of your file.
The other columns can be used for personalizations.

Structure details of FileReference

Use file list

{
    "JobType": "RCS", 
    "RcsMessage": 
    {
        "Type": 1,
        "Name": "rcsMessage.json",
        "Hosted": false,
        "Content":      "ewogICAgInRleHRfbWVzc2FnZSI6IHsKICAgICAgInRleHQiOiAiVGhpcyBpcyBhIHRleHQgbWVzc2FnZS4iCgl9Cn0="
    },
    "TrackingId": "Send RCS with file list", 
    "Lists": [ { "Name": "test.tab", "Hosted": false, "Type":0, "Content": "77u/MDAzMzc4Tg3OA==" } ] 
}

Sucessful response

Status: 200 : OK

Parameters list:

Sucessful response { “JobNumber”: 44608862 }

Error response

Status: 400: Bad request

Error response { “Message”: “The request is invalid.”, “ModelState”: { “job”: [ “An error has occurred.” ] } }

More Usage Examples

Scheduled job

{
    "JobType": "RCS", 
    "RcsMessage": 
    {
        "Type": 1,
        "Name": "rcsMessage.json",
        "Hosted": false,
        "Content":      "ewogICAgInRleHRfbWVzc2FnZSI6IHsKICAgICAgInRleHQiOiAiVGhpcyBpcyBhIHRleHQgbWVzc2FnZS4iCgl9Cn0="
    },
    "TrackingId": "Send Basic RCS", 
    "ScheduledStartTime": "2019-01-01T00:00:00.688Z",
    "AdhocRecipients": [ { "Name": "Dupont", "Address": "00337xxxxxx" } ] 
}

RCS message JSON structure

The following examples must be BASE64 encoded and put into the “Content” of the “RcsMessage” property.

Text message

{
    "text_message": {
      "text": "Test message"
    }
}

Media message

{
    "media_message": {
      "url": "https://exemple.url/logo.png"
    }
}

Choice message

{
    "choice_message": {
        "text_message": {
            "text": ""
        },
        "choices": [
        {
            "text_message": {
                "text": "Confirm"
            }
        },
        {
            "text_message": {
                "text": "Cancel"
            }
        }
        ]
    }
}

Card message

{
    "card_message": {
        "title": "Test title",
        "description": "Test message",
        "media_message": {
            "url": "https://exemple.url/logo.png"
        },
        "choices": [
        {
            "text_message": {
                "text": "Click here"
            }
        }
        ]
    }
}

Carousel message

{
    "carousel_message": {
        "cards": [
        {
            "title": "Text title",
            "description": "",
            "media_message": {
            "url": "https://exemple.url/logo.png"
        },
        "choices": [
        {
            "text_message": {
                "text": "Sign up here"
            }
        }
        ]
    },
    {
        "title": "Visit our website",
        "description": "",
        "media_message": {
            "url": "https://exemple.url/logo.png"
        },
        "choices": [
            {
                "url_message": {
                    "title": "Website",
                    "url": "https://docoon.com"
                }
            }
            ]
        },
        {
            "title": "Call our customer support line",
            "description": "",
            "media_message": {
                "url": "https://exemple.url/logo.png"
            },
            "choices": [
            {
                "call_message": {
                    "title": "Support line",
                    "phone_number": "+33XXXXX"
                }
            }
            ]
        }
        ] 
    }
}

Location message

{
    "location_message": {
        "title": "Your ride is here!",
        "label": "Meet your driver.",
        "coordinates": {
            "latitude": 55.610479,
            "longitude": 13.002873
        }
    }
}