Lista de APIs responsáveis por gerenciar as conversas do Agente.
Listar conversas
Lista todas as conversas de todos os agentes com paginação e recursos de filtro. O parâmetro cursor só fica disponível a partir da segunda requisição.
query Parameters
limitinteger · min: 1 · max: 100Número máximo de itens retornados por página.
Default: 25currentPageinteger · min: 0Número da página atual. Envie 0 para solicitar a primeira página. A resposta conterá o número da próxima página.
Default: 0totalPagesinteger · min: 0Número total de páginas disponíveis com base no limite e total de registros.
totalinteger · min: 0Número total de registros que correspondem à consulta.
dateInitstring · dateData inicial para filtro das conversas (formato ISO 8601: YYYY-MM-DD).
dateEndstring · dateData final para filtro das conversas (formato ISO 8601: YYYY-MM-DD).
searchstringTexto de busca para filtrar conversas. Pesquisa em todos os campos de texto da conversa (por exemplo, name, id, etc.).
metastringTexto de busca para filtrar conversas por valores de metadados. Pesquisa em todos os valores do objeto de metadata de cada conversa.
cursorstringCursor de paginação retornado no corpo da resposta anterior. Obrigatório para obter a página 2 em diante. Não inclua este parâmetro na primeira requisição — ele só estará disponível nas requisições subsequentes.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Lista de conversas retornada com sucesso, incluindo metadados de paginação.
totalintegerNúmero total de conversas que correspondem à consulta.
currentPageintegerNúmero da página atual (inicia em 1 após a primeira requisição).
totalPagesintegerTotal de páginas disponíveis.
cursorstringCursor para a próxima página. Use este valor na próxima requisição.
conversationsobject[]Array de objetos de conversa.
Metadados da conversa
Obtém as informações gerais (metadados) de uma conversa específica.
path Parameters
idConversationstring · requiredID da conversa.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Metadados da conversa recuperados com sucesso.
idstringIdentificação da conversa. Este
idpode ser usado no dashboard para acessar todos os detalhes da conversa.botnamestringNome do agente.
descriptionstringchannelStringCanal em que a conversa foi criada.
surveyNumberSe o usuário avaliou a conversa, este campo trará valores de 1 a 5. Se ainda não foi avaliada, retorna 0.
metaobjectMetadados definidos pelo usuário.
Listar mensagens da conversa
Lista todas as mensagens de uma conversa específica.
path Parameters
idConversationstring · requiredID da conversa.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typestring · requiredA URI reference that identifies the problem.
titlestring · requiredA short, human-readable summary of the problem.
statusnumber · requiredThe HTTP status code.
instancestring
Criar ID de conversa
Cria uma nova conversa para o agente informado.
path Parameters
botIdstring · requiredID do Agente.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Resposta contendo o ID da conversa criada.
idstring · required
Atualizar metadados da conversa
Atualiza os metadados da conversa adicionando pares nome–valor no objeto meta. Caso um campo já exista, seu valor é sobrescrito.
path Parameters
convIdstring · requiredID da conversa.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Mensagem de sucesso ao atualizar a conversa.
messagestring
Chat com stream
Retorna imediatamente cada bloco (token) gerado da resposta do agente.
path Parameters
idConversationstring · requiredID da conversa.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.Content-Typestring · requiredTipo de conteúdo do corpo da requisição. Utilize application/json.
Responses
Resposta de chat com o agente.
Schema para resposta de API que é apenas uma string simples.
Chat sem stream
Retorna a resposta gerada pelo agente somente quando estiver completa.
path Parameters
idConversationstring · requiredID da conversa.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.Content-Typestring · requiredTipo de conteúdo do corpo da requisição. Utilize application/json.
Responses
Resposta de chat com o agente.
idstring · requiredsendMensagesobject[] · required
Enviar feedback da mensagem
path Parameters
idmessagestring · requiredID gerado para cada interação do agente.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typestring · requiredA URI reference that identifies the problem.
titlestring · requiredA short, human-readable summary of the problem.
statusnumber · requiredThe HTTP status code.
instancestring
Enviar pesquisa de satisfação
path Parameters
idconvstring · requiredID da conversa.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typestring · requiredA URI reference that identifies the problem.
titlestring · requiredA short, human-readable summary of the problem.
statusnumber · requiredThe HTTP status code.
instancestring