WhatsApp API uploadMedia

上传媒体文件

通过API上传本地媒体文件到WhatsApp

• URL：https://api2.nxcloud.com/api/wa/uploadMedia
• Method：POST
• Content-Type：multipart/form-data
• 需要鉴权：是（备注：此接口的签名算法为hex(md5(headersStr + accessSecretStr))，计算签名时无需拼接body参数）

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
business_phone	String	是	86158xxxx1795	商户手机号码，需要带国码。如86158xxxx1795
messaging_product	String	是	whatsapp	发送消息的通道，应用于WhatsApp消息的发送时，值必须为“whatsapp”
file	file	是	-	媒体文件
type	String	是	参照媒体文件格式说明	媒体文件上传的格式，支持：image/jpeg, image/png, audio/aac, audio/mp4... 详情看 媒体文件说明的 "格式支持"

请求示例

body（multipart/form-data） 参数：

messaging_product = whatsapp
business_phone = 18506008399
type = image/jpeg
file = 

响应参数

参数名	类型	说明
code	Integer	结果编码
data	JsonObject	请求结果
message	String	请求结果说明

• data object参数：

参数名	类型	说明
id	String	系统生成的唯一的文件ID

响应示例

成功示例

{
    "code": 0,
    "data": {
        "id": "a75c6d9b-a7c8-4f41-8f61-94548e92cbee"
    },
    "message": "请求成功"
}

失败示例

{
    "code": -1,
    "message": "请求失败",
    "data": null
}

响应码说明

code	message	解决办法
0	请求成功
-1	请求失败	请联系技术人员排除问题
1000~100X	鉴权问题	详情查看API鉴权部分
9000	参数异常	参数遗漏，请检查必须的参数
9001	系统业务错误	请联系技术人员排除问题
9002	商户手机号错误	请确认商户号码是否属于whatsapp号码
9006	该whatsapp号码未绑定应用	请联系业务人员处理应用和手机号绑定操作

媒体文件格式说明

媒体类型	支持的格式	最大文件大小限制
image	image/jpeg, image/png * Images must be 8-bit, RGB or RGBA	5MB
audio	audio/aac, audio/mp4, audio/mpeg, audio/amr, audio/ogg (only opus codecs, base audio/ogg is not supported)	16MB
video	video/mp4, video/3gpp *only H.264 video codec and AAC audio codec is supported. *support videos with a single audio stream or no audio stream.	16MB
document	text/plain, application/pdf, application/vnd.ms-powerpoint, application/msword, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/vnd.openxmlformats-officedocument.presentationml.presentation,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet	100MB
sticker	image/webp	100KB