Skip to content

Um WhatsApp de teste para quem pede

POST/api/whatsapp/test

Auth
Requires a token
Who can call it:
owner
admin
API key:
campaigns:write
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner ou admin: um aviso de serviço para o próprio telefone, enviado na hora: não espera o horário de silêncio nem o teto diário da comunidade, mas exige o canal ligado, o plano, o telefone confirmado, o consentimento de WhatsApp, o modelo aprovado e o teto de preço (preço desconhecido recusa). Conta no uso e no custo. Fora de produção o envio é simulado. A resposta diz o que aconteceu: `sent`, `skipped` com `reason` ou `failed` com `code`. Limite próprio: 5 testes por hora por pessoa e 20 por dia na comunidade (429 `sms.testTooMany`).

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

The specification does not declare the fields of this body (a multipart upload, for example). See the topic guide.

Responses

StatusDescription
202Pedido registrado.
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
429Limite de testes (`sms.testTooMany`).

curl example

curl -X POST "https://api.memberfy.net/api/whatsapp/test" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'