Send a rich automation message to a conversation
curl --request POST \
--url https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"message": {
"text": "<string>",
"attachments": [
{
"uploadId": "<string>"
}
],
"quickReplies": [
{
"id": "<string>",
"label": "<string>",
"payload": "<string>"
}
],
"buttons": [
{
"id": "<string>",
"type": "POSTBACK",
"label": "<string>",
"payload": "<string>"
}
]
},
"teamId": "<string>"
}
'import requests
url = "https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}"
payload = {
"message": {
"text": "<string>",
"attachments": [{ "uploadId": "<string>" }],
"quickReplies": [
{
"id": "<string>",
"label": "<string>",
"payload": "<string>"
}
],
"buttons": [
{
"id": "<string>",
"type": "POSTBACK",
"label": "<string>",
"payload": "<string>"
}
]
},
"teamId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: {
text: '<string>',
attachments: [{uploadId: '<string>'}],
quickReplies: [{id: '<string>', label: '<string>', payload: '<string>'}],
buttons: [{id: '<string>', type: 'POSTBACK', label: '<string>', payload: '<string>'}]
},
teamId: '<string>'
})
};
fetch('https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}', 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.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}",
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' => [
'text' => '<string>',
'attachments' => [
[
'uploadId' => '<string>'
]
],
'quickReplies' => [
[
'id' => '<string>',
'label' => '<string>',
'payload' => '<string>'
]
],
'buttons' => [
[
'id' => '<string>',
'type' => 'POSTBACK',
'label' => '<string>',
'payload' => '<string>'
]
]
],
'teamId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}"
payload := strings.NewReader("{\n \"message\": {\n \"text\": \"<string>\",\n \"attachments\": [\n {\n \"uploadId\": \"<string>\"\n }\n ],\n \"quickReplies\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ],\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"type\": \"POSTBACK\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ]\n },\n \"teamId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": {\n \"text\": \"<string>\",\n \"attachments\": [\n {\n \"uploadId\": \"<string>\"\n }\n ],\n \"quickReplies\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ],\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"type\": \"POSTBACK\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ]\n },\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": {\n \"text\": \"<string>\",\n \"attachments\": [\n {\n \"uploadId\": \"<string>\"\n }\n ],\n \"quickReplies\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ],\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"type\": \"POSTBACK\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ]\n },\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "<string>",
"messageId": "<string>",
"externalMessageId": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"issues": [
{
"message": "<string>",
"code": "invalid_type",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}automation
Send a rich automation message to a conversation
Send a rich message, such as a button or card template, into a conversation using the same renderer the automation steps use. Returns 503 while messaging sending is temporarily disabled.
POST
/
api
/
v1
/
automation-rich-messages
/
conversations
/
{conversationId}
Send a rich automation message to a conversation
curl --request POST \
--url https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"message": {
"text": "<string>",
"attachments": [
{
"uploadId": "<string>"
}
],
"quickReplies": [
{
"id": "<string>",
"label": "<string>",
"payload": "<string>"
}
],
"buttons": [
{
"id": "<string>",
"type": "POSTBACK",
"label": "<string>",
"payload": "<string>"
}
]
},
"teamId": "<string>"
}
'import requests
url = "https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}"
payload = {
"message": {
"text": "<string>",
"attachments": [{ "uploadId": "<string>" }],
"quickReplies": [
{
"id": "<string>",
"label": "<string>",
"payload": "<string>"
}
],
"buttons": [
{
"id": "<string>",
"type": "POSTBACK",
"label": "<string>",
"payload": "<string>"
}
]
},
"teamId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
message: {
text: '<string>',
attachments: [{uploadId: '<string>'}],
quickReplies: [{id: '<string>', label: '<string>', payload: '<string>'}],
buttons: [{id: '<string>', type: 'POSTBACK', label: '<string>', payload: '<string>'}]
},
teamId: '<string>'
})
};
fetch('https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}', 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.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}",
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' => [
'text' => '<string>',
'attachments' => [
[
'uploadId' => '<string>'
]
],
'quickReplies' => [
[
'id' => '<string>',
'label' => '<string>',
'payload' => '<string>'
]
],
'buttons' => [
[
'id' => '<string>',
'type' => 'POSTBACK',
'label' => '<string>',
'payload' => '<string>'
]
]
],
'teamId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}"
payload := strings.NewReader("{\n \"message\": {\n \"text\": \"<string>\",\n \"attachments\": [\n {\n \"uploadId\": \"<string>\"\n }\n ],\n \"quickReplies\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ],\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"type\": \"POSTBACK\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ]\n },\n \"teamId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"message\": {\n \"text\": \"<string>\",\n \"attachments\": [\n {\n \"uploadId\": \"<string>\"\n }\n ],\n \"quickReplies\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ],\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"type\": \"POSTBACK\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ]\n },\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bundle.social/api/v1/automation-rich-messages/conversations/{conversationId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"message\": {\n \"text\": \"<string>\",\n \"attachments\": [\n {\n \"uploadId\": \"<string>\"\n }\n ],\n \"quickReplies\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ],\n \"buttons\": [\n {\n \"id\": \"<string>\",\n \"type\": \"POSTBACK\",\n \"label\": \"<string>\",\n \"payload\": \"<string>\"\n }\n ]\n },\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "<string>",
"messageId": "<string>",
"externalMessageId": "<string>"
}{
"message": "<string>",
"statusCode": 123,
"issues": [
{
"message": "<string>",
"code": "invalid_type",
"path": [
"<string>"
]
}
]
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}{
"message": "<string>",
"statusCode": 123
}Was this page helpful?