샘플 봇을 설치합니다.
이 API를 사용하려면 봇 정의 아래에 있는 봇 생성의 관리자 앱 범위가 필요합니다.
POST https://{{host}}/api/public/samplebots/{{botId}}/add
경로 매개 변수
| 매개 변수 | 필수/선택 사항 | 설명 |
|---|---|---|
| host | 필수 | 환경 URL(예: https://bots.kore.ai) |
| BotID | 필수 | 봇 ID 또는 스트림 ID. 봇의 일반 설정 페이지에서 이를 액세스할 수 있습니다. |
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다:
auth: {{JWT}}
AccountId: {{accountId}}
userId: {{userId}}
bot-language : en
콘텐츠 유형 응답
application/json
샘플 요청
curl -X POST \
'https://{{host}}/api/public/samplebots/{{bot_id}}/add' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json' \
-H 'AccountId: xexxbaxxxbxbxxxxxxxxcxfb' \
-H 'userId: u-fbxxfxxx-axfd-xfcx-abxx-xcxxxxaxexxx' \
-H 'bot-language: en
'
샘플 응답
{
"visibility": {
"namespace": "private",
"namespaceIds": [
"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660"
]
},
"languages": [],
"screenShots": [],
"downloadCount": 0,
"alerts": [
"l-be9b69b5-dbae-55f1-8499-c0b3db74602c"
],
"actions": [],
"dialogs": [
"dg-cbf01287-c284-5fb9-8686-b21c0b54cba6",
"dg-353f3abc-b307-58c2-b0aa-0b1e02635017"
],
"widgets": [],
"panels": [],
"forms": [],
"categoryIds": [
"451902a073c071463e2ce7c6"
],
"class": [],
"featured": false,
"profileRequired": true,
"sendVcf": false,
"isNLEnabled": true,
"interruptsEnabled": true,
"state": "setup",
"defaultLanguage": "en",
"_id": "st-cf8323be-e50e-5dd3-8870-2c8482e4bc2e",
"modifiedOn": "2021-01-12T10:55:11.551Z",
"sBannerColor": "#E44929",
"bBannerColor": "#E44929",
"createdOn": "2021-01-12T10:55:11.115Z",
"createdBy": "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660",
"lastModifiedBy": "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660",
"accountId": "5e81ba854b3b29780134c7fb",
"sharedBy": [],
"__v": 0,
"name": "Asana Sample_botowner@koreai.in_34",
"keywords": [],
"originalName": "Asana Sample",
"icon": "58f49848a8429af87912c7f1",
"color": "#E44929"
}
サンプルボットをインストールします。
このAPIを使用するために、[ボット定義] の [ボットの作成] の管理アプリスコープを必要とします。
ポスト https://{{host}}/api/public/samplebots/{{botId}}/add
パスパラメータ
| パラメータ | 必須/任意 | 説明 |
|---|---|---|
| ホスト | 必須 | 環境URL（例： https://bots.kore.ai） |
| BotID） | 必須 | ボットIDまたはストリームID。ボットの [一般設定] ページからアクセスすることができます。 |
認証
以下の構文を使用して、JWTをヘッダーに含むAPIを呼び出します。
auth: {{JWT}}
AccountId: {{accountId}}
userId: {{userId}}
bot-language : en
応答のコンテンツタイプ
application/json
サンプルリクエスト
curl -X POST \ 'https://{{host}}/api/public/samplebots/{{bot_id}}/add' \ -H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ -H 'content-type: application/json' \ -H 'AccountId: xexxbaxxxbxbxxxxxxxxcxfb' \ -H 'userId: u-fbxxfxxx-axfd-xfcx-abxx-xcxxxxaxexxx' \ -H 'bot-language: en '
サンプル応答
{ "visibility": { "namespace": "private", "namespaceIds": [ "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660" ] }, "languages": [], "screenShots": [], "downloadCount": 0, "alerts": [ "l-be9b69b5-dbae-55f1-8499-c0b3db74602c" ], "actions": [], "dialogs": [ "dg-cbf01287-c284-5fb9-8686-b21c0b54cba6", "dg-353f3abc-b307-58c2-b0aa-0b1e02635017" ], "widgets": [], "panels": [], "forms": [], "categoryIds": [ "451902a073c071463e2ce7c6" ], "class": [], "featured": false, "profileRequired": true, "sendVcf": false, "isNLEnabled": true, "interruptsEnabled": true, "state": "setup", "defaultLanguage": "en", "_id": "st-cf8323be-e50e-5dd3-8870-2c8482e4bc2e", "modifiedOn": "2021-01-12T10:55:11.551Z", "sBannerColor": "#E44929", "bBannerColor": "#E44929", "createdOn": "2021-01-12T10:55:11.115Z", "createdBy": "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660", "lastModifiedBy": "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660", "accountId": "5e81ba854b3b29780134c7fb", "sharedBy": [], "__v": 0, "name": "Asana Sample_botowner@koreai.in_34", "keywords": [], "originalName": "Asana Sample", "icon": "58f49848a8429af87912c7f1", "color": "#E44929" }
Leave a Reply
To install a sample bot.
To use this API, needs the Admin app scope of Bot Create under Bot Definition.
POST https://{{host}}/api/public/samplebots/{{botId}}/add
Path Parameters
| Parameter | Required/Optional | Description |
|---|---|---|
| host | Required | Environment URL, for example, https://bots.kore.ai |
| BotID | Required | Bot ID or Stream ID. You can access it from the General Settings page of the bot. |
Authorization
Invoke the API with JWT in the header with the following syntax:
auth: {{JWT}}
AccountId: {{accountId}}
userId: {{userId}}
bot-language : en
Response Content Type
application/json
Sample Request
curl -X POST \
'https://{{host}}/api/public/samplebots/{{bot_id}}/add' \
-H 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \
-H 'content-type: application/json' \
-H 'AccountId: xexxbaxxxbxbxxxxxxxxcxfb' \
-H 'userId: u-fbxxfxxx-axfd-xfcx-abxx-xcxxxxaxexxx' \
-H 'bot-language: en
'
Sample Response
{
"visibility": {
"namespace": "private",
"namespaceIds": [
"u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660"
]
},
"languages": [],
"screenShots": [],
"downloadCount": 0,
"alerts": [
"l-be9b69b5-dbae-55f1-8499-c0b3db74602c"
],
"actions": [],
"dialogs": [
"dg-cbf01287-c284-5fb9-8686-b21c0b54cba6",
"dg-353f3abc-b307-58c2-b0aa-0b1e02635017"
],
"widgets": [],
"panels": [],
"forms": [],
"categoryIds": [
"451902a073c071463e2ce7c6"
],
"class": [],
"featured": false,
"profileRequired": true,
"sendVcf": false,
"isNLEnabled": true,
"interruptsEnabled": true,
"state": "setup",
"defaultLanguage": "en",
"_id": "st-cf8323be-e50e-5dd3-8870-2c8482e4bc2e",
"modifiedOn": "2021-01-12T10:55:11.551Z",
"sBannerColor": "#E44929",
"bBannerColor": "#E44929",
"createdOn": "2021-01-12T10:55:11.115Z",
"createdBy": "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660",
"lastModifiedBy": "u-fb90f166-a5fd-5fc8-ab44-6c5388a1e660",
"accountId": "5e81ba854b3b29780134c7fb",
"sharedBy": [],
"__v": 0,
"name": "Asana Sample_botowner@koreai.in_34",
"keywords": [],
"originalName": "Asana Sample",
"icon": "58f49848a8429af87912c7f1",
"color": "#E44929"
}