---
title: "Enviar chatbot"
method: POST
path: "/v1/chatbot/send"
tags: ["Chatbots"]
---

# Enviar chatbot

`POST /v1/chatbot/send`

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.

## Request body

- PublicReqSendBotDTO
  - `botKey` string, uuid, nullable — Chave do chatbot a ser enviado.
  - `from` string, nullable — Número de telefone ou @usuarioinstagram do canal cadastrado na conta.
  - `to` string, nullable — Número de telefone ou @usuarioinstagram do destinatário.
  - `sessionId` string, 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.
  - `options` PublicReqSendBotOptionsDTO
    - `skipIfBotInExecution` boolean, nullable — Se outro chatbot estiver em execução, o chatbot não será enviado.
    - `skipIfInProgress` boolean, nullable — Se uma conversa estiver em andamento, o chatbot não será enviado.
    - `forceStartSession` boolean, nullable — Se uma conversa estiver em andamento, ela será concluída e uma nova será iniciada.
    - `hiddenSession` boolean, nullable — Determina se o atendimento deve estar oculto na tela. Válido apenas caso um novo atendimento seja criado ao enviar a mensagem. O atendimento passará a ser visível caso o contato responda.
  - `sessionMetadata` object, 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.
  - `contactMetadata` object, 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.
  - `senderId` string, nullable — ID de identificação no seu sistema para rastreamento e consulta do disparo.
  - `callbackUrl` string, nullable — URL para receber webhook quando o chatbot for iniciado ou falhar.

## Response `200`

Success

- PublicSessionDTO
  - `id` string, uuid
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `startAt` string, date-time
  - `endAt` string, date-time, nullable
  - `status` 'UNDEFINED' | 'STARTED' | 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'HIDDEN'
  - `companyId` string, uuid
  - `contactId` string, uuid, nullable
  - `channelId` string, uuid
  - `departmentId` string, uuid, nullable
  - `userId` string, uuid, nullable
  - `previewUrl` string, nullable
  - `title` string, nullable
  - `number` string, nullable
  - `utm` PublicUtmDTO
    - `sourceId` string, nullable
    - `source` string, nullable
    - `clid` string, nullable
    - `medium` string, nullable
    - `campaign` string, nullable
    - `content` string, nullable
    - `headline` string, nullable
    - `term` string, nullable
    - `referralUrl` string, nullable
  - `origin` string, nullable
  - `contactDetails` PublicContactDataDTO
    - `id` string, uuid, nullable
    - `name` string, nullable
    - `pictureUrl` string, nullable
    - `phonenumber` string, nullable
    - `instagram` string, nullable
    - `phonenumberFormatted` string, nullable
    - `tagsId` string[], nullable
    - `tagsName` string[], nullable
    - `status` 'ACTIVE' | 'ARCHIVED' | 'BLOCKED' | 'UNDEFINED'
  - `agentDetails` PublicAgentDataDTO
    - `id` string, uuid
    - `userId` string, uuid
    - `name` string, nullable
    - `shortName` string, nullable
    - `phoneNumber` string, nullable
    - `email` string, nullable
    - `pictureFileId` string, uuid, nullable
    - `pictureUrl` string, nullable
  - `channelDetails` PublicChannelIdentityDTO
    - `humanId` string, nullable
    - `platform` string, nullable
    - `provider` string, nullable
    - `providerVariable` string, nullable
    - `pictureUrl` string, nullable
    - `displayName` string, nullable
  - `departmentDetails` PublicDepartmentDataDTO
    - `id` string, uuid
    - `companyId` string, uuid
    - `name` string, nullable
    - `description` string, nullable
    - `isDefault` boolean
    - `isSupervisor` boolean
  - `classification` PublicSessionClassificationDTO
    - `id` string, uuid
    - `category` 'UNDEFINED' | 'WON' | 'LOST' | 'INFO' | 'OTHER'
    - `categoryDescription` string, nullable
    - `amount` number, double
    - `categoryName` string, nullable
  - `statusDescription` string, nullable
  - `timeService` string, nullable
  - `timeWait` string, nullable
  - `firstResponseAt` string, date-time, nullable
  - `botId` string, uuid, nullable
  - `unreadCount` integer
  - `lastMessageText` string, nullable
  - `lastInteractionDate` string, date-time, nullable
  - `lastMessageOut` string, date-time, nullable
  - `lastMessageIn` string, date-time, nullable
  - `windowStatus` 'ACTIVE' | 'EXPIRED' | 'NOT_STARTED'
  - `metadata` object, nullable
  - `channelType` 'GUPSHUP_WHATSAPP' | 'DIALOG360_WHATSAPP' | 'CLOUDAPI_WHATSAPP' | 'ZAPI_WHATSAPP' | 'EVOLUTIONAPI_WHATSAPP' | 'INSTAGRAM' | 'MESSENGER', nullable

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/revisions/811b2cdd2ec2/schema)