tencent cloud

文档反馈

更新会话分组数据

最后更新时间:2024-07-16 10:52:15

    功能说明

    会话分组标记数据独立于最近联系人,RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记数据最多支持1000个会话。本接口支持会话分组数据的更新,仅进阶版支持会话分组数据操作。

    接口调用说明

    请求 URL 示例

    https://xxxxxx/v4/recentcontact/update_contact_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    请求参数说明

    下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
    参数
    说明
    xxxxxx
    SDKAppID 所在国家/地区对应的专属域名:
    中国:console.tim.qq.com
    新加坡:adminapisgp.im.qcloud.com
    首尔: adminapikr.im.qcloud.com
    法兰克福:adminapiger.im.qcloud.com
    硅谷:adminapiusa.im.qcloud.com
    雅加达:adminapiidn.im.qcloud.com
    v4/recentcontact/update_contact_group
    请求接口
    sdkappid
    创建应用时即时通信 IM 控制台分配的 SDKAppID
    identifier
    必须为 App 管理员账号,更多详情请参见 App 管理员
    usersig
    App 管理员账号生成的签名,具体操作请参见 生成 UserSig
    random
    请输入随机的32位无符号整数,取值范围0 - 4294967295
    contenttype
    请求格式固定值为json

    最高调用频率

    200次/秒。

    请求包示例

    {
    "From_Account":"user20",
    "UpdateType":1,
    "UpdateGroup":{
    "UpdateGroupType":2,
    "OldGroupName":"test1",
    "ContactUpdateItem":[
    {
    "ContactOptType":1,
    "ContactItem":{
    "Type": 1,
    "To_Account": "user1"
    }
    }
    ]
    }
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    From_Account
    String
    必填
    请求方uid
    UpdateType
    Integer
    必填
    1 - 分组添加或删除会话。
    UpdateGroup
    Object
    必填
    分组纬度增删会话
    UpdateGroupType
    Integer
    必填
    更新类型:1 - 更新分组名; 2 - 更新会话分组
    OldGroupName
    String
    UpdateGroupType=1时,必填
    待更新的分组名
    NewGroupName
    String
    UpdateGroupType=1时,必填
    更新后的分组名,最多支持32个字节
    ContactUpdateItem
    Array
    选填
    指定更新的会话
    ContactOptType
    Integer
    必填
    更新类型: 1 - 分组添加会话; 2 - 分组删除会话.
    ContactItem
    Object
    必填
    会话对象
    Type
    Integer
    必填
    会话类型,c2c=1,group=2
    ToGroupId
    String
    必填
    群ID
    To_Account
    String
    必填
    用户ID

    应答包体示例

    {
    "UpdateType": 1,
    "UpdateGroupResult": {
    "UpdateGroupType": 2,
    "GroupName": "test1",
    "GroupId": 1,
    "OldGroupName": "test1",
    "ContactResultItem": [
    {
    "ContactOptType": 1,
    "ContactItem": {
    "Type": 1,
    "To_Account": "user1"
    },
    "ResultCode": 0,
    "ResultInfo": ""
    }
    ]
    },
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": ""
    }

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码,0表示成功,非0表示失败
    ErrorInfo
    String
    错误信息
    UpdateType
    Integer
    必填
    UpdateGroupResult
    Object
    分组维度更新结果
    UpdateGroupType
    Integer
    必填
    GroupName
    String
    当前操作的分组名称
    OldGroupName
    String
    当前操作老的分组名称
    GroupId
    Integer
    当前操作的分组 ID
    ContactResultItem
    Array
    会话操作结果
    ContactOptType
    Integer
    必填
    ContactItem
    Object
    会话对象
    Type
    Integer
    会话类型,c2c=1,group=2
    ToGroupId
    String
    群 ID
    To_Account
    String
    用户 ID
    ResultCode
    Integer
    对应会话的操作结果,错误码,0表示成功
    ResultInfo
    String
    对应会话的操作结果,错误描述

    错误码说明

    除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ResultCode、ResultInfo、ErrorCode 以及 ErrorInfo 来表示的。
    公共错误码(60000到79999)请参见 错误码
    本 API 私有错误码如下:
    错误码
    描述
    50001
    请求的 UserID 没有导入腾讯云移动通信后台,请先将 UserID 导入腾讯云移动通信后台
    50002
    请求参数错误,请根据错误描述检查请求参数
    50003
    请求需要 App 管理员权限
    50004
    服务端内部错误,请重试
    50005
    网络超时,请稍后重试
    51006
    修改会话标记时,调整的会话数为空或者超过了100个上限。
    51007
    GroupID 换 GroupCode 失败,内部错误或 Group 已经解散。
    51008
    会话分组的总的会话数超过了1000。
    51009
    删除会话分组时分组不存在。
    51010
    会话分组数超过了20个上限。
    51011
    会话分组名超过了32个字节。
    51012
    超过置顶会话数量上限。
    51013
    若请求的应用非进阶版,修改标准会话标记或者会话分组报错。

    接口调试工具

    通过 REST API 在线调试工具 调试本接口。
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持