WhatsApp API getMedia - nxtele/http-api-document GitHub Wiki
获取媒体文件
通过API获取已上传到WhatsApp的文件信息
- URL:
https://api2.nxcloud.com/api/wa/getMedia
- Method:
POST
- Content-Type:
application/json
- 需要鉴权:
是
鉴权机制
鉴权规则请参考地址:API接口调用约定
请求参数
header参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
accessKey |
String |
是 |
fme2na3kdi3ki |
用户身份标识 |
ts |
String |
是 |
1655710885431 |
当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
bizType |
String |
是 |
2 |
WhatsApp业务类型,取固定值“2” |
action |
String |
是 |
getMedia |
WhatsApp业务操作,取固定值“getMedia” |
sign |
String |
是 |
6e9506557d1f289501d333ee2c365826 |
API入参参数签名,签名算法 |
body参数:
参数名 |
类型 |
必选 |
示例值 |
说明 |
business_phone |
String |
是 |
86158xxxx1795 |
商户手机号码,需要带国码。如86158xxxx1795 |
messaging_product |
String |
是 |
whatsapp |
发送消息的通道,应用于WhatsApp消息的发送时,值必须为“whatsapp” |
Media-ID |
String |
是 |
fd81acff-eea8-4d9d-acc9-6c62904d6615 |
媒体文件ID |
请求示例
body(application/json) 参数:
{
"business_phone": "86158xxxx1795",
"Media-ID": "fd81acff-eea8-4d9d-acc9-6c62904d6615",
"messaging_product": "whatsapp"
}
响应参数
参数名 |
类型 |
说明 |
code |
Integer |
结果编码 |
data |
JsonObject |
请求结果 |
message |
String |
请求结果说明 |
参数名 |
类型 |
说明 |
mime_type |
String |
文件类型 |
file_name |
String |
文件名称 |
url |
String |
文件下载地址 |
响应示例
成功示例
{
"code": 0,
"data": {
"mime_type": "image/webp",
"file_name": "c5e744fab2a3b69941ed3c64",
"url": "https://goss.oss-cn-hongkong.aliyuncs.com/1b0a4c77-c5e7-44fa-b2a3-b69941ed3c64?Expires=1663747602&OSSAccessKeyId=LTAI5tBrjWM5EyDe6MA5uc7z&Signature=EW1KaByzd3rybo2swNSEKkpF5Lk%3D"
},
"message": "请求成功"
}
失败示例
{
"code": -1,
"message": "请求失败",
"data": null
}
响应码说明
code |
message |
解决办法 |
0 |
请求成功 |
|
-1 |
请求失败 |
请联系技术人员排除问题 |
1000~100X |
鉴权问题 |
详情查看API鉴权部分 |
9000 |
参数异常 |
参数遗漏,请检查必须的参数 |
9001 |
系统业务错误 |
请联系技术人员排除问题 |
9002 |
商户手机号错误 |
请确认商户号码是否属于whatsapp号码 |
9006 |
该whatsapp号码未绑定应用 |
请联系业务人员处理应用和手机号绑定操作 |