Bot トークルームのメンバーリスト照会

    Bot が参加しているトークルームのメンバーリストを照会します。

    メンバーリストは一度に最大 100 名まで取得できます。
    参加メンバーが 100 名を超える場合には、 Response に含まれる totalPage の値を参考に pages パラメータを変更して 101 名以降のメンバーリストを取得してください。

    API の種類

    サーバー API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/room/{roomId}/accounts

    HTTP Method

    GET

    Path Parameters

    パラメーター 必須 説明
    botNo Y トーク Bot 番号
    roomId Y トークルーム ID

    Query Parameters

    パラメーター 必須 説明
    page N ページ番号
    1回のリクエストで全メンバーを読み込めない場合に使用

    Request Example

    simple

    
    GET https://apis.worksmobile.com/r/apiid/message/v1/bot
    
    detail
    
    GET https://apis.worksmobile.com/r/apiid/message/v1/bot?page=2
    

    Response

    呼び出しに成功すると HTTP 200 コードとメンバーリスト、総ページ数を返します。

    プロパティ タイプ 説明
    accountIds array メンバーリスト
    totalPage number 総ページ数

    Response Example

    
    {
      "accountIds": ["user1@example.com", "user2@example.com"]
    }
    

    Error Code

    呼び出しに失敗するとエラーコードとエラーメッセージを返します。
    エラーコードはトーク Bot REST API エラーコードを参照してください。