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 APIsMessage RelatedMessage ExtensionPulling the Message Extension of a One-to-One Message

Pulling the Message Extension of a One-to-One Message

PDF
フォーカスモード
フォントサイズ
最終更新日: 2025-10-23 10:50:34

Feature Overview

App admins and conversation members can pull the message extension of a one-to-one message. Message extension is a set of custom key-value pairs.
Note
To use this feature, you need to purchase the Pro edition 、Pro Plus edition、Enterprise edition and enable the Set message extension feature on the Login and Message page in the Chat console.
Up to 300 key-value pairs can be set for each one-to-one message.
For one-to-one messages for which key-value pairs are set, they need to be specified to support message extension when being sent. For operation details, see Sending One-to-One Messages to One User.

Sample request URL

https://xxxxxx/v4/openim_msg_ext_http_svc/get_key_values?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/openim_msg_ext_http_svc/get_key_values
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

Basic format
Pull the message extension of a one-to-one message whose MsgKey is 44739199_12_1665388280:
{
    "From_Account": "62768",
    "To_Account": "116400",
    "MsgKey": "44739199_12_1665388280"
}
Pull the message extension of a one-to-one message whose MsgKey is 44739199_12_1665388280 and Seq is greater than or equal to 2:
{
    "From_Account": "62768",
    "To_Account": "116400",
    "MsgKey": "44739199_12_1665388280",
    "StartSeq": 2
}

Request fields

Field
Type
Required
Description
From_Account
String
No
UserID of the sender (used to specify the message sender)
To_Account
String
Yes
UserID of the recipient
MsgKey
String
Yes
Unique identifier of the one-to-one message. For how to obtain the MsgKey of the message, see the API for sending one-to-one messages to one user.
StartSeq
Integer
No
Message extension will be pulled for messages whose Seq is greater than or equal to StartSeq.

Sample response

{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "CompleteFlag": 1,
    "LatestSeq": 2,
    "ClearSeq": 0,
    "ExtensionList": [
        {
            "Key": "k1",
            "Value": "v1",
            "Seq": 1
        },
        {
            "Key": "k2",
            "Value": "v2",
            "Seq": 1
        },
        {
            "Key": "k3",
            "Value": "v3",
            "Seq": 2
        }
    ]
}

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
ExtensionList
Array
List of key-value pairs returned, where the key-value pairs are sorted by Seq. Up to 200 key-value pairs can be returned per pull. If there are more than 200 key-value pairs, they need to be pulled in batches based on StartSeq.
CompleteFlag
Integer
1: All key-value pairs are returned. 0: Not all key-value pairs are returned.
LatestSeq
Integer
Latest Seq of the backend, which is the maximum value of Seq among all key-value pairs.
ClearSeq
Integer
Seq for the clearing operation. All key-value pairs whose Seq is less than or equal to ClearSeq must be deleted locally on the client.

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 ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
Error Code
Description
10002
Internal server error. Try again.
10004
Invalid parameter. Check the error description and troubleshoot the issue.
10008
Invalid request: The request is not an Pro edition 、Pro Plus edition、Enterprise edition plan request.
23004
The one-to-one message does not exist.
前の記事へ: Sending Read Receipts for One-to-One Messages次の記事へ: Configuring Message Extension for a One-to-One Message

ヘルプとサポート

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

フィードバック