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

WhatsApp Cloud API - Block API | Документация для разработчиков

WhatsApp Cloud API - Block API

Экземпляр для программы магистратуры (LLM)
Версия
API Block позволяет компаниям управлять заблокированными пользователями в WhatsApp.
Используйте этот API, чтобы заблокировать отправку сообщений на номер вашей компании
Получить список заблокированных пользователей и разблокировать их при необходимости.
Для получения более подробной информации см. Руководство пользователя по блокировке .

База

URL
https://graph.facebook.com

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

ПОЛУЧАТЬ /{Версия}/{Идентификатор-номера-телефона}/block_users

Справочная информация по конечной точке: Получить бизнес-номер WhatsApp > block_users

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

ПОЛУЧАТЬ /{Версия}/{Номер-телефона-ID}/block_users
Попробуйте!
Выберите язык
локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния
{
"Заблокировать пользователей": {
"ценить": {
"данные": [
        {
"messaging_product": "WhatsApp",
"ва_ид": "16505551234"
        }
      ],
"пейджинг": {
"курсоры": {
"после": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD",
"до": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD"
        }
      }
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Путь Параметры
Версиянить·необходимый
Выберите язык
Номер телефона - IDнить·необходимый
Ответы
Выберите код состояния
Справочная информация по конечной точке: Получить бизнес-номер WhatsApp > block_users
200
Получить заблокированных пользователей
Выберите язык
Выберите код состояния
Тип контента: приложение/json
Схема: GetBlockedUsersData
Показать дочерние атрибуты
GetBlockedUsersData
данныемассив BlockedUser
Показать дочерние атрибуты
данные[]ЗаблокированныйПользователь
Показать дочерние атрибуты
messaging_productнить

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

Схема
Тип
Расположение
wa_id
нитьbearerAuth
пейджингПейджинг
Показывать дочерние атрибуты
курсорыКурсоры пагинации
Показать дочерние атрибуты
посленить
донить
Выберите язык
локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния
{
"Заблокировать пользователей": {
"ценить": {
"данные": [
        {
"messaging_product": "WhatsApp",
"ва_ид": "16505551234"
        }
      ],
"пейджинг": {
"курсоры": {
"после": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD",
"до": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2ODgzODM1ODQifQZDZD"
        }
      }
    }
  }
}

POST /{Version}/{Phone-Number-ID}/block_users

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

ПОЧТА /{Версия}/{Номер-телефона-ID}/block_users
Попробуйте!
Выберите язык
локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "block_users": [
    {
      "пользователь": "+16505551234"
    }
  ],
  "messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Заблокировать пользователя(ей)": {
"ценить": {
"block_users": {
"added_users": [
          {
"вход": "+16505551234",
"ва_ид": "16505551234"
          }
        ]
      },
"messaging_product": "WhatsApp"
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Параметры пути
Версиянить·необходимый
Номер телефона - IDнить·необходимый
Текст запросаНеобязательный
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты
block_usersмассив объектов
Показать дочерние атрибуты
block_users[]объект
Показать дочерние атрибуты
пользовательнить
messaging_productнить
Ответы
200
Заблокировать пользователя(ей)
Тип контента: приложение/json
Схема: BlockUsersData
Показать дочерние атрибуты
BlockUsersData
block_usersBlockUsersResult
Показать дочерние атрибуты
добавленные_пользователимассив BlockedUserOperation
Показать дочерние атрибуты
добавленные_пользователи[]BlockedUserOperation
Показать дочерние атрибуты
входнить
wa_idнить
messaging_productнить
Выберите язык
локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "block_users": [
    {
      "пользователь": "+16505551234"
    }
  ],
  "messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Заблокировать пользователя(ей)": {
"ценить": {
"block_users": {
"added_users": [
          {
"вход": "+16505551234",
"ва_ид": "16505551234"
          }
        ]
      },
"messaging_product": "WhatsApp"
    }
  }
}

Удалить /{Версия}/{Идентификатор-номер-телефона}/block_users

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

УДАЛИТЬ /{Версия}/{Номер-телефона-ID}/block_users
Попробуйте!
Выберите язык
локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "block_users": [
    {
      "пользователь": "+16505551234"
    }
  ],
  "messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Разблокировать пользователя(ей)": {
"ценить": {
"block_users": {
"удалённые_пользователи": [
          {
"вход": "+16505551234",
"ва_ид": "16505551234"
          }
        ]
      },
"messaging_product": "WhatsApp"
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"·необходимый
Тип носителя информации в теле запроса
Параметры пути
Версиянить·необходимый
Номер телефона - IDнить·необходимый
Текст запросаНеобязательный
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты
block_usersмассив объектов
Показать дочерние атрибуты
block_users[]объект
Показать дочерние атрибуты
пользовательнить
messaging_productнить
Ответы
200
Разблокировать пользователя(ей)
Тип контента: приложение/json
Схема: UnblockUsersData
Показать дочерние атрибуты
UnblockUsersData
block_usersUnblockUsersResult
Показать дочерние атрибуты
удаленные_пользователимассив BlockedUserOperation
Показать дочерние атрибуты
removed_users[]BlockedUserOperation
Показать дочерние атрибуты
входнить
wa_idнить
messaging_productнить
Выберите язык
локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/block_users' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "block_users": [
    {
      "пользователь": "+16505551234"
    }
  ],
  "messaging_product": "whatsapp"
}'
Выберите код состояния
{
"Разблокировать пользователя(ей)": {
"ценить": {
"block_users": {
"удалённые_пользователи": [
          {
"вход": "+16505551234",
"ва_ид": "16505551234"
          }
        ]
      },
"messaging_product": "WhatsApp"
    }
  }
}

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

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

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

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

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

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