WhatsApp Cloud API - Block API | Документация для разработчиков
WhatsApp Cloud API - Block API
Экземпляр для программы магистратуры (LLM)
Версия
API Block позволяет компаниям управлять заблокированными пользователями в WhatsApp.
Используйте этот API, чтобы заблокировать отправку сообщений на номер вашей компании
Получить список заблокированных пользователей и разблокировать их при необходимости.
Базовый URL
https://graph.facebook.com |
Конечные точки
ПОЛУЧАТЬ | |
ПОЧТА | |
УДАЛИТЬ |
GET /{Version}/{Phone-Number-ID}/block_users
Руководство: Блокировка пользователей
Справочная информация по конечной точке: GET WhatsApp Business Phone Number > block_users
Синтаксис запроса
GET / {Version} / {Phone-Number-ID} /block_users
Попробуйте!
Выберите язык
curl
--request GET \ --url
'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users ' \ --header
'Authorization: Bearer'' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния
{
"Получить заблокированных пользователей"
: { "значение"
: { "данные"
: [ {
"messaging_product"
: "whatsapp" , "wa_id"
: "16505551234" }
],
"paging"
: { "курсоры"
: { "после"
: "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2 ODgzODM1ODQifQZDZD" , "перед"
: "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2 ODgzODM1ODQifQZDZD" }
}
}
}
}
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
Строка идентификатора номера телефона · обязательный
Ответы
Руководство: Блокировка пользователей
Справочная информация по конечной точке: GET WhatsApp Business Phone Number > block_users
200
Получить заблокированных пользователей
Тип содержимого: application/json
Схема: GetBlockedUsersData
Показать дочерние атрибуты
GetBlockedUsersData
данных BlockedUser
Показать дочерние атрибуты
data[] BlockedUser
Показать дочерние атрибуты
messaging_product string
строка wa_id
пейджинг
Показать дочерние атрибуты
курсоры PaginationCursors
Показать дочерние атрибуты
после строки
перед строкой
Выберите язык
curl
--request GET \ --url
'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users ' \ --header
'Authorization: Bearer'' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния
{
"Получить заблокированных пользователей"
: { "значение"
: { "данные"
: [ {
"messaging_product"
: "whatsapp" , "wa_id"
: "16505551234" }
],
"paging"
: { "курсоры"
: { "после"
: "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2 ODgzODM1ODQifQZDZD" , "перед"
: "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2 ODgzODM1ODQifQZDZD" }
}
}
}
}
POST /{Version}/{Phone-Number-ID}/block_users
Руководство: Блокировка пользователей
Справочная информация по конечной точке: POST WhatsApp Business Phone Number > block_users
Синтаксис запроса
POST / {Version} / {Phone-Number-ID} /block_users
Попробуйте!
Выберите язык
curl
--request POST \ --url
'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users ' \ --header
'Authorization: Bearer'' \ --header
'Content-Type: application/json' \ --data
'{ "block_users": [
{
"user": "+16505551234"
}
],
"messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Заблокировать пользователя(ей)"
: { "value"
: { "block_users"
: { "added_users"
: [ {
"input"
: "+16505551234" , "wa_id"
: "16505551234" }
]
},
"messaging_product"
: "whatsapp" }
}
}
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
Строка идентификатора номера телефона · обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
block_users массив объектов
Показать дочерние атрибуты
объект block_users[]
Показать дочерние атрибуты
строка пользователя
messaging_product string
Ответы
Руководство: Блокировка пользователей
Справочная информация по конечной точке: POST WhatsApp Business Phone Number > block_users
200
Заблокировать пользователя(ей)
Тип содержимого: application/json
Схема: BlockUsersData
Показать дочерние атрибуты
BlockUsersData
block_users BlockUsersResult
Показать дочерние атрибуты
added_users из BlockedUserOperation
Показать дочерние атрибуты
added_users[] BlockedUserOperation
Показать дочерние атрибуты
входная строка
строка wa_id
messaging_product string
Выберите язык
curl
--request POST \ --url
'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users ' \ --header
'Authorization: Bearer'' \ --header
'Content-Type: application/json' \ --data
'{ "block_users": [
{
"user": "+16505551234"
}
],
"messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Заблокировать пользователя(ей)"
: { "value"
: { "block_users"
: { "added_users"
: [ {
"input"
: "+16505551234" , "wa_id"
: "16505551234" }
]
},
"messaging_product"
: "whatsapp" }
}
}
Удалить /{Версия}/{Идентификатор-номер-телефона}/block_users
Руководство: Блокировка пользователей
Справочная информация по конечной точке: DELETE WhatsApp Business Phone Number > block_users
Синтаксис запроса
УДАЛИТЬ / {Версия} / {Номер-телефона-ID} /block_users
Попробуйте!
Выберите язык
curl
--request DELETE \ --url
'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users ' \ --header
'Authorization: Bearer'' \ --header
'Content-Type: application/json' \ --data
'{ "block_users": [
{
"user": "+16505551234"
}
],
"messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Разблокировать пользователя(ей)"
: { "value"
: { "block_users"
: { "removed_users"
: [ {
"input"
: "+16505551234" , "wa_id"
: "16505551234" }
]
},
"messaging_product"
: "whatsapp" }
}
}
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required
Тип носителя информации в теле запроса
Параметры пути
Строка версии · обязательный
Строка идентификатора номера телефона · обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
block_users массив объектов
Показать дочерние атрибуты
объект block_users[]
Показать дочерние атрибуты
строка пользователя
messaging_product string
Ответы
Руководство: Блокировка пользователей
Справочная информация по конечной точке: DELETE WhatsApp Business Phone Number > block_users
200
Разблокировать пользователя(ей)
Тип содержимого: application/json
Схема: UnblockUsersData
Показать дочерние атрибуты
UnblockUsersData
block_users UnblockUsersResult
Показать дочерние атрибуты
removed_users массив BlockedUserOperation
Показать дочерние атрибуты
removed_users[] BlockedUserOperation
Показать дочерние атрибуты
входная строка
строка wa_id
messaging_product string
Выберите язык
curl
--request DELETE \ --url
'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users ' \ --header
'Authorization: Bearer'' \ --header
'Content-Type: application/json' \ --data
'{ "block_users": [
{
"user": "+16505551234"
}
],
"messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Разблокировать пользователя(ей)"
: { "value"
: { "block_users"
: { "removed_users"
: [ {
"input"
: "+16505551234" , "wa_id"
: "16505551234" }
]
},
"messaging_product"
: "whatsapp" }
}
}
Аутентификация
Схема | Тип | Расположение |
bearerAuth | HTTP Bearer | Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth