Pular para o conteúdo principal
Este guia cria um Contato, inicia uma conversa com um usuário interno do Bridge e cria uma mensagem. Execute o exemplo no seu servidor.
Use um Contato de teste para o qual você tem autorização de envio. A criação da conversa pode executar os templates iniciais do workspace antes da requisição separada de mensagem. Revise essa configuração primeiro: definir como false o sinalizador de envio externo da mensagem posterior não desabilita os templates iniciais da conversa.

Antes de começar

  • Obtenha uma chave de API para uso no servidor no guia de autenticação.
  • Tenha o ID do workspace, o providerChannelId de uma linha ativa de WhatsApp e o e-mail de um usuário interno do Bridge. Veja conceitos e identificadores.
  • Use um novo telefone de teste em formato internacional. Se o Contato já existir, use a consulta de contatos em vez de criá-lo novamente.
  • Verifique os atributos personalizados obrigatórios e a sequência inicial configurada no workspace. Este exemplo mínimo não envia atributos personalizados nem substitui os templates.
  • Escolha enableExternalBroadcast explicitamente: true solicita o envio externo quando as regras da conversa e do destinatário permitem; false ainda cria a mensagem, mas não realiza o envio externo. Nenhum dos valores confirma a entrega pelo provedor. Esse sinalizador não ignora regras de visibilidade ou permissões.

A sequência

O id do Contato passa a ser o identifier do participante externo, com identifierType: "ID". O id da conversa passa a ser o conversationId da mensagem.

Execute o exemplo

Use Node.js com fetch nativo. Salve como first-conversation.mjs. Configure estas variáveis de ambiente no servidor, usando os recursos de segredos e configuração da sua aplicação: Os nomes e a mensagem abaixo são exemplos. Substitua-os pelo conteúdo de teste desejado antes de executar.

Entenda o resultado

  • Uma resposta 201 de Contato informa sua identidade e workspace. Leia type para verificar a classificação real: NORMAL ou PARTIAL.
  • Uma resposta 201 de conversa fornece o ID a usar na próxima etapa. Quando nenhuma linha está livre, o Bridge pode recuperar uma conversa liberada com exatamente os participantes solicitados. Nesse caso, o ID e o histórico são mantidos, e os valores solicitados de name e status não são aplicados.
  • Uma resposta 201 de mensagem fornece messageId. Isso, por si só, não comprova que o WhatsApp entregou a mensagem ao Contato.
Este guia atribui explicitamente um usuário interno do Bridge. Para atribuir uma equipe, use a opção documentada teamId em vez de participants.internals: as duas opções são mutuamente exclusivas.

Se uma etapa falhar

O exemplo para na requisição que falhou e nunca repete uma operação de escrita automaticamente. Uma falha de rede pode deixar o resultado incerto. Consulte o recurso correspondente antes de repetir uma criação ou um envio. Veja respostas e erros para conhecer os formatos de resposta e decidir como recuperar a operação.

Próximos passos