Chat no seu app para iOS e Android: o SDK móvel

Atualizado em 20 de nov. de 202615 min de leitura
Português
Nesta página

O SDK móvel do Deskwoot coloca o seu chat ao vivo dentro do seu próprio app para iOS e Android como uma tela nativa, e não como uma página web. Seus clientes escrevem para a sua equipe e para o seu bot de IA direto no app, e a sua equipe responde no Deskwoot como sempre. Quando o app está fechado, as respostas chegam ao celular do cliente como notificações push. O seu desenvolvedor coloca o SDK no app com a ajuda da documentação para desenvolvedores. Você faz 2 coisas no Deskwoot, as duas na sua caixa de entrada de chat ao vivo, em Chat no seu app para iOS e Android: copia o token do widget para o seu desenvolvedor e salva a sua chave da Apple e a sua conta de serviço do Firebase, para que o Deskwoot possa enviar as notificações push.

O que os seus clientes recebem no seu app

É o mesmo chat do seu site. O app lê as mesmas configurações da caixa de entrada (a cor da sua marca, os seus textos, a sua equipe, o seu bot de IA e a sua central de ajuda) e mostra o visual que você escolheu para a caixa: Claro, Recepção ou Direto. As conversas do app chegam nessa caixa de entrada, e a sua equipe responde a elas como a qualquer outro chat.

  • O chat é uma tela nativa do seu app no iPhone, no iPad e no Android, não uma página web. Só o texto de um artigo de ajuda aparece em uma web view.
  • Seus clientes escrevem para a sua equipe e para o seu bot de IA, pesquisam na sua central de ajuda e leem as respostas sem sair do app. Eles podem enviar fotos e arquivos, e também fotos tiradas com a câmera se o seu app permitir a câmera.
  • O chat fala os 10 idiomas de visitantes do chat do seu site. Ele usa o idioma fixo da caixa de entrada, se você definiu um; se não, o idioma do seu app; se não, inglês. Por padrão ele fica claro ou escuro como o seu app.
  • Quando chega uma resposta com o app aberto e o chat fechado, um pequeno cartão sobe na parte de baixo do app com a foto e o nome de quem escreveu e 2 linhas da resposta. Um toque abre a conversa. O seu desenvolvedor pode desligar o cartão.
  • O app sabe quantas respostas o cliente ainda não leu, por exemplo para mostrar um contador no seu botão de ajuda. Ele também pode mostrar sobre o app o botão redondo de chat do seu site, mas esse botão fica escondido até o seu desenvolvedor ligá-lo.
  • Quando o app está fechado, as respostas chegam como notificações push, depois que você as configurar (passo 2 abaixo).

O seu app decide onde o chat abre: na página inicial dele, na conversa mais recente do cliente, numa conversa nova com um texto escolhido por você já digitado (o cliente pode mudar o texto e envia ele mesmo) ou direto na sua central de ajuda. A maioria dos apps abre o chat pelo próprio botão de ajuda.

Do que você precisa

  • Uma caixa de entrada de chat ao vivo no Deskwoot. O app usa o token do widget dela. Com o token da caixa de entrada do seu site, os chats do app e os do site chegam na mesma caixa. Para separar, crie uma segunda caixa de entrada de chat ao vivo para o app.
  • O seu próprio app para iPhone e iPad (iOS 15 ou mais recente), para Android (Android 5.0 ou mais recente) ou para os dois. O SDK é nativo: Swift no iOS, Kotlin ou Java no Android. Funcionam tanto apps Android feitos com Views quanto apps feitos com Jetpack Compose. Não existe pacote para React Native ou Flutter (veja as perguntas abaixo).
  • Um desenvolvedor que coloque o SDK no seu app. Tudo o que ele precisa está na documentação para desenvolvedores.
  • Para notificações push no iPhone: uma conta do Apple Developer em que você possa criar chaves. A Apple permite isso ao Account Holder e aos Admins.
  • Para notificações push no Android: acesso ao projeto do Firebase do seu app Android. O app precisa do Firebase Cloud Messaging.
  • No Deskwoot, a permissão para gerenciar caixas de entrada. Os administradores têm essa permissão, e também os agentes cujo papel customizado inclui Gerenciar caixas de entrada.

Funciona em qualquer plano do Deskwoot. O Deskwoot não verifica nenhum plano para o SDK nem para as notificações push, e todos os planos incluem caixas de entrada de chat ao vivo.

