IM グループのメンバーを一覧表示します。
操作説明
-
この操作を呼び出す前に、招待リンクを持つ IM グループを作成し、メンバーがそのリンクを使用して参加済みであることを確認してください。
-
IM グループを作成して招待リンクを追加するには、AddChatGroup API と AddChatGroupInviteLink API を呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:ListChatGroupParticipants |
list |
*すべてのリソース
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| BusinessNumber |
文字列 |
必須 |
ビジネス番号。ListChatGroup API を呼び出してビジネス番号を取得できます。 |
8613800*** |
| ChannelType |
文字列 |
任意 |
チャネルタイプ。有効な値:
説明
この操作は WhatsApp チャネルのみをサポートします。 |
|
| GroupId |
文字列 |
必須 |
グループ ID。ListChatGroup API を呼び出してグループ ID を取得できます。 |
EA939**** |
| CustSpaceId |
文字列 |
必須 |
直接の顧客向けのインスタンス ID、または ISV サブ顧客向けの SpaceId です。ID は [Channel Management] ページで確認できます。 |
cams-k*** |
| Page |
object |
任意 |
ページング情報。 |
|
| Size |
integer |
任意 |
ページサイズ。 |
20 |
| Index |
integer |
任意 |
ページ番号。 |
1 |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| AccessDeniedDetail |
文字列 |
アクセス拒否の詳細。 |
None |
| Message |
文字列 |
エラーメッセージ。 |
None |
| RequestId |
文字列 |
リクエスト ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Data |
object |
レスポンスデータ。 |
|
| Total |
integer |
参加者の総数。 |
8 |
| List |
配列<object> |
グループメンバーのリスト。 |
|
|
object |
グループメンバーに関する情報。 |
||
| ParticipantNumber |
文字列 |
グループメンバーの電話番号。 |
861382*** |
| Code |
文字列 |
リクエストのステータスコード。有効な値:
|
OK |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSON 形式 JSON
{
"AccessDeniedDetail": "None",
"Message": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Data": {
"Total": 8,
"List": [
{
"ParticipantNumber": "861382***"
}
]
},
"Code": "OK",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。