Envio

Chatbot

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

post/v1/send/chatbot

Request

  • Base URL: https://api.helena.run/core
  • URL: https://api.helena.run/core/v1/send/chatbot
  • 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 nullable
companyIdstring uuid
sessionIdstring uuid nullable
status'PROCESSING' | 'SAVED' | 'QUEUED' | 'SENT' | 'DELIVERED' | 'READ' | 'FAILED' | 'DELETED' | 'WAIT_REPLY'
senderIdstring nullable
statusUrlstring nullable
sentAtstring date-time nullable
failedReasonstring nullable
callbackUrlstring nullable
waitReplyboolean nullable

Changes

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