Что это
SMS API отправляет текстовое сообщение на один номер телефона. Используйте его для уведомлений, оповещений, транзакционных обновлений и других текстовых коммуникаций.Перед началом
- Сохраните ваш API-ключ YCloud в
YCLOUD_API_KEY. - Отформатируйте номер получателя в формате E.164.
- Зарегистрируйте одобренный
senderId, если это требуется для направления. - Укажите одобренную
signatureдля сообщений, отправляемых в материковый Китай.
Как это работает
Отправьте сообщение запросомPOST /sms. Успешный ответ означает, что YCloud принял запрос. Он не гарантирует финальной доставки.
YCloud обновляет статус сообщения с accepted на более поздний, например sent, delivered, undelivered или failed. Получайте эти изменения через вебхук sms.message.updated или получайте записи SMS через GET /sms.
Запрос
POST /sms
Поля запроса
Пример запроса
Ответ
Успешный ответ возвращает созданный объект SMS. Сохраните егоid, чтобы соотносить обновления доставки и получать сообщение позже.
Пример ответа
Поля ответа
Статус доставки
Подпишитесь наsms.message.updated для отслеживания изменений статуса исходящих. Подпишитесь на sms.inbound.received, если ваш аккаунт принимает SMS-ответы.
Используйте GET /sms для сверки записей по времени создания или ID сообщения.
Ограничения и устранение неполадок
- Доступность Sender ID и правила по контенту зависят от направления.
- Длинные сообщения могут использовать несколько SMS-сегментов и стоить дороже.
- Не повторяйте принятый запрос без стратегии идемпотентности. Повторный запрос может отправить дубликат сообщения.
- При расследовании проблем доставки используйте возвращённые
idиexternalId.

