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

API блокировки пользователей позволяет вашей компании блокировать попытки злоумышленников связаться с вами.

Принципы работы

Когда вы блокируете пользователя WhatsApp, происходит следующее:

• этот пользователь не сможет связаться с вашей компанией или увидеть, что вы находитесь в сети;
• ваша компания не сможет отправлять сообщения этому пользователю (при попытке сделать это вы получите сообщение об ошибке).
• С помощью этого API нельзя заблокировать другой аккаунт WhatsApp Business.

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

API блокировки пользователей является синхронным.

Ограничения

• Вы можете блокировать только тех пользователей, которые отправляли сообщения вашей компании в течение последних 24 часов.
• Лимит списка блокировки: 64 КБ.

Функции

API содержит 3 конечные точки:

// Block WhatsApp user numbers
POST /<PHONE_NUMBER_ID>/block_users

// Unblock WhatsApp user numbers
DELETE /<PHONE_NUMBER_ID>/block_users

// Get list of blocked WhatsApp user numbers
GET /<PHONE_NUMBER_ID>/block_users

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

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

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

POST /<PHONE_NUMBER_ID>/block_users

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

{
  "messaging_product": "whatsapp",
  // List of WhatsApp user numbers to be blocked
  "block_users": [
     {
       "user": "<PHONE_NUMBER> or <WA_ID>"
     }  
   ]
}

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

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

SUCCESS (200)

{
  "messaging_product": "whatsapp",
  "block_users": {
    "added_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      }
    ]
  }
}

Параметры ответа

MIXED SUCCESS/FAILURE (400)

{
  "messaging_product": "whatsapp",
  "block_users": {
    "added_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      ...
    ],
    "failed_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      ...
        "errors": [{
          "message": "<MESSAGE>",
          "code": "<CODE>",
          "error_data": {
            "details": "<DETAILS>""
          }]
        }
      }
    ]
  },
  "error": {
    "message": "(#139100) Failed to block/unblock users",
    "type": "OAuthException",
    "code": 139100,
    "error_data": {
      "details": "Failed to block some users, see the block_users response list for details"
    },
    "fbtrace_id": "<FBTRACE_ID>"
  }
}

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

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

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

DELETE /<PHONE_NUMBER_ID>/block_users

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

{
  "messaging_product": "whatsapp",
  "block_users": [
     {
       // List of WhatsApp user numbers to be unblocked
       "user": "<PHONE_NUMBER> or <WA_ID>"
     }  
   ]
}

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

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

SUCCESS (200)

{
  "messaging_product": "whatsapp",
  "block_users": {
    "added_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      }
    ]
  }
}

Параметры ответа

MIXED SUCCESS/FAILURE (400)

{
  "messaging_product": "whatsapp",
  "block_users": {
    "added_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      ...
    ],
    "failed_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      },
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      }
      ...
        "errors": [{
          "message": "<MESSAGE>",
          "code": "<CODE>",
          "error_data": {
            "details": "<DETAILS>""
          }]
        }
      }
    ]
  },
  "error": {
    "message": "(#139100) Failed to block/unblock users",
    "type": "OAuthException",
    "code": 139100,
    "error_data": {
      "details": "Failed to block some users, see the block_users response list for details"
    },
    "fbtrace_id": "<FBTRACE_ID>"
  }
}

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

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

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

GET /<PHONE_NUMBER_ID>/block_users

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

?limit=10, // Optional
&after=<AFTER_CURSOR>,   // Optional
&before=<BEFORE_CURSOR>  // Optional

Параметры ответа

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

SUCCESS

{
  "data": [
    {
      "block_users": [
      {
        "input": "<PHONE_NUMBER> or <WA_ID>",
        "wa_id": "<WA_ID>"
      } 
      ]
    }
  ],
  "paging": {
    "cursors": {
      "after": "MTAxNTExOTQ1MjAwNzI5NDE=",
      "before": "NDMyNzQyODI3OTQw"
    },
    "previous": "https://graph.facebook.com/{version}/{phone-number-id}/block_users?limit=10&before=NDMyNzQyODI3OTQw",
    "next": "https://graph.facebook.com/{version}/{phone-number-id}/block_users?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE="
  }
}

Параметры ответа

ERROR
{
  "messaging_product": "whatsapp",
  "error": {
    "message": "(#135002) Blocklist concurrent update",
    "type": "OAuthException",
    "code": 139102,
    "error_data": {
        "messaging_product": "whatsapp",
        "details": "Blocklist was updated during retrieval - retry with offset 0"
    },
    "fbtrace_id": "<FBTRACE_ID>"
  } 
}

Коды ошибок