トーク Bot ドメイン公開設定の修正

    トーク Bot のドメイン設定を修正します。
    この API の利用は、事前に トーク Bot のドメイン登録 API でドメイン登録を完了していることが前提となります。

    注意

    • メンバー指定は最大 150 名まで登録できます。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

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

    Path Parameters

    パラメーター 必須 説明
    botNo Y トーク Bot 番号
    domainId Y ドメイン ID

    Request

    パラメーター タイプ 必須 説明
    usePublic boolean N Bot リストへの公開
    ● true: 公開
    ● false: 非公開 (既定)
    usePermission boolean N Bot の利用権限
    ● true: メンバー指定
    ● false: すべて (既定)
    accountIds array N usePermission が true の場合、メンバーリスト

    Request Example

    simple

    
    PUT https://apis.worksmobile.com/r/apiid/message/v1/bot/123/domain/456
    
    detail
    
    PUT https://apis.worksmobile.com/r/apiid/message/v1/bot/123/domain/456
    {
      "usePublic": true,
      "usePermission": true,
      "accountIds": ["manager@example.com"]
    }
    

    Response

    呼び出しに成功すると HTTP 200 コードを返します。

    Error Code

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