Skip to main content

Qué es

La API de SMS envía un mensaje de texto a un número de teléfono. Úsela para notificaciones, alertas, actualizaciones transaccionales y otras comunicaciones basadas en texto.

Antes de empezar

  • Guarde su clave de API de YCloud en YCLOUD_API_KEY.
  • Aplique el formato E.164 al número del destinatario.
  • Registre un senderId aprobado cuando el destino lo requiera.
  • Proporcione un signature aprobado para los mensajes enviados a China continental.

Cómo funciona

Envía el mensaje con POST /sms. Una respuesta exitosa significa que YCloud aceptó la solicitud. No garantiza la entrega final. YCloud actualiza el mensaje de accepted a un estado posterior como sent, delivered, undelivered o failed. Recibe estos cambios a través del Webhook de sms.message.updated o recupera los registros de SMS con GET /sms.

Solicitud

POST /sms

Campos de solicitud

Ejemplo de solicitud

Respuesta

Una respuesta exitosa devuelve el objeto SMS creado. Guarde su id para correlacionar las actualizaciones de entrega y recuperar el mensaje más tarde.

Ejemplo de respuesta

Campos de respuesta

Estado de entrega

Suscríbase a sms.message.updated para los cambios de estado de salida. Suscríbase a sms.inbound.received si su cuenta recibe respuestas de SMS. Utilice GET /sms para conciliar los registros por hora de creación o ID de mensaje.

Límites y solución de problemas

  • La disponibilidad del ID del remitente y las reglas de contenido varían según el destino.
  • Los mensajes largos pueden usar múltiples segmentos de SMS y costar más.
  • No vuelva a intentar una solicitud aceptada sin una estrategia de idempotencia. Una solicitud repetida puede enviar un mensaje duplicado.
  • Utilice id y externalId devueltos cuando investigue un problema de entrega.