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

グループメッセージ拡張の設定

Feature Overview

App admins and group members can configure message extension for common group messages. Message extension is a set of custom key-value pairs.
Caution
To use this feature, you need to purchase the Premium 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 group message.
For group 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 Ordinary Messages in a Group.

API Calling Description

Applicable group types

Group Type ID
RESTful API Support
Private
Yes. Same as work groups (Work) in the new version.
Public
Yes
ChatRoom
Yes. Same as the meeting group (Meeting) in the new version.
AVChatRoom
No
Community
No
These are the preset group types in Chat. For more information, see Group System.

Sample request URL

https://xxxxxx/v4/openim_msg_ext_http_svc/group_set_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
Frankfurt: adminapiger.im.qcloud.com
Mumbai: adminapiind.im.qcloud.com
Silicon Valley: adminapiusa.im.qcloud.com
Jakarta: adminapiidn.im.qcloud.com
v4/openim_msg_ext_http_svc/group_set_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. The value is fixed to json.

Maximum call frequency

200 calls per second

Sample request

Basic format
Configure message extensions for the group message whose MsgSeq is 158:
{
"GroupId": "@TGS#1YMVAB3IZ",
"MsgSeq": 158,
"OperateType": 1,
"ExtensionList": [
{"Key": "key1", "Value": "value1", "Seq": 0},
{"Key": "key2", "Value": "value2", "Seq": 0},
]
}
Delete message extensions for the group message whose MsgSeq is 158:
{
"GroupId": "@TGS#1YMVAB3IZ",
"MsgSeq": 158,
"OperateType": 2,
"ExtensionList": [
{"Key": "key1", "Value": "", "Seq": 1}
]
}
Clear all message extensions for the group message whose MsgSeq is 158:
{
"GroupId": "@TGS#1YMVAB3IZ",
"MsgSeq": 158,
"OperateType": 3
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
Group ID
MsgSeq
Integer
Yes
Seq of the group message to be configured
OperateType
Integer
Yes
1: Setting key-value pairs for a message; 2: Deleting certain key-value pairs for a message; 3: Clearing all key-value pairs for a message
ExtensionList
Array
Yes (when OperateType is 1 or 2)
Up to 20 key-value pairs can be set or deleted per request
Fields of the objects in ExtensionList are described as follows:
Field
Type
Required
Description
Key
String
Yes
Key in a key-value pair, which can be up to 100 bytes
Value
String
Yes
Value in a key-value pair, which can be up to 1,000 bytes
Seq
Integer
Yes (when the API is not called by an app admin)
Version number of the current key-value pair. Seq is 0 when the API is called by a group member to configure a key-value pair for the first time and is 1 when the configuration is successful. For subsequent key-value pair configuration, the latest Seq of the key-value pair needs to be passed back to the backend, which then checks whether the key-value pair has been modified by others. If the Seq does not match the key-value pair, the configuration fails, and an error code is returned. The backend does not verify the Seq when the API is called by an app admin.

Sample response

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"ExtensionList": [
{
"ErrorCode": 0,
"Extension": {
"Key": "key1",
"Value": "value1",
"Seq": 1
}
},
{
"ErrorCode": 23001,
"Extension": {
"Key": "key2",
"Value": "value1234",
"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
Message extension configuration 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 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 Premium edition plan request.
23001
Seq conflict: The key-value setting has been modified by others. You need to pull the latest Seq to request again.
23002
The configured group message does not support message extension.
23003
Too many key-value setting attempts (more than 200 attempts per minute per message)
23004
The configured group message does not exist.