Manda um SMS de teste para mim
POST/api/sms/test
- Auth
- Requiere token
- Clave de API:
- campaigns:write
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
La especificación no declara los campos de este cuerpo (una subida multipart, por ejemplo). Consulta la guía del tema.
Respuestas
| Código | Descripción |
|---|---|
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`). |
Ejemplo con 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 '{}'