サーバー API

Secure authentication with UserSig
RESTful インターフェース
- RESTful APIの概要
- RESTful APIリスト
- メッセージ関連
  - メッセージ送信
    - 単一ユーザーへのシングルチャットメッセージの送信
    - 複数のユーザーへのシングルチャットメッセージの送信
    - グループ内で一般的なメッセージを送信
    - グループでシステムメッセージを送信
    - ライブブロードキャストグループのブロードキャストメッセージ
    - シングルメッセージのインポート
    - グループメッセージのインポート
  - 過去のメッセージ
    - 過去のシングルチャットメッセージの変更
    - 過去のグルップチャットメッセージの変更
    - 過去のシングルチャットメッセージの取得
    - 過去のグルップチャットメッセージの取得
  - メッセージ削除
    - 指定されたユーザーが送信したメッセージを削除
  - メッセージの取り消し
    - シングルチャットメッセージの取り消し
    - グループメッセージの取り消し
  - 既読レシート
    - シングルチャットメッセージを既読に設定
    - グループメッセージの既読レシート詳細の取得
    - グループメッセージの既読レシートの取得
  - メッセージ拡張
    - シングルチャットメッセージ拡張の取得
    - シングルチャットメッセージ拡張の設定
    - グループメッセージ拡張の取得
    - グループメッセージ拡張の設定
  - すべてのユーザーにプッシュします
    - 全員プッシュインタフェース
    - すべてのユーザーにプッシュします
    - アプリケーションプロパティ名の設定
    - アプリケーションプロパティ名の取得
    - ユーザープロパティの取得
    - ユーザープロパティの設定
    - ユーザープロパティの削除
    - ユーザーフラグの取得
    - ユーザーフラグの追加
    - ユーザーフラグの削除
    - ユーザーのすべてのフラグを削除
- セッション関連
  - セッションリスト
    - セッションリストの取得
  - 未読セッション数
    - メンバーの未読メッセージ数の設定
    - 未読シングルチャットメッセージ数を照会
  - セッションの削除
    - セッションの削除
  - セッショングループフラグ
    - セッショングループデータの作成
    - セッショングループデータの更新
    - セッショングループデータの削除
    - セッションフラグデータの作成・更新
    - セッショングループフラグの検索
    - セッショングループマークデータの取得
- グループ関連
  - グループ管理
    - アプリケーション内のすべてのグループを取得
    - グループの作成
    - グループの解散
    - ユーザーが参加しているグループを取得します
  - グループプロファイル
    - グループプロファイルの取得
    - グループプロファイルの変更
    - グループプロファイルのインポート
  - グループメンバーの管理
    - グループメンバーの追加
    - グループメンバーの削除
    - グループメンバーのブロック
    - グループメンバーのブロック解除
    - 一括発言禁止と発言禁止の解除
    - 発言を禁止されているグループメンバーのリストを取得
    - グループオーナーの変更
    - グループ内のユーザーの身分を照会
    - グループメンバーのインポート
  - グループメンバーの情報
    - グループメンバープロファイルの取得
    - グループメンバープロファイルの変更
    - Getting Specified Group Member Profiles
  - グループのカスタムプロパティ
    - グループのカスタムプロパティの取得
    - グループのカスタムプロパティの変更
    - グループのカスタムプロパティをクリアします
    - グループのカスタムプロパティをリセットします
    - グループのカスタムプロパティを削除します
  - ライブブロードキャストグループ管理
    - ライブブロードキャストグループのオンライン人数の取得
    - ライブブロードキャストグループメンバーのリストを取得
    - ライブブロードキャストグループメンバーのフラグ設定
    - ブロックされているグループメンバーのリストを取得
  - コミュニティ管理
    - トピックの作成
    - トピックの削除
    - トピックプロファイルの取得
    - トピックプロファイルの変更
    - トピック資料のインポート
  - グループカウンター
    - グループカウンターの取得
    - グループカウンターの更新
    - グループカウンターの削除
- ユーザー管理
  - アカウント管理
    - シングルアカウントのインポート
    - 複数アカウントのインポート
    - アカウント削除
    - アカウントの検索
  - ユーザー情報
    - プロファイルの設定
    - プロファイルの取得
  - ユーザー状態
    - アカウントのログイン状態が無効になりました。
    - アカウントのオンライン状態の確認
  - 友達管理
    - 友達の追加
    - 友達のインポート
    - 友達の更新
    - 友達の削除
    - すべての友達を削除
    - 友達の検証
    - 友達の取得
    - 指定友達の取得
  - 友達リスト
    - リストを追加
    - リストの削除
    - リストの取得
  - ブラックリスト
    - ユーザーをブラックリストに追加します
    - ユーザーをブラックリストから削除
    - ブラックリストの取得
    - ブラックリスト内のユーザーの検証
- 全員発言禁止の管理
  - 全員発言禁止の設定
  - 全員発言禁止の照会
