Отправка голосового кода

​

Что это

​

Перед началом

• Активируйте Voice для вашего аккаунта YCloud.
• Соберите номер телефона получателя в формате E.164.
• Сгенерируйте короткоживущий код из 4–6 цифр.
• Выберите поддерживаемый язык.
• Определите, будет ли статус приходить через callback URL или настроенный вебхук.

​

Как это работает

1. Сгенерируйте и безопасно сохраните вызов на верификацию.
2. Отправьте код через Voice API.
3. Сохраните возвращённый ID голосовой записи и ваш externalId.
4. Получайте обновления доставки через callback или вебхук.
5. Проверьте код в вашем приложении и завершите срок действия вызова.

​

Запрос

curl --request POST https://api.ycloud.com/v2/voices \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "+16315551111",
    "verificationCode": "123456",
    "language": "en",
    "externalId": "login-7f10b6",
    "callbackUrl": "https://example.com/webhooks/voice"
  }'

​

Ответ

{
  "id": "VOICE_MESSAGE_ID"
}

​

Статус доставки

​

Защита процесса верификации

• Быстро завершайте срок действия кодов.
• Ограничивайте попытки отправки и проверки по пользователю, направлению, IP и устройству.
• Никогда не логируйте код подтверждения.
• Предотвращайте повторное использование кода после одобрения.
• Не раскрывайте, принадлежит ли номер телефона аккаунту.

​

Ограничения и устранение неполадок

• verificationCode должен содержать от 4 до 6 цифр.
• Номера телефонов должны быть в формате E.164.
• Доступность языка может зависеть от страны или региона.
• Используйте externalId и ID записи YCloud для расследования доставки.
• Предпочитайте Verify API, когда хотите, чтобы YCloud управлял и доставкой, и проверкой кода в рамках единого жизненного цикла верификации.