Passo 1: Passe o token do widget para o seu desenvolvedor

  1. Acesse Configurações > Caixas de entrada e abra a caixa de entrada de chat ao vivo que o app vai usar.
  2. Em Instalação e privacidade, clique em Chat no seu app para iOS e Android.
  3. No topo, em Token do widget, clique em Copiar e envie o token para o seu desenvolvedor. O app passa o token para o Deskwoot ao iniciar, com uma única chamada: Deskwoot.setup.
  4. No fim do painel, Como adicionar o SDK ao seu app abre a documentação para desenvolvedores. Envie esse link também para o seu desenvolvedor: deskwoot.com/pt-BR/docs/mobile.

É só disso que o chat precisa: ele funciona no app mesmo sem notificações push. As notificações push (passo 2) acrescentam as respostas que chegam enquanto o app está fechado.

Passo 2: Configure as notificações push

As notificações push dão trabalho dos dois lados. O seu desenvolvedor prepara o app como a documentação para desenvolvedores explica em Notificações push. Você salva as credenciais com que o Deskwoot envia: uma chave de autenticação do APNs da Apple para os iPhones e uma conta de serviço do Firebase para os celulares Android. Depois, o servidor do Deskwoot envia cada push com as suas próprias contas da Apple e do Google. O SDK no app nunca fala com a Apple nem com o Google.

Você pode configurar iOS, Android ou os dois. Cada bloco do painel tem o próprio botão Salvar. Quando você clica nele, o Deskwoot primeiro pergunta à Apple ou ao Google se eles aceitam o que você digitou, e só salva se aceitarem. Se recusarem, uma linha embaixo do bloco diz o que está errado, e nada é salvo. Se a Apple ou o Google não responderem, tente de novo em instantes.

Notificações push no iPhone: a sua chave do APNs

Você precisa de 4 dados da sua conta do Apple Developer:

  • A chave de autenticação do APNs, um arquivo que termina em .p8. Na sua conta do Apple Developer, vá em Certificates, Identifiers & Profiles, clique em Keys e crie uma chave com o Apple Push Notification service ativado. Baixe o arquivo e guarde com cuidado: a Apple deixa baixar só uma vez.
  • O ID da chave. A Apple mostra o ID embaixo do nome da chave quando você seleciona a chave em Keys. Ele tem 10 letras e números.
  • O ID da sua equipe. Ele fica na sua conta do Apple Developer, em Membership details, e também tem 10 letras e números.
  • O Bundle ID do seu app, por exemplo com.example.app. O seu desenvolvedor conhece o Bundle ID pelo Xcode, e a Apple mostra ele em Certificates, Identifiers & Profiles, Identifiers.

A Apple pode limitar uma chave a um único ambiente, sandbox ou production. Apps da App Store e do TestFlight usam production, e builds de desenvolvimento usam sandbox. Quando você salva a chave, o Deskwoot pergunta à Apple para quais ambientes ela vale, e se for só um, uma linha no bloco iOS avisa você. Se a chave vale só para sandbox, a linha é um alerta: os iPhones com o seu app baixado da App Store ou do TestFlight não recebem notificações push, então crie também uma chave para production e salve-a. Se ela vale só para production, é apenas uma observação: os builds de desenvolvimento do seu app não recebem notificações push. Nos dois casos o bloco mostra Conectado, porque a Apple aceitou a chave. Por isso, confira se a sua chave vale para production, onde roda o app dos seus clientes.

Depois, no Deskwoot:

  1. Em Chat no seu app para iOS e Android, vá até o bloco iOS.
  2. Cole o conteúdo do arquivo .p8 em Chave de autenticação do APNs (.p8), ou clique em Enviar arquivo .p8 e escolha o arquivo.
  3. Digite o ID da chave, o ID da equipe e o Bundle ID.
  4. Clique em Salvar.

A Apple confere a chave, o ID da chave e o ID da equipe juntos, então os 3 precisam ser da mesma chave, e o Bundle ID precisa pertencer à sua equipe. Quando a Apple aceita, o bloco mostra Conectado e também o ID da chave, o ID da equipe e o Bundle ID. Só os iPhones com o app desse Bundle ID recebem notificações push.

Notificações push no Android: a sua conta de serviço do Firebase

