Bot を含むトークルーム作成

    Bot からメンバーを招待してトークルームを作成します。

    トークルーム作成に成功するとトークルーム ID を取得できます。
    トークルーム ID は、同じトークルームにメッセージを送信したり、トークルームの参加メンバーリストを照会する際に使用します。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    POST (Content-Type: application/json; charset=UTF-8)

    Path Parameters

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

    Request

    パラメーター タイプ 必須 説明
    accountIds array Y 招待するメンバーリスト
    title string N トークルーム名
    最大 1,000 字

    Request Example

    simple

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/room
    {
      "accountIds": ["user1@example.com", "user2@example.com"]
    }
    
    detail
    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123/room
    {
      "accountIds": ["user1@example.com", "user2@example.com"],
      "title": "my title"
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードと作成されたトークルーム ID を返します。

    プロパティ タイプ 説明
    roomId string 作成されたトークルーム ID

    Response Example

    
    {
      "roomId": "12345"
    }
    

    Error Code

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