- メンテナンス管理
  - メンテナンスデータの取得
  - 最新メッセージのダウンロード
  - サーバー IP アドレスの取得
- スマートロボット
  - スマートロボットのアカウントを取得
  - スマートロボットのアカウントを作成
  - スマートロボットのアカウントを削除
- All/Tagged Push
  - Pushing to All/Tagged Users
  - Obtaining Application Attribute Names
  - Setting Application Attribute Names
  - Obtaining User Attributes
  - Setting User Attributes
  - Deleting User Attributes
  - Obtaining User Tags
  - Adding User Tags
  - Deleting User Tags
  - Deleting All User Tags
  - Recalling Push
サーバーコールバック
- コールバックの概要
- コールバックコマンドリスト
- メンテナンス管理コールバック
  - インターフェースオーバークロックアラームコールバック
- オンライン状態のコールバック
  - 状態変更コールバック
- リレーションシップチェーンコールバック
  - プロファイル更新後
  - 友達を追加する前
  - 友達追加に応答する前
  - 友達を追加した後
  - 友達を削除した後
  - ユーザーをブラックリストに追加した後
  - ユーザーをブラックリストから削除した後
- シングルメッセージのコールバック
  - シングルチャットメッセージを送信する前
  - シングルチャットメッセージを送信した後
  - シングルチャットメッセージを既読に設定した後
  - シングルチャットメッセージを取り消した後
- グループコールバック
  - グループを作成する前
  - グループ作成後
  - グループ加入を申し込む前
  - グループに追加する前
  - ユーザーがグループに参加した後
  - メンバーがグループから退出した後
  - グループメッセージを送信する前
  - グループメッセージを送信した後
  - グループが満員になった後
  - グループ解散後
  - グループプロファイル変更後
  - グループメッセージ取り消し後のコールバック
  - ライブブロードキャストグループメンバーのオンライン・オフライン状態のコールバック
  - グループメッセージ送信異常のコールバック
  - トピックを作成する前
  - トピックを作成した後
  - トピック削除後
  - トピック情報変更コールバック
  - グループメンバープロファイル変更後のコールバック
  - グループプロパティ変更後のコールバック
  - 既読レシートの後のコールバック
  - グループオーナー変更後のコールバック
  - Group Creation Daily Net Increase Threshold Alarm Callback
- ロボット関連のコールバック
  - シングルチャットロボットメッセージコールバック
  - グループ内の @robot の後のコールバック

このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

グループのカスタムプロパティをクリアします

Feature Overview
 This API is used by the app admin to clear custom group attributes.
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
Yes
Community
No
These are the preset group types in Chat. For more information, see Group System.
Sample request URL
https://xxxxxx/v4/group_open_http_svc/clear_group_attr?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/group_open_http_svc/clear_group_attr
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
Clear the custom attributes of a group:
{
    "GroupId": "@TGS#aC5SZEAEF"
}
Request fields
Field
Type
Required
Description
GroupId
String
Yes
ID of the group whose custom attributes are to be cleared
Sample response
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode":0
}
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
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.
10007
No operation permissions. This error occurs when, for example, a group of this type does not support custom attribute operations.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Check whether the group ID is entered correctly and whether the group exists.
10045
The size of the custom attribute key exceeds the limit of 32 bytes.
10046
The size of the custom attribute value exceeds the limit of 4000 bytes.
10047
The number of custom attribute keys exceeds the limit of 16.
10048
The total size of custom attribute values exceeds the limit of 16000 bytes.
10049
The frequency of writing custom attributes to a group exceeds the limit. You can add, delete, or modify them for up to 5 times per second.

Feature Overview
API Calling Description
Error Codes

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	Yes
Community	No

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/group_open_http_svc/clear_group_attr	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`.

Field	Type	Required	Description
GroupId	String	Yes	ID of the group whose custom attributes are to be cleared

Error Code	Description
10002	Internal server error. Try again.
10004	Invalid parameter. Check the error description and troubleshoot the issue.
10007	No operation permissions. This error occurs when, for example, a group of this type does not support custom attribute operations.
10010	The group does not exist or has been deleted.
10015	Invalid group ID. Check whether the group ID is entered correctly and whether the group exists.
10045	The size of the custom attribute key exceeds the limit of 32 bytes.
10046	The size of the custom attribute value exceeds the limit of 4000 bytes.
10047	The number of custom attribute keys exceeds the limit of 16.
10048	The total size of custom attribute values exceeds the limit of 16000 bytes.
10049	The frequency of writing custom attributes to a group exceeds the limit. You can add, delete, or modify them for up to 5 times per second.

グループのカスタムプロパティをクリアします

Feature Overview

API Calling Description

Applicable group types

Sample request URL

Request parameters

Maximum call frequency

Sample request

Request fields

Sample response

Response fields

Error Codes

コミュニティに質問

グループでサポートを得る