tencent cloud

Chat

製品の説明
製品の概要
Basic Concepts
ユースケース
機能概要
アカウントシステム
ユーザープロフィールとリレーションシップチェーン
メッセージ管理
グループシステム
Official Account
Audio/Video Call
使用制限
購入ガイド
課金概要
価格説明
Purchase Instructions
Renewal Guide
支払い延滞説明
Refund Policy
ダウンロードセンター
SDK & Demo ソースコード
更新ログ
シナリオプラン
Live Streaming Setup Guide
AI Chatbot
極めて大規模なエンターテインメントコラボレーションコミュニティ
Discord実装ガイド
ゲーム内IM統合ガイド
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
クライアントAPIs
SDK API（Web）
Android
iOS & macOS
Swift
Flutter
SDK API（Electron）
SDK APIs (Unity)
SDK API（React Native）
C APIs
C++
サービス側 APIs
UserSigの生成
RESTful APIs
Webhooks
コンソールガイド
New Console Introduction
アプリケーションの作成とアップグレード
基本設定
機能設定
アカウント管理
グループ管理
Official Channel Management
コールバック設定
監視ダッシュボード
Viewing Guide for Resource Packages
Real-Time Monitor
補助ツールの開発
アクセス管理
Advanced Features
よくあるご質問
uni-app FAQs
 購入に関する質問
SDKに関する質問
アカウント認証に関する質問
ユーザープロファイルとリレーションシップチェーンに関する質問
メッセージに関する質問
グループに関する質問
ライブ配信グループに関する質問
ニックネームプロフィール画像に関連した問題
一般的なリファレンス
Service Level Agreement
セキュリティコンプライアンス認証
IM ポリシー
プライバシーポリシー
データプライバシーとセキュリティ契約
エラーコード
お問い合わせ
ドキュメントChatサービス側 APIsRESTful APIs Session RelatedPinned Conversation ManagementPin a conversation

Pin a conversation

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-26 16:09:04

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":"id1",
    "OperationType":1,
    "RecentContactItem": [
        {
            "Type": 1,
            "To_Account": "id2"
        },
        {
            "Type": 2,
            "GroupId": "group1"
        }
    ]
}

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.

前の記事へ: Querying Unread One-to-One Message Count次の記事へ: Deleting a conversation

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック