即时通信 IM
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 即时通信 IM > 服务端 API > REST API > 运营管理 > 聊天文件签名

聊天文件签名

最近更新时间：2023-07-26 18:03:43

我的收藏

本页目录：

接口调用说明

本接口用于获取聊天消息中的富媒体文件 FULL_CONTROL 权限的 URL 签名以及文件状态信息，默认有效期15分钟。一般 SDK 下发的文件 URL 为普通账号签名，违规封禁后，可以使用 FULL_CONTROL 权限的 URL 签名来查看封禁的资源。
说明
仅针对富媒体消息中使用 IM SDK 上传的文件有效，为了确保功能正常使用，请将终端 SDK 更新至4.9.x版本及以上，Web SDK 更新至v2.0.0版本及以上。

请求 URL 示例

https://console.tim.qq.com/v4/im_cos_msg/get_cos_sig?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
v4/im_cos_msg/get_cos_sig
获取 FULL_CONTROL 签名的接口，如果文件被封禁，客户管理员可以通过这个接口下载原始文件
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295

请求包示例

{
    "RawURLs": [
        {
            "ResourceID":1,
            "RawURL":"https://cos.ap-shanghai.myqcloud.com/98ec-shanghai-007-privatev2-01-1256635546/0345-1400187352/0612-yyy/9a0f4c42d208ccfb5aa47c29284aefc6.png"
        }，
        {
            "ResourceID":2,
            "RawURL":"https://cos.ap-shanghai.myqcloud.com/98ec-shanghai-007-privatev2-01-1256635546/0345-1400187352/0612-yyy/9a0f4c42d208ccfb5aa47c29284aefc7.png"
        }
    ]
}

请求包字段说明

字段
类型
属性
说明
RawURLs
Array
必填
批量查询的文件 URL，可从 IM 富媒体消息的 URL 字段获取
ResourceID
Integer
必填
同批次查询的资源 ID
RawURL
String
必填
同批次查询的文件 URL

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "PreSigURLs": [
        {
            "Code": 0,
            "Desc": "",
            "ResourceID": 1,
            "PreSigURL": "https://cos.ap-shanghai.myqcloud.com/98ec-shanghai-007-privatev2-01-1256635546/0345-1400187352/0612-yyy/9a0f4c42d208ccfb5aa47c29284aefc6.png?sign=xxxyyyzzz&im-time-expired=1653904781",
            "Status": 0
        },
        {
            "Code": 0,
            "Desc": "",
            "ResourceID": 2,
            "PreSigURL": "https://cos.ap-shanghai.myqcloud.com/98ec-shanghai-007-privatev2-01-1256635546/0345-1400187352/0612-yyy/9a0f4c42d208ccfb5aa47c29284aefc7.png?sign=xxxyyyzzz&im-time-expired=1653904781",
            "Status": 2
        }
    ]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
ErrorInfo
String
错误信息
PreSigURLs
Array
批量查询结果返回
ResourceID
Integer
同批查询的资源 ID
Code
Integer
指定资源 ID 对应的查询结果
Desc
String
指定资源 ID 对应的查询结果的描述
PreSigURL
String
指定资源 ID 对应的最高权限的签名 URL，可以下载封禁的文件，有效期15分钟
Status
Integer
指定资源 ID 对应的文件状态：
0：文件正常，SDK 可访问
1：文件被封禁，SDK 访问无权限，可使用 PreSigURL 访问
2：文件不存在，可能过期被删除

中国站