Criação de agente via API

Endpoint público para integração direta com sistemas de clientes.

Endpoint de envio

https://rcs.yup.chat/rcs/create

Autenticação

x-api-key: SUA_CHAVE_AQUI

Exemplo de cURL

curl -X POST "https://rcs.yup.chat/rcs/create" \
  -H "Content-Type: application/json" \
  -H "x-api-key: SUA_CHAVE_AQUI" \
  -d @payload.json

Payload JSON

{
  "agentDisplayName": "Minha Marca",
  "description": "Atendimento oficial via RCS.",
  "interactionsDescription": "Promoções, suporte e notificações.",
  "logoUri": "https://.../logo.jpg",
  "heroUri": "https://.../banner.jpg",
  "previewUri": "https://.../preview.png",

  "phone": "+55 (11) 99999-9999",
  "email": "contato@marca.com.br",
  "website": "https://marca.com.br",

  "privacy": { "uri": "https://marca.com.br/privacidade" },
  "terms": { "uri": "https://marca.com.br/termos" },

  "brandContact": {
    "name": "Responsável da Marca",
    "email": "responsavel@marca.com.br"
  },

  "brandPartnerCompanyName": "Agência XYZ",
  "brandPartnerContactName": "Ana Souza",
  "brandPartnerContactEmailAddress": "ana@agenciaxyz.com.br",

  "agentTypes": ["NON_CONVERSATIONAL"],
  "category": "PROMOTIONAL"
}

Referência de campos

Descrição dos campos aceitos no JSON de criação do agente. URLs devem ser HTTPS.

Campo Tipo Obrigatório Descrição Exemplo
agentDisplayName string Sim Nome de exibição do agente RCS (máx. 40 caracteres). "Minha Marca"
description string Sim Descrição curta do agente (máx. 100 caracteres). "Atendimento oficial via RCS."
interactionsDescription string Sim Tipos de interação: promoções, suporte, notificações, etc. "Promoções, suporte e notificações."
logoUri string (URL) Sim URL pública da logo (link direto; HTTPS recomendado). "https://.../logo.jpg"
heroUri string (URL) Sim URL pública do banner (link direto; HTTPS recomendado). "https://.../banner.jpg"
previewUri string (URL) Recomendado Imagem de preview (print do layout final do agente). "https://.../preview.png"
phone string Sim Telefone de contato (ideal E.164). "+5511999999999"
email string (e-mail) Sim E-mail público de contato do agente. "contato@marca.com.br"
website string (URL) Sim Site principal da marca (deve ser HTTPS). "https://marca.com.br"
privacy.uri string (URL) Sim URL da política de privacidade. "https://marca.com.br/privacidade"
terms.uri string (URL) Sim URL dos termos de serviço. "https://marca.com.br/termos"
brandContact.name string Sim Nome do contato responsável da marca (verificação). "Responsável da Marca"
brandContact.email string (e-mail) Sim E-mail do contato responsável da marca (verificação). "responsavel@marca.com.br"
brandPartnerCompanyName string Opcional Nome do parceiro (agência/consultoria), se existir. "Agência XYZ"
brandPartnerContactName string Opcional Nome do contato do parceiro. "Ana Souza"
brandPartnerContactEmailAddress string (e-mail) Opcional E-mail do contato do parceiro. "ana@agenciaxyz.com.br"
agentTypes array Sim Tipos aceitos: NON_CONVERSATIONAL e/ou CONVERSATIONAL. ["NON_CONVERSATIONAL"]
category string Sim Categoria: TRANSACTIONAL, PROMOTIONAL ou OTP. "PROMOTIONAL"
cnpj string Opcional* CNPJ da marca (pode ser obrigatório no fluxo interno conforme operação). "11.111.111/0001-00"
Dica: Na integração via API, o cliente hospeda as imagens. No formulário, o sistema faz upload e gera URLs.