Manda um SMS de teste para mim
POST/api/sms/test
- Auth
- Exige token
- Chave de API:
- campaigns:write
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Owner e 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, nenhuma saída e o teto de preço (preço desconhecido recusa). A resposta diz se saiu (`sent`), por que foi pulado (`skipped`, com `reason`) ou se o provedor recusou (`failed`, com `code`). Conta no uso e no custo como qualquer mensagem. Limite próprio: 5 testes por hora por pessoa e 20 por dia na comunidade, por canal (429 `sms.testTooMany`).
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo da requisição application/json
A especificação não declara os campos deste corpo (upload multipart, por exemplo). Consulte o guia do assunto.
Respostas
| Código | Descrição |
|---|---|
202 | Pedido registrado. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
429 | Limite de testes (`sms.testTooMany`). |
Exemplo com curl
curl -X POST "https://api.memberfy.net/api/sms/test" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'