GET/bots/{botId}

Bot を取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

bot
bot.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/bots/{botId}

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
botId integer 

Bot ID


format : int64
readOnly : true 
botName string 

Bot 名


required
maxLength : 100 
photoUrl string 

Bot プロフィール画像の URL (PNG 形式, 640×640 サイズを推奨, HTTPS のみ可能)


required
maxLength : 1000 
description string 

Bot の説明


required
maxLength : 100 
administrators array (string) 

Bot 担当者のユーザー ID リスト


required
minItems : 1
maxItems : 3
uniqueItems : true 
subadministrators array (string) 

Bot 副担当者のユーザー ID リスト


minItems : 0
maxItems : 3
uniqueItems : true 
allowDomains array (integer) 

Bot が使用可能なドメインリスト


minItems : 0
uniqueItems : true 
enableCallback boolean 

Callback URL の利用フラグ


default : false 
channelEvents array (string) 

Callback 受信するトークルームイベントタイプ

  • message: メッセージ
  • join: 複数人トークルームに招待
  • leave: 複数人トークルームから退室
  • joined: メンバーが複数人トークルームに参加
  • left: メンバーが複数人トークルームに退室
  • postback: ポストバックアクション
  • begin: 1:1 トークルームに参加
  • end: 1:1 トークルームから退室

default : message,join,leave,joined,left,postback
minItems : 0
uniqueItems : true 
callbackEvents array (string) 

ユーザーが送信可能なメッセージタイプ

  • text : テキスト
  • location : ユーザーの位置情報
  • sticker : スタンプ
  • image : 画像
  • file : ファイル
  • audio : 音声
  • video : ビデオ

minItems : 0
uniqueItems : true 
callbackUrl string 

メッセージ受信サーバーの URL(HTTPS のみ)


maxLength : 1000 
enableGroupJoin boolean 

トークルームへの招待形式

  • true : 1:N トークルームに招待できる
  • false : 1:1 トークでのみ利用できる

default : false 
defaultRichmenuId string 

デフォルトリッチメニュー ID

 
i18nBotNames array (i18nBotNames) 

Bot の多国語名リスト


minItems : 0 
i18nDescriptions array (i18nDescriptions) 

Bot の多国語説明リスト


minItems : 0 
i18nPhotoUrls array (i18nPhotoUrls) 

Bot の多国語画像リスト


minItems : 0 
createdTime string 

Bot の作成日時 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 
modifiedTime string 

Bot の更新日時 (YYYY-MM-DDThh:mm:ssTZD)


format : date-time
readOnly : true 

i18nBotNames

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
botName string 

Bot名


required
maxLength : 100 

i18nDescriptions

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
description string 

Bot の説明


required
maxLength : 100 

i18nPhotoUrls

PropertyTypeDescription
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 
photoUrl string 

Bot のプロフィール画像が保存された URL


required
maxLength : 1000 

Response Example

example

1{2  "botId": 2000001,3  "botName": "Example bot",4  "photoUrl": "https://example.com/favicon.png",5  "description": "WorksMobile's A.I. conversation enabled bot",6  "administrators": [7    "d191e339-3299-44e6-7a44-04d9cb01a5e0"8  ],9  "subadministrators": [10    "e417a131-a56d-44a4-5304-033e16fca8d1"11  ],12  "allowDomains": [13    1000000114  ],15  "enableCallback": true,16  "channelEvents": [17    "message",18    "join",19    "leave",20    "joined",21    "left",22    "postback",23    "begin",24    "end"25  ],26  "callbackEvents": [27    "text",28    "location",29    "sticker",30    "image",31    "file",32    "audio",33    "video"34  ],35  "callbackUrl": "https://example.com/callback",36  "createdTime": "2022-08-08T01:12:05+09:00",37  "modifiedTime": "2022-08-09T01:12:05+09:00",38  "enableGroupJoin": true,39  "defaultRichmenuId": "40001",40  "i18nBotNames": [41    {42      "language": "en_US",43      "botName": "Example bot"44    }45  ],46  "i18nDescriptions": [47    {48      "language": "en_US",49      "description": "Example description"50    }51  ],52  "i18nPhotoUrls": [53    {54      "language": "en_US",55      "photoUrl": "https://example.com/favicon.png"56    }57  ]58}