Sending Messages

Use this method to send messages to your clients via edna API.

schedule Method

A completed request using the schedule method results in a message that is sent to the messenger according to the parameters specified in the request body. If the request is successful, the server returns code 200 with a JSON object detailing the message identifier and its sending status. If the request fails, the server returns a response with an error code. Read more about error codes.

URL

To send a message, a POST request is sent to the following URL address:  https://app.edna.io/api/cascade/schedule

Request Format

A JSON object is passed in the request body with all the cascade and message parameters. These parameters depend on the message type and its contents.

Request Example

This is an example of the body of a request for the following cascade. First, a message is sent to the client via the push channel, then a WhatsApp message is sent, and finally a text is sent via an SMS channel.

{
    "requestId": "test-001",
    "cascadeId": 111,
    "subscriberFilter": {
        "address": "18000000000",
        "type": "PHONE"
    },
    "startTime": "2022-01-21T08:00:00Z",
    "content": {
        "smsContent": {
            "text": "Your card is ready. Pick it up at the bank office."
        },
        "whatsappContent": {
            "contentType": "TEXT",
            "text": "Your card is ready. Pick can pick it up at the bank office.",
            "attachment": {
                "url": "https://.jpg",
                "name": "How to find us",
                "size": 5123
            },
            "location": {
                "longitude": 56.7645,
                "latitude": 48.4564,
                "address": "London, Buckingham street"
            }
        },
        "pushContent": {
            "small": {
                "text": "Pick it up at the bank office.",
                "title": "Your card is ready",
                "imageUrl": "https://.png"
            },
            "big": {
                "title": "Your card is ready",
                "text": "Pick it up at the bank office.",
                "imageUrl": "https://.png"
            },
            "buttons": [
                {
                    "text": "Contact support",
                    "url": "DeeplinkSupport"
                },
                {
                    "text": "Remind me later",
                    "url": "DeeplinkLater"
                }
            ],
            "action": "DeeplinkMainPush",
            "effects": {
                "vibrate": "[500,100,500,150,50,50]",
                "lights": "#770808",
                "sound": "AthlonRoar",
                "androidNotificationChannel": "Order status"
            },
            "iosSettings": {
                "interruptionLevel": "ACTIVE",
                "category": "ednaPushCategory"
            }
        }
    }
}

Request Parameters

Below are tables with a full set of parameters, their types, and descriptions. Examples of requests for each channel and content type are available here.

General Parameters

whatsAppContent Parameters

viberContent Parameters

smsContent Parameters

pushContent Parameters

Quatation Marks in Text

Pay attention to how you put words in quotation marks. If you use the single (‘) or double quote (”) symbols in the message text, make sure to put the backslash (\) symbol before the opening and after the closing quotation mark. See the following example:

Correct:

"text": "Pablo! We are inviting you to our workshop \“Cooking with Tefal\” 11/25/2021 at 1 p.m. Don\'t miss this event! Give us a call: +7 (495) 100-00-00"

or

"text": "Pablo! We are inviting you to our workshop «Cooking with Tefal» on 11/25/2021 at 1 p.m. Don\'t miss this event! Give us a call: +7 (495) 100-00-00"

Incorrect:

"text": "Pablo! We are inviting you to our workshop “Cooking with Tefal” on 11/25/2021 at 1 p.m. Don't miss this event! Give us a call: +7 (495) 100-80-00"

Text Formatting in WhatsApp

WhatsApp allows you to format text inside your messages. Please note, you cannot disable this feature.

• Italic: Place an underscore on both sides of the text: _text_
• Bold: Place an asterisk on both sides of the text: *text*
• Strikethrough: Place a tilde on both sides of the text: ~text~
• Monospace: Place three backticks on both sides of the text: ```text```

Response Format

The response contains a JSON object with the ID of the sent message and one of the available response codes.

Attachment Types

All attachments that you send must comply with the following requirements. Otherwise, the message will not be delivered.

For details on the media attachment formats for WhatsApp, refer to this article.