This API retrieves the conversation sessions created. The API details are available in the Bot Builder and Bot Admin Console (BAC) app scopes.
To use this API, app needs the Bot Builder API scope of Bot sessions.
OR the Admin API Scope of Bot sessions under Bot Analytics.
POST https://{{host}}/api/public/bot/{{BotID}}/getSessions?containmentType={{containmentType}}
and https://{{host}}/api/public/getSessions?containmentType={{containmentType}}
for BAC.
Query Parameters
Parameter | Description |
---|---|
containmentType (introduced in ver9.0) |
Use to filter the results based on the type of the session i.e Self-service vs. Drop-off vs. Agent Transfer Valid values:
|
Body Parameters
Parameter | Description |
---|---|
userId (optional) | The ID of the user whose conversation history to access. Can be a user email id or enterprise assigned unique id. |
skip/offset (optional) | The number of messages to be skipped. |
limit (optional) | The number of messages to be shown on each page. |
dateFrom (optional) | Takes the date format yyyy-mm-dd (or) yyyy-mm-ddThh:mm:ss.msZ eg:2019-04-01 (or) 2019-04-01T13:25:58.515Z. If not provided, calculated as 7 days behind dataTo. |
dateTo (optional) | Takes the date format yyyy-mm-dd (or) yyyy-mm-ddThh:mm:ss.msZ eg:2019-04-01 (or) 2019-04-01 T13:26:05.598Z. If not provided, calculated as 7 days from dateFrom. If dateFrom is also not provided then set to Today. |
tags (optional) | Meta tags to filter the conversations. |
sessionType (optional) (introduced in ver8.0) |
Type to filter the conversations – can be:
|
Note: The duration between dateTo and dateFrom should be less than 7 days, else an error will be thrown.
권한 부여
다음 구문을 포함한 헤더에 JWT를 포함한 API를 호출합니다. auth: {{JWT}}
콘텐츠 유형 응답
application/JSON
샘플 요청
- 본문 없음
curl --location --request POST '{{host}}/api/public/getSessions?containmentType={{containmentType}}' \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ --header 'Content-Type: application/json' \ --data-raw ''
- 본문 포함
curl --location --request POST '{{host}}/api/public/bot/{{BotId}}/getSessions?containmentType={{containmentType}}' \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "skip" : 0, "limit" : 100, "dateFrom" : "2020-02-11", "dateTo" : "2020-02-12" }'
- 특정 봇의 경우
curl --location --request POST '{{host}}/api/public/bot/{{BotId}}/getSessions?containmentType={{containmentType}}' \ --header 'auth: {{YOUR_JWT_ACCESS_TOKEN}}' \ --header 'Content-Type: application/json' \ --data-raw '{ "skip" : 0, "limit" : 100, "dateFrom" : "2020-02-11", "dateTo" : "2020-02-12" }'
Sample Response
- for dropOff sessions
{ "total": 1, "moreAvailable": false, "sessions": [ { "sessionId": "xxxxaxxexxxaxexdxxxdxxxe", "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx", "channel": "rtm", "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx", "start_time": "2021-04-26T11:27:25.977Z", "end_time": "2021-04-26T11:27:26.145Z", "session_lang": [ "en" ], "sessionType": "interactive", "containmentType": "dropOff", "isDeveloper": false, "tags": { "userTags": [ { "value": "newuser", "name": "regular" } ], "sessionTags": [] }, "noOfMessagesExchanged": 1, "noOfTasksExecuted": 0 } ] }
- for Selfservice sessions
{ "total": 2, "moreAvailable": false, "sessions": [ { "sessionId": "xxxxaxxexxxaxexdxxxdxxxe", "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx", "channel": "rtm", "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx", "start_time": "2021-04-26T11:27:25.977Z", "end_time": "2021-04-26T11:27:26.145Z", "session_lang": [ "en" ], "sessionType": "non-interactive", "containmentType": "selfService", "isDeveloper": false, "tags": { "userTags": [ { "value": "newuser", "name": "regular" } ], "sessionTags": [] }, "noOfMessagesExchanged": 6, "noOfTasksExecuted": 0 }, { "sessionId": "xxxxaxxexxxaxexdxxxdxxxe", "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx", "channel": "rtm", "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx", "start_time": "2021-04-26T11:27:25.977Z", "end_time": "2021-04-26T11:27:26.145Z", "session_lang": [ "en" ], "sessionType": "non-interactive", "containmentType": "selfService", "isDeveloper": false, "tags": { "userTags": [ { "value": "newuser", "name": "regular" } ], "sessionTags": [] }, "noOfMessagesExchanged": 8, "noOfTasksExecuted": 0 } ] }
- for agent sessions
{ "total": 1, "moreAvailable": false, "sessions": [ { "sessionId": "xxxxaxxexxxaxexdxxxdxxxe", "botId": "st-ffeffxxx-xxxc-xexa-axxx-cxxabxxxxcxx", "channel": "rtm", "userId": "u-xxfexxxd-xxex-xdxe-xaec-xeaxbxxxxfxx", "start_time": "2021-04-26T11:27:25.977Z", "end_time": "2021-04-26T11:27:26.145Z", "session_lang": [ "en" ], "sessionType": "interactive", "containmentType": "agent", "isDeveloper": false, "tags": { "userTags": [], "sessionTags": [] }, "noOfMessagesExchanged": 7, "noOfTasksExecuted": 2 } ] }