Saltar al contenido

Liga ou desliga o canal SMS e define o teto diário

PUT/api/sms/settings

Auth
Requiere token
Clave de API:
campaigns:write
X-CommunityId
X-CommunityId Enví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. Ligar (`enabled: true`) exige `dailyCap` (de 1 a 50.000 mensagens por dia), mandado agora ou já salvo; sem ele, 422 com `param = dailyCap`. Ligar num plano sem SMS (`sms.messagesPerMonth` = 0) dá 409 `sms.channelNotOnPlan`. `personDailyCap` (1 a 20, padrão 5) limita as mensagens de fluxo por pessoa por dia em cada canal (SMS e WhatsApp). Campos omitidos ficam como estão. Desligar para os envios ainda na fila (são pulados com `smsChannelDisabled`).

Headers

NombreTipoDescripción
If-Unmodified-SinceopcionalstringOpcional: a versão lida (`updatedAt` de `GET /api/sms/settings` (a mesma versão das configurações de WhatsApp)), como data HTTP, se não vier `updatedAt` no corpo. Outra gravação depois dela responde 409.
X-CommunityIdopcionalstring (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

NombreTipoDescripción
enabledopcionalboolean
dailyCapopcionalinteger≥ 1, ≤ 50000
personDailyCapopcionalinteger≥ 1, ≤ 20

Respuestas

CódigoDescripción
200Configuração resultante.
400Requisição inválida — falha de validação.
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.
409Plano sem SMS (`sms.channelNotOnPlan`).
422Ligar sem teto diário, ou `personDailyCap` fora de 1 a 20.

Ejemplo con curl

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