---
title: "Bot Session API"
slug: "server-api-bot-bot-session-api"
updated: 2022-07-11T09:32:17Z
published: 2022-07-11T09:32:17Z
canonical: "developer.comm100.com/server-api-bot-bot-session-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developer.comm100.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bot Session API

## Summary

- Chatbot
  - [session](/docs/server-api-bot-bot-session-api#session)

## Session

- `POST /chatbots/{chatbotId}/sessions` - [Create session](/docs/server-api-bot-bot-session-api#create-session)
- `POST /sessions/{sessionId}:recieveMessage` - [Recieved Message](/docs/server-api-bot-bot-session-api#Recieved-Message)
- `POST /sessions/{sessionId}:triggerAnIntent` - [Trigger an intent](/docs/server-api-bot-bot-session-api#trigger-an-intent)
- `POST /sessions/{sessionId}:rate` - [Rate the bot answer as helpful or not helpful](/docs/server-api-bot-bot-session-api#rate-the-bot-answer-as-helpful-or-not-helpful)

## Related Object Json Format

### ChatbotSession Object

ChatbotSession Object is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | Guid |  | sessionId |
| `channel` | string |  | e.g., `Live Chat`, `Facebook Messenger`, `Twitter Direct Message`, `WeChat`, `WhatsApp`, `SMS`, `IVR` |
| `message` | [ChatbotMessage](/docs/server-api-bot-bot-session-api#ChatbotMessage-Object) Object |  |  |
| `context` | [ChatbotSessionContext](/docs/server-api-bot-bot-session-api#ChatbotSessionContext-Object) Object |  |  |

### ChatbotSessionContext Object

ChatbotSessionContext Object is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `chatbotId` | Guid |  | chatbotId |
| `currentIntentId` | Guid |  |  |
| `chatbotResponseId` | Guid |  |  |
| `authentication` | string |  | authentication data |
| `location` | string |  | the longitude and latitude of the location, e.g. "-39.900000,116.300000" |
| `formValues` | [FieldValue](/docs/server-api-bot-bot-session-api#FieldValue-object)[] |  | an array of [FieldValue](/docs/server-api-bot-bot-session-api#FieldValue-object) objects |
| `isFormSubmitted` | bool | false |  |
| `consecutiveTimesOfPossibleAnswers` | int | 0 |  |
| `invalidInputTimes` | int | 0 |  |
| `latestMessage` | [ChatbotMessage](/docs/server-api-bot-bot-session-api#ChatbotMessage-Object) Object |  |  |
| `customData` | Object |  | Custom data |

### FieldValue Object

FieldValue is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | string |  | the name of a field in a form. |
| `value` | string |  | the value of a field. |

### ChatbotMessage Object

ChatbotMessage Object is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | Guid |  | the unique id of the response |
| `messages` | List |  | MessageData |
| `disableChatInputArea` | bool | false | Only available when channel is `Live Chat`. |
| `smartTriggerActions` | [SmartTriggerAction](/docs/server-api-bot-bot-session-api#smart-trigger-action-object)[] |  | an array of [SmartTriggerAction](/docs/server-api-bot-bot-session-api#smart-trigger-action-object) objects. |
| `intentId` | Guid |  | id of the matched intent |
| `intentName` | string |  | name of the matched intent |
| `score` | float |  | the score of the intent matched, the value is beteween 0.0 and 100.0 |

MessageData Object is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | enum |  | type of the response,including `chatbotActionSendMessage`,`chatbotActionQuickReply`、 `chatbotActionSendImage`、`chatbotSendVideo`、`chatbotActionSSOLoginButton`,`chatbotActionCollectLocation`, `chatbotCollectCompany`, `chatbotCollectEmail`, `chatbotCollectName`, `chatbotActionCollectPhoneNumber`, `chatbotActionCollectComment`,`chatbotActionCollectVariableData`,`chatbotActionBookMeeting`,`chatbotActionTransferChat`,`chatbotActionGotoTaskbot` |
| `content` | object |  | response's content. when type is `chatbotActionSendMessage`, it represents [SendMessage](/docs/server-api-bot-bot-session-api#SendMessage-object); when type is `chatbotActionQuickReply`,it represents [QuickReply](/docs/server-api-bot-bot-session-api#QuickReply-object);when type is `chatbotActionSendImage`,it represents [SendImage](/docs/server-api-bot-bot-session-api#SendImage-object);when type is `chatbotActionSendVideo`,it represents [SendVideo](/docs/server-api-bot-bot-session-api#SendVideo-Object); when type is `chatbotActionSSOLoginButton`, it represents [SSOLoginButton](/docs/server-api-bot-bot-session-api#SSOLoginButton-Object);when type is `chatbotActionCollectLocation`, it represents [CollectLocation](/docs/server-api-bot-bot-session-api#CollectLocation-Object);when type is `chatbotActionCollectCompany`, it represents [CollectCompany](/docs/server-api-bot-bot-session-api#CollectCompany-Object);when type is `chatbotActionCollectEmail`, it represents [CollectEmail](/docs/server-api-bot-bot-session-api#CollectEmail-Object);when type is `chatbotActionCollectName`, it represents [CollectName](/docs/server-api-bot-bot-session-api#CollectName-Object);when type is `chatbotActionCollectPhoneNumber`, it represents [CollectPhoneNumber](/docs/server-api-bot-bot-session-api#CollectPhoneNumber-Object);when type is `chatbotActionCollectComment`, it represents [CollectComment](/docs/server-api-bot-bot-session-api#CollectComment-Object);when type is `chatbotActionCollectVariableData`, it represents [CollectVariableData](/docs/server-api-bot-bot-session-api#CollectVariableData-Object);when type is `chatbotActionBookMeeting`, it represents [BookMeeting](/docs/server-api-bot-bot-session-api#BookMeeting-Object);when type is `chatbotActionTransferChat`, it represents [TransferChat](/docs/server-api-bot-bot-session-api#TransferChat-Object);when type is `chatbotActionGotoTaskbot`, it represents [GotoTaskbot](/docs/server-api-bot-bot-session-api#GotoTaskbot-Object); |

### Smart Trigger Action Object

Smart Trigger Action is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | enum |  | the type of the action. enum:[`sendNotification`,`autoMonitor`,`transferChat`,`changeAssignee`,`addToSegment`] |
| `isEnabled` | bool | false | if an action is enabled. |
| `agentOfflineMessage` | string |  | agent offlineMessage prompt message |
| `targetType` | enum |  | the trigger action target type. enum: `department`, `agent`, `segment`. |
| `selectedDepartments` | Guid[] |  | Only available when targetType is `department`. |
| `selectedAgents` | Guid[] |  | Only available when targetType is `agent`. |
| `segmentId` | Guid |  | Only available when targetType is `segment`. |

### GreetingMessage Object

GreetingMessage is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `responses` | [ChatbotResponse](/docs/server-api-bot-bot-session-api#Chatbot-Response-Object)[] |  | an array of [ChatbotResponse](/docs/server-api-bot-bot-session-api#Chatbot-Response-Object) object. |

### HighConfidenceAnswer Object

HighConfidenceAnswer is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `responses` | [ChatbotResponse](/docs/server-api-bot-bot-session-api#Chatbot-Response-Object)[] |  | an array of [ChatbotResponse](/docs/server-api-bot-bot-session-api#Chatbot-Response-Object) object. |

### PossibleAnswer Object

PossibleAnswer is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | Text of the Possible Answer message |
| `audio` | string |  | base64 string, convert the message text to speech |
| `intents` | [IntentScore](/docs/server-api-bot-bot-session-api#IntentScore-object)[] |  | an array of [IntentScore](/docs/server-api-bot-bot-session-api#IntentScore-object) |

### IntentScore Object

IntentScore is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `id` | Guid |  | id of the intent |
| `name` | string |  | name of the intent |
| `score` | float |  | the score of the intent matched, value is between 0.0 and 100.0 |

### NoAnswer Object

NoAnswer is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | text of the No Answer message |
| `audio` | string |  | base64 string, convert the message text to speech |
| `ifIncludeContactAgentOption` | bool |  |  |

### AuthenticationRequest Object

AuthenticationRequest is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `signInMessage` | string |  | message of the sign in |
| `audio` | string |  | base64 string, convert the signInMessage text to speech |
| `signInButtonText` | string |  | text of the sign in link |
| `signInURL` | string |  | url of the sign in |

### LocationRequest Object

LocationRequest is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | message of the sign in |
| `buttonText` | string |  | text of the sign in link |

### Prompt Object

Prompt is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `question` | string |  |  |
| `audio` | string |  | base64 string, convert the signInMessage text to speech |
| `options` | string[] |  | an array of string |

### FormRequest Object

FormRequest is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | A separate message which is sent before the button is sent. |
| `title` | string |  | when a button is sent to visitor, clicking this button will open a form that contains information bot wants to collect from the visitor. the title refers to the title of that form, and it is also placed on the button as a name. |
| `isConfirmationRequired` | bool |  | whether visitor needs to click confirm after filling out the information in a form. |
| `fields` | [Field](/docs/server-api-bot-bot-session-api#field-object)[] |  | an array of [Field](/docs/server-api-bot-bot-session-api#field-object) Object |
| `submitButtonText` | string |  |  |
| `cancelButtonText` | string |  |  |
| `confirmButtonText` | string |  |  |

### Field Object

Field is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | enum |  | enums: `text` ,`textArea`,`radio` ,`checkBox` ,`dropDownList` ,`checkBoxList`,`email` type refers to the different kinds of fields which can be used in a form. |
| `name` | string |  | a field’s name in a form. |
| `defaultValue` | string |  | a field’s value |
| `isRequired` | bool |  | to mark whether a field in a form is required or not. |
| `isMasked` | bool |  | if this is true, visitor information will be masked with symbols in chat logs. |
| `options` | string[] |  | an array of of string when the fieldType is `radio` ,`dropDownList` ,`checkBoxList` |
| `order` | integer |  | must greater than or equal 0, ascending sort |

### NotHelpfulMessage Object

NotHelpfulMessage is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | text of the message |
| `ifIncludeContactAgentOption` | bool |  | include Contact An Agent or not . |

### Chatbot Response Object

Response is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | enum |  | enums: `text` ,`htmlText` ,`button`,`quickReply` ,`image` ,`video` ,`ivrMenu` ,`transferCall` . |
| `content` | object |  | response's content. when type is `text` or `htmlText`, it represents [Text Response](/docs/server-api-bot-bot-session-api#Text-Response-Object); when type is `image` ,it represents [ImageResponse](/docs/server-api-bot-bot-session-api#ImageResponse-Object);when type is `video`, the content is the video url, it represents string; when type is `button`,it represents [ButtonResponse](/docs/server-api-bot-bot-session-api#buttonresponse-object);when type is `quickReply`, it represents [QuickReplyResponse](/docs/server-api-bot-bot-session-api#QuickReplyResponse); when type is `ivrMenu`, it represents [IVRMenu Response](/docs/server-api-bot-bot-session-api#IVRMenu-Response-Object);when type is `transferCall`, it represents [TransferCall Response](/docs/server-api-bot-bot-session-api#TransferCall-Response-Object); |
| `disableChatInputArea` | bool | false | Only available when channel is `Live Chat`. |
| `delayTime` | decimal | 1 | how many seconds delay to show |

### Text Response Object

Text Response is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `text` | string |  | string |
| `audio` | string |  | base64 string, convert the text to speech |

### ImageResponse Object

Image is represented as simple flat JSON objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `name` | string |  | name of the image |
| `url` | string |  | url of the image |

### ButtonResponse Object

ButtonResponse is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | text above buttons,this text will be sent before buttons. |
| `buttons` | [Button](/docs/server-api-bot-bot-session-api#button-Object)[] |  | an array of [Button](/docs/server-api-bot-bot-session-api#button-Object). |

### Button Object

Button is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `buttonText` | string |  | text on button. |
| `type` | enum |  | enums contain `triggerAnIntent`,`link` and `webView`,type of buttons |
| `linkUrl` | string |  | url of the web page you want to open. |
| `intentId` | Guid |  | id of the intent you choosed. |
| `openIn` | string |  | enums contain `sideWindow`,`newWindow`,`currentWindow`, it represents the way that a page will be opened. |
| `openStyle` | string |  | enums contain `compact`,`tall` and `full`,it represents the size of the webview that will be opened. |

### QuickReplyResponse

QuickReplyResponse is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | text sent before quickreplys. |
| `quickReplyItems` | [QuickReplyItem](/docs/server-api-bot-bot-session-api#QuickReplyItem-object)[] |  | an array of [QuickReplyItem](/docs/server-api-bot-bot-session-api#QuickReplyItem-Object). |

### QuickReplyItem Object

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `type` | enum |  | enum values, `triggerAnIntent`,`contactAnAgent` |
| `text` | string |  | text of quickreply item . |
| `intentId` | Guid |  | Only available when type is `triggerAnIntent`. |

### IVRMenu Response Object

IVRMenu Response is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `message` | string |  | The message sent to visitor before the options.This message will be transferred to IVR and read to visitor |
| `audio` | string |  | base64 string, convert the message text to speech |
| `invalidInputActionRepeatTime` | integer |  | How many times will this IVR Menu repeat if there is invalid input |
| `keys` | [IVRMenuKey](/docs/server-api-bot-bot-session-api#IVRMenuKey-object)[] |  | The valid keys for visitor to choose options. the key contains: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `0`, `*`, `#`. Each key can only be used once in an IVR menu. Visitor can press the key to choose the option. |

### IVRMenuKey Object

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `key` | string |  | The valid keys for visitor to choose options. the key contains: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`, `0`, `*`, `#`. Each key can only be used once in an IVR menu. Visitor can press the key to choose the option. |
| `text` | string |  | text of quickreply item . |
| `intentId` | Guid |  |  |

### TransferCall Response Object

TransferCall Response is represented as simple flat json objects with the following keys:

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `targetNumber` | string |  | phone number. |

## Endpoints

### Create session

`POST /chatbots/{chatbotId}/sessions`

#### Parameters

Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `chatbotId` | Guid | yes | the unique id of the bot |

Request body

The request body contains data with the follow structure:

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `channel` | string | yes |  | eg: `Live Chat`, `Facebook Messenger`, `Twitter Direct Message`, `WeChat`, `WhatsApp`, `SMS`, `IVR` |
| `id` | Guid | yes |  | id of the session, you must generate the unique sessionId |
| `context` | [ChatbotSessionContext](/docs/server-api-bot-bot-session-api#ChatbotSessionContext-Object) Object | no |  |  |

example:

```
  {
    "channel":"IVR",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {   
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }
```

#### Response

the response is: [ChatbotSession](/docs/server-api-bot-bot-session-api#ChatbotSession-Object) Object

#### Example

Using curl

```
curl -H "Content-Type: application/json" -d '{
    "channel":"IVR",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {   
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }' -X POST https://domain.comm100.com/chatbots/a9928d68-92e6-4487-a2e8-8234fc9d1f48/sessions
```

Response

```
  HTTP/1.1 200 OK
  Content-Type:  application/json

  {    
    "channel":"IVR",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    },
    "message":{
      "id":"d3f5b968-ad51-42af-b759-64c0afc40b84",
      "visitorQuestion":"",
      "type":"greetingMessage",
      "content":{
        "responses":[
          {
            "type":"text",
            "content": {
              "text":"Hi, I'm Peely, I'm glad to help you.",
              "audio":"UklGRrj2AQBXQVZFZm10IBAAAAABAAEAwF0AAIC7AAACABAAZGF0YZT2AQA..."
            }
          },
          {
            "type":"text",
            "content": {
              "text":"You can ask any questions. If you want to know what I can help with, you can say Menu or Options",
              "audio":"UklGRrj2AQBXQVZFZm10IBAAAAABAAEAwF0AAIC7AAACABAAZGF0YZT2AQA..."
            }
          }
        ]
      }
    }    
  }
```

### Recieved Message

`POST /sessions/{sessionId}:recieveMessage`

#### Parameters

Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | Guid | yes | id of the chat or conversation |

Request body

The request body contains data with the follow structure:

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `channel` | string | yes |  | eg: `Live Chat`, `Facebook Messenger`, `Twitter Direct Message`, `WeChat`, `WhatsApp`, `SMS`, `Voice` |
| `textInput` | string | no |  | text |
| `context` | [ChatbotSessionContext](/docs/server-api-bot-bot-session-api#ChatbotSessionContext-Object) Object | yes |  |  |

example:

```
  {
    "channel":"Facebook Messenger",
    "textInput":"i want to buy NBN",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    },
  }
```

#### Response

the response is: [ChatbotSession](/docs/server-api-bot-bot-session-api#ChatbotSession-Object) Object

#### Example

Using curl

```
curl -H "Content-Type: application/json" -d '{
    "channel":"Facebook Messenger",
    "textInput":"i want to buy NBN",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    },
  }' -X POST https://domain.comm100.com/sessions/f9928d68-92e6-4487-a2e8-8234fc9d1f48:detectIntent
```

Response

```
  HTTP/1.1 200 OK
  Content-Type:  application/json

  {    
    "channel":"Facebook Messenger",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "currentIntentId": "8d6892e6-92e6-4487-a2e8-92e68d6892e6",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    },
    "message":{
      "id":"d3f5b968-ad51-42af-b759-64c0afc40b84",
      "visitorQuestion":"i want to buy NBN",
      "type":"highConfidenceAnswer",
      "content":{
        "intentId": "7534fdsca-92e6-4487-a2e8-92e68d6892e6",
        "intentName": "buy nbn",
        "score": 89.25,
        "responses":[
          {
            "type":"htmlText",
            "content": {
              "text":"<div>Hi, what can i do for you?</div>",
            }
          },
          {
            "type":"image",
            "content": {
              "name":"greeting.png",
              "url": "https://bot.comm100.com/botapi/images/greeting.png"
            }
          }
        ]
      }
    }    
  }
```

### Trigger an intent

`POST /sessions/{sessionId}:triggerAnIntent`

#### Parameters

Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | Guid | yes | id of the chat or conversation |

Request body

The request body contains data with the follow structure:

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `channel` | string | yes |  | eg: `Live Chat`, `Facebook Messenger`, `Twitter Direct Message`, `WeChat`, `WhatsApp`, `SMS` |
| `intentId` | Guid | yes |  | id of the intent triggered |
| `context` | [ChatbotSessionContext](/docs/server-api-bot-bot-session-api#ChatbotSessionContext-Object) Object | yes |  |  |

example:

```
  {
    "channel":"Live Chat",
    "intentId":"8d6892e6-92e6-4487-a2e8-92e68d6892e6",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }
```

#### Response

the response is: [ChatbotSession](/docs/server-api-bot-bot-session-api#ChatbotSession-Object) Object

#### Example

Using curl

```
curl -H "Content-Type: application/json" -d '{
    "channel":"Live Chat",
    "intentId":"8d6892e6-92e6-4487-a2e8-92e68d6892e6",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }' -X POST https://domain.comm100.com/sessions/f9928d68-92e6-4487-a2e8-8234fc9d1f48:triggerAnIntent
```

Response

```
  HTTP/1.1 200 OK
  Content-Type:  application/json

  {    
    "channel":"Live Chat",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "currentIntentId": "8d6892e6-92e6-4487-a2e8-92e68d6892e6",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    },
    "message":{
      "id":"d3f5b968-ad51-42af-b759-64c0afc40b84",
      "visitorQuestion":"Lost Card",
      "type":"authenticationRequest",
      "content":{
        "signInMessage": "Please Login",
        "signInButtonText": "Login",
        "signInURL": "https://domain.comm100.com/ssoidp/ssoLogin.aspx"  
      }
    }    
  }
```

### Rate the bot answer as helpful or not helpful

`POST /sessions/{sessionId}:rate`

#### Parameters

Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `sessionId` | Guid | yes | id of the chat or conversation |

Request body

The request body contains data with the follow structure:

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `channel` | string | yes |  | eg: `Live Chat`, `Facebook Messenger`, `Twitter Direct Message`, `WeChat`, `WhatsApp`, `SMS` |
| `chatbotMessageId` | Guid | yes |  | the id of the [ChatbotMessage](/docs/server-api-bot-bot-session-api#ChatbotMessage-object) |
| `type` | enum | yes |  | `helpful` or `notHelpful` |
| `context` | [ChatbotSessionContext](/docs/server-api-bot-bot-session-api#ChatbotSessionContext-Object) Object | yes |  |  |

example:

```
  {
    "channel":"Live Chat",
    "chatbotMessageId":"4487fc9d-92e6-4487-a2e8-92e68d6892e6",
    "type": "notHelpful",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }
```

#### Response

the response is: [ChatbotSession](/docs/server-api-bot-bot-session-api#ChatbotSession-Object) Object

#### Example

- Rate the bot as not helpful

Using curl

```
curl -H "Content-Type: application/json" -d '{
    "channel":"Live Chat",
    "chatbotMessageId":"4487fc9d-92e6-4487-a2e8-92e68d6892e6",
    "type": "notHelpful",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }' -X POST https://domain.comm100.com/sessions/f9928d68-92e6-4487-a2e8-8234fc9d1f48:rate
```

Response

```
  HTTP/1.1 200 OK
  Content-Type:  application/json
  {    
    "channel":"Live Chat",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    },
    "message":{
      "id":"d3f5b968-ad51-42af-b759-64c0afc40b84",
      "visitorQuestion":"",
      "type":"notHelpfulMessage",
      "content":{
        "messageWhenNotHelpful":"I am sorry that this doesn't answer your question. Please click on following button to connect to an agent.",
        "ifIncludeContactAgentOptionWhenNotHelpful": true,
      },
      "smartTriggerActions":[
        {
          "type":"transfer", 
          "isEnabled": true,
          "targetType": "department",
          "selectedDepartments": ["sadwe21d-92e6-4487-a2e8-92e68d6892e6"] 
        }
      ]
    }    
  }
```

- Rate the bot as helpful

Using curl

```
curl -H "Content-Type: application/json" -d '{
    "channel":"Live Chat",
    "chatbotMessageId":"4487fc9d-92e6-4487-a2e8-92e68d6892e6",
    "type": "helpful",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }
  }' -X POST https://domain.comm100.com/sessions/1487fc9d-92e6-4487-a2e8-92e68d6892e6:rate
```

Response

```
HTTP/1.1 200 OK
  Content-Type:  application/json
  {    
    "channel":"Live Chat",
    "id": "f9928d68-92e6-4487-a2e8-8234fc9d1f48",
    "context": {
      "chatbotId": "a9928d68-92e6-4487-a2e8-8234fc9d1f48",
      "customData": {
        "name":"Kart",
        "email":"kart@yahoo.com",
        "phone":"123-4355-212",
      }
    }       
  }
```