Skip to main content
POST
/
action
/
multicast
Multicast
curl --request POST \
  --url https://api.livechatinc.com/v3.6/agent/action/multicast \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": {
    "agents": {
      "all": true,
      "ids": [
        "smith@example.com",
        "agent@example.com"
      ],
      "groups": [
        1,
        2
      ]
    }
  },
  "content": {
    "example": {
      "nested": "json"
    }
  }
}
'
import requests

url = "https://api.livechatinc.com/v3.6/agent/action/multicast"

payload = {
"recipients": { "agents": {
"all": True,
"ids": ["smith@example.com", "agent@example.com"],
"groups": [1, 2]
} },
"content": { "example": { "nested": "json" } }
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
recipients: {
agents: {all: true, ids: ['smith@example.com', 'agent@example.com'], groups: [1, 2]}
},
content: {example: {nested: 'json'}}
})
};

fetch('https://api.livechatinc.com/v3.6/agent/action/multicast', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.livechatinc.com/v3.6/agent/action/multicast",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'recipients' => [
'agents' => [
'all' => true,
'ids' => [
'smith@example.com',
'agent@example.com'
],
'groups' => [
1,
2
]
]
],
'content' => [
'example' => [
'nested' => 'json'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.livechatinc.com/v3.6/agent/action/multicast"

payload := strings.NewReader("{\n \"recipients\": {\n \"agents\": {\n \"all\": true,\n \"ids\": [\n \"smith@example.com\",\n \"agent@example.com\"\n ],\n \"groups\": [\n 1,\n 2\n ]\n }\n },\n \"content\": {\n \"example\": {\n \"nested\": \"json\"\n }\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.livechatinc.com/v3.6/agent/action/multicast")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"recipients\": {\n \"agents\": {\n \"all\": true,\n \"ids\": [\n \"smith@example.com\",\n \"agent@example.com\"\n ],\n \"groups\": [\n 1,\n 2\n ]\n }\n },\n \"content\": {\n \"example\": {\n \"nested\": \"json\"\n }\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.livechatinc.com/v3.6/agent/action/multicast")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"recipients\": {\n \"agents\": {\n \"all\": true,\n \"ids\": [\n \"smith@example.com\",\n \"agent@example.com\"\n ],\n \"groups\": [\n 1,\n 2\n ]\n }\n },\n \"content\": {\n \"example\": {\n \"nested\": \"json\"\n }\n }\n}"

response = http.request(request)
puts response.read_body
Required scopes: multicast:rw

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
recipients
object
required

The recipients of the multicast message. At least one of recipients.agents.all, recipients.agents.ids, or recipients.agents.groups is required.

content
any
required

A JSON message to be sent.

type
string

The multicast message type.

Response

200

Multicast sent.