Chatbots

Listar

get

Listagem de chatbots.

Autorizações
Parâmetros de consulta
NamestringOpcional

Filtro por nome do chatbot.

ChannelIdsstring · uuid[]Opcional

Filtro por ID do canal. É possível informar mais de um ID.

DefaultDepartmentIdsstring · uuid[]Opcional

Filtro por ID da equipe padrão. É possível informar mais de um ID.

CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1
PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15
OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:
Respostas
200

Success

application/json
get
/v1/chatbot
GET /chat/v1/chatbot HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-06T22:34:13.834Z",
      "updatedAt": "2025-11-06T22:34:13.834Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "archived": true,
      "name": "text",
      "type": "Reactive",
      "channelIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "defaultDepartmentId": "123e4567-e89b-12d3-a456-426614174000",
      "publishStatus": "NOT_PUBLISHED",
      "automationUsage": [
        "Api"
      ]
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Enviar chatbot

post

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.

Autorizações
Corpo
botKeystring · uuid | nuloOpcional

Chave do chatbot a ser enviado.

fromstring | nuloOpcional

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

tostring | nuloOpcional

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

sessionIdstring · uuid | nuloOpcional

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

Respostas
200

Success

application/json
post
/v1/chatbot/send
POST /chat/v1/chatbot/send HTTP/1.1
Host: api.wts.chat
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 338

{
  "botKey": "123e4567-e89b-12d3-a456-426614174000",
  "from": "text",
  "to": "text",
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "options": {
    "skipIfBotInExecution": true,
    "skipIfInProgress": true,
    "forceStartSession": true,
    "hiddenSession": true
  },
  "sessionMetadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "contactMetadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-06T22:34:13.834Z",
  "updatedAt": "2025-11-06T22:34:13.834Z",
  "startAt": "2025-11-06T22:34:13.834Z",
  "endAt": "2025-11-06T22:34:13.834Z",
  "status": "UNDEFINED",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "contactId": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "departmentId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "previewUrl": "text",
  "title": "text",
  "number": "text",
  "utm": {
    "sourceId": "text",
    "source": "text",
    "clid": "text",
    "medium": "text",
    "campaign": "text",
    "content": "text",
    "headline": "text",
    "term": "text",
    "referralUrl": "text"
  },
  "origin": "text",
  "contactDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "pictureUrl": "text",
    "phonenumber": "text",
    "instagram": "text",
    "phonenumberFormatted": "text",
    "tagsId": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "tagsName": [
      "text"
    ],
    "status": "ACTIVE"
  },
  "agentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "shortName": "text",
    "phoneNumber": "text",
    "email": "text",
    "pictureFileId": "123e4567-e89b-12d3-a456-426614174000",
    "pictureUrl": "text"
  },
  "channelDetails": {
    "humanId": "text",
    "platform": "text",
    "provider": "text",
    "providerVariable": "text",
    "pictureUrl": "text",
    "displayName": "text"
  },
  "departmentDetails": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "isDefault": true,
    "isSupervisor": true
  },
  "classification": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "category": "UNDEFINED",
    "categoryDescription": "text",
    "amount": 1,
    "categoryName": "text"
  },
  "statusDescription": "text",
  "timeService": "text",
  "timeWait": "text",
  "firstResponseAt": "2025-11-06T22:34:13.834Z",
  "botId": "123e4567-e89b-12d3-a456-426614174000",
  "unreadCount": 1,
  "lastMessageText": "text",
  "lastInteractionDate": "2025-11-06T22:34:13.834Z",
  "windowStatus": "ACTIVE",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "channelType": "GUPSHUP_WHATSAPP"
}

Atualizado