RCS API

RCS API — Mensagens Ricas e Interativas

Envie mensagens ricas com cards, carrosséis, botões de ação e sugestões inteligentes via RCS. Suporte a imagens de alta qualidade, vídeos e interações avançadas com rastreamento em tempo real.

Introdução

A RCS API da Yup Chat permite que você envie mensagens ricas e interativas com suporte a cards, carrosséis, botões de ação, sugestões inteligentes e mídia de alta qualidade. Com rastreamento avançado de visualizações, cliques e interações em tempo real, você pode criar experiências de comunicação envolventes e mensuráveis. A API também oferece fallback automático para SMS em dispositivos não compatíveis.

Mensagens Ricas

Envie cards com imagens, títulos, descrições e botões de ação interativos.

Carrosséis

Crie apresentações de múltiplos cards com navegação intuitiva (até 10 cards).

Sugestões Inteligentes

Ofereça respostas rápidas com botões de sugestão contextualizados.

Rastreamento Avançado

Acompanhe visualizações, cliques e interações em tempo real via webhooks.

Autenticação

HTTP Basic Authentication

A RCS API utiliza autenticação HTTP Basic com seu ID e Token. Você deve enviar suas credenciais codificadas em Base64 no header Authorization.

Authorization: Basic <base64(ID:TOKEN)>

Exemplo: Se seu ID é "user123" e seu Token é "token456", você codifica "user123:token456" em Base64, resultando em "dXNlcjEyMzp0b2tlbjQ1Ng==".

Dica: Obtenha suas credenciais em "Informações da conta" no Dashboard da Yup Chat.

Exemplo de Autenticação

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/rcs/messages/rcsmsg_123

Base URL

Todos os endpoints da RCS API são acessados através da seguinte URL base:

https://api.yup.chat/v1/

Todos os exemplos de endpoints nesta documentação devem ser prefixados com esta URL base. Por exemplo, o endpoint POST /rcs/messages completo seria: https://api.yup.chat/v1/rcs/messages

Endpoints

POST/rcs/messages

Envia uma mensagem RCS rica com suporte a cards, carrosséis e sugestões.

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
`to`	String	Sim	Número de telefone com código de país (ex: 5511999999999)
`type`	String	Sim	Tipo de mensagem: card, carousel, suggestion, text
`card`	Object	Não	Objeto do card com title, description, image_url, suggestions
`fallback_text`	String	Não	Texto alternativo para dispositivos não compatíveis

Exemplo de Requisição

curl -X POST https://api.yup.chat/v1/rcs/messages \
  -u 'SEU_ID:SEU_TOKEN' \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999999999",
    "type": "card",
    "card": {
      "title": "Promoção Especial",
      "description": "Aproveite 50% de desconto",
      "image_url": "https://example.com/image.jpg",
      "suggestions": [
        {"text": "Ver Mais", "action": "view_more"},
        {"text": "Comprar", "action": "buy"}
      ]
    },
    "fallback_text": "Promoção Especial: 50% de desconto!"
  }'

Exemplo de Resposta (200 OK)

{
  "id": "rcsmsg_1234567890abcdef",
  "status": "sent",
  "to": "5511999999999",
  "type": "card",
  "timestamp": "2024-01-19T10:30:00Z",
  "message_type": "outbound",
  "fallback_to_sms": false,
  "tracking": {
    "delivered": false,
    "read": false,
    "clicked": false
  }
}

GET/rcs/messages/:id

Consulta o status e detalhes de uma mensagem RCS enviada.

Parâmetros

Parâmetro	Tipo	Descrição
`id`	String	ID único da mensagem RCS

Exemplo de Requisição

curl -u 'SEU_ID:SEU_TOKEN' \
  https://api.yup.chat/v1/rcs/messages/rcsmsg_1234567890abcdef

Exemplo de Resposta (200 OK)

{
  "id": "rcsmsg_1234567890abcdef",
  "status": "delivered",
  "to": "5511999999999",
  "type": "card",
  "timestamp": "2024-01-19T10:30:00Z",
  "delivered_at": "2024-01-19T10:30:05Z",
  "read_at": "2024-01-19T10:31:00Z",
  "tracking": {
    "delivered": true,
    "read": true,
    "clicked": true,
    "click_action": "buy"
  }
}

Status Retornados

Sent

A mensagem foi aceita e enviada para a operadora, mas ainda não foi entregue ao destinatário.

Delivered

A mensagem foi entregue com sucesso ao dispositivo do destinatário.

Read

A mensagem foi lida pelo destinatário (confirmação de leitura recebida).

Failed

A mensagem falhou permanentemente. Pode ser devido a número inválido ou dispositivo não compatível.

Fallback

A mensagem foi degradada para SMS porque o dispositivo não suporta RCS.

Clicked

O destinatário clicou em um botão ou sugestão da mensagem.

Recursos Principais

Mensagens Ricas

Envie cards com imagens, títulos, descrições e botões de ação

Carrosséis

Crie apresentações de múltiplos cards com navegação intuitiva

Sugestões Inteligentes

Ofereça respostas rápidas com botões de sugestão contextualizados

Mídia de Alta Qualidade

Compartilhe imagens, vídeos e documentos com resolução otimizada

Rastreamento Avançado

Acompanhe visualizações, cliques e interações em tempo real

Fallback Automático

Mensagens degradam automaticamente para SMS em dispositivos não compatíveis

Casos de Uso

Catálogos de Produtos

Exiba produtos com imagens, preços e botões de compra em carrosséis

Promoções Visuais

Campanhas de marketing com cards ricos e imagens de alta qualidade

Confirmação de Pedidos

Notificações transacionais com detalhes visuais e status de entrega

Pesquisas Interativas

Colete feedback com sugestões de resposta e análise de cliques

Ofertas Personalizadas

Recomendações com imagens, descrições e CTAs contextualizadas

Atendimento Visual

Suporte com imagens de produtos, tutoriais e guias passo a passo

Pronto para Começar?

Integre a RCS API em minutos e comece a enviar mensagens ricas e interativas.