Send Message
curl --request POST \
--url http://localhost:8080/api/v1/conversations/{cuuid}/messages \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"attachments": [
123
],
"private": true,
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"mentions": [
{
"id": 123
}
],
"echo_id": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/conversations/{cuuid}/messages"
payload = {
"message": "<string>",
"attachments": [123],
"private": True,
"to": ["<string>"],
"cc": ["<string>"],
"bcc": ["<string>"],
"mentions": [{ "id": 123 }],
"echo_id": "<string>"
}
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({
message: '<string>',
attachments: [123],
private: true,
to: ['<string>'],
cc: ['<string>'],
bcc: ['<string>'],
mentions: [{id: 123}],
echo_id: '<string>'
})
};
fetch('http://localhost:8080/api/v1/conversations/{cuuid}/messages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/conversations/{cuuid}/messages",
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([
'message' => '<string>',
'attachments' => [
123
],
'private' => true,
'to' => [
'<string>'
],
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
],
'mentions' => [
[
'id' => 123
]
],
'echo_id' => '<string>'
]),
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 := "http://localhost:8080/api/v1/conversations/{cuuid}/messages"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"attachments\": [\n 123\n ],\n \"private\": true,\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"mentions\": [\n {\n \"id\": 123\n }\n ],\n \"echo_id\": \"<string>\"\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("http://localhost:8080/api/v1/conversations/{cuuid}/messages")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"attachments\": [\n 123\n ],\n \"private\": true,\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"mentions\": [\n {\n \"id\": 123\n }\n ],\n \"echo_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/conversations/{cuuid}/messages")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"attachments\": [\n 123\n ],\n \"private\": true,\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"mentions\": [\n {\n \"id\": 123\n }\n ],\n \"echo_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"conversation_id": 123,
"conversation_uuid": "<string>",
"content": "<string>",
"text_content": "<string>",
"private": true,
"sender_id": 123,
"meta": {
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"from": [
"<string>"
],
"subject": "<string>"
},
"attachments": [
{}
]
}
}Conversations
Send Message
POST
/
api
/
v1
/
conversations
/
{cuuid}
/
messages
Send Message
curl --request POST \
--url http://localhost:8080/api/v1/conversations/{cuuid}/messages \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"message": "<string>",
"attachments": [
123
],
"private": true,
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"mentions": [
{
"id": 123
}
],
"echo_id": "<string>"
}
'import requests
url = "http://localhost:8080/api/v1/conversations/{cuuid}/messages"
payload = {
"message": "<string>",
"attachments": [123],
"private": True,
"to": ["<string>"],
"cc": ["<string>"],
"bcc": ["<string>"],
"mentions": [{ "id": 123 }],
"echo_id": "<string>"
}
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({
message: '<string>',
attachments: [123],
private: true,
to: ['<string>'],
cc: ['<string>'],
bcc: ['<string>'],
mentions: [{id: 123}],
echo_id: '<string>'
})
};
fetch('http://localhost:8080/api/v1/conversations/{cuuid}/messages', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/api/v1/conversations/{cuuid}/messages",
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([
'message' => '<string>',
'attachments' => [
123
],
'private' => true,
'to' => [
'<string>'
],
'cc' => [
'<string>'
],
'bcc' => [
'<string>'
],
'mentions' => [
[
'id' => 123
]
],
'echo_id' => '<string>'
]),
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 := "http://localhost:8080/api/v1/conversations/{cuuid}/messages"
payload := strings.NewReader("{\n \"message\": \"<string>\",\n \"attachments\": [\n 123\n ],\n \"private\": true,\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"mentions\": [\n {\n \"id\": 123\n }\n ],\n \"echo_id\": \"<string>\"\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("http://localhost:8080/api/v1/conversations/{cuuid}/messages")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"message\": \"<string>\",\n \"attachments\": [\n 123\n ],\n \"private\": true,\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"mentions\": [\n {\n \"id\": 123\n }\n ],\n \"echo_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/api/v1/conversations/{cuuid}/messages")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": \"<string>\",\n \"attachments\": [\n 123\n ],\n \"private\": true,\n \"to\": [\n \"<string>\"\n ],\n \"cc\": [\n \"<string>\"\n ],\n \"bcc\": [\n \"<string>\"\n ],\n \"mentions\": [\n {\n \"id\": 123\n }\n ],\n \"echo_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"conversation_id": 123,
"conversation_uuid": "<string>",
"content": "<string>",
"text_content": "<string>",
"private": true,
"sender_id": 123,
"meta": {
"to": [
"<string>"
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"from": [
"<string>"
],
"subject": "<string>"
},
"attachments": [
{}
]
}
}Authorizations
basicAuthtokenAuth
Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>
Path Parameters
Body
application/json
Message details
Specifies whether the message is sent by an agent or a contact.
Available options:
agent, contact Message content
Attachment IDs
Whether message is private (internal note)
Email recipients
CC recipients
BCC recipients
Agents or teams mentioned in a private note.
Show child attributes
Show child attributes
Client-generated identifier echoed back to deduplicate the message on the sender's side
Was this page helpful?
⌘I

