Управление бизнес-аккаунтами WhatsApp — API для добавления телефонных номеров | Документация для разработчиков
Управление бизнес-аккаунтами WhatsApp - API для добавления телефонных номеров
Экземпляр для программы магистратуры (LLM)
Версия
API для добавления телефонных номеров в бизнес-аккаунт WhatsApp.
Этот интерфейс позволяет компаниям добавлять номера телефонов в свои бизнес-аккаунты WhatsApp
для целей обмена сообщениями.
POST /{Version}/{Business-ID}/add_phone_numbers
Добавьте предварительно подтвержденный номер телефона в бизнес-аккаунт WhatsApp. Эта конечная точка используется для
Партнеры создают пул собственных номеров, предназначенных для конечных клиентов
можно приобрести.
Варианты использования:
Добавьте новые телефонные номера для масштабирования операций обмена сообщениями
Настройте телефонные номера для разных офисов компании
Управление номерами телефонов для корпоративной рассылки сообщений
Настройте телефонные номера для конкретных сценариев обмена сообщениями
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Требования к номеру телефона:
Должно быть в формате E.164 (например, +1234567890)
Не должен быть уже зарегистрирован в другом бизнес-аккаунте WhatsApp
Необходимо иметь возможность принимать SMS-сообщения для подтверждения
Необходимо соблюдать правила WhatsApp для бизнес-мессенджеров
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка Business-ID · обязательный
Идентификатор вашего бизнес-аккаунта WhatsApp. Этот идентификатор можно найти в вашем личном кабинете
или через API для управления бизнес-процессами.
Необходимый
Номер телефона для добавления в корпоративный аккаунт
Тип содержимого: application/json
Схема: AddPhoneNumbersRequest
Показать дочерние атрибуты
Добавить номер телефона Запрос
номер телефона строка · обязательный
Номер телефона для добавления в корпоративный аккаунт. Принимает номера в формате E.164 или в отформатированном виде
с пробелами, дефисами и скобками (например, +1234567890, +1 (631) 555-1000, +1-631-555-1000).
Номер телефона будет нормализован и проверен конечным устройством.
Ответы
Добавьте предварительно подтвержденный номер телефона в бизнес-аккаунт WhatsApp. Эта конечная точка используется для
Партнеры создают пул собственных номеров, предназначенных для конечных клиентов
можно приобрести.
Варианты использования:
Добавьте новые телефонные номера для масштабирования операций обмена сообщениями
Настройте телефонные номера для разных офисов компании
Управление номерами телефонов для корпоративной рассылки сообщений
Настройте телефонные номера для конкретных сценариев обмена сообщениями
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Требования к номеру телефона:
Должно быть в формате E.164 (например, +1234567890)
Не должен быть уже зарегистрирован в другом бизнес-аккаунте WhatsApp
Необходимо иметь возможность принимать SMS-сообщения для подтверждения
Необходимо соблюдать правила WhatsApp для бизнес-мессенджеров
200
Номер телефона успешно добавлен
Тип содержимого: application/json
Схема: AddPhoneNumbersResponse
Показать дочерние атрибуты
AddPhoneNumbersResponse
строковый идентификатор · обязательный
Уникальный идентификатор для предварительно проверенного объекта телефонного номера, который был создан
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
Комментарии отсутствуют
Комментарии отсутствуют