1"use strict";(self["webpackChunknxcloud"]=self["webpackChunknxcloud"]||[]).push([[4010],{64010:function(n,e,s){s.r(e),e["default"]='# Block Users\n\nThe Block Users API enables your business to block bad actors from contacting you.\n\n## How it Works\n\nWhen you block a WhatsApp user, the following happens:\n\n- The user cannot contact your business or see that you are online.\n- Your business cannot message the user. If you do, you will encounter an error.\n- You cannot use this API to block another WhatsApp Business\n\nErrors on the API occur per-number since blocks might be successful on some numbers and not others.\n\nThe Block Users API is synchronous.\n\n## Limitations\n\n- You can only block users that have messaged your business in the last 24 hours.\n- 64k blocklist limit\n\n## Features\n\nThe API contains 3 endpoints:\n\n```\n// Block WhatsApp user numbers\n/api/wa/createBlockUsers\n\n// Unblock WhatsApp user numbers\n/api/wa/deleteBlockUsers\n\n// Get list of blocked WhatsApp user numbers\n/api/wa/getBlockUsers\n```\n\n## Authentication Mechanism\n\nPlease refer to the following link for authentication rules: [API Interface Call Convention](/document-en/common/interface-contract)\n\n## Request Parameters\n\n### header Parametersï¼\n\n| Parameter Name | Type | Required | Example | Description |\n| -------------- | ------ | -------- | -------------------------------- | ------------------------------------------------------------ |\n| accessKey | String | Yes | fme2na3kdi3ki | User identity identifier |\n| ts | String | Yes | 1655710885431 | Current timestamp of the request (in milliseconds). The maximum allowed time difference is 60 seconds on the server side. |\n| bizType | String | Yes | 2 | WhatsApp business type, fixed value "2" |\n| action | String | Yes | mt | WhatsApp business operation, fixed value "mt" |\n| sign | String | Yes | 6e9506557d1f289501d333ee2c365826 | API input parameter signature, [signature algorithm](/document-en/common/interface-contract) |\n\n\n\n## Block Users\n\nUse this endpoint to block a list of WhatsApp user numbers.\n\n### API\n\n- URLï¼`https://api2.nxcloud.com/api/wa/createBlockUsers`\n- Methodï¼`POST`\n- Content-Typeï¼`application/json`\n- Requires authentication: Yes\n\n### Request Body\n\n| Parameter Name | Type | Required | Example | Description |\n| ----------------- | --------------- | -------- | ------------- | ------------------------------------------------------------ |\n| appkey | String | Yes | | Appkey of the NxCloud WhatsApp application |\n| business_phone | String | Yes | 86158xxxx1795 | WhatsApp number , including country code. e.g., 86158xxxx1795 |\n| messaging_product | String | Yes | whatsapp | Channel for sending messages, must be "whatsapp" when sending WhatsApp messages |\n| block_users | **User Object** | Yes | | List of user(s) to block.Each element contains a `user` field. |\n\n#### User \n\n| Parameter Name | Type | Required | Example | Description |\n| -------------- | ------ | -------- | ------- | ---------------------------------------------- |\n| user | String | Yes | 861xxx | The phone number or WhatsApp ID to be blocked. |\n\n### Request Body example\n\n```json\n{\n "appkey": "xxx",\n "messaging_product": "whatsapp",\n "business_phone": "852xxx",\n "block_users": [\n {\n "user": "86133xxx"\n },\n {\n "user": "86144xxx"\n }\n ]\n}\n```\n\n### Response Parameters\n\n| Parameter Name | Description |\n| ---------------------- | ------------------------------------------------------------ |\n| `block_users`*Object* | Contains two lists: `added-users` â List of successfully blocked users. `failed_users` â List of users failed to be blocked. |\
1n| `added_users`*Object* | List of successfully blocked users.Contains values of both: `input` |\n| `failed_users`*Object* | List of users failed to be blocked. Contains values of both: `input` |\n\n\n\n### Response SUCCESS\n\n```json\n{\n "code": 0,\n "data": {\n "block_users": {\n "added_users": [\n {\n "input": "86133xxx",\n "wa_id": "86133xxx"\n },\n {\n "input": "86144xxx",\n "wa_id": "86144xxx"\n }\n ]\n },\n "messaging_product": "whatsapp"\n },\n "message": "请æ±æå"\n}\n```\n\n### Response MIXED SUCCESS/FAILURE\n\n```json\n{\n "code": 0,\n "data": {\n "block_users": {\n "failed_users": [\n {\n "input": "861xxx",\n "errors": [\n {\n "code": 131047,\n "message": "Re-engagement check failed",\n "error_data": {\n "details": "Failed to block due to re-engagement check failed"\n }\n }\n ]\n }\n ],\n "added_users": [\n {\n "input": "86133xxx",\n "wa_id": "86133xxx"\n }\n ]\n },\n "messaging_product": "whatsapp"\n },\n "message": "请æ±æå"\n}\n```\n\n\n\n## Unblock Users\n\nUse this endpoint to unblock a list of WhatsApp user numbers.\n\n### API\n\n- URLï¼`https://api2.nxcloud.com/api/wa/deleteBlockUsers`\n- Methodï¼`POST`\n- Content-Typeï¼`application/json`\n- Requires authentication: Yes\n\n### Request Body\n\n| Parameter Name | Type | Required | Example | Description |\n| ----------------- | --------------- | -------- | ------------- | ------------------------------------------------------------ |\n| appkey | String | Yes | | Appkey of the NxCloud WhatsApp application |\n| business_phone | String | Yes | 86158xxxx1795 | WhatsApp number , including country code. e.g., 86158xxxx1795 |\n| messaging_product | String | Yes | whatsapp | Channel for sending messages, must be "whatsapp" when sending WhatsApp messages |\n| block_users | **User Object** | Yes | | List of user(s) to block.Each element contains a `user` field. |\n\n#### User \n\n| Parameter Name | Type | Required | Example | Description |\n| -------------- | ------ | -------- | ------- | ---------------------------------------------- |\n| user | String | Yes | 861xxx | The phone number or WhatsApp ID to be blocked. |\n\n### Request Body example\n\n```json\n{\n "appkey": "8eoKFyos",\n "messaging_product": "whatsapp",\n "business_phone": "xxx",\n "block_users": [\n {\n "user": "xxx"\n }\n ]\n}\n```\n\n### Response Parameters\n\n| Parameter Name | Description |\n| ------------------------- | ------------------------------------------------------------ |\n| `block_users`**Object** | `removed-users` - List of removed successfully blocked usersã |\n| `removed_users`**Object** | List of removed successfully blocked users.Contains values of both: `input` |\n\n### Response SUCCESS\n\n```json\n{\n "code": 0,\n "data": {\n "block_users": {\n "removed_users": [\n {\n "input": "xxx",\n "wa_id": "xxx"\n }\n ]\n },\n "messaging_product": "whatsapp"\n },\n "message": "请æ±æå"\n}\n```\n\n\n\n## Get List of Blocked Numbers\n\nUse this endpoint to get a list of blocked numbers on your WhatsApp Business number.\n\n### API\n\n- URLï¼`https://api2.nxcloud.com/api/wa/getBlockUsers`\n- Methodï¼`POST`\n- Content-Typeï¼`application/json`\n- Requires authentication: Yes\n\n### Request Body\n\n| Parameter Name | Type | Required | Example | Description |\n| ----------------- | ------ | -------- | ------------- | ------------------------------------------------------------ |\n| appkey | String | Yes | | Appkey of the NxCloud WhatsApp application |\n| business_phone | String | Yes | 86158xxxx1795 | WhatsApp number , including country code. e.g., 86158xxxx1795 |\n| messaging_product | String | Yes | whatsapp | Channel for sending messages, must be "whatsapp" when sending WhatsApp messages |\n| limit | Long | Yes/No | | Maximum number of blocked users to fetch in the request. |\n| after | String | Yes/No | | |\n| before | String | Yes/No | | |\n\n### Request Body example\n\n```json\n{\n "appkey": "xxx",\n "messaging_product": "whatsapp",\n "business_phone": "852xxx"\n}\n```\n\n### Response Parameters\n\n| Parameter Name | Description |\n| ---------------- | ------------------------------------ |\n| `data`*Object* | `wa_id` Unique ID of a WhatsApp user |\n| `paging`*Object* | paging |\n\n\n\n### Response SUCCESS\n\n```json\n{\n "code": 0,\n "data": {\n "data": [\n {\n "messaging_product": "whatsapp",\n "wa_id": "xxx"\n },\n {\n "messaging_product": "whatsapp",\n "wa_id": "xxx"\n }
1\n ],\n "paging": {\n "cursors": {\n "before": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NTM4NDc1MzgxOTk5NzAifQZDZD",\n "after": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NTM4NDc1MzgxOTk5NzAifQZDZD"\n }\n }\n },\n "message": "请æ±æå"\n}\n```\n\n'}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.