Pin a conversation

Overview
Pin a conversation.
API Call Instructions
Request URL Example
https://xxxxxx/v4/recentcontact/top?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Query Parameters
The table below lists only the parameters relevant to this API call. For more details on additional parameters, please refer to the REST 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
Frankfurt: adminapiger.im.qcloud.com
Tokyo: adminapijpn.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/recentcontact/top
API endpoint.
sdkappid
SDKAppID assigned by the Chat console when creating the application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Signature generated by the App administrator. For details, see Generate UserSig.
random
Enter a random 32-bit unsigned integer, value range: 0 - 4294967295.
contenttype
Request format, fixed value: json.
Rate Limit
Maximum 200 requests per second.
Request Example
{
  "From_Account": "user_0001",
  "OperationType": 1,
  "RecentContactItem": [
    {
      "Type": 1,
      "To_Account": "user_0002"
    },
    {
      "Type": 2,
      "GroupId": "@TGS#1B2AUI7RZ"
    }
  ]
}
Request Fields
Field
Type
Required
Description
From_Account
String
Required
The user for whom the conversation is being pinned.
OperationType
Integer
Required
Pin operation type:
1: Pin conversation.
2: Unpin conversation.
RecentContactItem
Array
Required
Array of conversation objects.
Type
Integer
Required
Conversation type:
1: C2C conversation（One-to-one chat）.
2: G2C conversation（Group chat）.
To_Account
String
Required
Required for C2C conversations; UserID of the C2C conversation.
GroupId
String
Optional
Required for G2C conversations; Group ID of the G2C conversation.
Response Example
{
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "ErrorDisplay": ""
}
Response Fields
Field
Type
Description
ActionStatus
String
Result of processing the request:
OK: Success.
FAIL: Failure.
ErrorCode
Integer
Error code:
0: Success.
Non-zero: Failure. For details on non-zero values, see Error Codes.
ErrorInfo
String
Detailed error information.
ErrorDisplay
String
Detailed information for client display.
Error Codes
Unless a network error occurs (such as a 502 error), the HTTP return code for this API is always 200. Actual error codes and messages are provided in the response body via ErrorCode, and ErrorInfo.
For common error codes (60000 to 79999), see Error Codes.
Private error codes for this API are as follows:
Error Code
Description
50001
The requested UserID has not been imported to Chat. Please import the UserID first.
50002
Request parameter error. Please check the request parameters according to the error description.
50003
App administrator permission is required for this request.
50004
Internal server error. Please try again.
50005
Network timeout. Please try again later.
API Debugging Tool
Use the REST API Online Debugging Tool to test 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` Frankfurt: `adminapiger.im.qcloud.com` Tokyo: `adminapijpn.im.qcloud.com` Silicon Valley: `adminapiusa.im.qcloud.com` Jakarta: `adminapiidn.im.qcloud.com`
v4/recentcontact/top	API endpoint.
sdkappid	SDKAppID assigned by the Chat console when creating the application.
identifier	Must be an App administrator account. For more details, see App Administrator.
usersig	Signature generated by the App administrator. For details, see Generate UserSig.
random	Enter a random 32-bit unsigned integer, value range: 0 - 4294967295.
contenttype	Request format, fixed value: `json`.

Field	Type	Required	Description
From_Account	String	Required	The user for whom the conversation is being pinned.
OperationType	Integer	Required	Pin operation type: 1: Pin conversation. 2: Unpin conversation.
RecentContactItem	Array	Required	Array of conversation objects.
Type	Integer	Required	Conversation type: 1: C2C conversation（One-to-one chat）. 2: G2C conversation（Group chat）.
To_Account	String	Required	Required for C2C conversations; UserID of the C2C conversation.
GroupId	String	Optional	Required for G2C conversations; Group ID of the G2C conversation.

Error Code	Description
50001	The requested UserID has not been imported to Chat. Please import the UserID first.
50002	Request parameter error. Please check the request parameters according to the error description.
50003	App administrator permission is required for this request.
50004	Internal server error. Please try again.
50005	Network timeout. Please try again later.