Diferenciar envio e gestão do grupo

As rotas desta página enviam conteúdo para um grupo. Elas não criam grupos, não alteram participantes e não substituem as operações administrativas de título, descrição, convite ou permissões. Como uma única mensagem pode alcançar várias pessoas, confirme o destino e a finalidade antes de chamar a API.

Tela de gestão de grupos com seleção de conexão e listagem de identificadores
Consulte o grupo e sua conexão antes de usar qualquer identificador como destino de uma mensagem.

Preparar credencial e destino

Área de APIs com criação de credencial e aviso de proteção do token
Use URL base, ApiID e token do mesmo ambiente; mantenha o token somente no cabeçalho de autorização.
  1. 1

    Confirme que a conexão está ativa e participa do grupo de homologação.

  2. 2

    Se o grupo permitir mensagens somente de administradores, confirme que a conta conectada possui essa função.

  3. 3

    Consulte ou exporte o identificador técnico do grupo pela área de gestão ou pela rota de listagem correspondente.

  4. 4

    Abra a documentação interativa da versão e confirme qual formato ela espera no campo number.

  5. 5

    Faça a primeira validação com uma única mensagem curta e sem dados pessoais.

Enviar uma mensagem de texto

Use POST /v2/api/external/{ApiID}/group com corpo JSON. ApiID é uma string obrigatória no caminho e a autenticação usa o esquema Bearer da credencial ativa.

  • body:string — campo de conteúdo publicado pela rota.
  • number:string — identificador do destino no formato aceito pela versão atual.
  • externalKey:string — campo de chave externa, sem regra pública de unicidade ou repetição segura.
  • isClosed:boolean — campo de estado cujo efeito não é detalhado nessa família.
  1. 1

    Monte o corpo somente com os quatro campos publicados.

  2. 2

    Use em externalKey uma referência sem dados pessoais, credenciais ou significado financeiro.

  3. 3

    Não automatize isClosed como true antes de confirmar seu efeito em um grupo controlado.

  4. 4

    Envie uma única requisição e registre horário, estado HTTP e a referência usada.

  5. 5

    Confirme a mensagem no grupo antes de permitir uma nova tentativa.

Enviar mídia por URL

Use POST /v2/api/external/{ApiID}/groupMediaUrl. A rota publica mediaUrl:string, body:string, number:string, externalKey:string e isClosed:boolean.

  1. 1

    Escolha um arquivo pequeno, fictício e sem metadados pessoais.

  2. 2

    Confirme na documentação interativa o modelo de acesso aceito para mediaUrl.

  3. 3

    Não inclua o token da API nem um segredo permanente no endereço do arquivo.

  4. 4

    Não trate body como legenda obrigatória; essa finalidade não aparece no schema publicado.

  5. 5

    Envie uma vez e confirme no grupo qual conteúdo foi realmente entregue.

Considerar visibilidade e moderação

Configurações de mensagens, visibilidade de grupos e conversas fechadas
Ignorar mensagens e mostrar grupos são controles da experiência interna; não presuma que eles alterem o contrato de envio externo.
  • Ignorar Mensagens de Grupo controla a criação de tickets a partir de mensagens recebidas; a tela não documenta bloqueio do envio pela API.
  • Mostrar Grupos para todos os usuários altera a visibilidade interna, não os campos das duas rotas.
  • Uma Word List ou outra regra de moderação pode remover conteúdo depois do envio.
  • Grupos que aceitam mensagens somente de administradores podem recusar a conta conectada sem essa permissão.

Reconhecer os limites do contrato

  • Nenhuma propriedade do corpo aparece formalmente marcada como obrigatória.
  • A única resposta publicada é HTTP 200 com schema vazio.
  • Não há messageId, ticketId, confirmação de entrega, leitura ou resultado por participante.
  • Não há limites publicados de texto, arquivo, frequência ou quantidade de grupos.
  • Não há rate limit, timeout, idempotência ou política de retentativa documentados.
  • Não há compatibilidade publicada por conector, dispositivo ou versão do aplicativo.
  • Esta família não publica envio Base64, áudio, localização, contato ou mensagem interativa.

Resolver falhas sem repetir o envio

  • Grupo incorreto: interrompa o consumidor e revalide number na listagem atual.
  • Mensagem recusada: confira conexão, participação da conta e permissão de administrador quando aplicável.
  • Mídia recusada: valide acesso, formato e limites atuais sem acrescentar mimeType por analogia.
  • Resposta 200 sem mensagem visível: confira o grupo, a sessão e as evidências disponíveis antes de reenviar.
  • Mensagem removida depois do envio: revise Word List e demais regras de moderação.
  • Ticket do grupo ausente: revise Ignorar Mensagens de Grupo e as regras de visibilidade, sem concluir que o envio externo falhou.
  • Mensagem duplicada: procure timeouts, consumidores concorrentes e retentativas automáticas.