Enviar um SMS

​

O que é

​

Antes de começar

• Armazene sua chave de API da YCloud em YCLOUD_API_KEY.
• Formate o número do destinatário no formato E.164.
• Registre um senderId aprovado quando o destino exigir.
• Forneça uma signature aprovada para mensagens enviadas à China continental.

​

Como funciona

​

Requisição

​

Campos da requisição

​

Exemplo de requisição

curl --request POST https://api.ycloud.com/v2/sms \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "+16315551111",
    "text": "Your verification code is 123456.",
    "externalId": "login-10001"
  }'

​

Resposta

​

Exemplo de resposta

{
  "id": "MESSAGE_ID",
  "to": "+16315551111",
  "text": "Your verification code is 123456.",
  "regionCode": "US",
  "totalSegments": 1,
  "status": "accepted",
  "externalId": "login-10001",
  "createTime": "2026-07-16T12:00:00.000Z"
}

​

Campos da resposta

​

Status de entrega

​

Limites e solução de problemas

• A disponibilidade de Sender ID e as regras de conteúdo variam conforme o destino.
• Mensagens longas podem usar múltiplos segmentos de SMS e custar mais.
• Não repita uma requisição aceita sem uma estratégia de idempotência. Uma requisição repetida pode enviar uma mensagem duplicada.
• Use o id retornado e o externalId ao investigar um problema de entrega.