フローの一覧を取得します。
操作説明
-
この操作を呼び出してフローをクエリするか、Flow Builder コンソールでフローを手動でクエリできます。
-
この操作を呼び出す前に、フローが正常に作成されていることを確認してください。
-
正常に作成されたフローがない場合は、Flow Builder コンソールでフローを手動で作成するか、 CreateChatFlow 操作を呼び出してフローを作成してください。
-
この操作のオプションパラメーターは、フローをクエリするためのフィルター条件です。これらのパラメーターを指定しない場合、すべてのフローが返されます。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:ListChatFlow |
list |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Status |
string |
任意 |
フローのステータス。デフォルト値: NORMAL。 列挙値:
|
NORMAL |
| PageNo |
integer |
任意 |
ページ番号。 |
1 |
| PageSize |
integer |
任意 |
1 ページあたりのエントリ数。 |
20 |
| FlowTriggerType |
string |
任意 |
フローのトリガータイプ。有効な値:
列挙値:
|
TriggeredByWhatsApp |
| ReturnWithOnlineVersion |
boolean |
任意 |
オンラインステータスを返すかどうかを指定します。有効な値:
|
true |
| Keyword |
string |
任意 |
検索キーワード。このパラメーターは、フロー名のあいまい一致に使用されます。 |
LLM |
| BizCode |
string |
任意 |
ビジネステナントコード。デフォルト値: ALICOM_OPAAS。 列挙値:
|
ALICOM_OPAAS |
| BizExtend |
object |
任意 |
ビジネス拡張情報。デフォルト値: 空のコレクション。 |
{} |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| Response |
object |
応答データ。 |
|
| AccessDeniedDetail |
string |
アクセス拒否の詳細。 |
None |
| RequestId |
string |
リクエスト ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Message |
string |
エラーメッセージ。 |
None |
| Code |
string |
エラーコード。詳細については、「エラーコード」をご参照ください。 |
OK |
| Success |
boolean |
操作が成功したかどうかを示します。有効な値:
|
true |
例
成功レスポンス
JSONJSON
{
"Response": {
"test": "test",
"test2": 1
},
"AccessDeniedDetail": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Message": "None",
"Code": "OK",
"Success": true
}
エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。