Como criar uma caixa de entrada de canal de API? | Guia do Usuário

Para criar e configurar uma caixa de entrada de canal de API em instalações do Trino AI, siga as etapas descritas abaixo.

Configurar o canal da API

Passo 1. Vá para Configurações → Caixas de entrada → “Adicionar caixa de entrada”.

Passo 2. Clique no ícone "API".

Etapa 3. Forneça um nome para o canal e uma URL de retorno. Veja um exemplo:

Etapa 4. "Adicione agentes" à sua caixa de entrada da API.

A configuração da caixa de entrada está concluída.

Enviar mensagens para o canal da API

Para enviar mensagens ao canal da API, certifique-se de entender os seguintes modelos e nomenclatura usados no Trino AI.

Canal : Canal define o tipo de fonte das conversas. Ex.: Facebook, Twitter, API, etc.
Caixa de entrada : você pode criar várias fontes de conversas do mesmo tipo de canal. Por exemplo, você pode ter mais de uma página do Facebook conectada a uma conta do Trino AI. Cada página é chamada de caixa de entrada no Trino AI.
Conversa : Uma conversa é uma coleção de mensagens.
Contato : Cada conversa tem uma pessoa real associada a ela, chamada de contato.
Caixas de entrada de contatos : esta é a sessão de cada contato em uma caixa de entrada. Um contato pode ter várias sessões e várias conversas na mesma caixa de entrada.

Como enviar uma mensagem em um canal de API?

Para enviar uma mensagem em um canal de API, crie um contato, inicie uma conversa e, por fim, envie a mensagem.

As APIs exigem isso api_access_token no cabeçalho da solicitação. Você pode obter esse token acessando as Configurações do seu Perfil → Token de Acesso.

1. Crie um contato

Passe o ID da caixa de entrada do canal da API, juntamente com outros parâmetros especificados. Isso criará uma sessão automaticamente. Um exemplo de resposta seria semelhante ao mostrado abaixo.

{
  "email": "string",
  "name": "string",
  "phone_number": "string",
  "thumbnail": "string",
  "additional_attributes": {},
  "contact_inboxes": [
    {
      "source_id": "string",
      "inbox": {
        "id": 0,
        "name": "string",
        "website_url": "string",
        "channel_type": "string",
        "avatar_url": "string",
        "widget_color": "string",
        "website_token": "string",
        "enable_auto_assignment": true,
        "web_widget_script": "string",
        "welcome_title": "string",
        "welcome_tagline": "string",
        "greeting_enabled": true,
        "greeting_message": "string"
      }
    }
  ],
  "id": 0,
  "availability_status": "string"
}

Como você pode ver no payload, você poderá ver o contact_inboxes e cada um contact_inbox terá um source_id. O ID de origem pode ser visto como o identificador da sessão. Você o usará **source_id**para criar uma nova conversa, conforme definido abaixo.

2. Crie uma conversa

Use o source_id recebido na chamada de API anterior. Você receberá um ID de conversa que pode ser usado para criar uma mensagem.

{
  "id": 0
}

3. Crie uma nova mensagem

Existem 2 tipos de mensagens.

Entrada : mensagens enviadas pelo usuário final são classificadas como mensagens recebidas.
Saída : As mensagens enviadas pelo agente são classificadas como mensagens de saída.

Se você chamar a API com o conteúdo correto, receberá um payload semelhante a este:

{
    "id": 0,
    "content": "This is a incoming message from API Channel",
    "inbox_id": 0,
    "conversation_id": 0,
    "message_type": 0,
    "content_type": null,
    "content_attributes": {},
    "created_at": 0,
    "private": false,
    "sender": {
        "id": 0,
        "name": "Pranav",
        "type": "contact"
    }
}

Se tudo correr bem, você verá a conversa no painel do Trino AI.

Você será notificado quando uma nova mensagem for criada na URL especificada durante a criação do canal da API.

Receber mensagens usando URL de retorno de chamada

Quando uma nova mensagem é criada no canal da API, você receberá uma solicitação POST para a URL de retorno de chamada especificada durante a criação do canal da API. O payload ficaria assim:

Tipo de evento : message_created

{
  "id": 0,
  "content": "This is a incoming message from API Channel",
  "created_at": "2020-08-30T15:43:04.000Z",
  "message_type": "incoming",
  "content_type": null,
  "content_attributes": {},
  "source_id": null,
  "sender": {
    "id": 0,
    "name": "contact-name",
    "avatar": "",
    "type": "contact"
  },
  "inbox": {
    "id": 0,
    "name": "API Channel"
  },
  "conversation": {
    "additional_attributes": null,
    "channel": "Channel::Api",
    "id": 0,
    "inbox_id": 0,
    "status": "open",
    "agent_last_seen_at": 0,
    "contact_last_seen_at": 0,
    "timestamp": 0
  },
  "account": {
    "id": 1,
    "name": "API testing"
  },
  "event": "message_created"
}

Crie interfaces usando APIs de cliente

As APIs de cliente disponíveis para o canal de API ajudarão você a criar interfaces voltadas para o cliente para o Trino AI.

Essas APIs são úteis para casos como os listados abaixo.

Use uma interface de bate-papo personalizada em vez do widget de bate-papo do Trino AI.
Crie interfaces de conversação em seus aplicativos móveis.
Adicione o Trino AI a outras plataformas para as quais o Trino AI não tem um SDK oficial.

Criando objetos de clientes

Você pode criar e recuperar objetos de dados do cliente usando inbox_identifier e customer_identifier.

Identificador da caixa de entrada

Você pode obtê-lo inbox_identifier no seu canal de API -> Configurações -> Configuração.

Identificador do cliente

O customer_identifier ou o source_id podem ser obtidos ao criar o cliente usando a API de criação. Você precisará armazenar esse identificador no seu cliente para fazer outras solicitações em nome do cliente. Isso pode ser feito em cookies, armazenamento local, etc.

APIs disponíveis

Algumas das coisas que você pode fazer com as APIs são:

Criar, visualizar e atualizar contato
Criar e listar conversas
Criar, listar e atualizar mensagens

Autenticação HMAC

As APIs do Cliente também suportam Autenticação HMAC . O token HMAC para o Canal pode ser obtido executando o seguinte comando no seu console Rails.

# replace api_inbox_id with your inbox id
Inbox.find(api_inbox_id).channel.hmac_token

Conectando-se aos WebSockets do Trino AI

Para obter atualizações em tempo real do painel do agente, conecte-se ao Trino AI WebSockets usando o seguinte URL.

<your installation url>/cable

Autenticando sua conexão WebSocket

Após assinar usando o cliente pubsub_token, você receberá eventos direcionados ao seu objeto de cliente. O **pubsub_token**é fornecido durante a chamada da API de criação do cliente.

Exemplo

const connection = new WebSocket('ws://localhost:3000/cable');
connection.send(JSON.stringify({ command:"subscribe", identifier: "{\\"channel\\":\\"RoomChannel\\",\\"pubsub_token\\":\\""+ customer_pubsub_token+"\\"}" }));

Implementação

Aqui está um exemplo de interface de bate-papo criada sobre as APIs do cliente.