Send Broadcast Message

Broadcast template messages to your contacts

The Send Broadcast Message method is used if you wish to send the same message to a group of your contacts. You must ask your admin to generate a session key for the specific channel in order to send the message.

POSThttps://{ISLASH_API_ENDPOINT}/api/public/broadcast

Header parameters

Body

application/json

session*string

The session key generated by your admin for controlling which channel is allowed to send message across API

name*string

The name of this broadcast, e.g. Marketing for Winter Sale

template_name*string

The template message name in system Please find it in the iSlash platform

scheduled_at*any

At what time will this message be sent in the format of YYYY-MM-DD HH:MM:SS. (e.g. 2022-01-01 15:00:00)

variable_1any

[Optional] depend on the template

$name: customer name in system

Or free text

**Make sure it contains no newlines, tabs, or more than 4 consecutive spaces

variable_2any

[Optional] depend on the template

$name: customer name in system

Or free text

**Make sure it contains no newlines, tabs, or more than 4 consecutive spaces

variable_3any

[Optional] depend on the template

$name: customer name in system

Or free text

**Make sure it contains no newlines, tabs, or more than 4 consecutive spaces

button_url_variable_1string

[Optional] Depends on the template, either set in here or in each contact.

Free text **Make sure it contains no newlines, tabs, or more than 4 consecutive spaces

mediafile

[Optional] Depends on the template, image/video/document

attach_label_idstring

[Optional] The label ids that will be attached after the broadest message being sent. To attach multiple labels, use “,” to separate. E.g. 1,2,3

See the list of available labels from the Labels API

assign_tostring

[Optional] The email address of the iSlash user that will be assigned to after the broadcast is sent

contacts[i][first_name]string

First name of the contact

**i is the array index number, starting from 0

contacts[i][last_name]string

Last name of the contact

**i is the array index number, starting from 0

contacts[i][identity]string

The target contact number (i.e.: 85256872847)

**i is the array index number, starting from 0

contacts[i][variable_1]string

[Optional] Depends on the template, either set in here or in each contact.

**i is the array index number, starting from 0

contacts[i][button_url_variable _1]string

[Optional] Depends on the template, either set in here or in each contact.

**i is the array index number, starting from 0

Response

200

Success

Body

application/json

metaobject

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://{ISLASH_API_ENDPOINT}/api/public/broadcast', {
    method: 'POST',
    headers: {
      "X-USER-TOKEN": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "session": "text",
      "name": "text",
      "template_name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "meta": {
    "code": "text",
    "message": "text"
  },
  "data": {}
}

Sample Response

{
    "meta": {
        "code": "RESP_OKAY",
        "message": "Success",
        "trace_id": "040a6b96021b02e3"
    },
    "data": []
}