Enviar mensagem de lista
curl --request POST \
--url https://api.d-api.cloud/api/v1/interactive/send/list \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"sessionId": "<string>",
"to": "<string>",
"description": "<string>",
"buttonText": "<string>",
"sections": [
{
"rows": [
{
"rowId": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"title": "<string>"
}
],
"title": "<string>",
"footerText": "<string>",
"mentionAll": true
}
'import requests
url = "https://api.d-api.cloud/api/v1/interactive/send/list"
payload = {
"sessionId": "<string>",
"to": "<string>",
"description": "<string>",
"buttonText": "<string>",
"sections": [
{
"rows": [
{
"rowId": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"title": "<string>"
}
],
"title": "<string>",
"footerText": "<string>",
"mentionAll": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sessionId: '<string>',
to: '<string>',
description: '<string>',
buttonText: '<string>',
sections: [
{
rows: [{rowId: '<string>', title: '<string>', description: '<string>'}],
title: '<string>'
}
],
title: '<string>',
footerText: '<string>',
mentionAll: true
})
};
fetch('https://api.d-api.cloud/api/v1/interactive/send/list', 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.d-api.cloud/api/v1/interactive/send/list",
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([
'sessionId' => '<string>',
'to' => '<string>',
'description' => '<string>',
'buttonText' => '<string>',
'sections' => [
[
'rows' => [
[
'rowId' => '<string>',
'title' => '<string>',
'description' => '<string>'
]
],
'title' => '<string>'
]
],
'title' => '<string>',
'footerText' => '<string>',
'mentionAll' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.d-api.cloud/api/v1/interactive/send/list"
payload := strings.NewReader("{\n \"sessionId\": \"<string>\",\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"rowId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"footerText\": \"<string>\",\n \"mentionAll\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.d-api.cloud/api/v1/interactive/send/list")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sessionId\": \"<string>\",\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"rowId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"footerText\": \"<string>\",\n \"mentionAll\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.d-api.cloud/api/v1/interactive/send/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sessionId\": \"<string>\",\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"rowId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"footerText\": \"<string>\",\n \"mentionAll\": true\n}"
response = http.request(request)
puts response.read_bodyGuias
Enviar mensagem de lista
Envie uma mensagem interativa com lista de opções.
POST
/
api
/
v1
/
interactive
/
send
/
list
Enviar mensagem de lista
curl --request POST \
--url https://api.d-api.cloud/api/v1/interactive/send/list \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"sessionId": "<string>",
"to": "<string>",
"description": "<string>",
"buttonText": "<string>",
"sections": [
{
"rows": [
{
"rowId": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"title": "<string>"
}
],
"title": "<string>",
"footerText": "<string>",
"mentionAll": true
}
'import requests
url = "https://api.d-api.cloud/api/v1/interactive/send/list"
payload = {
"sessionId": "<string>",
"to": "<string>",
"description": "<string>",
"buttonText": "<string>",
"sections": [
{
"rows": [
{
"rowId": "<string>",
"title": "<string>",
"description": "<string>"
}
],
"title": "<string>"
}
],
"title": "<string>",
"footerText": "<string>",
"mentionAll": True
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sessionId: '<string>',
to: '<string>',
description: '<string>',
buttonText: '<string>',
sections: [
{
rows: [{rowId: '<string>', title: '<string>', description: '<string>'}],
title: '<string>'
}
],
title: '<string>',
footerText: '<string>',
mentionAll: true
})
};
fetch('https://api.d-api.cloud/api/v1/interactive/send/list', 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.d-api.cloud/api/v1/interactive/send/list",
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([
'sessionId' => '<string>',
'to' => '<string>',
'description' => '<string>',
'buttonText' => '<string>',
'sections' => [
[
'rows' => [
[
'rowId' => '<string>',
'title' => '<string>',
'description' => '<string>'
]
],
'title' => '<string>'
]
],
'title' => '<string>',
'footerText' => '<string>',
'mentionAll' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.d-api.cloud/api/v1/interactive/send/list"
payload := strings.NewReader("{\n \"sessionId\": \"<string>\",\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"rowId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"footerText\": \"<string>\",\n \"mentionAll\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.d-api.cloud/api/v1/interactive/send/list")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sessionId\": \"<string>\",\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"rowId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"footerText\": \"<string>\",\n \"mentionAll\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.d-api.cloud/api/v1/interactive/send/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sessionId\": \"<string>\",\n \"to\": \"<string>\",\n \"description\": \"<string>\",\n \"buttonText\": \"<string>\",\n \"sections\": [\n {\n \"rows\": [\n {\n \"rowId\": \"<string>\",\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n }\n ],\n \"title\": \"<string>\",\n \"footerText\": \"<string>\",\n \"mentionAll\": true\n}"
response = http.request(request)
puts response.read_bodyMensagens de lista apresentam opções organizadas em seções, abertas por um
botão (
buttonText). Ótimas para menus, catálogos e fluxos de atendimento.
A estrutura mínima exige description, buttonText e sections. Cada seção
tem um título e uma lista de linhas (rows), cada uma com title e um
identificador retornado quando o usuário seleciona a opção.
Use
title e footerText para dar contexto ao menu. O identificador de cada
linha chega no webhook de mensagem recebida quando o usuário escolhe.Authorizations
API Key para autenticação. Formato: <API_KEY>
Body
application/jsonmultipart/form-datatext/plain
Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Minimum string length:
1Response
200
Resposta bem-sucedida
⌘I
