API для бизнес-профилей WhatsApp | Документация для разработчиков

API профиля WhatsApp Business

Экземпляр для программы магистратуры (LLM)

Просмотреть в формате Markdown

Версия

Этот конечный пункт позволяет приложениям получать исчерпывающую информацию о бизнес-профилях WhatsApp

включая данные профиля, контактную информацию и метаданные компании. Это необходимо для управления

Жизненный цикл бизнес-профиля и понимание текущего состояния конфигурации.

Базовый URL

https://graph.facebook.com

Конечные точки

ПОЛУЧАТЬ	/{Версия}/{ID профиля WhatsApp для бизнеса}
ПОЧТА	/{Версия}/{ID профиля WhatsApp для бизнеса}

GET /{Version}/{WhatsApp-Business-Profile-ID}

Получите исчерпывающую информацию о профиле WhatsApp Business, включая сведения о компании

Контактные данные и настройки профиля.

Варианты использования:

Получение информации о бизнес-профиле и метаданных

Проверьте настройки профиля и контактные данные

Проверьте статус профиля и информацию о компании

Перед началом бизнес-операций проверьте состояние профиля

Ограничение скорости запросов:

Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.

Кэширование:

Данные профиля могут кэшироваться в течение умеренного времени, но информация о компании может измениться

Периодически. Внедрите соответствующие стратегии аннулирования кэша.

Синтаксис запроса

GET / {Version} / {WhatsApp-Business-Profile-ID}

Попробуйте!

Выберите язык

curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{WhatsApp-Business-Profile-ID }' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'

Выберите код состояния

{
 "complete_profile"
 : { "summary"
 : "Полный бизнес-профиль со всеми подробностями" , "value"
 : { "id"
 : "1234567890123456" , "account_name"
 : "Бизнес-аккаунт электронной коммерции" , "description"
 : "Ведущая платформа электронной коммерции для качественных товаров" , "email"
 : " [email protected] " , "about"
 : "Качественные товары с доставкой по всему миру" , "address"
 : "123 Business Street, Commerce City, CC 12345" , "vertical"
 : "РОЗНИЧНАЯ ТОРГОВЛЯ" , "websites"
 : [ "https://www.business-example.com"
 , "https://shop.business-example.com"
 ],
 "profile_picture_url"
 : "https://pps.whatsapp.net/v/profile-picture-url" , "messaging_product"
 : "whatsapp" }
 },
 "minimal_profile"
 : { "summary"
 : "Минимальный бизнес-профиль только с обязательными полями " , "value"
 : { "id"
 : "2345678901234567" }
 }
 }

Параметры заголовка

Строка User-Agent

Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.

Строка авторизации · обязательный

Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.

Параметры пути

Строка версии · обязательный

Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.

Строка идентификатора бизнес-профиля WhatsApp · обязательный

Идентификатор вашего бизнес-профиля WhatsApp. Этот идентификатор присваивается при создании профиля

Его можно найти в вашем WhatsApp Business Manager или через API для управления бизнесом.

Параметры запроса

поля строка

Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,

Будут возвращены поля по умолчанию (идентификатор и любые доступные поля профиля).

Доступные поля: id, account_name, description, email, about, address, vertical, websites, profile_picture_url, messaging_product

Ответы

Получите исчерпывающую информацию о профиле WhatsApp Business, включая сведения о компании

Контактные данные и настройки профиля.

Варианты использования:

Получение информации о бизнес-профиле и метаданных

Проверьте настройки профиля и контактные данные

Проверьте статус профиля и информацию о компании

Перед началом бизнес-операций проверьте состояние профиля

Ограничение скорости запросов:

Кэширование:

Данные профиля могут кэшироваться в течение умеренного времени, но информация о компании может измениться

Периодически. Внедрите соответствующие стратегии аннулирования кэша.

200

Данные бизнес-профиля WhatsApp успешно получены

Тип содержимого: application/json

Схема: WhatsAppBusinessProfileNode

Показать дочерние атрибуты

WhatsAppBusinessProfileNode

строковый идентификатор · обязательный

