Enviar chatbot

post

https://api.chatbotv4.sincorp.com.br/chat/v1/chatbot/send

Permite iniciar a execução de um chatbot.
Durante a execução do chatbot, a interação com a conversa fica desabilitada para atendentes na central de atendimento.
A execução pode ser cancelada a qualquer momento, via API ou através da central de atendimento.
Este endpoint segue as mesmas regras do canal de atendimento, por exemplo: uma conversa só pode ser iniciada no WhatsApp utilizando um modelo de mensagem.
Caso o contato não esteja cadastrado, ele será cadastrado automaticamente antes do envio.

Body Params

Parâmetros para iniciar o chatbot.

botKey

uuid | null

Chave do chatbot a ser enviado.

from

string | null

Número de telefone ou @usuarioinstagram do canal cadastrado na conta.

string | null

Número de telefone ou @usuarioinstagram do destinatário.

sessionId

uuid | null

ID da conversa para a qual o chatbot deve ser enviado.
Se a conversa estiver concluída, o chatbot será executado sem reiniciá-la.

options

object

sessionMetadata

object | null

Metadados relevantes para o atendimento. Através deste campo, é possível salvar propriedades adicionais para o atendimento, na estrutura chave-valor.
Qualquer metadado adicionado poderá ser utilizado como parâmetro nas mensagens e condicionais do chatbot, além de serem enviados de volta nos webhooks.
Esses metadados são enviados apenas enquanto o atendimento estiver ativo, ou seja, não são enviados em atendimentos posteriores.

contactMetadata

object | null

Metadados relevantes para o contato. Através deste campo, é possível salvar propriedades adicionais para o contato, na estrutura chave-valor.
Qualquer metadado adicionado poderá ser utilizado como parâmetro nas mensagens e condicionais do chatbot, além de serem enviados de volta nos webhooks.
Esses metadados são salvos no contato e, portanto, são enviados mesmo em atendimentos posteriores.

senderId

string | null

ID de identificação no seu sistema para rastreamento e consulta do disparo.

callbackUrl

string | null

URL para receber webhook quando o chatbot for iniciado ou falhar.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

500Server Error