ロボット一覧取得API

この記事の内容
  1. ロボット一覧の取得
  2. 事前操作
  3. リクエスト
  4. リクエストヘッダー
  5. リクエストパラメータ
  6. レスポンス
  7. レスポンスデータ構造
  8. レスポンスデータの例
  9. 使用例
  10. curlの例

ロボット一覧の取得

api.example.com、console.example.com、files.example.com は説明用のアドレスです。実際の環境で指定された API、管理画面、ファイル配布先の URL に置き換えてください。

このインターフェースは、ロボット一覧をページごとに取得するために使用します。

事前操作

  1. 認証インターフェースを使用してaccessTokenを取得します。

リクエスト

基本 パラメータ値 説明
HTTP URL https://api.example.com/oapi/app/open/query/list
HTTP Method POST

リクエストヘッダー

基本 パラメータ値 説明
Authorization Bearer {accessToken} {accessToken}変数は、認証インターフェースが返すaccess Tokenに置き換える必要があります

リクエストパラメータ

名称 タイプ 必須かどうか 説明
appId String いいえ ロボットID
size String いいえ 1ページあたりの件数。デフォルトは30、最大100です
page String いいえ ページ番号。デフォルトは1です
ownerUserSearchKey String いいえ ユーザー検索キーワード。アカウントの完全一致のみをサポートします
appName String いいえ ロボット名のあいまい一致

レスポンス

レスポンスデータ構造

名称 タイプ 説明
data object 結果データ
|─ ownerName string ロボット所有者の名称
|─ ownerAccount string ロボット所有者のアカウント
|─ ownerId string 所有者のid
|─ appId string appid
|─ appName string ロボット名
|─ appTypeName string ロボットタイプ名
|─ appType string ロボットタイプの列挙値。app:ロボット、activity:コマンド
|─ createTime string 作成日時
|─ updateTime string 変更日時
|─ version string バージョン。値の内容:未リリース、バージョン
|─ supportParam boolean ロボットパラメータをサポートするかどうか
|─ icon string アイコン画像のダウンロードアドレス
page object ページ分割情報
|─ total integer 総件数
|─ size integer 1ページあたりの件数
|─ page integer 現在のページ
|─ pages integer 総ページ数
|─ offset integer オフセット
|─ sortColumn string¦ 並べ替えに使用するcolumnの名称
|─ order string¦ 並べ替え方法 desc/asc。デフォルトでは降順で並べ替えます
code integer 戻り値の結果コード
200は成功、その他は失敗を示します
success boolean 呼び出しが成功したかどうか。このフィールドでインターフェースの呼び出しが成功したかどうかを判断できます
requestId string リクエストid。問題の調査に使用します
serverIp string 処理を行うサービスのIP
serverInstName string 処理を行うサービスのインスタンス名
msg string ステータスコードの説明

レスポンスデータの例

{
  "data": [
    {
      "ownerName": "测试",
      "ownerAccount": "ceshi2@csqy1",
      "ownerId": "c8d9647f-1435-4b5f-bd64-b5d4613e5283",
      "appId": "107f0f23-3584-4b1b-8665-443605722f95",
      "appName": "kkkkk",
      "appTypeName": "应用",
      "appType": "app",
      "createTime": "2024-05-08 13:49:13",
      "updateTime": "2024-05-08 13:50:24",
      "version": "1",
      "supportParam": false,
      "icon": ""
    }
  ],
  "page": {
    "total": 1,
    "size": 30,
    "page": 1,
    "pages": 30,
    "offset": 0,
    "order": "desc"
  },
  "code": 200,
  "success": true,
  "requestId": "2f296259-d953-4939-9701-bc28ac43e002"
}

使用例

curlの例

curl --location --request POST 'https://api.example.com/oapi/app/open/query/list' \ --header 'Authorization: Bearer 2eed910f-6ade-4e0c-9007-0feade4f5df6' \ \ --header 'Content-Type: application/json' \ --header 'Accept: */*' \ --header 'Host: api.example.com' \ --header 'Connection: keep-alive' \ --data-raw '{ "appId": "string", "size": "30", "page": "1", "ownerUserSearchKey": "string", "appName": "string" }'
OpenAPIの記事一覧ページの先頭へ ↑