はじめに
対話型AIプラットフォーム
チャットボットの概要
自然言語処理(NLP)
ボットの概念と用語
クイックスタートガイド
プラットフォームへのアクセス
ボットビルダーの操作
リリースノート
最新バージョン(英語)
以前のバージョン(英語)
廃止機能(英語)
コンセプト
設計
ストーリーボード
ダイアログタスク
ダイアログタスクとは
ダイアログビルダー
ノードタイプ
インテントノード
ダイアログノード
エンティティノード
フォームノード
確認ノード
ロジックノード
ボットアクションノード
サービスノード
Webhookノード
スクリプトノード
グループノード
エージェント転送ノード
ユーザープロンプト
音声通話プロパティ
イベント ハンドラー
ナレッジグラフ
ナレッジグラフの抽出
ナレッジグラフの構築
ボットにナレッジグラフを追加
グラフの作成
ナレッジグラフの構築
既存のソースからFAQを構築
特性、同義語、停止用語
変数ネームスペースの管理
更新
ノード間の質問と回答の移動
用語の編集と削除
質問と応答の編集
ナレッジグラフの分析
通知タスク
スモールトーク
デジタルスキル
デジタルフォーム
デジタルビュー
デジタルビューとは
パネル
ウィジェット
トレーニング
トレーニングとは
機械学習
機械学習とは
モデル検証
ファンダメンタルミーニング
ナレッジグラフ
示唆
ランキングおよび解決
NLPの詳細設定
NLPのガイドライン
インテリジェンス
インテリジェンスとは
コンテキスト
コンテキストインテント
割り込み
複数インテントの検出
エンティティの変更
デフォルトの会話
センチメント管理
トーン分析
テストとデバッグ
ボットと会話
発話テスト
バッチテスト
会話テスト
デプロイ
チャネル
公開
分析
ボットの分析
NLPメトリクス
会話フロー
Usage Metrics
封じ込め測定
カスタムダッシュボード
カスタムダッシュボードとは
メタタグ
カスタムダッシュボードとウィジェット
ユニバーサルボット
ユニバーサルボットとは
ユニバーサルボットの定義
ユニバーサルボットの作成
ユニバーサルボットのトレーニング
ユニバーサルボットのカスタマイズ
他言語の有効化
ストア
プラントと使用
Overview
Usage Plans
Support Plans
Invoices
管理
ボット認証
複数言語対応ボット
個人を特定できる情報の編集
ボット変数の使用
IVRのシステム連携
一般設定
ボット管理
ハウツー
会話スキルの設計
バンキングボットを作成
バンキングボット – 資金の振り替え
バンキングボット – 残高を更新
ナレッジグラフを構築
スマートアラートの予約方法
デジタルスキルの設計
デジタルフォームの設定方法
デジタルビューの設定方法
データテーブルのデータの追加方法
データテーブルのデータの更新方法
Add Data from Digital Forms
ボットのトレーニング
示唆の使用方法
インテントとエンティティのパターンの使用方法
コンテキスト切り替えの管理方法
ボットのデプロイ
エージェント転送の設定方法
ボット関数の使用方法
コンテンツ変数の使用方法
グローバル変数の使用方法
Web SDK Tutorial(英語)
Widget SDK Tutorial(英語)
ボットの分析
カスタムダッシュボードの作成方法
カスタムタグを使ってフィルタリング
管理
ボット管理者コンソール
ダッシュボード
ユーザーの管理
ユーザーの管理
グループの管理
ロール管理
ボット管理モジュール
登録
ユーザーの招待
招待状の一括送信
ユーザーデータのインポート
Active Directoryからユーザーを同期
セキュリティ/コンプライアンス
シングル サインオンの使用
セキュリティ設定
Billing(日本未対応)
  1. ホーム
  2. Docs
  3. Virtual Assistants
  4. API Guide
  5. Create User API

Create User API

To add users to an account.

