Creating or Updating Conversation Mark Data

聚焦模式

字号

最后更新时间： 2026-04-14 11:25:27

Feature Overview
This API supports the creation or update of standard conversation marks as well as custom conversation marks. 
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/mark_contact?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/mark_contact
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",
  "MarkItem": [
    {
      "OptType": 3,
      "ContactItem": {
        "Type": 1,
        "To_Account": "user_0002"
      },
      "SetMark": [
        1,
        2,
        3
      ],
      "CustomMark": "abcd"
    }
  ]
}
Request fields
Field
Type
Required
Description
From_Account
String
Yes
Fill in UserID, request to create conversation marks for this user.
MarkItem
Array
Yes
Array of conversation marks. The array can contain up to 100 conversation marks.
OptType
Integer
Yes
Operation type：
1: Setting standard conversation marks; 
2: Setting custom conversation marks; 
3: Setting both standard and custom conversation marks.
ContactItem
Object
Yes
Conversation object to be operated.
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.
ClearMark
Array
No
Sequence number of the bit for which a standard mark is to be canceled. The value n indicates to cancel the mark value for bit n.
SetMark
Array
No
Sequence number of the bit for which a standard mark is to be set. The value n indicates to set the mark value for bit n.
CustomMark
String
No
Set a custom conversation mark. Up to 256 bytes are supported.
A standard conversation mark has 64 bits in total: the first 32 bits are internally used by Chat, and the last 32 bits are extended bits that can be customized by customers. Internal bits are described as follows:
Bit 0: Mark a conversation as "favorite"
Bit 1: Mark a conversation (important conversation) as unread
Bit 2: Mark a conversation as collapsed
Bit 3: Mark a conversation as hidden
Sample response
{
  "ResultItem": [
    {
      "OptType": 3,
      "ContactItem": {
        "Type": 1,
        "To_Account": "user_0002"
      },
      "ResultCode": 0,
      "ResultInfo": ""
    }
  ],
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": ""
}
Response fields
Field
Type
Description
ResultItem
Array
Conversation mark operation result.
OptType
Integer
Operation type：
1: Setting standard conversation marks; 
2: Setting custom conversation marks; 
3: Setting both standard and custom conversation marks.
ContactItem
Object
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.
ResultCode
Integer
The result. 0 means success and other values mean failure. For details on non-zero results, see Error Codes.
ResultInfo
String
Error description of To_Account. This field is empty if the request is successful.
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.
51006
When you are modifying conversation mark, the number of conversations is empty or exceeds the upper limit of 100.
51007
Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
51008
The number of marked conversations has reached the system limit (the default supports up to 1000 conversations).
51013
The current version does not support Conversation Standard Marking. To access this feature, please upgrade to the Pro edition, Pro edition Plus, or Enterprise edition.
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/mark_contact	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 create conversation marks for this user.
MarkItem	Array	Yes	Array of conversation marks. The array can contain up to 100 conversation marks.
OptType	Integer	Yes	Operation type： 1: Setting standard conversation marks; 2: Setting custom conversation marks; 3: Setting both standard and custom conversation marks.
ContactItem	Object	Yes	Conversation object to be operated.
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.
ClearMark	Array	No	Sequence number of the bit for which a standard mark is to be canceled. The value `n` indicates to cancel the mark value for bit n.
SetMark	Array	No	Sequence number of the bit for which a standard mark is to be set. The value `n` indicates to set the mark value for bit n.
CustomMark	String	No	Set a custom conversation mark. Up to 256 bytes are supported.

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.
51006	When you are modifying conversation mark, the number of conversations is empty or exceeds the upper limit of 100.
51007	Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
51008	The number of marked conversations has reached the system limit (the default supports up to 1000 conversations).
51013	The current version does not support Conversation Standard Marking. To access this feature, please upgrade to the Pro edition, Pro edition Plus, or Enterprise edition.

tencent cloud

Chat

Creating or Updating Conversation Mark Data

Feature Overview

API Calling Description

Sample request URL

Request parameters

Maximum call frequency

Sample request

Request fields

Sample response

Response fields

Error Codes

API Debugging Tool

帮助和支持