As notificações push para celulares Android passam pelo Firebase Cloud Messaging, com uma conta de serviço do projeto do Firebase que o seu app Android usa.

  1. No Firebase, abra o projeto do seu app, depois Configurações do projeto, depois Contas de serviço, e gere uma nova chave privada. O Firebase entrega um arquivo JSON.
  2. No Deskwoot, em Chat no seu app para iOS e Android, vá até o bloco Android.
  3. Cole o conteúdo do arquivo em JSON da conta de serviço, ou clique em Enviar arquivo .json e escolha o arquivo.
  4. Clique em Salvar.

O Google confere se essa conta de serviço pode enviar mensagens no projeto dela. Para isso, a chave dela precisa ser válida, ela precisa de uma função que pode enviar mensagens, e a API do Firebase Cloud Messaging precisa estar ativada no projeto. Quando o Google aceita, o bloco mostra Conectado e também o projeto e o e-mail da conta de serviço. Se os celulares Android realmente pertencem a esse projeto, isso só aparece no primeiro push de verdade (veja a próxima seção).

O que o status quer dizer

Na visão geral da caixa de entrada, a linha Chat no seu app para iOS e Android mostra um destes:

  • Não configurado: não há credenciais de push salvas. O chat no seu app funciona do mesmo jeito, só que sem notificações push.
  • Notificações push em iOS, Notificações push em Android ou Notificações push em iOS e Android: as plataformas com credenciais salvas.
  • Não envia: a Apple ou o Google recusou os push que o Deskwoot tentou enviar com as suas credenciais salvas.

Dentro do painel, cada bloco mostra o próprio status: Conectado, Não configurado ou Não envia. Com Não envia, uma linha no bloco diz o motivo:

  • A Apple recusa a chave, o ID da chave ou o ID da equipe. Salve os corretos.
  • A Apple recusa o Bundle ID. Salve o Bundle ID do seu app.
  • O Google não envia com essa conta de serviço. Verifique se a chave dela ainda existe, se ela tem uma função que pode enviar mensagens e se a API do Firebase Cloud Messaging está ativada no projeto dela.
  • Os celulares Android pertencem a outro projeto do Firebase, não ao da conta de serviço. Envie a conta de serviço do projeto do Firebase do seu app.

Não envia continua até um push passar de novo ou você salvar credenciais novas. O bloco iOS também pode mostrar que alguns iPhones usam um Bundle ID diferente do salvo, e quantos são. Esses iPhones não recebem notificações push, então confira se o Bundle ID salvo é o do seu app.

Chaves salvas: substituir ou remover

Depois de salvar, o campo da chave ou do JSON fica vazio de novo, com um aviso de que há uma salva. O Deskwoot guarda a chave e o JSON criptografados e nunca mais mostra esses dados, nem nesta página nem pela API. Continuam visíveis o ID da chave, o ID da equipe e o Bundle ID, e para Android o projeto do Firebase e o e-mail da conta de serviço.

  • Para substituir a chave ou a conta de serviço, cole ou envie a nova e clique em Salvar. O Deskwoot confere de novo com a Apple ou o Google.
  • Para mudar só o ID da chave, o ID da equipe ou o Bundle ID, edite o campo e clique em Salvar. A chave salva continua, então você não precisa enviar de novo.
  • Para remover um bloco, clique em Remover e confirme com Remover. A partir daí, os iPhones (ou os celulares Android) não recebem notificações push até você adicionar credenciais novas. O chat no seu app continua funcionando.

Quando sai uma notificação push

O Deskwoot envia um push para cada resposta que o cliente vê no chat: uma resposta de alguém da sua equipe, uma resposta do seu bot de IA ou uma mensagem automática. Ele nunca envia um push para as mensagens do próprio cliente, para notas privadas ou enquanto o bot de IA ainda está digitando a resposta. Conversas marcadas como spam e contatos bloqueados não recebem nenhum.

  • Se o cliente não estava online um instante antes, o push sai na hora.
  • Se ele estava online um instante antes, o Deskwoot espera 12 segundos. Se até lá ele já leu a resposta, nenhum push sai. Assim, quem está olhando a conversa não é incomodado.
  • Cada resposta toca no celular só uma vez. Ela vai para cada celular em que o cliente usa o seu app com essa caixa de entrada, até 10 celulares.
  • Se o celular estiver desligado ou sem conexão, a Apple e o Google guardam o push por um dia e depois descartam.

