Skip to content

WhatsApp API uploadTemplateFile

GiuFLim edited this page Dec 6, 2022 · 3 revisions

上传模板示例文件

上传媒体文件用于配置模板示例。媒体文件通过HTTP multipart/form-data上传

  • URL:https://api2.nxcloud.com/api/wa/uploadTemplateFile
  • Method:POST
  • Content-Type:multipart/form-data
  • 需要鉴权:

鉴权机制

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

请求参数

header参数:

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

body参数:

参数名 类型 必选 示例值 说明
business_phone String 86158xxx1795 商户的WhatsApp号码列表,需要带国码,如185xxx99
messaging_product String whatsapp 发送消息的通道,应用于WhatsApp消息的发送时,值必须为“whatsapp”
file file 路径文件存储的本地目录。例如:"@/local/path/file.jpg"
type String image/jpeg 文件类型
支持:application/pdf、video/mp4、image/jpeg、image/png、image/jpg

请求示例

body(multipart/form-data) 参数:

messaging_product = whatsapp
business_phone = 185xxx99
type = image/jpeg
file = 

响应参数

参数名 类型 说明
code Integer 结果编码
data JsonObject 请求结果
message String 请求结果说明
  • data object参数:
参数名 类型 说明
id String 系统生成的唯一的文件ID

响应示例

成功示例

{
    "code": 0,
    "data": {
        "id": "4:Pz8xxxW8"
    },
    "message": "请求成功"
}

失败示例

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

响应码说明

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

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally