Name
Name
### **User Input** |
Name
Name
Name
Name
## Likable Service | **Method** | **POST** | | ---------- | ---------------------------------------- | | URL: | **/org/{orgUUID}/env/{envUUID}/likable** | | Type: | **application/json** | The likable service is used when an answer is configured to be evaluable. When this option is enable, the answer should give the user a thumbs up / thumbs down option (like / dislike) in the chat.
Name
| Method: | POST | |
|---|---|---|
| URL: | /conversations/{sessionCode}/satisfactions | |
| Type: | application/json |
Name
Name
### **Request body** | **Name** | **Type** | **Required** | **Description** | | ----------------- | ------------ | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **evaluation** | Short number | Yes | This number represents how the user graded the virtual agent. It is recommended to be a number from 1 to 10, but can be changed to use other systems (i.e. 5 stars) | | **answered** | Short number | Yes | Considering that a user interacts with a virtual agent to have a question/problem answered:1 – the user had its problem solved0 – his problem was not solved | | **userComments** | String | No | User comments about the session. | | **expireSession** | Boolean | Yes | ·This value must be **true** if you wish the session to immediately be expired when the user sends this evaluation.It should be **false instead if** the session must not be expired so that the conversation might still continue | ### **Response body** The satisfaction service will return a HTTP Status 200 with a “Success” string.
### Sample request ``` { "evaluation": 5, "answered": "true", "userComments": "You answered where to find the information, but why didn’t you give the info in the chat?", "expireSession": true } ``` ### Sample response "Success" ## Recommended Practices ### Message Protection Messages sent to the conversation API are sent with both the user’s message data, which may contain sensitive information and with your Syntphony CAI token. While one attempt a straightforward implementation in their front-end website that immediately calls our API, we highly recommend against that as it can endanger your user's data, your token integrity, and breaches the GDPR. Leaving this valuable information exposed may be exploited and also exposes your token to anyone who wants it in the console. Furthermore, your data is now spoofable by softwares such as sharks which may intercept your messages if they are transmitted with their data in a human language. Sending your raw requests from the front-end is an understandable practice during your development phase, but we highly recommend you to add a custom security layer for this data, encrypting all messages sent by the front-end. One adequate way to do this, is to have your back-end act as a security intermediate. A secure message flow would have the messages your user is sending though your chat, encrypted by a library such as CryptoJS, sent to your back-end server instead, which will then decrypt the message and send the request to the Conversation API itself, where the data is not spoofable or exploitable by users.
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.conversational-ai.syntphony.com/user-guide/api-docs/api-guidelines/creating-channels-the-conversation-api.md?ask=