抖音开放平台Logo
开发者文档
小程序
“/”唤起搜索
控制台
  • OpenAPI 简介
  • 通用参数
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 订阅消息
  • 分发
  • 搜索能力
  • 私信和群聊
  • 私信管理
  • 群聊管理
  • 经营工具
  • 小程序引导卡片
  • 图片上传
  • 获取消息中的多媒体资源
  • 私域经营常见问题
  • 挂载
  • 支付
  • 运营
  • 生活服务
  • 垂直行业
  • 其它

    • 获取消息中的多媒体资源

    收藏
    我的收藏

    使用限制

      •只能获取发送时间为半年内消息多媒体资源
    ​

    接口说明

    获取消息中的用户发送的本地图片、本地视频多媒体资源。
    ​

    基本信息

    名称
    描述
    HTTP URL
    https://open.douyin.com/api/im/message/resources/
    ​
    HTTP Method
    GET
    Scope
    im.multimedia_message
    ​
    权限要求
    应用需获取 im.multimedia_message 权限
    ​
    ​

    请求头

    名称
    字段类型
    是否必填
    示例
    描述
    access-token
    String
    是
    ​
    接口调用的凭证。来源
    ​
    content-type
    String
    是
    ​
    固定值"application/json"
    ​
    ​

    请求参数

    Query

    名称
    字段类型
    是否必填
    示例
    描述
    conversation_id
    String
    是
    @9fdVxXwOOLDZg4JyKuOM0+Qc7912foPP+BPpJ3qw2uLFARa/H760zdRmYqig357zEBqu7zZ/C7rfG4tqP82908PQ==
    会话 ID，来源于接收私信消息事件或群消息 Webhook 事件，对应 webhook 的 content 里的 conversation_short_id 字段（长期有效）
    由于 conversation_id 包含 + = 等特殊字符，传参时需要进行编码
    message_id
    String
    是
    @9VxXwOOLDZg4JyKuOM0+Qc79fadf12foPP+BPpJ3qw2uLFARa/H760zdRmYqig357zEBqu7zZ/C7rfG4tqP82908PQ==
      •仅支持 webhook content 中 msg_type 为user_local_image 和 user_local_video 的 message_id
      •由于 message_id 包含 + = 等特殊字符，传参时需要进行编码
    open_id
    String
    是
    2d3201d1-4cf2-4f01-8368-b6f2fb04ac7d
    授权用户唯一标识。来源
    ​

    请求示例

    ## 调用接口返回多媒体资源 URL
curl --location --request GET 'https://open.douyin.com/api/im/message/resources/?open_id=2d3201d1-4cf2-4f01-8368-b6f2fb04ac7d&message_id=%409VwDhOCRTcMhM22uc8ptWc791m3uPvyEPZV5rgOlKFAVbPT860zdRmYqig357zEB4Kil85ESSP%2B5XoOMbKfd5w%3D%3D&conversation_id=%409VwDhOCRTcMhM22uc8ptWc791WbvOP%2BHMpxwrAOiL1MWa%2FH460zdRmYqig357zEBdsmeO0WyFq81ZGOrbYMEaw%3D%3D' \
--header 'access-token: act.b5efd5ad64f0cfea3df3ff57e4efd2KnC0VisBaEXFnQRo' 


## 后续访问图片，Header 中需要填充 Access-Token, OpenID 参数
curl --location 'https://api-normal.amemv.com/im_open/media?type=image&secret=skv2Z1fhiKw1gGBsGa4%3D' \
--header 'OpenID: 2d3201d1-4cf2-4f01-8368-b6f2fb04ac7d' \
--header 'Access-Token: act.b5efd5ad64f0cfea3df3ff57e4efd2KnC0VisBaEXFnQRo'
    ​

    响应参数

    Body

    名称
    字段类型
    是否必填
    示例
    描述
    data
    Struct
    是
    ​
    ​
    ​
    media_type
    String
    否
    ​
    资源类型，image/video
    ​
    url
    String
    否
    ​
    资源访问链接，有效期 30 天
    ​
    访问 URL 时，需额外在请求 Header 中携带 Access-Token, OpenID 字段，字段的值与调用本接口的AccessToken, OpenID 相同，否则无法访问相关资源
    err_msg
    String
    是
    "access_token无效"
    错误描述
    ​
    err_no
    Int32
    是
    28001003
    错误码
    ​
    log_id
    String
    是
    "202405291440576E078D8757B9"
    日志id
    ​
    ​

    响应示例

    正常示例

    {
  "err_no": 0,
  "err_msg": "",
  "log_id": "202407110422171F56841DE9E1C23E715C",
  "data": {
    "media_type": "image",
    "url": "https://api-normal.amemv.com/im_open/media?type=image&secret=skv2Z1fhiKw1gGBsGa4%3D"
  }
}
    ​

    异常示例

    {
  "err_no": 28001008,
  "err_msg": "access_token过期,请刷新或重新授权",
  "log_id": "20240711044452AF709254C5F1B364A8D0"
}
    ​

    错误码

    HTTP 状态码
    错误码
    错误码描述
    排查建议
    200
    28001005
    系统内部错误，请重试
    ​
    请求重试，若依然无解请向平台提交反馈
    ​
    200
    28001003
    access_token无效
    ​
    重新请求生成access_token
    ​
    200
    28001008
    access_token过期,请刷新或重新授权
    ​
    重新请求生成access_token
    ​
    200
    28001016
    当前应用已被封禁或下线
    ​
    clientKey被封禁或者下线
    ​
    200
    28001006
    网络调用错误，请重试
    ​
    重试即可
    ​
    200
    28001014
    应用未授权任何能力
    ​
    确认应用是否授权能力
    ​
    200
    28001018
    应用未获得该能力
    ​
    开通相关能力
    ​
    200
    28003017
    quota已用完
    ​
    联系平台处理
    ​
    200
    28001019
    应用该能力已被封禁
    ​
    该能力被封禁，联系平台处理
    ​
    200
    28001007
    参数不合法
    ​
    根据错误信息检查请求参数是否填写正常
    ​
    200
    28029006
    权限校验失败
    请检查用户是否有消息访问权限
    ​
    200
    28029020
    未获取到资源链接
    ​
    ​
    ​
    200
    28029015
    未知资源类型
    ​
    ​
    ​
    200
    28029016
    不支持的消息类型
    ​
    ​
    ​
    200
    28029017
    非会话内用户
    ​
    ​
    ​
    200
    28029018
    消息状态异常
    ​
    请确认消息处于正常可见状态
    ​
    200
    28029019
    多媒体资源为空
    ​
    ​
    ​
    200
    28029014
    资源签发失败，请重试
    ​
    ​
    ​
    200
    28029021
    资源加密失败
    ​
    ​
    ​
    200
    28029022
    无法获取相应消息
    ​
    ​
    ​
    200
    28029023
    没有权限访问消息
    ​
    ​
    ​
    ​