トーク Bot 詳細情報の照会

    トーク Bot の詳細情報を照会します。

    API の種類

    サーバー API

    Request URL

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

    HTTP Method

    GET

    Path Parameters

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

    Request Example

    
    POST https://apis.worksmobile.com/r/apiid/message/v1/bot/123
    

    Response

    呼び出しに成功するとHTTP 200 とトーク Bot 詳細情報を返します。

    プロパティ タイプ 説明
    name string トーク Bot 名
    i18nNames[] array 多言語名のリスト
    i18nNames[].language string 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nNames[].name string 各言語のトーク Bot 名
    photoUrl string トーク Bot プロフィール画像の URL
    i18nPhotoUrls[] array 各言語でのプロフィール画像リスト (URL)
    i18nPhotoUrls[].language string 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nPhotoUrls[].photoUrl string 画像の URL
    description string トーク Bot の説明
    i18nDescriptions[] array 多言語でのトーク Bot の説明リスト
    i18nDescriptions[].language string 言語コード
    ●ja_JP
    ●ko_KR
    ●zh_CN
    ●zh_TW
    ●en_US
    i18nDescriptions[].description string 説明
    createdTime number トーク Bot が登録された日時。Unix time で表示 (単位: msec)
    modifiedTime number トーク Bot が修正された日時。Unix time で表示 (単位: msec)
    managers array トーク Bot 担当者の LINE WORKS アカウント
    submanagers array トーク Bot 副担当者の LINE WORKS アカウント
    domainInfos array 利用可能なドメインリスト
    domainInfos[].domainId number ドメイン ID
    domainInfos[].usePublic boolean Bot リストへの公開
    ● true: 公開
    ● false: 非公開
    domainInfos[].usePermission boolean Bot の利用権限
    ● true: メンバー指定
    ● false: すべて
    domainInfos[].accountIds array (usePermission が true の場合のみ) メンバーリスト
    useGroupJoin boolean トークルームへの招待形式
    ● true: 複数人のトークルームに招待可
    ● false: 1:1 トークのみ
    useDomainScope boolean トーク Bot の利用範囲
    ● true: 指定ドメインのみ 
    ● false: 全ドメイン
    domainIds array (useDomainScope が true の場合のみ)ドメインリスト
    useCallback boolean callbackの利用
    ● true: On
    ● false: Off
    callbackUrl string (useCallback が true の場合にのみ) メッセージ受信サーバーの URL
    callbackEvents array メンバーが送信可能なメッセージタイプ
    ● "text": テキスト
    ● "location": メンバーの位置情報
    ● "sticker": スタンプ
    ● "image": 画像
    ● "file": ファイル

    Response Example

    
    {
      "name": "echo bot",
      "photoUrl": "https://developers.worksmobile.com/favicon.png",
      "description": "WorksMobile's A.I. conversation enabled bot",
      "callbackUrl": "https://xxx",
      "callbackEvents": ["text", "location", "sticker", "image"],
      "tenantId": 123123,
      "createdTime": 1464693120000,
      "modifiedTime": 1464694324000,
      "managers": ["manager@example.com", "manager2@example.com"],
      "submanagers": ["submanager@example.com"],
      "domainInfos": [{
        "domainId": 123,
        "usePublic": true,
        "usePermission": false
      },{
        "domainId": 456,
        "usePublic": true,
        "usePermission": true,
        "accountIds": ["manager@example.com"]
      }],
      "useGroupJoin": true,
      "useDomainScope": false,
      "useCallback": true,
      "callbackUrl": "https://xxx",
      "callbackEvents": ["text", "location", "sticker", "image", "file"]
    }
    

    Error Code

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