功能说明
本接口支持删除用户的会话分组数据。
说明:
会话分组、会话标记独立于最近联系人,REST API 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。
会话分组和标记功能需开通旗舰版或企业版,同时可拉取云端会话数受 IM 基础套餐 中云端会话列表拉取个数的限制,若分组、标记会话数超过对应限制,则无法完整拉取会话,可通过升级 IM 套餐版本提升云端会话数限制。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/recentcontact/del_contact_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com新加坡: adminapisgp.im.qcloud.com首尔: adminapikr.im.qcloud.com东京: adminapijpn.im.qcloud.com法兰克福: adminapiger.im.qcloud.com硅谷: adminapiusa.im.qcloud.com雅加达: adminapiidn.im.qcloud.com |
v4/recentcontact/del_contact_group | 请求接口。 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID。 |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 请求格式固定值为 json。 |
最高调用频率
200次/秒。
请求包示例
{"From_Account": "user_0001","GroupName": ["group_0001" // 一次只支持删除一个会话分组.]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
From_Account | String | 必填 | 填 UserID,请求删除该用户的会话分组。 |
GroupName | Array | 必填 | 待删除的会话分组列表,当前仅支持单个删除。 |
应答包体示例
{"GroupItem": [{"GroupName": "group_0001","GroupId": 1}],"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": ""}
应答包字段说明
字段 | 类型 | 说明 |
GroupItem | Array | 删除的分组对象。 |
GroupName | String | 对应的会话分组名称。 |
GroupId | Integer | 删除的会话分组 ID。 |
ActionStatus | String | 请求处理的结果: OK 表示处理成功。 FAIL 表示失败。 |
ErrorCode | Integer | 错误码: 0表示成功。 非0表示失败。 |
ErrorInfo | String | 错误信息。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 ErrorCode 和 ErrorInfo 来表示的。
错误码 | 描述 |
50001 | 请求的 UserID 没有导入即时通信 IM,请先将 UserID 导入即时通信 IM。 |
50002 | 请求参数错误,请根据错误描述检查请求参数。 |
50003 | 请求需要 App 管理员权限。 |
50004 | 服务端内部错误,请重试。 |
50005 | 网络超时,请稍后重试。 |
51009 | 未找到指定的会话分组,请确认分组名称是否正确。 |
51011 | 会话分组名超过了64个字节。 |
51013 | 当前版本暂不支持会话分组功能,请升级到旗舰版或企业版后使用。 |