封锁用户 - nxtele/http-api-document GitHub Wiki

封锁用户

利用封锁用户 API，您的商家能够封锁恶意攻击者，阻止其联系您。

运作方式

封锁 WhatsApp 用户后，会发生以下情况：

被封锁的用户无法联系您的商家，也看不到您是否在线。
您的商家无法向被封锁的用户发送消息。如果发送消息，就会出现错误。
您无法使用此 API 来封锁另一个 WhatsApp Business 用户

并非所有手机号都能成功封锁，因此 API 上出现的每个错误均对应单个手机号。

在封锁用户 API 上执行的操作是同步操作。

限制

您只能封锁过去 24 小时向您的商家发送过消息的用户。
黑名单上限为 64000

功能

此 API 包含 3 个接口：

// Block WhatsApp user numbers
/api/wa/createBlockUsers

// Unblock WhatsApp user numbers
/api/wa/deleteBlockUsers

// Get list of blocked WhatsApp user numbers
/api/wa/getBlockUsers

鉴权机制

鉴权规则请参考地址：API接口调用约定

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	fme2na3kdi3ki	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	2	WhatsApp业务类型，取固定值“2”
action	String	是	mt	WhatsApp业务操作，取固定值“mt”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名，签名算法

封锁用户

使用此端点封锁列表中的所有 WhatsApp 用户手机号。

接口

URL：https://api2.nxcloud.com/api/wa/createBlockUsers
Method：POST
Content-Type：application/json
需要鉴权：是

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
business_phone	String	是	86133xxx	商户的WhatsApp号码，需要带国码。如86158xxxx1795
block_users	User Object	是		要封锁的用户的名单。每个元素包含一个 `user` 字段

User

参数名	类型	必选	示例值	说明
user	String	是	861xxx	要封锁的手机号或 WhatsApp 编号

请求示例

{
    "appkey": "xxx",
    "messaging_product": "whatsapp",
    "business_phone": "852xxx",
    "block_users": [
        {
            "user": "86133xxx"
        },
        {
            "user": "86144xxx"
        }
    ]
}

响应结果

参数	描述
`block_users`对象	包含两份名单：`added-users` - 成功封锁的用户的名单。`failed_users` - 未能封锁的用户的名单。
`added_users`对象	成功封锁的用户的名单。包含两个字符串的值: `input`
`failed_users`对象	未能封锁的用户的名单包含两个字符串的值： `input`

响应示例1 SUCCESS

{
    "code": 0,
    "data": {
        "block_users": {
            "added_users": [
                {
                    "input": "86133xxx",
                    "wa_id": "86133xxx"
                },
                {
                    "input": "86144xxx",
                    "wa_id": "86144xxx"
                }
            ]
        },
        "messaging_product": "whatsapp"
    },
    "message": "请求成功"
}

响应示例2 MIXED SUCCESS/FAILURE

{
    "code": 0,
    "data": {
        "block_users": {
            "failed_users": [
                {
                    "input": "861xxx",
                    "errors": [
                        {
                            "code": 131047,
                            "message": "Re-engagement check failed",
                            "error_data": {
                                "details": "Failed to block due to re-engagement check failed"
                            }
                        }
                    ]
                }
            ],
            "added_users": [
                {
                    "input": "8613xxx",
                    "wa_id": "8613xxx"
                }
            ]
        },
        "messaging_product": "whatsapp"
    },
    "message": "请求成功"
}

对用户解除封锁

使用此端点为列表中的所有 WhatsApp 用户手机号解除封锁。

接口

URL：https://api2.nxcloud.com/api/wa/deleteBlockUsers
Method：POST
Content-Type：application/json
需要鉴权：是

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
business_phone	String	是	86133xxx	商户的WhatsApp号码，需要带国码。如86158xxxx1795
block_users	User Object	是		要封锁的用户的名单。每个元素包含一个 `user` 字段

User

参数名	类型	必选	示例值	说明
user	String	是	861xxx	要封锁的手机号或 WhatsApp 编号

请求示例

{
    "appkey": "8eoKFyos",
    "messaging_product": "whatsapp",
    "business_phone": "xxx",
    "block_users": [
        {
            "user": "xxx"
        }
    ]
}

响应结果

参数	描述
`block_users`对象	包含：`removed-users` - 成功解除封锁的用户的名单。
`removed_users`对象	成功解除封锁的用户的名单。包含两个字符串的值: `input`

响应示例 SUCCESS

{
    "code": 0,
    "data": {
        "block_users": {
            "removed_users": [
                {
                    "input": "xxx",
                    "wa_id": "xxx"
                }
            ]
        },
        "messaging_product": "whatsapp"
    },
    "message": "请求成功"
}

获取所有已封锁的手机号

使用此端点获取您的 WhatsApp Business 电话号码上所有已封锁的手机号。

接口

URL：https://api2.nxcloud.com/api/wa/getBlockUsers
Method：POST
Content-Type：application/json
需要鉴权：是

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
business_phone	String	必须/无
		必须/无		请求中可获取的已封锁用户数上限。
after	String	必须/无		这是指向已返回的数据页面末尾的游标。
before	String	必须/无		这是指向已返回的数据页面开头的游标。

请求示例

{
    "appkey": "xxx",
    "messaging_product": "whatsapp",
    "business_phone": "852xxx"
}

响应结果

参数	描述
`data`对象	wa_id
`paging`对象	分页结果

响应示例 SUCCESS

{
    "code": 0,
    "data": {
        "data": [
            {
                "messaging_product": "whatsapp",
                "wa_id": "xxx"
            },
            {
                "messaging_product": "whatsapp",
                "wa_id": "xxx"
            }
        ],
        "paging": {
            "cursors": {
                "before": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NTM4NDc1MzgxOTk5NzAifQZDZD",
                "after": "eyJvZAmZAzZAXQiOjAsInZAlcnNpb25JZACI6IjE3NTM4NDc1MzgxOTk5NzAifQZDZD"
            }
        }
    },
    "message": "请求成功"
}