This API requires JWT generated by an application created only from the Bot Admin Console.
This feature was introduced in ver7.1 of the platform.

Method POST
Endpoint https://{{host}}/api/public/users
Content Type application/json
Authorization

auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: User Management > User Management

 

Path Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

 

Sample Request

curl -X POST \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "deskkore1@gmail.com",
                "orgUserId": "org assigned user id",
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": [
                "e-06b41cdd-7678-5394-b958-40ca5662f502"
            ],
            "roles": [
                {
                    "roleId": "5d9d8db30d54920a8df1e68b",
                    "streamId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                },
                {
                    "roleId": "5d9d920dabdc1e6e8ec99342",
                    "streamId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                },
                {
                    "roleId": "5bbcb20c8bfd33db440ec1d1"
                },
                {
                    "roleId": "5d9d8d930d54920a8df1e689"
                }         
            ],
            "assignBotTasks": [
              {
                "streamId": "st-xxx-xx-xxx-xxx-xxxx",
                "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
               } 
            ],
            "canCreateBot": true,
            "isDeveloper": true
        }
]
}'

 

Body Parameters

Parameter Required/Optional Description
users
The array of details for each user to include user email id, user first name, group to which the user will belong, roles to be assigned to the Bots, and the permissions.

Note: The following entries till isDeveloper are the sub-parameters of the users parameter.
userInfo.emailId Required Email Ids of the user being added
userInfo.orgUserId Optional User id assigned by your organization of the user being added
userInfo.firstName Optional First name of the user being added
userInfo.lastName Optional Last name of the user being added
userInfo.companyName Optional Company to which the user being added belongs
userInfo.dept Optional Department to which the user being added belongs
userInfo.companyContactPhone Optional Contact Phone of the Company to which the user being added belongs
userInfo.worknumber Optional Work number of the user being added
userInfo.street Optional Street Address of the user being added
userInfo.suiteNo Optional Suite No Address of the user being added
userInfo.city Optional City Address of the user being added
userInfo.zip Optional Zip Address of the user being added
userInfo.state Optional State Address of the user being added
userInfo.country Optional Country Address of the user being added
groups Optional array of group ids to which the user should belong
roles Optional array of roleId-botId combinations saying what role the user has on which bot
assignBotTasks Optional

array of bots that need to be assigned to the user

streamId Id of the Bot to be assigned to the user
dialogs Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned
canCreateBot Optional Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
Default value is “true”.
isDeveloper Optional Determines if the specified users can have access to Bot Builder. Set to true or false.
Default value is “true”.
sendEmail Optional Determines if an email needs to be sent to the user containing activation link to activate users under the account. Set to true or false.
Default value is “true”.

 

Sample Response

  • For success case:
    {
            "msg": "Users are created Successfully"
        };
  • Failure case:
    {
        "failedUserDetails": [
            {
                "userInfo": {
                    "emailId": "deskkore1",
                    "firstName": "user1",
                    "status": "failure",
                    "reason": {
                        "statusCode": 400,
                        "status": 400,
                        "customCode": 400,
                        "errors": [
                            {
                                "msg": "INVALID_EMAIL",
                                "code": 400
                            }
                        ],
                        "_headers": {},
                        "message": "INVALID_EMAIL",
                        "name": "BadRequest"
                    }
                }
            }
    ]
    }
    

Create User API

To add users to an account.

This API requires JWT generated by an application created only from the Bot Admin Console.
This feature was introduced in ver7.1 of the platform.

Method POST
Endpoint https://{{host}}/api/public/users
Content Type application/json
Authorization

auth: {{JWT}}

See How to generate the JWT Token.

API Scope
  • Bot Builder: Not Applicable
  • Admin Console: User Management > User Management

 

Path Parameters

Parameter Description
host Environment URL, for example, https://bots.kore.ai

 

Sample Request

