微信小程序开发文档 微信小程序 uploadTempMedia

2024-02-25 开发教程 微信小程序开发文档 匿名 3

customerServiceMessage.uploadTempMedia

本接口应在服务器端调用,详细说明参见服务端API。 本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载
wx-server-sdk >= 0.4.0

把媒体文件上传到微信服务器。目前仅支持图片。用于发送客服消息或被动回复用户消息。

调用方式:

  • HTTPS 调用
  • 云调用

HTTPS 调用

请求地址

POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
typestring文件类型
mediaFormDataform-data 中媒体文件标识,有filename、filelength、content-type等信息

type 的合法值

说明最低版本
image图片

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
typestring文件类型
media_idstring媒体文件上传后,获取标识,3天内有效。
created_atnumber媒体文件上传时间戳

errcode 的合法值

说明最低版本
40004无效媒体文件类型

type 的合法值

说明最低版本
image图片

调用示例

使用 CURL 命令,用 FORM 表单方式上传一个多媒体文件

curl -F media=@test.jpg "https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE"

返回示例

{
"errcode": 0,
"errmsg": "ok",
"type": "image",
"media_id": "MEDIA_ID",
"created_at": "xxx"
}

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.customerServiceMessage.uploadTempMedia

需在 config.json 中配置 customerServiceMessage.uploadTempMedia API 的权限,详情

请求参数

属性类型默认值必填说明
typestring文件类型
mediaFormData媒体文件数据

type 的合法值

说明最低版本
image图片

media 的结构

属性类型默认值必填说明
contentTypestring数据类型,传入 MIME Type
valueBuffer文件 Buffer

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
typestring文件类型
mediaIdstring媒体文件上传后,获取标识,3天内有效。
createdAtnumber媒体文件上传时间戳

errCode 的合法值

说明最低版本
0成功

type 的合法值

说明最低版本
image图片

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
40004无效媒体文件类型

返回示例

{
"errCode": 0,
"errMsg": "openapi.customerServiceMessage.uploadTempMedia:ok",
"type": "image",
"mediaId": "MEDIA_ID",
"createdAt": "xxx"
}

SDK 调用示例

// cloud = require('wx-server-sdk')
// ...
// 方法返回 Promise
cloud.openapi.customerServiceMessage.uploadTempMedia({
type: 'image',
media: {
contentType: 'image/png',
value: Buffer
}
})