Início rápido do Sandbox
Crie, liste e remova um número de teste pela Platform API pública.
Números de teste exigem acesso da equipe ao beta. Quando o beta é oferecido, um proprietário ou administrador da equipe abre Recursos opcionais, seleciona Números de teste e Participar, revisa os termos e seleciona Aceitar e participar. O Inspector aparece separadamente na mesma lista. Sem acesso a números de teste, a criação e o uso ficam bloqueados; os números existentes continuam disponíveis para consulta, parada e exclusão.
Você precisa de:
- O UUID de um projeto de desenvolvimento.
- Uma chave de equipe com
sessions:readesessions:manage.
Mantenha a credencial em um servidor confiável.
1. Criar um número de teste#
curl -X POST "https://api.polymorfa.com/platform/sessions/testing" \
-H "Authorization: Bearer $POLYMORFA_TEAM_KEY" \
-H "Content-Type: application/json" \
-d '{
"projectId": "'"$PROJECT_ID"'",
"name": "Quickstart sender",
"country": "US"
}'projectId é obrigatório. country é opcional e tem US como padrão; ele aceita um dos 243 códigos ISO alfa-2 compatíveis com o WhatsApp publicados no esquema da solicitação. A resposta contém o identificador gerado da sessão de teste. Uma resposta bem-sucedida significa que o dispositivo controlado pela API do número está conectado e pronto para receber comandos. O dispositivo vinculado se reconecta depois de reinícios do serviço ou do app, sem outra etapa de pareamento. Remover o número de teste invalida esse dispositivo.
Números de teste só podem enviar mensagens para números de teste ativos do mesmo projeto. Uma solicitação de envio pode identificar o destinatário como um número E.164, como +15551234567, em conversation.phoneNumber. Um destinatário malformado, desconhecido, parado, removido ou de outro projeto retorna o mesmo resultado 404 Not Found, e nenhuma conversa, contato ou mensagem é criado. As sessões de API de números de teste simulam os comandos públicos de mensagens e de sessão, incluindo mídia, alterações e confirmações de mensagens, contatos, grupos, canais, presença, privacidade, perfis, etiquetas e catálogos comerciais. O dispositivo controlado pela API e o Inspector leem o mesmo estado simulado de conta e conversa. As solicitações de mensagem continuam disponíveis enquanto o Inspector do destinatário está fechado e são entregues depois que ele se reconecta. Remover o destinatário cancela a entrega pendente. Nenhum comando simulado entra em contato com o WhatsApp ou com um destinatário real.
2. Listar as sessões do projeto#
curl "https://api.polymorfa.com/platform/sessions?projectId=$PROJECT_ID" \
-H "Authorization: Bearer $POLYMORFA_TEAM_KEY"Selecione a linha cujo identificador de sessão gerado corresponde à resposta de criação. As linhas de números de teste têm testMode: true.
3. Remover o número de teste#
curl -X DELETE \
"https://api.polymorfa.com/platform/sessions/$SESSION_ID" \
-H "Authorization: Bearer $POLYMORFA_TEAM_KEY"A remoção fecha uma sessão aberta do Inspector e limpa o estado simulado do número antes de retornar sucesso. Se não for possível fechar o número, a solicitação falha e mantém o registro disponível para você tentar novamente. A remoção é permanente. Use as páginas de endpoint geradas da Platform API para ver os esquemas completos de solicitação, resposta, autorização e erros.
Próximos passos#
Liste e gerencie números de teste.
Inspector: propriedade e dispositivosAbra uma sessão de teste no app para desktop.
Limites do SandboxRevise a taxa de envio e os dados incluídos.
AutenticaçãoRevise os públicos e os escopos das credenciais, incluindo tokens de projeto.
Eventos de testeEnvie eventos de webhook de teste assinados.