Conceitos principais

Contas

Uma conta é um usuário final identificado por um número de telefone E.164 (+228…).

StatusSignificado
pendingConvidado / ainda não totalmente verificado
claimedO usuário concluiu a verificação por OTP e pode usar o aplicativo
blockedDescadastrado / bloqueado

Os parceiros vinculam contas a si mesmos (M2M ou campos do provedor). Os usuários vinculados veem esse parceiro no seu hub.

Parceiros

Um parceiro é uma organização (por exemplo, SEED) com:

  • Chaves de API
  • Modelos
  • Cadeia de canais (in-app → WhatsApp → SMS)
  • Bots e fluxos opcionais
  • Branding (logotipo e nome)

Mensagens

As mensagens de parceiro → usuário podem ser:

TipoComportamento no hub
Texto, mídia, link, HTMLMensagens de hub independentes (lista, as mais recentes primeiro)
Convites para fluxosCartões de fluxo independentes
Respostas de suporteDentro de uma conversa iniciada pelo usuário

A API para parceiros POST /messages cria mensagens do hub, não conversas de suporte.

Tipos de conteúdo

content_typeDescrição
textTexto simples
imageURL de imagem ou base64
documentPDF / arquivos
audioArquivo de áudio
videoArquivo de vídeo
linkCartão CTA (url + label + title)
htmlNewsletter móvel (HTML)
flowConvite para um formulário interativo com várias etapas
systemMensagem do sistema da plataforma

Conversas

As conversas são interações de suporte:

  • São criadas quando um usuário inicia uma solicitação de suporte
  • Os agentes respondem pelo Partner Hub / API de agente
  • As sessões de bot podem usar assuntos como Bot · … (ocultos no menu «Conversas» do usuário)

Canais de entrega

São configurados por parceiro como uma cadeia ordenada, por exemplo:

  1. inapp: aplicativo móvel / Application Client do MorisBox
  2. whatsapp
  3. sms

Os OTPs e as mensagens críticas podem forçar um subconjunto de canais.

Catálogo completo das superfícies do cliente, das ferramentas para parceiros e do comportamento dos canais: Plataformas.

Idempotência

Informe idempotency_key no envio para evitar duplicatas durante novas tentativas:

{ "idempotency_key": "partner-order-98765" }

O mesmo parceiro + a mesma chave retorna a mensagem original.