Перейти к основному содержимому

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--requestGET \
--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": {
"курсоры": {
"после": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD",
"перед": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD"
        }
      }
    }
  }
}
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
Phone-Number-IDСтрока·обязательный
Ответы
Справочная информация по конечной точке: GET WhatsApp Business Phone Number > block_users
200
Получить заблокированных пользователей
Тип содержимого: application/json
Схема: GetBlockedUsersData
Показать дочерние атрибуты
GetBlockedUsersData
данныхBlockedUser
Показать дочерние атрибуты
data[]BlockedUser
Показать дочерние атрибуты
messaging_productstring
wa_idстрока
пейджинг​
Показать дочерние атрибуты
курсорыPaginationCursors
Показать дочерние атрибуты
послестроки
передстрокой
Выберите язык
curl--requestGET \
--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": {
"курсоры": {
"после": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD",
"перед": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD"
        }
      }
    }
  }
}

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"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
Phone-Number-IDСтрока·обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
block_usersмассив объектов
Показать дочерние атрибуты
block_users[]объект
Показать дочерние атрибуты
пользователястрока
messaging_productstring
Ответы
Справочная информация по конечной точке: POST WhatsApp Business Phone Number > block_users
200
Заблокировать пользователя(ей)
Тип содержимого: application/json
Схема: BlockUsersData
Показать дочерние атрибуты
BlockUsersData
block_usersBlockUsersResult
Показать дочерние атрибуты
added_usersиз BlockedUserOperation
Показать дочерние атрибуты
added_users[]BlockedUserOperation
Показать дочерние атрибуты
входнаястрока
wa_idстрока
messaging_productstring
Выберите язык
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"·обязательный
Тип носителя информации в теле запроса
Параметры пути
версииСтрока·обязательный
Phone-Number-IDСтрока·обязательный
Текст запросаНеобязательный
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
block_usersмассив объектов
Показать дочерние атрибуты
block_users[]объект
Показать дочерние атрибуты
пользователястрока
messaging_productstring
Ответы
Справочная информация по конечной точке: DELETE WhatsApp Business Phone Number > block_users
200
Разблокировать пользователя(ей)
Тип содержимого: application/json
Схема: UnblockUsersData
Показать дочерние атрибуты
UnblockUsersData
block_usersUnblockUsersResult
Показать дочерние атрибуты
removed_usersмассив BlockedUserOperation
Показать дочерние атрибуты
removed_users[]BlockedUserOperation
Показать дочерние атрибуты
входнаястрока
wa_idстрока
messaging_productstring
Выберите язык
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
Вернуться наверх