Enviar mensagem no Front, por uma API

Envia uma nova mensagem a partir de um canal, o que inicia uma nova conversa, e responde 202 com um message_uid. Sai na hora, e o Front arquiva a nova conversa, a menos que options.archive seja false. Exige a permissão de envio no token de API.

Identificador
front_send_message

A chamada

POST https://connect.reportei.com/api/tools/front_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "channel_id": "<channel_id>",
    "to": [],
    "body": "<body>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
channel_idstringSimChannel that sends the message: the id starting with cha_ from List channels, or alt:address: followed by the channel address, like alt:address:support@acme.com.
toarraySimRecipient handles, like email addresses or phone numbers, depending on the channel.
bodystringSimBody of the message. Email channels accept HTML.
ccarrayNãoHandles that get a copy.
bccarrayNãoHandles that get a blind copy.
subjectstringNãoSubject, for email messages.
author_idstringNãoId of the teammate the message is sent on behalf of, starting with tea_, from List teammates.
optionsobjectNãoTags to add and whether to archive the new conversation after sending.

Conexões possíveis

O seu cliente conecta a conta do Front uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/front_send_message. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Front

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.