curl -X POST \
  https://{{host}}/api/public/users \
  -H 'Content-Type: application/json' \
  -H 'auth: YOUR_JWT_ACCESS_TOKEN' \
  -d '{
    "users": [
        {
            "userInfo": {
                "emailId": "deskkore1@gmail.com",
                "orgUserId": "org assigned user id",
                "firstName": "user1",
                "lastName":"user1",
                "companyName":"company_name",
                "dept":"dept",
                "companyContactPhone":"12334444",
                "worknumber":"321",
                "street":"street",
                "suiteNo":"suite",
                "city":"city",
                "zip":"123123",
                "state":"state",
                "country":"country"
            },
            "groups": [
                "e-06b41cdd-7678-5394-b958-40ca5662f502"
            ],
            "roles": [
                {
                    "roleId": "5d9d8db30d54920a8df1e68b",
                    "streamId": "st-b8525f88-6dd3-54a7-8a97-734ecb748733"
                },
                {
                    "roleId": "5d9d920dabdc1e6e8ec99342",
                    "streamId": "st-16511425-15c5-5cdf-b652-a796db7d134b"
                },
                {
                    "roleId": "5bbcb20c8bfd33db440ec1d1"
                },
                {
                    "roleId": "5d9d8d930d54920a8df1e689"
                }         
            ],
            "assignBotTasks": [
              {
                "streamId": "st-xxx-xx-xxx-xxx-xxxx",
                "dialogs": ["dg-xxxx-xx-xx-xx-xxxx"]
               } 
            ],
            "canCreateBot": true,
            "isDeveloper": true
        }
]
}'

 

Body Parameters

Parameter Required/Optional Description
users
The array of details for each user to include user email id, user first name, group to which the user will belong, roles to be assigned to the Bots, and the permissions.

Note: The following entries till isDeveloper are the sub-parameters of the users parameter.
userInfo.emailId Required Email Ids of the user being added
userInfo.orgUserId Optional User id assigned by your organization of the user being added
userInfo.firstName Optional First name of the user being added
userInfo.lastName Optional Last name of the user being added
userInfo.companyName Optional Company to which the user being added belongs
userInfo.dept Optional Department to which the user being added belongs
userInfo.companyContactPhone Optional Contact Phone of the Company to which the user being added belongs
userInfo.worknumber Optional Work number of the user being added
userInfo.street Optional Street Address of the user being added
userInfo.suiteNo Optional Suite No Address of the user being added
userInfo.city Optional City Address of the user being added
userInfo.zip Optional Zip Address of the user being added
userInfo.state Optional State Address of the user being added
userInfo.country Optional Country Address of the user being added
groups Optional array of group ids to which the user should belong
roles Optional array of roleId-botId combinations saying what role the user has on which bot
assignBotTasks Optional

array of bots that need to be assigned to the user

streamId Id of the Bot to be assigned to the user
dialogs Array of dialog task ids within the bot that need to be assigned to the user. If not given, all the dialog tasks are assigned
canCreateBot Optional Determines if the specified users can create bots in their Bot Builder accounts. Set to true or false.
Default value is “true”.
isDeveloper Optional Determines if the specified users can have access to Bot Builder. Set to true or false.
Default value is “true”.
sendEmail Optional Determines if an email needs to be sent to the user containing activation link to activate users under the account. Set to true or false.
Default value is “true”.

 

Sample Response

  • For success case:
    {
            "msg": "Users are created Successfully"
        };
  • Failure case:
    {
        "failedUserDetails": [
            {
                "userInfo": {
                    "emailId": "deskkore1",
                    "firstName": "user1",
                    "status": "failure",
                    "reason": {
                        "statusCode": 400,
                        "status": 400,
                        "customCode": 400,
                        "errors": [
                            {
                                "msg": "INVALID_EMAIL",
                                "code": 400
                            }
                        ],
                        "_headers": {},
                        "message": "INVALID_EMAIL",
                        "name": "BadRequest"
                    }
                }
            }
    ]
    }
    
メニュー