Antes de começar
- Obtenha uma chave de API para uso no servidor no guia de autenticação.
- Tenha o ID do workspace, o
providerChannelIdde 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
enableExternalBroadcastexplicitamente:truesolicita o envio externo quando as regras da conversa e do destinatário permitem;falseainda 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 comfetch 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
201de Contato informa sua identidade e workspace. Leiatypepara verificar a classificação real:NORMALouPARTIAL. - Uma resposta
201de 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 denameestatusnão são aplicados. - Uma resposta
201de mensagem fornecemessageId. Isso, por si só, não comprova que o WhatsApp entregou a mensagem ao Contato.
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
- Faça upload e envie um anexo.
- Escolha e preencha um template de WhatsApp.
- Consulte os contratos completos de requisição e resposta para criar um Contato, criar uma conversa e criar uma mensagem.

