Antes de Iniciar

Para iniciar o envio de mensagens pela Zapster, é essencial que você tenha uma instância ativa, que funciona como o seu ponto de comunicação individualizado.

Criação da Instância

Antes de mais nada, crie uma instância utilizando os nossos endpoints de gestão de instâncias. Esse processo gera um ID único para a sua instância, que será utilizado nas etapas seguintes.

Como Enviar Mensagens

Com sua instância criada, você tem duas abordagens para enviar mensagens:

No Corpo da Requisição: Inclua o instance_id da instância diretamente no body da requisição de envio de mensagens.

Via Cabeçalho HTTP: Utilize o cabeçalho X-Instance-ID em sua requisição para especificar a instância desejada.

Ambos os métodos garantem que a mensagem seja enviada pela instância correta, mantendo a organização e a eficiência na comunicação com seus contatos.

Envio de Mensagens com Mídia

Para enviar mensagens com mídia na Zapster, você tem duas opções:

  • Base64: Envie o conteúdo da mídia codificado em base64. Essa abordagem pode ser mais lenta, pois nossos servidores precisarão converter os dados de base64 de volta para o formato de arquivo original.

  • URL: Forneça a URL direta para o arquivo de mídia. Essa é a opção recomendada, pois é mais eficiente. Ao usar URLs, os arquivos de mídia são acessados diretamente do link fornecido, eliminando a necessidade de conversão e acelerando o processo de envio.

Lembre-se de que, independentemente do método escolhido, a integridade e a disponibilidade da mídia são essenciais para garantir a entrega bem-sucedida da mensagem.

Envio de Mensagens para Grupos

Para comunicar-se com grupos através de nossa API, siga os passos abaixo:

  1. Identifique o ID do Grupo: Primeiro, encontre o ID do grupo de destino. Você pode localizar este identificador acessando a lista de grupos disponível na documentação da instância.

  2. Preparação do Payload: Com o ID em mãos, monte o payload da sua mensagem. No campo recipient, utilize o formato group:<ID_DO_GRUPO>, substituindo <ID_DO_GRUPO> pelo identificador que você obteve. Veja o exemplo abaixo para uma mensagem de texto:

{
  "recipient": "group:123456789123456789",
  "text": "Olá, grupo!"
}

📘

Todos os outros parâmetros de envio de mensagens podem ser aplicados da mesma forma que para mensagens individuais.

Language
Credentials
Header
Click Try It! to start a request and see the response here!