{"id":30273,"date":"2021-08-24T10:17:39","date_gmt":"2021-08-24T09:17:39","guid":{"rendered":"https:\/\/multisite.korebots.com\/v9-0\/uncategorised-ja\/bots-platform-api-reference\/"},"modified":"2021-08-24T10:18:33","modified_gmt":"2021-08-24T09:18:33","slug":"bots-platform-api-reference","status":"publish","type":"post","link":"https:\/\/multisite.korebots.com\/v9-0\/uncategorised-ja\/bots-platform-api-reference\/","title":{"rendered":"Web \u30bd\u30b1\u30c3\u30c8\u63a5\u7d9a\u3068 RTM"},"content":{"rendered":"

Kore.ai SDK \u30e9\u30a4\u30d6\u30e9\u30ea\u306f\u3001Kore.ai \u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u3068\u306e\u901a\u4fe1\u306b Web \u30bd\u30b1\u30c3\u30c8 \u30c1\u30e3\u30cd\u30eb\u3092\u4f7f\u7528\u3057\u307e\u3059\u3002Web \u30bd\u30b1\u30c3\u30c8 \u30bb\u30c3\u30b7\u30e7\u30f3\u3092\u521d\u671f\u5316\u3059\u308b\u305f\u3081\u306b\u3001Kore.ai SDK \u306f\u4ee5\u4e0b\u306e \u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u306e\u30a8\u30f3\u30c9 \u30dd\u30a4\u30f3\u30c8\u3092\u4f7f\u7528\u3057\u307e\u3059\u3002Kore.ai \u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0 SDK \u3092\u4f7f\u7528\u3059\u308b\u5834\u5408\u306f\u3001JWT \u30c8\u30fc\u30af\u30f3\u306e\u307f\u3092\u751f\u6210\u3057\u3066\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 SDK \u306b\u6e21\u3059\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002<\/p>\n<\/div><\/div>

<\/div><\/div>

<\/span>\u521d\u671f\u5316<\/span><\/h2>\n

\u3053\u306e\u30bb\u30af\u30b7\u30e7\u30f3\u3067\u306f\u3001Kore.ai SDK \u304c Web \u30bd\u30b1\u30c3\u30c8 \u30bb\u30c3\u30b7\u30e7\u30f3\u3092\u521d\u671f\u5316\u3059\u308b\u65b9\u6cd5\u306b\u3064\u3044\u3066\u8aac\u660e\u3057\u307e\u3059\u3002\u3053\u308c\u306f\u53c2\u7167\u7528\u3067\u3059\u3002<\/p>\n

<\/span>\u5fc5\u8981\u6761\u4ef6<\/span><\/h3>\n

\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u304c\u767b\u9332\u3055\u308c\u3001Kore.ai \u30dc\u30c3\u30c8\u30d3\u30eb\u30c0\u30fc \u30c4\u30fc\u30eb\u3067\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 ID \u3068\u30b7\u30fc\u30af\u30ec\u30c3\u30c8 \u30ad\u30fc\u304c\u751f\u6210\u3055\u308c\u307e\u3059\u3002<\/p>\n

<\/span>\u30b9\u30c6\u30c3\u30d7 1<\/strong><\/span><\/h3>\n

JWT \u306f\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306e\u8cc7\u683c\u60c5\u5831\u3068\u30e6\u30fc\u30b6\u30fc\u60c5\u5831\u3092\u4f7f\u7528\u3057\u3066\u30b5\u30fc\u30d0\u30fc\u5074\u3067\u751f\u6210\u3055\u308c\u307e\u3059\u3002JWT \u306f\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306b\u6e21\u3055\u308c\u307e\u3059\u3002<\/p>\n<\/div><\/div>

<\/div><\/div>

<\/span>\u30b9\u30c6\u30c3\u30d7 2<\/strong><\/span><\/h3>\n

\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306f\u3001\u4ee5\u4e0b\u306e\u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u306e\u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8\u3092\u4f7f\u7528\u3057\u3066\u3001\u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u4e0a\u306e accessToken<\/code> \u7528\u306b JWT \u30c8\u30fc\u30af\u30f3\u3092\u4ea4\u63db\u3057\u307e\u3059\u3002<\/span>\u3053\u306e\u30bb\u30af\u30b7\u30e7\u30f3\u3067\u306f\u3001\u4ee5\u4e0b\u306e JSON \u69cb\u6587\u306b\u57fa\u3065\u3044\u3066\u3001 \/api\/1.1\/<\/span>oAuth<\/span>\/token\/jwtgrant<\/span><\/code>  \u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8\u3092\u4f7f\u7528\u3057\u3066\u30c1\u30e3\u30c3\u30c8\u306b\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u6295\u7a3f\u3059\u308b\u30ea\u30af\u30a8\u30b9\u30c8\u306e\u30d5\u30a9\u30fc\u30de\u30c3\u30c8\u306b\u3064\u3044\u3066\u8aac\u660e\u3057\u307e\u3059\u3002 POST https:\/\/{{APIHost}}\/api\/1.1\/oAuth\/token\/jwtgrant<\/code><\/p>\n

{ "assertion": “{{JWT Token}}”, "botInfo": { "chatBot": "{{Bot Name}}", "taskBotId": "st-f74a3430-3b19-55a3-be41-1ab1a35c4685" } )<\/pre>\n
\u30b5\u30f3\u30d7\u30eb cURL<\/strong><\/h4>\n
curl 'https:\/\/{{APIHost}}\/api\/1.1\/oAuth\/token\/jwtgrant' \\ -H 'content-type: application\/json'  \\ --data-binary '{"assertion":"{JWT Token}}","botInfo":{"chatBot":"{{Bot Name}}","taskBotId":"st-f74a3430-3b19-55a3-be41-1ab1a35c4685"}}<\/pre>\n
\u30ec\u30b9\u30dd\u30f3\u30b9<\/h4>\n
\u4ee5\u4e0b\u306e\u30b5\u30f3\u30d7\u30eb JSON \u30ec\u30b9\u30dd\u30f3\u30b9\u3067\u306f\u3001 accessToken<\/code> \u304a\u3088\u3073\u305d\u306e\u30c8\u30fc\u30af\u30f3\u306b\u95a2\u9023\u4ed8\u3051\u3089\u308c\u305f\u30e6\u30fc\u30b6\u30fc\u304c\u8868\u793a\u3055\u308c\u3066\u3044\u307e\u3059\u3002<\/p>\n
{ "authorization": { "accessToken": "ZdV2OL_UZ_MvHog-rs8k9KJFNWBICvquSc3jpeaRDE_-", \/\/ access token to user at \/api\/rtm "token_type": "bearer", "expiresDate": "2019-06-28T06:52:23.160Z", \/\/expiry date for access token "issuedDate": "2019-02-28T06:52:23.160Z" \/\/access token issuedDate }, "userInfo": { "userId": "u-4f6c68e0-551a-5dd9-a33a-1af3dc9cadcc", \/\/ user id which is unique for the user and can be used at bot messages api "accountId": "5c66514d09ab3565deb2e30a", \/\/ account id in which the user is present "orgId": "o-88aad7f1-0d32-5765-93d7-f40c80402114", \/\/ organization id of the user "identity": "cs-5b08ed1e-5fa7-5aaa-9c21-28bf8c90b739\/admin1212@qakore.xyz", \/\/identity of user from the channel perspective "enrollType": "free", \/\/Enrollment type (Free\/ Paid etc) "managedBy": "5c66514d09ab3565deb2e30a", \/\/(The account id) "fName": "", \/\/first name of the user \/\/ (fetched if the user is registered on the platform) "lName": "" \/\/last name of the user \/\/ (fetched if the user is registered on the platform) } }<\/pre>\n<\/div><\/div>
<\/div><\/div>
<\/span>\u30b9\u30c6\u30c3\u30d7 3<\/strong><\/span><\/h3>\n
\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306f\u3001\u4ee5\u4e0b\u306e\u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8\u3092\u4f7f\u7528\u3057\u3066 Web \u30bd\u30b1\u30c3\u30c8\u306e URL \u3092\u53d6\u5f97\u3057\u307e\u3059\u3002\u3053\u306e\u30bb\u30af\u30b7\u30e7\u30f3\u3067\u306f\u3001\u4ee5\u4e0b\u306e JSON \u69cb\u6587\u306b\u57fa\u3065\u3044\u3066\u3001 \/api\/1.1\/rtm\/start<\/code>  \u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8\u3092\u4f7f\u7528\u3057\u3066 Web \u30bd\u30b1\u30c3\u30c8 URL \u3092\u53d6\u5f97\u3059\u308b\u30ea\u30af\u30a8\u30b9\u30c8\u306e\u30d5\u30a9\u30fc\u30de\u30c3\u30c8\u306b\u3064\u3044\u3066\u8aac\u660e\u3057\u307e\u3059\u3002<\/p>\n
\u30e1\u30e2:<\/strong> \u3053\u306e URL \u306f\u6709\u52b9\u671f\u9593\u304c\u77ed\u304f\u300130 \u79d2\u5f8c\u306b\u671f\u9650\u5207\u308c\u306b\u306a\u308a\u307e\u3059\u3002\u6709\u52b9\u671f\u9650\u304c\u5207\u308c\u308b\u524d\u306b\u3001\u63a5\u7d9a\u306b\u4f7f\u7528\u3055\u308c\u3066\u3044\u308b\u3053\u3068\u3092\u78ba\u8a8d\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002<\/p>\n
POST https:\/\/{{APIHost}}\/api\/1.1\/rtm\/start<\/code><\/p>\n
{ "botInfo": { "chatBot": "Twitter", "taskBotId": "st-f74a3430-3b19-55a3-be41-1ab1a35c4685" }}<\/pre>\n
accessToken<\/code> \u306f\u3001\u627f\u8a8d\u30d8\u30c3\u30c0\u30fc\u306e bearer<\/code> \u30d1\u30e9\u30e1\u30fc\u30bf\u3067\u6e21\u3055\u308c\u307e\u3059\u3002<\/p>\n
\u30b5\u30f3\u30d7\u30eb cURL<\/strong><\/h4>\n
curl 'https:\/\/{{APIHost}}\/api\/1.1\/rtm\/start' \\ -H 'content-type: application\/json' \\ -H 'Authorization: bearer {{accessToken}}' \\ --data-binary '{"botInfo":{"chatBot":"{{Bot Name}}","taskBotId":"st-f74a3430-3b19-55a3-be41-1ab1a35c4685"}'<\/pre>\n
\u30ec\u30b9\u30dd\u30f3\u30b9<\/h4>\n
\u4ee5\u4e0b\u306e JSON \u30ec\u30b9\u30dd\u30f3\u30b9\u306e\u30b5\u30f3\u30d7\u30eb\u306f\u3001Web \u30bd\u30b1\u30c3\u30c8\u306e URL \u3092\u793a\u3057\u3066\u3044\u307e\u3059\u3002<\/p>\n
{"url":"wss:\/\/xxx.yyy.com:443\/rtm\/bot?sid=GhKrtrEC61g7hAnmvKAVnJIHG0DS1Lzv"}<\/pre>\n<\/div><\/div>
<\/div><\/div>
<\/span>RTM \u30a4\u30d9\u30f3\u30c8 \u30ea\u30d5\u30a1\u30ec\u30f3\u30b9<\/span><\/span><\/h2>\n
\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u3068 Kore.ai \u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u306e\u9593\u3067\u306f\u3001\u4ee5\u4e0b\u306e\u3088\u3046\u306a\u30ea\u30a2\u30eb\u30bf\u30a4\u30e0 \u30a4 \u30d9\u30f3\u30c8\u304c\u3084\u308a\u53d6\u308a\u3055\u308c\u307e\u3059\u3002<\/span><\/p>\n
<\/span>RTM \u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a4\u30d9\u30f3\u30c8<\/span><\/span><\/h3>\n
\u3053\u306e\u30bb\u30af\u30b7\u30e7\u30f3\u3067\u306f\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u304b\u3089Web \u30bd\u30b1\u30c3\u30c8\u7d4c\u7531\u3067 Kore.ai \u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u306b\u9001\u4fe1\u3055\u308c\u308b RTM \u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a4\u30d9\u30f3\u30c8\u306e JSON \u30ec\u30b9\u30dd\u30f3\u30b9\u306b\u3064\u3044\u3066\u8aac\u660e\u3057\u307e\u3059\u3002\u30a4\u30d9\u30f3\u30c8 \u30bf\u30a4\u30d7<\/strong> \/bot.message<\/code> \u8aac\u660e:<\/strong> \u30e6\u30fc\u30b6\u30fc\u304c\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u6295\u7a3f\u3057\u305f\u3068\u304d\u306b\u30c8\u30ea\u30ac\u30fc\u3055\u308c\u307e\u3057\u305f\u3002\u4ee5\u4e0b\u306e\u30da\u30a4\u30ed\u30fc\u30c9\u306f\u3001\u30e6\u30fc\u30b6\u30fc\u304c\u5165\u529b\u3057\u305f\u30e1\u30c3\u30bb\u30fc\u30b8\u3092 \u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u306b\u9001\u4fe1\u3059\u308b\u305f\u3081\u306b\u4f7f\u7528\u3055\u308c\u307e\u3059\u3002<\/p>\n
{ "clientMessageId": 1466692440896, "message": { "body": "Here is the message.", "attachments": [ ] }, "resourceid": "\/bot.message", "botInfo": { "chatBot": "CNN", "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce" }, "id": 1466692440896 }<\/pre>\n
<\/span>RTM \u30b5\u30fc\u30d0\u30fc \u30a4\u30d9\u30f3\u30c8<\/span><\/span><\/h3>\n
\u3053\u306e\u30bb\u30af\u30b7\u30e7\u30f3\u3067\u306f\u3001Web \u30bd\u30b1\u30c3\u30c8\u3092\u4ecb\u3057\u3066\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306b\u9001\u4fe1\u3055\u308c\u308b RTM \u30b5\u30fc\u30d0\u30fc \u30a4\u30d9\u30f3\u30c8 JSON \u30ec\u30b9\u30dd\u30f3\u30b9\u306b\u3064\u3044\u3066\u8aac\u660e\u3057\u307e\u3059\u3002<\/span>\u30a4\u30d9\u30f3\u30c8 \u30bf\u30a4\u30d7<\/strong> ack<\/code> \u8aac\u660e\uff1a<\/strong>\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u304b\u3089\u30a4\u30d9\u30f3\u30c8\u3092\u53d7\u4fe1\u3059\u308b\u305f\u3073\u306b\u9001\u4fe1\u3055\u308c\u308b\u53d7\u4fe1\u78ba\u8a8d\u3002\u4ee5\u4e0b\u306e\u30da\u30a4\u30ed\u30fc\u30c9\u306f\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u304b\u3089\u306e\u30a4\u30d9\u30f3\u30c8\u3092\u78ba\u8a8d\u3059\u308b\u305f\u3081\u306b\u4f7f\u7528\u3055\u308c\u307e\u3059\u3002<\/p>\n
{ "ok": true, "replyto": 1466692440896, "message": "delivered", "type": "ack" }<\/pre>\n
\u30a4\u30d9\u30f3\u30c8 \u30bf\u30a4\u30d7:<\/strong> bot_response<\/code> \u8aac\u660e\uff1a<\/strong>\u30af\u30e9\u30a4\u30a2\u30f3\u30c8\u30a2\u30d7\u30ea\u304b\u3089\u306e\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u51e6\u7406\u3059\u308b\u305f\u3073\u306b\u9001\u4fe1\u3055\u308c\u308b\u53d7\u4fe1\u78ba\u8a8d\u3002\u4ee5\u4e0b\u306e\u30da\u30a4\u30ed\u30fc\u30c9\u306f\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u304b\u3089\u306e\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u51e6\u7406\u3059\u308b\u969b\u306b\u9001\u4fe1\u3055\u308c\u307e\u3059\u3002<\/p>\n
{ "type": "bot_response", "from": "bot", "message": [ { "type": "text", "cInfo": { "body": " Hi." } } ], "botInfo": { "chatBot": "CNN", "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce" }, "createdOn": "2016-06-23T14:34:00.025Z", "icon": "https:\/\/devbots.kore.com\/api\/getMediaStream\/market\/f-683e82be-fc25-5921-bf41-4104780f71c2.png" }<\/pre>\n
\u30a4\u30d9\u30f3\u30c8 \u30bf\u30a4\u30d7:<\/strong> user_message<\/code> \u8aac\u660e:<\/strong> \u30e6\u30fc\u30b6\u30fc\u304c\u5225\u306e\u540c\u6642\u30bb\u30c3\u30b7\u30e7\u30f3\u304b\u3089\u30b5\u30fc\u30d0\u30fc\u306b\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u5165\u529b\u3057\u3066\u9001\u4fe1\u3057\u305f\u3068\u304d\u306b\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306b\u9001\u4fe1\u3055\u308c\u307e\u3059\u3002\u4ee5\u4e0b\u306e\u30da\u30a4\u30ed\u30fc\u30c9\u306e\u30b5\u30f3\u30d7\u30eb\u304c\u3001\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306b\u9001\u4fe1\u3055\u308c\u307e\u3059\u3002<\/p>\n
{ "botInfo": { "chatBot": "CNN", "taskBotId": "st-8aaf0939-c34a-5976-8e2e-5c91e685b2ce" }, "from": "self", "message": { "body": "how are you doing ", "attachments": [] }, "id": 1466692871803, "type": "user_message" }<\/pre>\n<\/div><\/div>
<\/div><\/div>
<\/span>\u4f1a\u8a71\u5c65\u6b74\u306e\u53d6\u5f97<\/span><\/h2>\n
\u30af\u30e9\u30a4\u30a2\u30f3\u30c8 \u30a2\u30d7\u30ea\u306f\u3001\u4e0a\u8a18\u30b9\u30c6\u30c3\u30d7 2 \u3067\u751f\u6210\u3057\u305f\u30a2\u30af\u30bb\u30b9 \u30c8\u30fc\u30af\u30f3\u3092\u4f7f\u7528\u3057\u3066\u3001\u30dc\u30c3\u30c8 \u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u306e\u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8 \/api\/botmessages\/rtm?botId={{botId}}<\/code>\u306b\u30ea\u30af\u30a8\u30b9\u30c8\u3057\u3001\u30e6\u30fc\u30b6\u30fc\u3068\u30c1\u30e3\u30c3\u30c8\u30dc\u30c3\u30c8\u306e\u9593\u3067\u4ea4\u308f\u3055\u308c\u305f\u904e\u53bb\u306e\u30e1\u30c3\u30bb\u30fc\u30b8\u3092\u53d6\u5f97\u3057\u307e\u3059\u3002\u3053\u306e\u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8\u304b\u3089\u306e\u30ec\u30b9\u30dd\u30f3\u30b9\u3092\u4f7f\u7528\u3057\u3066\u3001\u30c1\u30e3\u30c3\u30c8 \u30a6\u30a3\u30f3\u30c9\u30a6\u306b\u4f1a\u8a71\u306e\u5c65\u6b74\u3092\u8868\u793a\u3067\u304d\u307e\u3059\u3002\u3053\u306e\u30bb\u30af\u30b7\u30e7\u30f3\u3067\u306f\u3001\u4ee5\u4e0b\u306e JSON \u69cb\u6587\u306b\u57fa\u3065\u3044\u3066\u3001 \/api\/botmessages\/rtm<\/code> \u30a8\u30f3\u30c9\u30dd\u30a4\u30f3\u30c8\u3092\u4f7f\u7528\u3057\u3066 Web \u30bd\u30b1\u30c3\u30c8 URL \u3092\u53d6\u5f97\u3059\u308b\u30ea\u30af\u30a8\u30b9\u30c8\u306e\u30d5\u30a9\u30fc\u30de\u30c3\u30c8\u306b\u3064\u3044\u3066\u8aac\u660e\u3057\u307e\u3059\u3002<\/p>\n
GET https:\/\/{{APIHost}}\/api\/botmessages\/rtm?botId={{botId}}<\/pre>\n
\u30af\u30a8\u30ea \u30d1\u30e9\u30e1\u30fc\u30bf<\/strong>:<\/p>\n