WhatsApp API uploadPublicKey - nxtele/http-api-document GitHub Wiki
上传业务公钥
上传业务公钥。
- URL:
https://api2.nxcloud.com/v1/wa/m/flows/uploadPublicKey
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
鉴权机制
鉴权规则请参考地址:API接口调用约定
请求参数
header参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
accessKey |
String |
是 |
fme2na3kdi3ki |
用户身份标识 |
ts |
String |
是 |
1655710885431 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType |
String |
是 |
2 |
WhatsApp业务类型,取固定值“2” |
action |
String |
是 |
uploadPublicKey |
WhatsApp业务操作,取固定值“uploadPublicKey” |
sign |
String |
是 |
6e9506557d1f289501d333ee2c365826 |
API入参参数签名,签名算法 |
body参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
phone |
String |
是 |
86158xxx1795 |
商户的WhatsApp号码列表,需要带国码,如185xxx99 |
messaging_product |
String |
是 |
whatsapp |
发送消息的通道,应用于WhatsApp消息的发送时,值必须为“whatsapp” |
business_public_key |
String |
是 |
-----BEGIN PUBLIC KEY-----\r\n您的公钥\r\n-----END PUBLIC KEY----- |
公钥 |
请求示例
body(application/json) 参数:
{
"phone":"185****99",
"business_public_key":"-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwxbertLEzFrCp8mFnb3kDkhlB/uDjbHVmEXqwUeuuINkL1Ura12/t5Ut3ZUruCMZ3uihqYPM8b4dex0MIXFsyGswyoHlxvqX8PnxQszE2cYgn5CzaD4zvvPIPP3ADrKdpYtKJrQppMLvV0vDypcA7OonSnWg036JojnyNPfSQhTZXW6Sy6g/rJ44SmfAedw3Vc6TT/jKCaAtyiEblNnpM8vw2qyRqJr3DfX7VSWIFsM/cf8mJaE/sp+1J0M7ESQbQB45JTBcylNhbDlwPyb/c5hreOi0QVl3bagortH/ylRWlrEFHmbARPUsbcwBNKTjgPxpzG/WIV4TL+Suo1dXaQIDAQAB\r\n-----END PUBLIC KEY-----"
}
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
结果编码 |
data |
JsonObject |
请求结果 |
message |
String |
请求结果说明 |
参数名 |
类型 |
说明 |
success |
boolean |
更新操作成功或失败 |
响应示例
成功示例
{
"code": 0,
"message": "Success",
"data": {
"success": true
}
}
失败示例
{
"code": 400,
"message": "uploadPublicKey error",
"data": {
"error": {
"message": "(#100) Invalid parameter",
"type": "OAuthException",
"code": 100.0,
"error_data": {
"messaging_product": "whatsapp",
"details": "Business public key is invalid"
},
"fbtrace_id": "AyOk0mgCumlU3ihozS2Q00x"
}
}
}
响应码说明
code |
message |
解决办法 |
0 |
请求成功 |
|
400 |
请求失败 |
请联系技术人员排除问题 |
1000~100X |
鉴权问题 |
详情查看API鉴权部分 |