业务主页

业务主页

您业务电话号码的业务主页将提供有关您商家的更多信息，如商家的营业地址、网站、描述等。

功能

此 API 包含 2个接口：

// 通过 API 获取主页
/api/wa/getBusinessProfile

// 通过 API 更新主页
/api/wa/updateBusinessProfile

鉴权机制

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

请求参数

header参数：

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

通过 API 获取主页

请求特定的业务主页字段

接口

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

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
business_phone	String	是	86133xxx	商户的WhatsApp号码，需要带国码。如86158xxxx1795

请求示例

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

响应结果

参数	描述
about	About信息
address	地址信息
description	介绍信息
email	email
profile_picture_url	主页图片
vertical	商业类型
websites	网址信息

响应示例 SUCCESS

{
    "code": 0,
    "data": {
        "data": [
            {
                "about": "Hey there! I am using WhatsApp.",
                "address": "xxx",
                "description": "xxx",
                "email": "xxx",
                "profile_picture_url": "https://pps.whatsapp.net/xxx",
                "websites": [
                    "https://www.xxx.com/"
                ],
                "vertical": "PROF_SERVICES",
                "messaging_product": "whatsapp"
            }
        ]
    },
    "message": "请求成功"
}

通过 API 更新主页

更新特定的业务主页字段。

接口

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

body参数：

参数名	类型	必选	示例值	说明
appkey	String	是	pem28kje	应用appkey
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
business_phone	String	是	86133xxx	商户的WhatsApp号码，需要带国码。如86158xxxx1795
about	String	必须/无		about信息
address	String	必须/无		地址信息
description	String	必须/无		描述信息
email	String	必须/无		email信息
profile_picture_handle		必须/无	4:udid000xxx	主页图片信息 上传文件模板示例 获取 header_handle 值
vertical	String	必须/无		商业类型
websites	array of strings	必须/无		网址信息

请求示例

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

响应结果

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

响应示例 SUCCESS

{
    "code": 0,
    "data": {
        "success": true
    },
    "message": "请求成功"
}

vertical 支持的值

ALCOHOL = Alcoholic Beverages
APPAREL = Clothing and Apparel
AUTO = Automotive
BEAUTY = Beauty, Spa and Salon
EDU = Education
ENTERTAIN = Entertainment
EVENT_PLAN = Event Planning and Service
FINANCE = Finance and Banking
GOVT = Public Service
GROCERY = Food and Grocery
HEALTH = Medical and Health
HOTEL = Hotel and Lodging
NONPROFIT = Non-profit
ONLINE_GAMBLING = Online Gambling & Gaming
OTC_DRUGS = Over-the-Counter Drugs
OTHER = Other
PHYSICAL_GAMBLING = Non-Online Gambling & Gaming (E.g. Brick and mortar)
PROF_SERVICES = Professional Services
RESTAURANT = Restaurant
RETAIL = Shopping and Retail
TRAVEL = Travel and Transportation