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

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

Руководство по API блокировки пользователей

Обновлено: 23 февраля 2026 г
API блокировки пользователей позволяет вашей компании блокировать доступ недобросовестных пользователей к вашим услугам.

Как это работает

При блокировке пользователя WhatsApp происходит следующее:
    Пользователь не может связаться с вашей компанией или увидеть, что вы находитесь в сети.Ваша компания не может отправлять сообщения пользователю. В противном случае вы столкнетесь с ошибкой.
    Ошибки в API возникают для каждого номера отдельно, поскольку блокировка может быть успешной для одних номеров и неудачной для других.
    API для блокировки пользователей работает синхронно.

    Ограничения

      Вы можете заблокировать только тех пользователей, которые отправляли сообщения вашей компании в течение последних 24 часов.Вы не можете использовать этот API для блокировки другого аккаунта WhatsApp Business.В черный список включено не более 64 000 пользователей.

      Функции

      API содержит три конечные точки:
      // Блокировка номеров пользователей WhatsApp POST /< PHONE_NUMBER_ID >/ block_users
      // Разблокировка номеров пользователей WhatsApp DELETE / <PHONE_NUMBER_ID> / block_users
      // Получить список заблокированных номеров пользователей WhatsApp GET / <PHONE_NUMBER_ID> / block_users

      Блокировать пользователей

      Используйте этот конечный пункт для блокировки списка номеров пользователей WhatsApp.

      Конечная точка

      POST /< PHONE_NUMBER_ID >/ block_users

      Текст запроса

      {
      "messaging_product"
      : "whatsapp" , "block_users"
      : [ {
      "user"
      : " или " }
      ]
      }

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

      Параметр Описание
      messaging_product
      Нить
      Необходимый
      Для отправки запроса необходимо использовать мессенджер WhatsApp .
      block_users
      Множество
      Необходимый
      Список пользователей для блокировки.
      Каждый элемент содержит пользователя .
      пользователь
      нить
      Номер телефона или идентификатор WhatsApp, который вы хотите заблокировать.

      Объект ответа

      УСПЕХ (200)

      {
      "messaging_product"
      : "whatsapp" , "block_users"
      : { "added_users"
      : [ {
      "input"
      : " или " , "wa_id"
      : " " }
      ]
      }
      }

      Параметры отклика

      Параметр Описание
      block_users
      Объект
      Содержит два списка:
        added_users — Список успешно заблокированных пользователей.failed_users — Список пользователей, которые не были заблокированы.
        добавленные_пользователи
        Объект
        Список успешно заблокированных пользователей.
        Содержит значения обоих параметров:
          вход
          Строка — номер телефона пользователя WhatsApp
          wa_id
          Строка — Уникальный идентификатор пользователя WhatsApp
          failed_users
          Объект
          Список пользователей, которые не были заблокированы.
          Содержит значения:
            вход
            Строка — номер телефона пользователя WhatsApp
            wa_id
            Строка — Уникальный идентификатор пользователя WhatsApp (может отсутствовать, если номер недействителен)
            ошибки
            Массив — Подробная информация об ошибке для пользователя
            Смешанный успех/неудача (400)

            {
            "messaging_product"
            : "whatsapp" , "block_users"
            : { "added_users"
            : [ {
            "input"
            : " или " , "wa_id"
            : " " },
            {
            "вход"
            : " или " , "wa_id"
            : " " },
            ...
            ],
            "failed_users"
            : [ {
            "input"
            : " или " , "wa_id"
            : " " , // Может отсутствовать, если число неверно "errors"
            : [ {
            "message"
            : " " , "code"
            : , "error_data"
            : { "details"
            : "
            "
            }
            }
            ]
            }
            ]
            },
            "error"
            : { "message"
            : "(#139100) Не удалось заблокировать/разблокировать пользователей" , "type"
            : "OAuthException" , "code"
            : 139100 , "error_data"
            : { "details"
            : подробности см. в списке ответов block_users },
            "fbtrace_id"
            : " " }
            }

            Разблокировать пользователей

            Используйте этот адрес электронной почты, чтобы разблокировать список номеров пользователей WhatsApp.

            Конечная точка

            Удалить /< Номер_телефона_ID >/ block_users

            Текст запроса

            {
            "messaging_product"
            : "whatsapp" , "block_users"
            : [ {
            "user"
            : " или " }
            ]
            }

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

            Параметр Описание
            messaging_product
            Нить
            Необходимый
            Для отправки запроса необходимо использовать мессенджер WhatsApp .
            block_users
            Множество
            Необходимый
            Список пользователей, которых нужно разблокировать.
            Каждый элемент содержит пользователя .
            пользователь
            нить
            Номер телефона или идентификатор WhatsApp, который вы хотите разблокировать.

            Объект ответа

            УСПЕХ (200)

            {
            "messaging_product"
            : "whatsapp" , "block_users"
            : { "removed_users"
            : [ {
            "input"
            : " или " , "wa_id"
            : " " }
            ]
            }
            }

            Параметры отклика

            Параметр Описание
            block_users
            Объект
            Содержит два списка:
              removed_users — Список успешно разблокированных пользователей.failed_users — Список пользователей, которые не были разблокированы.
              удаленные_пользователи
              Объект
              Список успешно разблокированных пользователей.
              Содержит значения обоих параметров:
                вход
                Строка — номер телефона пользователя WhatsApp
                wa_id
                Строка — Уникальный идентификатор пользователя WhatsApp
                failed_users
                Объект
                Список пользователей, которые не были разблокированы.
                Содержит значения:
                  вход
                  Строка — номер телефона пользователя WhatsApp
                  wa_id
                  Строка — Уникальный идентификатор пользователя WhatsApp (может отсутствовать, если номер недействителен)
                  ошибки
                  Массив — Подробная информация об ошибке для пользователя
                  Смешанный успех/неудача (400)

                  {
                  "messaging_product"
                  : "whatsapp" , "block_users"
                  : { "removed_users"
                  : [ {
                  "input"
                  : " или " , "wa_id"
                  : " " },
                  {
                  "вход"
                  : " или " , "wa_id"
                  : " " },
                  ...
                  ],
                  "failed_users"
                  : [ {
                  "input"
                  : " или " , "wa_id"
                  : " " , // Может отсутствовать, если число неверно "errors"
                  : [ {
                  "message"
                  : " " , "code"
                  : , "error_data"
                  : { "details"
                  : "
                  "
                  }
                  }
                  ]
                  }
                  ]
                  },
                  "error"
                  : { "message"
                  : "(#139100) Не удалось заблокировать/разблокировать пользователей" , "type"
                  : "OAuthException" , "code"
                  : 139100 , "error_data"
                  : { "details"
                  : "Не удалось разблокировать некоторых пользователей, подробности см. в списке ответов block_users" },
                  "fbtrace_id"
                  : " " }
                  }

                  Получить список заблокированных номеров

                  Используйте этот адрес электронной почты, чтобы получить список заблокированных номеров для вашего бизнес-номера WhatsApp.

                  Конечная точка

                  GET / <PHONE_NUMBER_ID> / block_users

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

                  ? limit = 10 & after =< AFTER_CURSOR > & before =< BEFORE_CURSOR >

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

                  Параметр Описание
                  лимит
                  Необязательный
                  Максимальное количество заблокированных пользователей, которое можно получить в запросе.
                  после
                  Необязательный
                  до
                  Необязательный

                  Объект ответа

                  УСПЕХ

                  {
                  "data"
                  : [ {
                  "messaging_product"
                  : "whatsapp" , "wa_id"
                  : " " }
                  ],
                  "paging"
                  : { "cursors"
                  : { "after"
                  : "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2 ODgzODM1ODQifQZDZD" , "before"
                  : "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3Mzc2Nzk2 ODgzODM1ODQifQZDZD" }
                  }
                  }

                  Параметры отклика

                  Параметр Описание
                  данные
                  Множество
                  Список заблокированных пользователей.
                  Каждый элемент содержит messaging_product и wa_id .
                  messaging_product
                  Нить
                  Необходимый
                  Для отправки запроса необходимо использовать мессенджер WhatsApp .
                  wa_id
                  Нить
                  Уникальный идентификатор пользователя WhatsApp
                  пейджинг
                  Объект

                  коды ошибок

                  ОШИБКА
                  {
                  "messaging_product"
                  : "whatsapp" , "error"
                  : { "message"
                  : "(#139102) Одновременное обновление списка блокировки" , "type"
                  : "OAuthException" , "code"
                  : 139102 , "error_data"
                  : { "details"
                  : "Список блокировки был обновлен во время получения - повторная попытка со смещением 0" },
                  "fbtrace_id"
                  : " " }
                  }
                  Код Описание
                  139100
                  Не удалось заблокировать/разблокировать некоторых пользователей
                  Массовая блокировка не смогла заблокировать некоторых или всех пользователей.
                  139101
                  Достигнут лимит черного списка
                  В черный список добавлено 64 000 пользователей.
                  139102
                  Одновременное обновление списка заблокированных устройств
                  Проблема возникает, когда список заблокированных пользователей обновляется во время выполнения запроса на пагинацию, и значение version_id не совпадает.
                  139103
                  Внутренняя ошибка
                  Внутренняя ошибка. Пожалуйста, попробуйте еще раз.
                  130429
                  Превышен лимит запросов
                  Происходит при одном из следующих событий:
                    В самом запросе слишком много цифр.Или же, слишком много запросов поступает за короткий промежуток времени.
                    131021
                    Самоблокировка
                    Не удалось заблокировать собственный номер телефона.
                    131047
                    Требуется возобновление взаимодействия
                    Это происходит, если компания не получала сообщений с этого номера в течение последних 24 часов.
                    Эта ошибка также будет возвращена, если номер принадлежит недействительному пользователю WhatsApp.