会话分组标记数据独立于最近联系人,RestAPI 支持会话分组、会话标准标记、会话自定义标记等字段增删改查。会话分组标记最多支持1000个会话,而一个用户最多支持20个会话分组。本接口支持会话分组数据的创建,仅旗舰版支持会话分组数据操作。
https://xxxxxx/v4/recentcontact/create_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 adminapiind.im.qcloud.com adminapiusa.im.qcloud.com |
v4/recentcontact/create_contact_group | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | 必须为 App 管理员帐号,更多详情请参见 App 管理员 |
usersig | App 管理员帐号生成的签名,具体操作请参见 生成 UserSig |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为json |
200次/秒。
{
"From_Account":"user15",
"GroupContactItem":[
{
"GroupName":"test0",
"ContactItem": [
{
"Type": 1,
"To_Account": "user0"
}
]
}
]
}
字段 | 类型 | 属性 | 说明 |
---|---|---|---|
From_Account | String | 必填 | 请求方uid |
GroupContactItem | Array | 必填 | 待添加的会话分组,当前仅支持单个添加 |
GroupName | String | 必填 | 待添加的会话分组名称,最多32个字节 |
ContactItem | Array | 必填 | 待添加的会话列表 |
Type | Integer | 必填 | 会话类型,c2c=1,group=2 |
ToGroupId | String | 选填 | 群ID |
To_Account | String | 选填 | 用户ID |
{
"GroupResultItem": [
{
"GroupItem": {
"GroupName": "test2",
"GroupId": 2
},
"ResultItem": [
{
"ContactItem": {
"Type": 1,
"To_Account": "user1"
},
"ResultCode": 0,
"ResultInfo": ""
}
]
}
],
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}
字段 | 类型 | 说明 |
---|---|---|
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
GroupResultItem | Array | 会话分组添加结果 |
GroupItem | Object | 会话分组对象 |
GroupName | String | 会话分组名称 |
GroupId | Integer | 会话分组ID |
ResultItem | Array | 操作结果 |
ContactItem | Integer | 会话对象 |
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 在线调试工具 调试本接口。
本页内容是否解决了您的问题?