• UIKit
  • SDK
  • サーバー API
Chat/
サーバー API/
RESTful インターフェース/
セッション関連/
セッショングループフラグ/
サーバー API
  • UserSig の生成
  • RESTful インターフェース
    • RESTful インターフェースの概要
    • RESTful インターフェースリスト
    • メッセージ関連
      • メッセージ送信
        • 単一ユーザーへのシングルチャットメッセージの送信
        • 複数のユーザーへのシングルチャットメッセージの送信
        • グループ内で一般的なメッセージを送信
        • グループでシステムメッセージを送信
        • ライブブロードキャストグループのブロードキャストメッセージ
        • シングルメッセージのインポート
        • グループメッセージのインポート
      • 過去のメッセージ
        • 過去のシングルチャットメッセージの変更
        • 過去のグルップチャットメッセージの変更
        • 過去のシングルチャットメッセージの取得
        • 過去のグルップチャットメッセージの取得
      • メッセージ削除
        • 指定されたユーザーが送信したメッセージを削除
      • メッセージの取り消し
        • シングルチャットメッセージの取り消し
        • グループメッセージの取り消し
      • 既読レシート
        • シングルチャットメッセージを既読に設定
        • グループメッセージの既読レシート詳細の取得
        • グループメッセージの既読レシートの取得
      • メッセージ拡張
        • シングルチャットメッセージ拡張の取得
        • シングルチャットメッセージ拡張の設定
        • グループメッセージ拡張の取得
        • グループメッセージ拡張の設定
      • すべてのユーザーにプッシュします
        • 全員プッシュインタフェース
        • すべてのユーザーにプッシュします
        • アプリケーションプロパティ名の設定
        • アプリケーションプロパティ名の取得
        • ユーザープロパティの取得
        • ユーザープロパティの設定
        • ユーザープロパティの削除
        • ユーザーフラグの取得
        • ユーザーフラグの追加
        • ユーザーフラグの削除
        • ユーザーのすべてのフラグを削除
    • セッション関連
      • セッションリスト
        • セッションリストの取得
      • 未読セッション数
        • メンバーの未読メッセージ数の設定
        • 未読シングルチャットメッセージ数を照会
      • セッションの削除
        • セッションの削除
      • セッショングループフラグ
        • セッショングループデータの作成
        • セッショングループデータの更新
        • セッショングループデータの削除
        • セッションフラグデータの作成・更新
        • セッショングループフラグの検索
        • セッショングループマークデータの取得
    • グループ関連
      • グループ管理
        • アプリケーション内のすべてのグループを取得
        • グループの作成
        • グループの解散
        • ユーザーが参加しているグループを取得します
      • グループプロファイル
        • グループプロファイルの取得
        • グループプロファイルの変更
        • グループプロファイルのインポート
      • グループメンバーの管理
        • グループメンバーの追加
        • グループメンバーの削除
        • グループメンバーのブロック
        • グループメンバーのブロック解除
        • 一括発言禁止と発言禁止の解除
        • 発言を禁止されているグループメンバーのリストを取得
        • グループオーナーの変更
        • グループ内のユーザーの身分を照会
        • グループメンバーのインポート
      • グループメンバーの情報
        • グループメンバープロファイルの取得
        • グループメンバープロファイルの変更
      • グループのカスタムプロパティ
        • グループのカスタムプロパティの取得
        • グループのカスタムプロパティの変更
        • グループのカスタムプロパティをクリアします
        • グループのカスタムプロパティをリセットします
        • グループのカスタムプロパティを削除します
      • ライブブロードキャストグループ管理
        • ライブブロードキャストグループのオンライン人数の取得
        • ライブブロードキャストグループメンバーのリストを取得
        • ライブブロードキャストグループメンバーのフラグ設定
        • ブロックされているグループメンバーのリストを取得
      • コミュニティ管理
        • トピックの作成
        • トピックの削除
        • トピックプロファイルの取得
        • トピックプロファイルの変更
        • トピック資料のインポート
      • グループカウンター
        • グループカウンターの取得
        • グループカウンターの更新
        • グループカウンターの削除
    • ユーザー管理
      • アカウント管理
        • シングルアカウントのインポート
        • 複数アカウントのインポート
        • アカウント削除
        • アカウントの検索
      • ユーザー情報
        • プロファイルの設定
        • プロファイルの取得
      • ユーザー状態
        • アカウントのログイン状態が無効になりました。
        • アカウントのオンライン状態の確認
      • 友達管理
        • 友達の追加
        • 友達のインポート
        • 友達の更新
        • 友達の削除
        • すべての友達を削除
        • 友達の検証
        • 友達の取得
        • 指定友達の取得
      • 友達リスト
        • リストを追加
        • リストの削除
        • リストの取得
      • ブラックリスト
        • ユーザーをブラックリストに追加します
        • ユーザーをブラックリストから削除
        • ブラックリストの取得
        • ブラックリスト内のユーザーの検証
    • 全員発言禁止の管理
      • 全員発言禁止の設定
      • 全員発言禁止の照会
    • メンテナンス管理
      • メンテナンスデータの取得
      • 最新メッセージのダウンロード
      • サーバー IP アドレスの取得
    • スマートロボット
      • スマートロボットのアカウントを取得
      • スマートロボットのアカウントを作成
      • スマートロボットのアカウントを削除
  • トリガー
    • コールバックの概要
    • コールバックコマンドリスト
    • メンテナンス管理コールバック
      • インターフェースオーバークロックアラームコールバック
    • オンライン状態のコールバック
      • 状態変更コールバック
    • リレーションシップチェーンコールバック
      • プロファイル更新後
      • 友達を追加する前
      • 友達追加に応答する前
      • 友達を追加した後
      • 友達を削除した後
      • ユーザーをブラックリストに追加した後
      • ユーザーをブラックリストから削除した後
    • シングルメッセージのコールバック
      • シングルチャットメッセージを送信する前
      • シングルチャットメッセージを送信した後
      • シングルチャットメッセージを既読に設定した後
      • シングルチャットメッセージを取り消した後
    • グループコールバック
      • グループを作成する前
      • グループ作成後
      • グループ加入を申し込む前
      • グループに追加する前
      • ユーザーがグループに参加した後
      • メンバーがグループから退出した後
      • グループメッセージを送信する前
      • グループメッセージを送信した後
      • グループが満員になった後
      • グループ解散後
      • グループプロファイル変更後
      • グループメッセージ取り消し後のコールバック
      • ライブブロードキャストグループメンバーのオンライン・オフライン状態のコールバック
      • グループメッセージ送信異常のコールバック
      • トピックを作成する前
      • トピックを作成した後
      • トピック削除後
      • トピック情報変更コールバック
      • グループメンバープロファイル変更後のコールバック
      • グループプロパティ変更後のコールバック
      • 既読レシートの後のコールバック
      • グループオーナー変更後のコールバック
    • コールバック相互認証設定ガイド
      • Apache 相互認証の設定
      • Nginx 相互認証の設定
    • スマートロボットのコールバック
      • スマートロボットのシングルチャットメッセージのカスタムコールバック
このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

セッションフラグデータの作成・更新

Feature Overview

Conversation group mark data is independent of recent contacts. You can use RESTful APIs to add, delete, modify, and query conversation group, standard conversation mark, custom conversation mark, and other fields. Conversation marks support up to 1,000 conversations. This API can be used to create or update standard or custom conversation marks. Only the Premium edition supports standard conversation mark operations, and custom conversation mark operations have no such restrictions.

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
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":"user0",
"MarkItem":[
{
"OptType":3,
"ContactItem":{
"Type":1,
"To_Account":"user1"
},
"SetMark":[1,2,3],
"CustomMark":"abcd"
}
]
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
UID of the requester
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
Group ID
To_Account
String
No
User ID
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": "user1"
},
"ResultCode": 0,
"ResultInfo": ""
}
],
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "",
"ErrorDisplay": ""
}

Response fields

Field
Type
Description
ActionStatus
String
Request result. OK: Successful; FAIL: Failed
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information
ResultItem
Array
Conversation mark operation result
OptType
Integer
Yes
ContactItem
Integer
Conversation object
Type
String
Conversation type. 1: One-to-one conversation; 2: Group conversation
ToGroupId
String
Group ID
To_Account
String
Recipient's user ID
ResultCode
Integer
Error code in the conversation operation result. 0: Successful
ResultInfo
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 into the Tencent Cloud Chat backend. Please import.
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 total number of conversations in the conversation group exceeds 1,000.
51009
The conversation group does not exist when a deletion attempt is made.
51010
The number of conversation groups exceeds the upper limit of 20.
51011
The conversation group name contains more than 32 bytes.
51012
Exceeded the maximum number of conversations pinned to the top.
51013
If the requested app is not of the Premium edition, an error will be reported when a standard conversation mark or conversation group is modified.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.