Уникальный идентификатор для бизнес-профиля WhatsApp

строка имени_аккаунта

Название бизнес-счета

строка описания

Описание бизнеса

email string (email)

Контактный адрес электронной почты компании

о строке

Текст раздела «О нас» в профиле компании

строка адреса

Физический адрес предприятия

вертикальный WhatsAppBusinessВертикальный

Отраслевая вертикальная классификация для бизнеса

массив строк (uri) для веб-сайтов

Список URL-адресов веб-сайтов, связанных с компанией

Показать дочерние атрибуты

websites[] string (uri)

profile_picture_url string (uri)

URL изображения профиля компании

profile_picture_handle string

Идентификатор изображения профиля для операций загрузки

messaging_product "whatsapp"

Используемая служба обмена сообщениями

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

Страница не найдена — идентификатор бизнес-профиля WhatsApp не существует или недоступен

Тип содержимого: 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

Удобное для пользователя сообщение об ошибке для отображения

Выберите язык

curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{WhatsApp-Business-Profile-ID }' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'

Выберите код состояния

{
 "complete_profile"
 : { "summary"
 : "Полный бизнес-профиль со всеми подробностями" , "value"
 : { "id"
 : "1234567890123456" , "account_name"
 : "Бизнес-аккаунт электронной коммерции" , "description"
 : "Ведущая платформа электронной коммерции для качественных товаров" , "email"
 : " [email protected] " , "about"
 : "Качественные товары с доставкой по всему миру" , "address"
 : "123 Business Street, Commerce City, CC 12345" , "vertical"
 : "РОЗНИЧНАЯ ТОРГОВЛЯ" , "websites"
 : [ "https://www.business-example.com"
 , "https://shop.business-example.com"
 ],
 "profile_picture_url"
 : "https://pps.whatsapp.net/v/profile-picture-url" , "messaging_product"
 : "whatsapp" }
 },
 "minimal_profile"
 : { "summary"
 : "Минимальный бизнес-профиль только с обязательными полями " , "value"
 : { "id"
 : "2345678901234567" }
 }
 }

POST /{Version}/{WhatsApp-Business-Profile-ID}

Обновите информацию в профиле WhatsApp Business, такую как описание бизнеса, адрес электронной почты, почтовый адрес

и другие данные профиля. Эта операция соответствует функциональности GraphWhatsAppBusinessProfilePost.

Варианты использования:

Обновите информацию о бизнес-профиле и метаданные

Измените контактные данные и описание компании

Изменить классификацию бизнес-вертикалей

Обновите URL-адреса веб-сайтов и фотографию профиля

Поддерживайте актуальность информации в профиле компании

Загрузка фотографии профиля:

Рекомендуется использовать API возобновляемой загрузки для получения идентификатора загрузки, а затем использовать его

Загрузите ID, чтобы получить идентификатор изображения для profile_picture_handle .

Ограничение скорости запросов:

Синтаксис запроса

POST / {Version} / {WhatsApp-Business-Profile-ID}

Попробуйте!

Выберите язык

curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{WhatsApp-Business-Profile-ID }' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{ "messaging_product": "whatsapp",
 "account_name": "Updated E-commerce Business",
 "description": "Updated leading e-commerce platform
 for premium products", "email": "
 [email protected] ", "about": "Premium products delivered worldwide with
 excellent service", "address": "456 Updated Business Avenue, Commercial
 City, CC 54321", "vertical": "RETAIL",
 "websites": [
 "https://www.updated-business-example.com",
 "https://shop.updated-business-example.com"
 ],
 "profile_picture_handle": "4:VGVzdC5wbmc=:aW1hZ2
 UvanBlZw==:ARat4Mt-L09JON3f30SmDkdyPSuyBkDDYiB4TFX uXISjdgHoNp2b7j882_9Jzr2tPrdKxi92UygyVzTivJiOvmebM pZ6MIjTik3gTyI3ZCQAgQ:e:1659995302:202230845125416 1:636685196:ARZf1ftR5N6-qSLtklU" }'

Выберите код состояния

{
 "successful_update"
 : { "summary"
 : "Ответ на успешное обновление профиля" , "value"
 : { "id"
 : "1234567890123456" , "success"
 : true }
 }
 }

Параметры заголовка

Строка User-Agent

Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.

Строка авторизации · обязательный

Параметры пути

Строка версии · обязательный

Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.

Строка идентификатора бизнес-профиля WhatsApp · обязательный

Идентификатор вашего бизнес-профиля WhatsApp. Этот идентификатор присваивается при создании профиля

Его можно найти в вашем WhatsApp Business Manager или через API для управления бизнесом.

Текст запросаНеобходимый

Тип содержимого: application/json

Схема: WhatsAppBusinessProfileUpdateRequest

Показать дочерние атрибуты

Запрос на обновление бизнес-профиля WhatsApp

messaging_product "whatsapp" · required

Служба обмена сообщениями, использованная для запроса

строка имени_аккаунта

Название бизнес-счета

строка описания

Описание бизнеса

email string (email)

Контактный адрес электронной почты компании

о строке

Текст раздела «О нас» в профиле компании

строка адреса

Физический адрес предприятия

вертикальный WhatsAppBusinessВертикальный

Отраслевая вертикальная классификация для бизнеса

массив строк (uri) для веб-сайтов

Список URL-адресов веб-сайтов, связанных с компанией

Показать дочерние атрибуты

websites[] string (uri)

profile_picture_handle string

Идентификатор изображения профиля, сгенерированного с помощью API возобновляемой загрузки

Ответы

Обновите информацию в профиле WhatsApp Business, такую как описание бизнеса, адрес электронной почты, почтовый адрес

и другие данные профиля. Эта операция соответствует функциональности GraphWhatsAppBusinessProfilePost.

Варианты использования:

Обновите информацию о бизнес-профиле и метаданные

Измените контактные данные и описание компании

Изменить классификацию бизнес-вертикалей

Обновите URL-адреса веб-сайтов и фотографию профиля

Поддерживайте актуальность информации в профиле компании

Загрузка фотографии профиля:

Загрузите ID, чтобы получить идентификатор изображения для profile_picture_handle .

Ограничение скорости запросов:

200

Профиль WhatsApp Business успешно обновлен

Тип содержимого: application/json

Схема: WhatsAppBusinessProfileUpdateResponse

Показать дочерние атрибуты

WhatsAppBusinessProfileUpdateResponse

строка идентификатора

Обновленный идентификатор бизнес-профиля WhatsApp

успех логическое значение

Указывает, было ли обновление успешным

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

Страница не найдена — идентификатор бизнес-профиля WhatsApp не существует или недоступен

Тип содержимого: 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

Удобное для пользователя сообщение об ошибке для отображения

Выберите язык

curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{WhatsApp-Business-Profile-ID }' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{ "messaging_product": "whatsapp",
 "account_name": "Updated E-commerce Business",
 "description": "Updated leading e-commerce platform
 for premium products", "email": "
 [email protected] ", "about": "Premium products delivered worldwide with
 excellent service", "address": "456 Updated Business Avenue, Commercial
 City, CC 54321", "vertical": "RETAIL",
 "websites": [
 "https://www.updated-business-example.com",
 "https://shop.updated-business-example.com"
 ],
 "profile_picture_handle": "4:VGVzdC5wbmc=:aW1hZ2
 UvanBlZw==:ARat4Mt-L09JON3f30SmDkdyPSuyBkDDYiB4TFX uXISjdgHoNp2b7j882_9Jzr2tPrdKxi92UygyVzTivJiOvmebM pZ6MIjTik3gTyI3ZCQAgQ:e:1659995302:202230845125416 1:636685196:ARZf1ftR5N6-qSLtklU" }'

Выберите код состояния

{
 "successful_update"
 : { "summary"
 : "Ответ на успешное обновление профиля" , "value"
 : { "id"
 : "1234567890123456" , "success"
 : true }
 }
 }

Аутентификация

Схема	Тип	Расположение
bearerAuth	HTTP Bearer	Заголовок: `Авторизация`

Примеры использования

bearerAuth:

Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:

bearerAuth