Como enviar mensagens RCS com a API da Zenvia

Saiba o que são as mensagens RCS, o que é o protocolo RCS e confira um passo de como você pode utilizá-las com a API da Zenvia.

As mensagens RCS utilizam um novo padrão, chamado de Rich Communication Services, que possibilita o envio de comunicações por meio de textos, áudios, vídeos e fotos. Com isso, as empresas passam a ter uma possibilidade bastante importante para os negócios, a de criar e construir diálogos interativos com os clientes.

Com a API da ZENVIA, consegue-se integrar de forma prática o canal RCS na comunicação das empresas. Além disso,  é possível testá-lo de forma gratuita em nosso Sandbox

Saiba neste artigo sobre o que são mensagens RCS e confira um passo a passo para utilizá-las com a API da ZENVIA.

O que são as mensagens RCS

Em meio a tantos novos aplicativos de mensagem, o SMS continua sendo uma solução prática e de grande alcance. Entre os principais motivos estão o fato de  não necessitar de aplicativos, alta conectividade ou de um smartphone de última geração para ser efetivo.  Agora, com a criação do protocolo RCS, ele passa a ter ainda mais recursos, aproximando-se de soluções mais novas, como o WhatsApp.

O RCS (Rich Communication Services) é justamente um protocolo de comunicação criado com o objetivo de otimizar aquilo que as mensagens SMS já fazem. Dessa forma, possibilita a utilização de mensagens de texto que conseguem transmitir outras mídias, como imagens ou vídeos.

Dentre as soluções de comunicação da ZENVIA, temos a API de RCS que também está em nosso Sandbox. No Sandbox, é possível realizar testes das mensagens RCS sem custo, com um limite de requisições. 


Em vez de um número, ele irá fornecer uma palavra-chave (composta de duas palavras aleatórias) que funciona como um identificador. Basta enviar a palavra-chave por mensagem para um contato cadastrado e você poderá testar a API. 

Na sequência, veremos como acessar esse recurso e como funciona o fluxo básico de troca de mensagens RCS.

Passo a passo para envio de mensagens RCS no Sandbox

1. Criando uma conta

Para utilizar o Sandbox, crie uma conta gratuita no site. Após o login, será liberado o acesso à plataforma da ZENVIA. Na tela inicial, vá até o menu Produtos. Lá, você encontrará a área para desenvolvedores e terá acesso a configurações do Sandbox, tokens e documentação das APIs.

2. Configurando o Sandbox

No menu Produtos, clique em Sandbox e, em seguida, clique no botão Criar Novo. Siga o passo a passo para configurar o canal e obter sua palavra-chave. Para este tutorial, vamos selecionar a opção RCS:


No passo seguinte, Contatos, você poderá cadastrar seu número (precisa ser um número válido). O Sandbox irá enviar uma mensagem para esse número e solicitar confirmação para que ele possa ser usado para receber as mensagens RCS de teste. Basta clicar em Accept:


O último passo serve para cadastrar um webhook. Por enquanto, pode deixar em branco, veremos como usar webhooks mais tarde. Abaixo, um exemplo de como ficará a configuração depois de finalizada:


Após configurar o canal, volte para o menu Produtos e acesse Tokens e Webhooks. Você verá na listagem o token do Sandbox:


Vamos precisar da palavra-chave e do token para nos comunicarmos com a API.

3. Enviando mensagens

A documentação de todas as APIs da ZENVIA podem ser acessadas aqui. Olhando na seção RCS da documentação, podemos encontrar o formato do payload e a URL para enviar uma mensagem.

Para testar o envio, utilizaremos neste exemplo o Insomnia, um API Client gratuito que pode ser baixado aqui. Após instalar o Insomnia, no menu lateral, clique no botão com sinal + para criar uma nova requisição. 

Seguindo a documentação, nossa requisição ficará assim:

  • from: normalmente aqui ficaria o número de telefone que está enviando a mensagem, mas como estamos testando via Sandbox, vamos colocar a palavra-chave que configuramos na plataforma da ZENVIA.
  • to: número de telefone que receberá a mensagem (55+DDD+número). Neste caso, coloque o contato que você cadastrou anteriormente, no painel do Sandbox.
  • type: tipo do conteúdo. Neste exemplo, vamos utilizar o tipo text.
  • text: a mensagem que você quer enviar.

Também precisamos configurar o cabeçalho da requisição. Clique na aba Header e adicione o Content-Type e o token gerado na plataforma da ZENVIA:


Não se esqueça de informar a URL http://api.zenvia.com/v2/channels/rcs/messages e o tipo de requisição como sendo POST.  

Agora é só clicar em Send. Seu contato irá receber a mensagem:

4. Recebendo Mensagens

E se o contato responder, como podemos receber a mensagem? Para isso, vamos configurar um webhook, uma URL para receber requisições.

Para facilitar, vamos utilizar o site https://webhook.site. Ele cria uma URL única e permite usá-la como webhook sem precisar de um cadastro.

Acesse o site e copie a URL fornecida em Your Unique URL:


Volte no Sandbox, na plataforma da ZENVIA, onde você configurou sua palavra-chave. Clique nos três pontinhos para abrir as opções e selecione Subscription.

Podemos configurar dois tipos de webhook: um para receber mensagens e outro para receber status da conversa. Vamos configurar um webhook de mensagens, no campo da esquerda. Cole aqui a URL única que você recebeu e salve.


Agora é só o contato responder a mensagem enviada anteriormente:


Seu webhook irá receber a requisição com o conteúdo da mensagem:

5. Enviando Mensagens Interativas

Vimos como o  fluxo básico de troca de mensagens da API de RCS funciona, mas o diferencial das mensagens RCS é a interatividade. Vamos ver um exemplo disso, enviando uma mensagem do tipo card. Volte na documentação disponível aqui e, na seção Send a RCS message, troque o type do exemplo para card para ver as opções de payload disponíveis.

Seguindo a documentação da API de RCS, a requisição no Insomnia ficará assim:


Esse payload criará um card simples, com uma imagem, uma mensagem e um botão de resposta. Não esqueça de adicionar a mesma URL e headers do exemplo anterior. Clique em Send e seu contato receberá a mensagem:


Ao clicar no botão, o contato enviará uma mensagem com texto do botão:


Será possível capturar a mensagem no webhook configurado anteriormente:


Esse tipo de mensagem, que envia respostas pré-definidas, facilita muito para criar campanhas de marketing ou pesquisas de satisfação, por exemplo. 

Na documentação da API de RCS você encontra detalhes sobre os diferentes tipos de payload que podem ser enviados e mais opções para o tipo card, além de outras informações como formas de autenticação e mensagens de erro. 

Aproveite para explorar a documentação de APIs de outros canais como WhatsApp, que também possui Sandbox para testar gratuitamente. Qualquer dúvida, é só entrar em contato!

*Amanda Polotow é Desenvolvedora de Software na Zenvia | LinkedIn e GitHub.

Categorias:
Escrito por

Amanda Polotow

Leia também

Fique por dentro e confira as nossas dicas sobre o mercado mobile e interação digital.