IM

  • IM > API 文档 > 服务端API > 文件操作接口

    文件操作接口

    最近更新时间:2021-06-29 09:50:10

    文件操作接口

    下载头像

    基本信息

    Path: /file/download/avatar

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    Query

    参数名称 是否必须 示例 备注
    image_type 图片类型,1: 原图,2: 缩略图, 3: 封面图
    object_name 对象名
    sdk_sign SDK的签名
    store_token 文件token
    thumbnail_strategy 缩略图生成策略, 1 - 第三方服务器生成, 2 - 本地服务器生成,默认值是 1

    返回数据

    名称类型是否必须默认值备注其他信息

    下载聊天文件

    基本信息

    Path: /file/download/chat

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    Query

    参数名称 是否必须 示例 备注
    file_sign 文件签名
    format 需要下载的音频文件格式amr/mp3 默认为amr
    image_type 图片类型,1: 原图,2: 缩略图, 3: 封面图
    sdk_sign SDK的签名
    source 请求来源, miniprogram - 小程序,默认值是 ‘’
    store_token 文件token
    thumbnail_strategy 缩略图生成策略, 1 - 第三方服务器生成, 2 - 本地服务器生成,默认值是 1

    返回数据

    名称类型是否必须默认值备注其他信息

    获取上传用户头像URL

    基本信息

    Path: /file/upload/avatar/user

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须
    ├─ download_urlstring非必须
    ├─ oss_body_paramobject非必须
    ├─ upload_urlstring非必须
    messagestring非必须错误信息,如果成功,该项为null

    获取上传群头像URL

    基本信息

    Path: /file/upload/avatar/group

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    Query

    参数名称 是否必须 示例 备注
    group_id group_id

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须
    ├─ download_urlstring非必须
    ├─ oss_body_paramobject非必须
    ├─ upload_urlstring非必须
    messagestring非必须错误信息,如果成功,该项为null

    获取上传聊天文件的URL

    基本信息

    Path: /file/upload/chat

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    Query

    参数名称 是否必须 示例 备注
    file_type 文件类型 100: 普通聊天文件, 101: 语音聊天文件(amr格式),102: 图片聊天文件, 103: 视频聊天文件, 104: 语音聊天文件(mp3格式)200: 普通共享文件, 201: 语音共享文件, 202: 图片共享文件, 203: 视频共享文件
    to_id to_id
    to_type 1: 用户,2: 群组

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    dataobject非必须
    ├─ download_urlstring非必须
    ├─ oss_body_paramobject非必须
    ├─ upload_urlstring非必须
    messagestring非必须错误信息,如果成功,该项为null

    获取聊天文件转发的URL

    基本信息

    Path: /file/upload/forward

    Method: GET

    接口描述:

    请求参数

    Headers

    参数名称 参数值 是否必须 示例 备注
    access-token 令牌
    app_id 应用ID
    group_id 仅当access-token为管理员token时,可以设置此字段,表示以此群ID的管理员身份来调用此接口
    user_id 仅当access-token为管理员token时,可以设置此字段,表示以此用户ID的身份来调用此接口

    Query

    参数名称 是否必须 示例 备注
    file_sign 文件签名
    to_id to_id
    to_type 1: 用户,2: 群组

    返回数据

    名称类型是否必须默认值备注其他信息
    codeinteger非必须返回码,200是成功

    format: int32

    datastring非必须结果数据
    messagestring非必须错误信息,如果成功,该项为null
    以上内容是否对您有帮助?
  • Qvm free helper
    Close