Chatbots

Enviar chatbot

Permite iniciar a execução de um chatbot.<br />Durante a execução do chatbot, a interação com a conversa fica desabilitada para atendentes na central de atendimento.<br />A execução pode ser cancelada a qualquer momento, via API ou através da central de atendimento.<br />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.<br />Caso o contato não esteja cadastrado, ele será cadastrado automaticamente antes do envio.

post/v1/chatbot/send

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v1/chatbot/send
  • Auth: API key in header Authorization

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.<br />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
startAtstring date-time
endAtstring date-time nullable
status'UNDEFINED' | 'STARTED' | 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'HIDDEN'
companyIdstring uuid
contactIdstring uuid nullable
channelIdstring uuid
departmentIdstring uuid nullable
userIdstring uuid nullable
previewUrlstring nullable
titlestring nullable
numberstring nullable
originstring nullable
statusDescriptionstring nullable
timeServicestring nullable
timeWaitstring nullable
firstResponseAtstring date-time nullable
botIdstring uuid nullable
unreadCountinteger
lastMessageTextstring nullable
lastInteractionDatestring date-time nullable
lastMessageOutstring date-time nullable
lastMessageInstring date-time nullable
windowStatus'ACTIVE' | 'EXPIRED' | 'NOT_STARTED'
metadataobject nullable
channelType'GUPSHUP_WHATSAPP' | 'DIALOG360_WHATSAPP' | 'CLOUDAPI_WHATSAPP' | 'ZAPI_WHATSAPP' | 'EVOLUTIONAPI_WHATSAPP' | 'INSTAGRAM' | 'MESSENGER' nullable

Changes

No recorded changes to this operation across all 1 revision of this API.