v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

Envio

Chatbot

Enfileira o disparo de um chatbot para um contato. O processamento ocorre de forma assíncrona após o retorno deste endpoint. 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. Este endpoint tem rate limit individual e permite 1000 requisições a cada 2 minutos.

post/v1/send/chatbot

Request body

botKeystring uuid nullable

Chave do chatbot a ser enviado.

fromstring nullable

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

tostring nullable

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

sessionIdstring uuid nullable

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

sessionMetadataobject nullable

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.

contactMetadataobject nullable

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.

senderIdstring nullable

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

callbackUrlstring nullable

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

Response

Success

idstring uuid

createdAtstring date-time

updatedAtstring date-time nullable

companyIdstring uuid

sessionIdstring uuid nullable

senderIdstring nullable

statusUrlstring nullable

sentAtstring date-time nullable

failedReasonstring nullable

callbackUrlstring nullable

waitReplyboolean nullable