Подтверждение номера телефона для бизнес-аккаунта WhatsApp — API кода подтверждения | Документация для разработчиков
Подтверждение номера телефона бизнес-аккаунта WhatsApp - API кода подтверждения
Экземпляр для программы магистратуры (LLM)
Версия
API для проверки кодов подтверждения номера телефона для бизнес-аккаунтов WhatsApp.
Этот интерфейс позволяет компаниям проверять коды подтверждения номера телефона, отправляемые во время
Процесс регистрации или подтверждения номера телефона.
POST /{Version}/{Phone-Number-ID}/verify_code
Проверьте код подтверждения номера телефона для бизнес-аккаунта WhatsApp.
Этот конечный пункт используется для завершения процесса проверки номера телефона путем отправки данных
Код подтверждения, полученный по SMS или голосовому звонку.
Варианты использования:
Полная проверка номера телефона во время первоначальной настройки
Подтвердите право собственности на номер телефона для обеспечения возможности обмена сообщениями
Завершить процесс регистрации телефонного номера
Полная проверка переноса телефонного номера
Ограничение скорости запросов:
Количество попыток проверки ограничено во избежание злоупотреблений. Неудачные попытки могут привести к..
В случае временной блокировки используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Безопасность:
Проверочные коды действуют ограниченное время (обычно 10 минут) и предназначены для одноразового использования.
Многократные неудачные попытки могут активировать дополнительные меры безопасности.
Синтаксис запроса
POST / {Version} / {Phone-Number-ID} /verify_code
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора номера телефона · обязательный
Номер телефона аккаунта WhatsApp Business, требующий подтверждения.
Этот идентификатор присваивается при добавлении номера телефона в ваш бизнес-аккаунт WhatsApp.
Текст запросаНеобходимый
Тип содержимого: application/json
Схема: VerifyCodeRequest
Показать дочерние атрибуты
VerifyCodeRequest
строка кода · обязательный
Код подтверждения, полученный по SMS или голосовому звонку
Ответы
Проверьте код подтверждения номера телефона для бизнес-аккаунта WhatsApp.
Этот конечный пункт используется для завершения процесса проверки номера телефона путем отправки данных
Код подтверждения, полученный по SMS или голосовому звонку.
Варианты использования:
Полная проверка номера телефона во время первоначальной настройки
Подтвердите право собственности на номер телефона для обеспечения возможности обмена сообщениями
Завершить процесс регистрации телефонного номера
Полная проверка переноса телефонного номера
Ограничение скорости запросов:
Количество попыток проверки ограничено во избежание злоупотреблений. Неудачные попытки могут привести к..
В случае временной блокировки используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Безопасность:
Проверочные коды действуют ограниченное время (обычно 10 минут) и предназначены для одноразового использования.
Многократные неудачные попытки могут активировать дополнительные меры безопасности.
200
Код подтверждения номера телефона успешно проверен
Тип содержимого: application/json
Схема: VerifyCodeResponse
Показать дочерние атрибуты
VerifyCodeResponse
успех логическое значение · обязательно
Указывает, был ли успешно подтвержден код проверки
строка идентификатора
Идентификатор номера телефона, который был подтвержден
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
404
Номер телефона не найден — идентификатор номера телефона не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемая сущность — недействительный или просроченный код подтверждения
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth