getTempMedia.md 4.59 KB

小程序客服 /客服消息 /获取客服消息内的临时素材

获取客服消息内的临时素材

接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

接口说明

接口英文名

getTempMedia

功能描述

该接口用于获取客服消息内的临时素材。即下载临时的多媒体文件。目前小程序仅支持下载图片文件

注意事项

如果调用成功,会直接返回图片二进制内容,如果请求失败,会返回 JSON 格式的数据。

调用方式

HTTPS 调用

GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN 

云调用

  • 出入参和 HTTPS 调用相同,调用方式可查看云调用说明文档
  • 接口方法为: openapi.customerServiceMessage.getTempMedia

第三方调用

  • 调用方式以及出入参和 HTTPS 相同,仅是调用的 token 不同
  • 该接口所属的权限集 id 为:1、3、8、9、11、19、30、31、59、61、62、100
  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

请求参数

属性 类型 必填 说明
access_token / cloudbase_access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。access_token和cloudbase_access_token二选一 其中access_token可通过getAccessToken接口获得; 如果是第三方代调用请传入authorizer_access_token; cloudbase_access_token可通过getOpenData接口获得
media_id string 媒体文件 ID。可通过 uploadTempMedia 接口获得media_id

返回参数

属性 类型 说明
Buffer Buffer 成功时返回的图片 Buffer
errcode number 失败时返回错误码
errmsg string 失败时返回错误信息

调用示例

示例说明: CURL请求失败示例

请求数据示例

curl -I -G "https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID" 

返回数据示例

{
  "errcode": 40007,
  "errmsg": "无效媒体文件 ID"
}
 

示例说明: 云函数调用

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.customerServiceMessage.getTempMedia({
        "mediaId": ''
      })
    return result
  } catch (err) {
    return err
  }
} 

返回数据示例

{
  "errCode": 0,
  "errMsg": "openapi.customerServiceMessage.getTempMedia:ok",
   "contentType": "image/jpeg",
   "buffer": "Buffer"
} 

错误码

错误码 错误码取值 解决方案
-1 system error 系统繁忙,此时请开发者稍候再试
40001 invalid credential access_token isinvalid or not latest 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口