Feedback

Searching for Conversation Group Marks

Feature Overview
This API is used to query the conversation group mark data of a specified conversation.
Note:
Conversation grouping and Conversation Marking operate independently from the recent contacts list. The REST API supports CRUD operations for conversation grouping, Standard Conversation Marking, and Custom Conversation Marking fields.
Each user can create up to 20 conversation groups. A session can join multiple groups. The session cap is set at 1000, and exceeding it will return error code: 51008.
Session tags and session custom fields have a combined upper limit of 1000 sessions. Exceeding this limit will return error code: 51008.
Conversation grouping and marking features require enabling Pro Edition、Pro Plus Edition or Enterprise Edition. The number of cloud sessions that can be pulled is limited by the Number of Conversations to Pull in the Chat basic package. If the number of grouped or marked sessions exceeds the corresponding limit, complete session retrieval may fail. You can upgrade the Chat package version to increase the cloud session limit.
API Calling Description
Sample request URL
https://xxxxxx/v4/recentcontact/search_contact_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
Parameter
Description
xxxxxx
Domain name corresponding to the country/region where your SDKAppID is located.
China: console.tim.qq.com
Singapore: adminapisgp.im.qcloud.com
Seoul: adminapikr.im.qcloud.com
Tokyo: adminapijpn.im.qcloud.com
Frankfurt: adminapiger.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/recentcontact/search_contact_group
Request API.
sdkappid
SDKAppID assigned by the Chat console when an app is created.
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.
Maximum call frequency
200 calls per second.
Sample request
{
  "From_Account": "user_0001",
  "ContactItem": [
    {
      "Type": 1,
      "To_Account": "user_0002"
    },
    {
      "Type": 2,
      "ToGroupId": "@TGS#1B2AUI7RZ"
    }
  ]
}
Request fields
Field
Type
Required
Description
From_Account
String
Yes
Fill in UserID, request to search conversation group/mark for this user.
ContactItem
Array
Yes
List of conversation objects to be searched. Up to 300 conversations can be searched at a time.
Type
Integer
Yes
Conversation type：
1: One-to-one conversation.
2: Group conversation.
ToGroupId
String
No
Assign value only for Group conversation, fill in the group ID of the conversation party.
To_Account
String
No
Assign value only for One-to-one conversation, fill in the UserID of the conversation party.
Sample response
{
  "ContactResultItem": [
    {
      "Type": 1,
      "To_Account": "user_0002",
      "StandardMark": "11111110",
      "CustomMark": "abcde",
      "ContactGroupId": [
        1,
        2
      ],
      "Timestamp": 1775217000
    },
    {
      "Type": 2,
      "ToGroupId": "@TGS#1B2AUI7RZ",
      "StandardMark": "",
      "ContactGroupId": [
        1
      ],
      "Timestamp": 1775186067
    }
  ],
  "GroupItem": [
    {
      "GroupName": "group_0001",
      "GroupId": 1
    },
    {
      "GroupName": "group_0002",
      "GroupId": 2
    }
  ],
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": ""
}
Response fields
Field
Type
Description
ContactItem
Integer
Conversation object.
Type
Integer
Conversation type：
1: One-to-one conversation.
2: Group conversation.
ToGroupId
String
Assign value only for Group conversation, fill in the group ID of the conversation party.
To_Account
String
Assign value only for One-to-one conversation, fill in the UserID of the conversation party.
StandardMark
String
Standard mark capability bit, for example, 011111110.
CustomMark
String
Custom mark.
ContactGroupId
Array
Group to which the conversation belongs.
Timestamp
Integer
Last update timestamp of the conversation group.
GroupItem
Array
Conversation group object.
GroupName
String
Conversation group name.
GroupId
Integer
Conversation group ID.
ActionStatus
String
The request result.
OK: successful.
FAIL: failed.
ErrorCode
Integer
Error code in the conversation operation result.
0: Successful.
Non-zero: Failed.
ErrorInfo
String
Error description in the conversation operation result.
Error Codes
The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:
Error Code
Description
50001
The requested UserID has not been imported to Chat. Please import the UserID first.
50002
Incorrect request parameter. Check your request according to the error description.
50003
The request requires app admin permissions.
50004
Internal server error. Please try again.
50005
Network timeout. Try again later.
51007
Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
﻿

Parameter	Description
xxxxxx	Domain name corresponding to the country/region where your SDKAppID is located. China: `console.tim.qq.com` Singapore: `adminapisgp.im.qcloud.com` Seoul: `adminapikr.im.qcloud.com` Tokyo: `adminapijpn.im.qcloud.com` Frankfurt: `adminapiger.im.qcloud.com` Silicon Valley: `adminapiusa.im.qcloud.com` Jakarta: `adminapiidn.im.qcloud.com`
v4/recentcontact/search_contact_group	Request API.
sdkappid	SDKAppID assigned by the Chat console when an app is created.
identifier	App admin account. For more information, see the App Admin section in Login Authentication.
usersig	Signature generated by the app admin account. For details, see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Request format, which should always be `json`.

Field	Type	Required	Description
From_Account	String	Yes	Fill in UserID, request to search conversation group/mark for this user.
ContactItem	Array	Yes	List of conversation objects to be searched. Up to 300 conversations can be searched at a time.
Type	Integer	Yes	Conversation type： 1: One-to-one conversation. 2: Group conversation.
ToGroupId	String	No	Assign value only for Group conversation, fill in the group ID of the conversation party.
To_Account	String	No	Assign value only for One-to-one conversation, fill in the UserID of the conversation party.

Error Code	Description
50001	The requested UserID has not been imported to Chat. Please import the UserID first.
50002	Incorrect request parameter. Check your request according to the error description.
50003	The request requires app admin permissions.
50004	Internal server error. Please try again.
50005	Network timeout. Try again later.
51007	Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.