Devolver o JSON enviado (eco)
/tools/echoDevolve, igual, o JSON que você mandar. Serve para gerar mensagens dinâmicas na requisição externa do fluxo sem ter um servidor seu: monte no corpo o JSON de mensagens e ações, com as variáveis do contato, e a resposta traz esse JSON de volta. Veja Requisição externa: o fluxo chama o seu sistema.
curl -X POST "https://app.nextagsai.com.br/api/tools/echo" \
-H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"messages": [
{
"message": {
"text": "Oi, Ana! Seu pedido PED-1001 saiu para entrega."
}
}
],
"actions": [
{
"action": "add_tag",
"tag_name": "cliente-vip"
}
]
}'const resposta = await fetch('https://app.nextagsai.com.br/api/tools/echo', {
method: 'POST',
headers: {
'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({
messages: [
{
message: {
text: 'Oi, Ana! Seu pedido PED-1001 saiu para entrega.',
},
},
],
actions: [
{
action: 'add_tag',
tag_name: 'cliente-vip',
},
],
}),
});
const dados = await resposta.json();
console.log(resposta.status, dados);import os
import requests
resposta = requests.post(
"https://app.nextagsai.com.br/api/tools/echo",
headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
json={
"messages": [
{
"message": {
"text": "Oi, Ana! Seu pedido PED-1001 saiu para entrega.",
},
},
],
"actions": [
{
"action": "add_tag",
"tag_name": "cliente-vip",
},
],
},
timeout=30,
)
print(resposta.status_code, resposta.json())<?php
$ch = curl_init('https://app.nextagsai.com.br/api/tools/echo');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'messages' => [
[
'message' => [
'text' => 'Oi, Ana! Seu pedido PED-1001 saiu para entrega.',
],
],
],
'actions' => [
[
'action' => 'add_tag',
'tag_name' => 'cliente-vip',
],
],
]),
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);Autenticação
Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.
Corpo da requisição
JSONContent-Type: application/json
messagesarray de objeto MensagemPor exemplo, as mensagens do conteúdo dinâmico. O eco aceita qualquer JSON e devolve igual: estes campos são só o uso mais comum.
actionsarray de objeto AçãoPor exemplo, as ações do conteúdo dinâmico.
actions[].actionstringobrigatórioValores: add_tag remove_tag set_field_value unset_field_value send_flow transfer_conversation_to assign_conversation unassign_conversation
actions[].tag_namestringO nome da etiqueta (add_tag, remove_tag).
actions[].field_namestringO nome do campo (set_field_value, unset_field_value).
actions[].valuestringO valor do campo (set_field_value) ou human/bot (transfer_conversation_to).
actions[].flow_idinteger ou stringO ID do fluxo (send_flow).
actions[].admin_idinteger ou stringO ID do administrador (assign_conversation).
Respostas
O mesmo JSON que veio no corpo.
messagesarray de objeto MensagemPor exemplo, as mensagens do conteúdo dinâmico. O eco aceita qualquer JSON e devolve igual: estes campos são só o uso mais comum.
actionsarray de objeto AçãoPor exemplo, as ações do conteúdo dinâmico.
actions[].actionstringobrigatórioValores: add_tag remove_tag set_field_value unset_field_value send_flow transfer_conversation_to assign_conversation unassign_conversation
actions[].tag_namestringO nome da etiqueta (add_tag, remove_tag).
actions[].field_namestringO nome do campo (set_field_value, unset_field_value).
actions[].valuestringO valor do campo (set_field_value) ou human/bot (transfer_conversation_to).
actions[].flow_idinteger ou stringO ID do fluxo (send_flow).
actions[].admin_idinteger ou stringO ID do administrador (assign_conversation).
A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.
Relacionados
Este conteúdo ajudou?
Obrigado! Sua resposta ajuda a melhorar a central.