- 製品の説明
- 購入ガイド
- ダウンロードセンター
- シナリオプラン
- クライアントAPIs
- サービス側 APIs
- UserSigの生成
- RESTful APIs
- RESTful API Overview
- REST APIAPIインターフェースリスト
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- グループ作成前のコールバック
- グループ作成後のコールバック
- グループへの参加の申請前のコールバック
- グループへのメンバー招待前のコールバック
- 新しいメンバーによるグループ参加後のコールバック
- グループメンバーが離れた後にコールバックする
- グループ内発言前のコールバック
- グループ内発言後のコールバック
- グループ満員後のコールバック
- グループ解散後のコールバック
- グループ情報変更後のコールバック
- グループメッセージ撤回後のコールバック
- Webhook for Online and Offline Status of Audio-Video Group Members
- グループメッセージを送信した場合の異常系コールバック
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- コンソールガイド
- よくあるご質問
- 一般的なリファレンス
- IM ポリシー
- エラーコード
- お問い合わせ
- 製品の説明
- 購入ガイド
- ダウンロードセンター
- シナリオプラン
- クライアントAPIs
- サービス側 APIs
- UserSigの生成
- RESTful APIs
- RESTful API Overview
- REST APIAPIインターフェースリスト
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- グループ作成前のコールバック
- グループ作成後のコールバック
- グループへの参加の申請前のコールバック
- グループへのメンバー招待前のコールバック
- 新しいメンバーによるグループ参加後のコールバック
- グループメンバーが離れた後にコールバックする
- グループ内発言前のコールバック
- グループ内発言後のコールバック
- グループ満員後のコールバック
- グループ解散後のコールバック
- グループ情報変更後のコールバック
- グループメッセージ撤回後のコールバック
- Webhook for Online and Offline Status of Audio-Video Group Members
- グループメッセージを送信した場合の異常系コールバック
- Before a Topic Is Created
- After a Topic Is Created
- After a Topic Is Deleted
- Topic Profile Change Webhook
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- コンソールガイド
- よくあるご質問
- 一般的なリファレンス
- IM ポリシー
- エラーコード
- お問い合わせ
機能説明
アプリのバックグラウンドでは、このコールバックを介してグループメンバーが他のユーザーをグループに招待するリクエストをリアルタイムで確認できます。アプリのバックグラウンドで、グループメンバーが他のユーザーをグループに直接招待するリクエストをブロックすることも可能です。
注意事項
コールバックを有効にするには、コールバックURLを設定し、このコールバックプロトコルに対応するスイッチをオンにする必要があります。設定方法の詳細については、サードパーティコールバックの設定ドキュメントをご参照ください。
コールバックの方向は、IMバックグラウンドからアプリバックグラウンドへHTTP POSTリクエストを送信するようになっています。
アプリのバックグラウンドがコールバックリクエストを受信した後、リクエストURLのパラメータSDKAppIDが自分のSDKAppIDであるかどうかを確認する必要があります。
その他のセキュリティ関連事項については、サードパーティコールバックの概要：セキュリティに関する考慮事項ドキュメントをご参照ください。
このコールバックをトリガーする可能性のあるシナリオ
アプリユーザーがクライアントで他のユーザーをグループに招待するリクエストを送信した場合。
アプリ管理者がREST APIでユーザーをグループに追加した場合。
コールバックの発生時間
IMバックグラウンドがターゲットユーザーをグループに追加する前（リレーションシップチェーンホスティングが存在し、アプリがIMでフレンドシップ検証を設定している場合、コールバックがフレンドシップ検証の承認後に発生します）。
インターフェースの説明
リクエストURLの例
以下の例のアプリ設定のコールバックURLは
https://www.example.comです。
例：https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
リクエストパラメータの説明
パラメータ | 説明 |
https | リクエストプロトコルはHTTPS、リクエストメソッドはPOSTです |
www.example.com | コールバックURL |
SdkAppid | アプリケーションの作成時にIMコンソールで割り当てられたSDKAppID |
CallbackCommand | Group.CallbackBeforeInviteJoinGroupという固定値が適用されます |
contenttype | JSONという固定値が適用されます |
ClientIP | クライアントIP。形式の例：127.0.0.1 |
OptPlatform |
リクエストパケットの例
{"CallbackCommand": "Group.CallbackBeforeInviteJoinGroup","GroupId": "@TGS#2J4SZEAEL","Type": "Public","Operator_Account": "leckie","DestinationMembers": [{"Member_Account": "jared"},{"Member_Account": "leckie"}],"EventTime":"1670574414123"//ミリ秒レベル、イベントのトリガータイムスタンプ}
リクエストパケットフィールドの説明
フィールド | タイプ | 説明 |
CallbackCommand | String | コールバックコマンド |
GroupId | String | 他のユーザーを追加するループID |
Type | String | |
Operator_Account | String | リクエスト操作者のUserID |
DestinationMembers | Array | グループに招待するUserIDの集合 |
EventTime | Integer | イベントがトリガーされるミリ秒レベルのタイムスタンプ |
レスポンスパケットの例
ユーザー全員のグループ参加の許可
アプリのバックグラウンドで、すべてのリクエストに関連するすべてのユーザーのグループ参加を許可します。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0 // グループへの参加リクエストの処理の続行を許可することを示す}
一部のメンバーのグループ参加のブロック
アプリのバックグラウンドで一部のユーザーをグループに招待するリクエストを拒否し、RefusedMembers_AccountでこれらのIdentifierを返します。
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"RefusedMembers_Account": [ // 参加を拒否したユーザーのリスト"jared"]}
レスポンスパケットフィールドの説明
フィールド | タイプ | 属性 | 説明 |
ActionStatus | String | 必須 | リクエスト処理の結果。OKは処理に成功したことを意味し、FAILは失敗したことを意味します |
ErrorCode | Integer | 必須 | エラーコード。0はグループへの参加リクエストの処理の続行を許可することを示します。1はそのリクエストを拒否することを示します。サービスニーズに応じて、エラーコードを指定してユーザーのグループへの参加を拒否する必要がある場合は、エラーコード「ErrorCode」と「ErrorInfo」をクライアントに送信し、エラーコード「ErrorCode」を[10100,10200]の範囲内にある値に設定してください |
ErrorInfo | String | 必須 | エラー情報 |
RefusedMembers_Account | Array | 任意 | 参加を拒否したユーザーIDの集合 |
参照情報
REST API：グループメンバーの追加
はい
いいえ
この記事はお役に立ちましたか？