O título da notificação diz quem escreveu: o primeiro nome da pessoa da sua equipe ou o nome do seu bot de IA; se não, o nome da sua empresa. O texto mostra a resposta como texto simples, até 160 caracteres. Numa resposta que só tem um arquivo, ele diz no idioma do celular que um arquivo foi enviado (num celular em português, "Enviou um arquivo"). Um toque na notificação abre a conversa no seu app.

Clientes conectados no seu app

Sem mais nenhuma configuração, o cliente conversa no app como visitante anônimo, e a conversa fica naquele celular. Se os seus clientes fazem login no seu app, o app pode dizer ao chat quem eles são. Aí as conversas acompanham o cliente em todos os aparelhos e no chat do seu site na mesma caixa de entrada, e a sua equipe vê quem está escrevendo.

Funciona exatamente como a verificação de identidade no seu site, com a mesma chave secreta, que você cria na mesma caixa de entrada de chat ao vivo, em Reconhecer clientes conectados. O seu servidor assina o id de usuário do cliente com essa chave e, depois do seu próprio login, o app passa o usuário e a assinatura para o SDK. Como criar a chave e assinar o id de usuário está em Verificação de identidade de clientes conectados. A chamada no app está na documentação para desenvolvedores.

A chave fica só no seu servidor. Nunca coloque a chave dentro do app: qualquer pessoa que descompactar o app poderia ler a chave e conversar como qualquer um dos seus clientes.

Quando um cliente sai da conta no seu app, o app avisa o SDK. O SDK apaga o que guardou sobre esse cliente no celular, o celular deixa de receber notificações push dele, e o próximo chat começa como um visitante novo e anônimo. As conversas dele ficam no Deskwoot e voltam quando ele fizer login de novo.

Perguntas frequentes

Isso custa a mais, e de qual plano eu preciso?

O SDK e as notificações push não têm preço próprio, e o Deskwoot não verifica nenhum plano para eles. Todos os planos incluem caixas de entrada de chat ao vivo, então funciona em qualquer plano. Para as notificações push, você usa a sua própria conta do Apple Developer e o seu próprio projeto do Firebase.

Existe um SDK para React Native ou Flutter?

Não. O Deskwoot tem SDKs nativos para iOS (Swift) e para Android (Kotlin e Java), e nenhum pacote para React Native ou Flutter. Em um app feito com eles, você pode mostrar o chat do seu site em uma web view com o modo embedded do widget. Modo embedded: o chat em um container ou em tela cheia mostra como.

Preciso do Firebase no iOS?

Não. O Deskwoot envia as notificações push para iPhone direto para a Apple com a sua chave de autenticação do APNs, e o SDK não traz o Firebase. Você só precisa do Firebase para o Android.

Quem envia as notificações push, o Deskwoot ou nós?

O servidor do Deskwoot envia, com a sua chave de autenticação do APNs e a sua conta de serviço do Firebase, ou seja, pelas suas próprias contas da Apple e do Google. O seu app só passa o token de push dele para o SDK ao iniciar. As suas próprias notificações push continuam suas: o SDK pega só as do Deskwoot e deixa todas as outras para o seu app.

O SDK pede permissões aos meus clientes?

Ele nunca pede permissão para mostrar notificações. Quem pede é o seu app, quando for conveniente, como faz com as próprias notificações. No Android 13 e mais recente, sem essa permissão nenhuma notificação aparece. Fora isso, o SDK não precisa de nenhuma permissão no iPhone e, no Android, só do acesso à internet. Seus clientes podem enviar fotos e arquivos sem nenhuma permissão. A câmera só funciona se o seu app permitir. O cartão que mostra uma resposta com o app aberto também não precisa de permissão.

O que o cliente vê quando o app está fechado?

Uma notificação push com o nome de quem escreveu e até 160 caracteres da resposta. Um toque abre a conversa no seu app. Se o app estiver aberto e o chat fechado, quem mostra a resposta é um pequeno cartão na parte de baixo do app. Enquanto o cliente olha essa conversa, nenhuma notificação aparece.

Este guia foi útil?

Continue lendo

Perguntar ao Fynn sobre este guia

Receba uma resposta curta deste guia e do resto da Central de Ajuda.

Ainda precisa de ajuda?

Fynn responde no chat a partir destes guias, e você também fala com a equipe por lá.