Integração Twitter Direct Message
A estratégia Ominichannel diz respeito à capacidade de um produto de estar presente e utilizável para o cliente em qualquer lugar e através de diversas plataformas, aplicativos, redes sociais, entre outros. O 4biz disponibiliza então a integração da ferramenta através de diversos canais e redes sociais que iremos conhecer através desse e de outros documentos sobre o Omnichannel. Nesse iremos abordar como é feita a integração do 4biz com a rede social Twitter.
É necessário ter permissão de acesso ao Sistema.
Ter um grupo cadastrado para receber todos os usuários/solicitantes do Twitter Direct Message.
Ter um portfólio cadastrado que possua a "Atividade" a ser disponibilizada pelo Twitter Direct Message.
Configurar os parâmetros referentes ao SmartChat (parâmetros 118, 315, 317, 390, 447).
Configurar os parâmetros referentes à Helper (parâmetros 402, 423, 441, 442, 450, 453).
Ter permissão para criar e/ou editar uma interação Omnichannel.
Ter realizado toda a configuração necessária no Twitter developer (será apresentada mais adiante no documento)
Para acessar a funcionalidade do Omnichannel no 4biz, vá até Menu > Sistema > Configurações > Interações Omnichannel. Será apresentada a tela com os filtros para pesquisar pelas interações e a lista de interações já presentes na ferramenta. Antes de preencher os dados para criação de uma interação Omnichannel no 4biz, é necessário realizar anteriormente a configuração no próprio Twitter Developer.
Para realizar a integração através de direct message do Twitter é necessário utilizar o site Twitter Developer (develloper.twitter.com), pois, é ele que irá apresentar as informações que iremos utilizar na configuração do 4biz. Para criar uma conta no Twitter Developer é preciso ter primeiramente uma conta cadastrada no Twitter (twitter.com). Após ter criado as contas, vamos seguir os seguintes passos:
- No primeiro acesso, o Twitter Developer vai pedir que descreva a razão para sua utilização. Marque a que achar mais conveniente para você. Além disso, também irá pedir que você valide seus dados.
- O Twitter Developer ainda pede que você responda, em inglês, como você pretende utilizar a API deles. Recomendamos deixar configurado como "sim" e preencher apenas as opções: "In English, please describe how you plan to use Twitter data and/or APIs. The more detailed the response, the easier it is to review and approve." e "Will your app use Tweet, Retweet, like, follow or Direct Message functionality?".
- Depois que submeter suas respostas, o twitter enviará um e-mail para confirmar seus dados. Entre novamente na sua conta, clique no seu avatar e depois vá em "Apps".
- Na página de Apps, clicar em "Create New App" para criar um novo app.
- Preencher os campos necessários:
Campo | Descrição |
|---|---|
App name (obrigatório) | Dar um nome para o aplicativo |
Application description (obrigatório) | Descreva o aplicativo sendo criado |
Website URL (obrigatório) | Colocar a URL do seu domínio |
Enable sign in with Twitter | Clicar caso deseje permitir que este aplicativo seja usado para fazer login com o Twitter. Recomendado não marcar |
Tell us how this app will be used | Descrever para o próprio Twitter Developer o propósito desse aplicativo e como será utilizado pelo cliente |
- Após criar o aplicativo, será direcionado para a página de informações desse app. A primeira aba "App details" mostra os campos que foram preenchidos na criação do aplicativo.
- Na aba "Keys and tokens", é possível gerenciar as chaves, chaves secretas e tokens de acesso do aplicativo.
- Em "Consumer API Keys" será apresentada a chave e a chave secreta da API que serão utilizadas para configurar o Omnichannel no 4biz.
- Para gerar tokens de acesso e tokens de acesso secreto, clicar em "Generate" em "Access token & access token secret". Esses tokens serão utilizados para configurar o Omnichannel no 4biz.
🖊 Nota: Note que aparecerá um pop-up com os tokens de acesso para ser copiado, pois, uma vez fechada essa janela, os dados do token de acesso não poderão mais ser visualizados por questões de segurança. Porém, é possível gerar novos tokens clicando em "Regenerate", só que os tokens antigos serão invalidados.
- Já na aba "Permissions", clicar em editar para dar o tipo de permissão de acesso para a plataforma. No nosso caso, vamos marcar a opção de "Read, Write and Direct Message", na qual o aplicativo terá permissão de ler, escrever e realizar mensagem direta do Twitter.
- Após criar o aplicativo, é necessário criar um ambiente no Twitter Developers. Para isso clique no seu avatar e vá em "Dev environments".
🖊 Nota: Para utilizar uma das assinaturas de APIs do Twitter, você precisa configurar um ambiente de desenvolvimento para o endpoint. Todos os pacotes de assinatura de API suportam pelo menos 1 ambiente de desenvolvimento (o número vai depender dos detalhes de seu pacote), que pode ser usado para isolar uso, regras, limites de taxa ou outra forma dentro de seus sistemas.
- Para a nossa integração, utilizaremos a opção "Account Activity API/Sandbox". Clicar em "Set up dev environment" para configurar esse ambiente de desenvolvimento.
- Será apresentada uma tela com os campos para configurar o ambiente:
Campo | Descrição |
|---|---|
Dev environment label | Colocar um identificador para o aplicativo |
App | Selecionar o aplicativo que foi criado anteriormente |
Após preencher os campos, será apresentado na tela de ambientes a descrição do aplicativo que acabamos de configurar, sendo também possível de deletar esse ambiente.
Para acessar a funcionalidade do Omnichannel no 4biz, vá até Menu > Sistema > Configurações > Interações Omnichannel. Clique em "Novo".
Preencher os campos que irão aparecer:
Campo | Descrição |
|---|---|
Identificador | Este código o 4biz já traz preenchido, e não pode ser alterado |
Nome | O usuário que for realizar o cadastro poderá colocar qualquer Nome desejado |
Canal de Interação | Selecionar o canal de interação desejável. Nesse caso, a opção "Twitter Direct Message" |
Unidade Default | Unidade utilizada na criação do colaborador/solicitante do Twitter Direct Message |
Grupo Default | Grupo que será configurado o colaborador/solicitante do serviço Twitter Direct Message |
Atividade Default | Atividade a ser disponibilizada para a criação de tickets relacionados ao Twitter Direct Message |
Origem do Contato | Configurar de onde virá o contato, nesse caso, Twitter |
Habilitar Interceptação com Helper | Habilitar esta opção somente quando quiser que o usuário/Solicitante do Twitter Direct Message tenha interação com o chatbot |
Ambiente de Desenvolvimento | É o nome do ambiente que foi configurado no campo "Dev environment label" do Twitter Developer |
Chave da API | A chave gerada no próprio Twitter Developer na aba "Keys and tokens", o campo "API key" |
Chave Secreta da API | A chave secreta gerada no próprio Twitter Developer na aba "Keys and tokens", o campo "API secret key" |
Token de Acesso | O token gerado no próprio Twitter Developer na aba "Keys and tokens", o campo "Access token" |
Segredo do Token de Acesso | O token secreto gerado no próprio Twitter Developer na aba "Keys and tokens", o campo "Access token secret" |
URL de Retorno de Chamada | O domínio da aplicação que irá receber os chamados provenientes do Twitter |
Caso deseje editar ou excluir uma interação, vá até a página inicial de Interações do Omnichannel, selecione uma das interações existentes para editar, ou clique em "Ações" e selecione a opção "Excluir".
