Obter website no Crisp, por uma API
Retorna o nome, o domínio e o logo de um workspace do Crisp, para distinguir os ids que Listar websites devolve.
- Identificador
- crisp_get_website
A chamada
POST https://connect.reportei.com/api/tools/crisp_get_website/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"website_id": "<website_id>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| website_id | string | Sim | Id of the workspace, from List websites. |
Conexões possíveis
O seu cliente conecta a conta do Crisp uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Usuário e senha
O cliente informa as credenciais do app numa tela do Connect, ou o seu sistema as envia por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/crisp_get_website. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Crisp
- Listar websitesGETLista os workspaces do Crisp, chamados de websites na API, onde o plugin deste token está instalado, com seu website_id. Obter website dá o nome de cada um. As páginas começam em 1, e uma lista data vazia indica que não há mais páginas.
- Listar conversasGETLista as conversas de um workspace, com session_id, state, contagens de não lidas, operador atribuído, última mensagem e o meta do visitante (nickname, email, phone, segments). As páginas começam em 1, e uma página com menos itens que per_page é a última.
- Obter conversaGETRetorna uma conversa com seu estado, operador atribuído, contagens de não lidas, última mensagem, people_id do contato e o meta do visitante. As mensagens vêm de Listar mensagens da conversa.
- Listar mensagens da conversaGETRetorna o último lote de mensagens de uma conversa, com type, sender, content e timestamp em milissegundos. Para paginar rumo às mensagens mais antigas, envie o timestamp da mensagem mais antiga do lote como timestamp_before.
- Enviar mensagemPOSTEnvia uma mensagem como operador em uma conversa. O type text vai ao visitante na hora; o type note é uma nota interna vista só pelos operadores.
- Atualizar estado da conversaPATCHMuda o estado de uma conversa para pending, unresolved ou resolved.
- Atribuir conversaPATCHAtribui uma conversa a um operador, que é notificado, a menos que silent seja true.
- Atualizar meta da conversaPATCHAtualiza os dados do visitante e o assunto ou os segmentos de uma conversa. Envie só os campos a mudar.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
