API Messaging
The following are the most important APIs to use to establish complete functionality with Lynn. For more information on the complete set of APIs, you can use the following URL Messenger Service
Authentication token generation
One of the necessary requirements for using the Lynn API is to verify that the consumer (user or service) is authorized to use the API; To do this, the first thing to do is to obtain the authentication token.
Important Points:
• Protected Method: No, it can be queried directly.
• Route: /api/LynnService/CreateToken
• Metod: POST
Parameter Table
| Parámetro | Locación | Description |
|---|---|---|
| BODY | { "accessToken": "string", "accessTokenSecret": "string", "tenant": “number” } accessToken Text string that is part of the authentication parameters, generated when creating tenant security credentials and can no longer be modified. Example: 90234137e9752f1. Note: It is similar to a user. accessTokenSecret Text string that is part of the authentication parameters, generated when creating tenant security credentials and can no longer be modified. Example: 66d83a1b-4da4-42f5-9883-44b8f32c36d5. Tenant Numeric identifier of the tenant. Obtained from the Lynn graphical interface. |
Respuestas
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | Note: This response must be included in the header of the following requests in order to handle security. Example: Variable Authorization: bearer eyJhbGciOiJIUzoEzKw4ly8jgmmAoxJbg Json Response { "token": "eIkpXVCJ9.eyJhefWYXYMSl8e84YxLxrCWKVeY4N Us_2c239NG4" } |
| 401 | Unauthorized | No response. |
Return an active chat session
Returns a session by its ID as long as it is active. If it is not active, it will create a new session and assign the same ID sent as a parameter.
Important Points:
- Protected Method: Yes.
- Include the token of the [authentication token generation] method in the header of the request (#Generación_de_token).
Route:
/api/LynnService/SessionByCriteria/{criteria}/{value}/{inactivityTimeout}/{clientIdentification}/{callIId}/{capacityType}/{clientId}/{channelId}/{tenant}/{verbose}
Metod: POST
Parameters table
| Parámetro | Locación | Description |
|---|---|---|
| criteria | URL | Text string with the search criteria for the record, has a common format. Example: rut_usuario. |
| value | URL | Value corresponding to the criteria established in the previous parameter, has an open text string format. Example: 231231, abcds 232dsdda, 0000-0000-0000-0000. |
| inactivityTimeout | URL | Inactivity time in seconds to compare and only obtain the last interactions whose last request is less than the value of this parameter, this inactivity time does not apply while it is in the strategy queue. |
| clientIdentification | URL | Client name, it must be maintained throughout the conversation. |
| callId | URL | Identifier of the associated voice call, if applicable, otherwise it can be sent with the value "unknown". |
| capacityType | URL | Type of channel capacity. The valid capabilities are: - UNKNOWN = 0 - PhoneCall = 1 - DeviceVoice = 2 - WebViewer = 3 - OfficialChannel = 4, - UnOfficialChannel = 5 |
| clientId | URL | Client identifier, it is a uniqueidentifier that must be maintained throughout the conversation. |
| channelId | URL | Identifier of the channel through which the client is communicating and that is registered on the platform that supports the tenant. |
| tenant | URL | The value of the configured tenant id for the client. |
| verbose | URL | Level of logs to generate [1…5]. |
| BODY | Ud_X Custom parameters sent to the API that correspond to user data, the json can be sent with any number of these parameters. Json Response { "ud_1":"val1", "ud_2":"val2", "ud_3":"val3" } |
Responses:
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | Note: The answer can be a list of this object, which is just an example and may vary in some parameters. This response corresponds to an elasticsearch document, important parameters: _index Code of the index where the document is located. _source Object that describes the type of information stored in the document. Level Message level, indicates whether the record type is confirmation or log. Example: - Dialog for chat messages. - Debug for log messages. - Audit for audit messages. - Error for error messages. subLevel Corresponds to a specific activity according to the specified level and depends on the generic classification indicated by the client. Criteria Search criteria to identify records of a session, for example: client's identity card, ID, among others. CriteriaValue Value of the search criteria defined in the previous parameter. Host Name or IP address of the Lynn server that generated the record. Session Identifier of the session provided in the call that was successfully retrieved. Json Response {
|
| 401 | Unauthorized | Unanswered. |
Forcing an intention in an already created session
Using this function, a specific intention can be induced in Lynn without the corresponding text evaluation in the cognitive engine.
Important Points:
- Protected Method:: Yes.
- Include the token of the Token Generator method in the request header.
Path:
/api/LynnService/SendTextMessageWithIntent/{sessionId}/{capacityType}/{clientId}/{intent}
Metod: POST
Parameter table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the configured tenant id in Lynn. |
| sessionId | URL | Identifier of the session to which you want to send the message. |
| capacityType | URL | Type of capacity of the channel. Valid capacities are: - UNKNOWN = 0 - PhoneCall = 1 - DeviceVoice = 2 - WebViewer = 3 - OfficialChannel = 4, - UnOfficialChannel = 5 |
| clientId | URL | Client identifier, it is a uniqueidentifier that must be maintained throughout the conversation. |
| intent | URL | The intent to force. This causes Lynn to execute that intent without associated text evaluation. |
| BODY | The message text to send. The body is sent in plain text format. |
Response
| Http code | Description | response body |
|---|---|---|
| 200 | Success | This response corresponds to a response where the requested intention does not exist, important parameters: sessionId Identifier of the current session, generated at the time of creating the session and whose validity will be equal to that established in the timeout parameter at the time of creating the session. intent Number of the requested intention, if its value is null it corresponds to the intention that was attempted to force does not exist. eventMessages List of objects corresponding to the message events set in the response for visual processing. event Identifies the type of event associated with the message, there are 43 types of message events, to see the complete list go to Message Events. Message Events. messageType Type of message of the response: 1 Menu, 2 Event, 3 Text, it is in each object of the eventMessages list. code Sub-Event generated in the message response, you can find the complete list in Message Sub-Events. availableByVoice Boolean value that indicates whether the message event is available by voice. availableByText Boolean value that indicates whether the message event is available in text. Json Response {
} |
| HTTP Code | Description | response body |
| - | - | - |
| 401 | Unauthorized | Unanswered. |
Send a text message in an established session
Using this function, a text message can be sent from the client to Lynn.
Important Points:
- Protected Method: Yes.
- Include the authentication token in the request header from the Authentication Token Generation method
Route:
/api/LynnService/SendTextMessage/{sessionId}/{capacityType}/{clientId}
Metod: POST
Parameters Table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the tenant ID configured in Lynn. |
| sessionId | URL | Identifier of the session to which you want to send the message. |
| capacityType | URL | Type of channel capacity. Valid capacities are: - UNKNOWN = 0 - PhoneCall = 1 - DeviceVoice = 2 - WebViewer = 3 - OfficialChannel = 4, - UnOfficialChannel = 5 |
| clientId | URL | Client identifier, it is a uniqueidentifier that must be maintained throughout the conversation. |
| BODY | The text of the message to be sent. The body is sent in plain text format. |
Responses
| Http Code | Description | Response Body |
|---|---|---|
| 200 | Success | This response corresponds to a response where the requested intention does not exist, important parameters: sessionId Identifier of the current session, generated at the time of creating the session and whose validity will be equal to that established in the timeout parameter at the time of creating the session. intent Number of the requested intention, if its value is null it corresponds to the intention that was attempted to force does not exist. eventMessages List of objects corresponding to the message events set in the response for visual processing. event Identifies the type of event associated with the message, there are 43 types of message events, to see the complete list go to Message Events. Message Events. messageType Type of message of the response: 1 Menu, 2 Event, 3 Text, it is in each object of the eventMessages list. code Sub-Event generated in the message response, you can find the complete list in Message Sub-Events. availableByVoice Boolean value that indicates whether the message event is available by voice. availableByText Boolean value that indicates whether the message event is available in text. Json Response {
} |
| 401 | Unauthorized | Unanswered. |
Send induced message
Induces the bot to send a message previously established by the client.
Important points:
- Protected method: Yes.
- Include the authentication token in the request header using the Authentication Token Generation method.
Route:
/api/LynnService/SendInducedMessage/{tenant}/{sessionId}/{availableByVoice}/{availableByText}/{capacityType}/{clientId}
Metod: POST
Parameters table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the tenant id configured in Lynn. |
| sessionId | URL | Identifier of the session to which you want to send the message. |
| availableByVoice | URL | Boolean value indicating whether the message event is available by voice. |
| availableByText | URL | Boolean value indicating whether the message event is available in text. |
| capacityType | URL | Type of channel capacity. Valid capacities are: - UNKNOWN = 0 - PhoneCall = 1 - DeviceVoice = 2 - WebViewer = 3 - OfficialChannel = 4, - UnOfficialChannel = 5 |
| clientId | URL | Client identifier, it is a uniqueidentifier that must be maintained throughout the conversation. |
Response
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | sessionId Identifier of the current session, generated at the moment of creating the session and whose validity will be equal to the one established in the timeout parameter at the time of creating the session. intent Number of the requested intent, if its value is null it corresponds to the attempted intent being non-existent. eventMessages List of objects that correspond to the event messages set in the response for their visual processing. event Identifies the type of event associated with the message, there are 43 types of message events, to see the complete list go to Menssage Event. messageType Type of message in the response: 1 Menu, 2 Event, 3 Text, it is found in each object of the eventMessages list. code Sub-event generated in the message response, the complete list can be found in Message Sub-Events. availableByVoice Boolean value that indicates if the message event is available by voice. availableByText Boolean value that indicates if the message event is available by text. Json Response {
} |
| 401 | Unauthorized | Unanswered |
Request the value of a configuration parameter
Obtains the value of a configuration parameter for a tenant using the configuration name as the search criteria.
Important Points:
- Protected Method: Yes.
- Include the authentication token generated by the Authentication Token Generation .
Route:
/api/LynnService/GetConfiguration/{tenant}/{configurationName}
Metod: POST
Parameter Table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the tenant ID configured in Lynn. |
| configurationName | URL | Name of the configuration assigned at the time of creation.. |
Responses
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | Name This represents the name of the configuration you just queried and is identical to the value placed in the configurationName field. value This is the value of that configuration. Json Response { "name": "CHAT_ENGINE", "value": "PURE_ENGAGE" } |
| 401 | Unauthorized | No response. |
Modify the value of a configuration parameter
Modify the value of a configuration parameter of a tenant using the configuration name as the search criteria.
Important points:
- Protected Method: Yest.
- Include the authentication token method Token Generation in the request header.
Route:
/api/LynnService/SetConfiguration/{tenant}/{configurationName}
Metod: POST
Parameters table
| Parámetro | Locación | Description |
|---|---|---|
| tenant | URL | Numerical value that relates to the tenant ID configured in Lynn. |
| configurationName | URL | Name of the configuration assigned to it at the time of creation. |
| BODY | Plain text configuration value to be set. |
Responses
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | Name This represents the name of the configuration that was just queried and is identical to the value placed in the configurationName field. value This is the new value that the configuration will handle. Json Response { "name": "CHAT_ENGINE", "value": " _ENGAGE" } |
| 401 | Unauthorized | No Response. |
Reading messages from a session
By periodically executing this function, all available messages in Lynn for the client can be obtained. It is recommended that for voice environments, the frequency of execution of this function should be at least one second. For chat environments, this frequency should be configured to 4 seconds.
Important Points:
- Protected Method: Yes.
- Include the authentication token generated by the Authentication Token Generation method in the request header.
Route:
/api/LynnService/ReadMessages/{tenant}/{sessionId}/{capacityType}/{clientId}/{date}
Metod: POST
Parameter Table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the tenant id configured in Lynn. |
| sessionId | URL | Identifier of the session from which to read messages. |
| capacityType | URL | Type of channel capacity. Valid capacities are: - UNKNOWN = 0, - PhoneCall = 1, - DeviceVoice = 2, - WebViewer = 3, - OfficialChannel = 4, - UnOfficialChannel = 5 |
| clientId | URL | Identifier of the client, which is a uniqueidentifier that should be maintained throughout the conversation. |
| date | URL | Date on which the request is made. |
The received messages can be of 3 types:
- Text messages.
- Menu messages.
- Event messages.
All messages are correlated with a field called Correlation, which serves to order them.
Responses
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | This corresponds to a response where Lynn offers all available messages for the client, important parameters: sessionId Identifier of the current session, generated at the time of session creation and whose validity will be equal to that established in the timeout parameter at the time of session creation. |
textMessages List where data of text, voice text, and audio messages are found. menuMessages List where the title, voice title, and audio of the menu are found. eventMessages List where the event and code of the messages are found. awaitingMenu Boolean indicating if the menu is awaiting. awaitingText Boolean indicating if the text is awaiting. awaitingValidation If validation is awaiting, it contains two strings: BusinessType, Regex, and two booleans: AvailableByVoice and AvailableByText. awaitingType Type of wait. supportCancelation It is a boolean, true: if it is active in the conversation, false: if the conversation is null or the manipulated intention of the conversation is null, it returns false. Json Response {
} Ejemplo 2 {
} |
||
| 401 | Unauthorized | No Response. |
Send Menu Response Message
This method allows sending a response to a menu.
Important Points:
- Protected Method: Yes.
- Include the authentication token generated in the Authentication Token Generation method in the request header.
Route: /api/LynnService/SendMenuResponseMessage/{tenant}/{sessionId}/{ capacityType}/{clientId}
Metod: POST
Parameter Table
| Parameter | Location | Description |
|---|---|---|
| Tenant | URL | Identifier of the tenant. |
| sessionId | URL | Identifier of the session to which the message is to be sent. |
| capacityType | URL | Capacity type of the channel. Valid capacities are: - UNKNOWN = 0, - PhoneCall = 1, - DeviceVoice = 2, - WebViewer = 3, - OfficialChannel = 4, - UnOfficialChannel = 5 |
| clientId | URL | Client identifier, a uniqueidentifier that must be kept throughout the conversation. |
Responses
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | This corresponds to a response where Lynn sends the response of a menu, important parameters include: sessionId Identifier of the current session, generated at the time of session creation and whose validity will be equal to that established in the timeout parameter at the time of creating the session. eventMessages List of objects corresponding to the events of the messages established in the response for visual processing. messageType Type of message of the response: 1 Menu, 2 Event, 3 Text, is found in each object of the eventMessages list. code Sub-Event generated in the message response, the complete list can be found in Message Sub-Events. availableByVoice Boolean value that indicates whether the message event is available by voice. availableByText Boolean value that indicates whether the message event is available in text. Json Response {
} |
| 401 | Unauthorized | No response. |
Add/update entities to an already created and in-use session
Entities are variables that can be used during the execution of a session. These variables are passed at the beginning of the session creation and are shared by all conversations that originate during the lifetime of the session. Additionally, when a conversation is created within a session as a result of a cognitive evaluation, all the entities that the cognitive engine has been able to infer using the evaluation text are also added to this conversation. Using this function, extra entities (variables) can be added to an in-use session.
Important points:
- Protected Method: Yes.
- Include the authentication token generated by the Authentication Token Generation method in the request header.
Route: /api/LynnService/SetEntity/{tenant}/{sessionId}/{entityName}
Metod: POST
Parameter table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numerical value that relates to the tenant id configured in Lynn. |
| sessionId | URL | Session identifier. |
| entityName | URL | Name of the entity to add/update. |
Responses
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | Success Boolean value indicating whether or not the entity could be established for the current session. Error Error message included only when Success is false; in any other case, it is omitted from the response. This indicates the reason why attempting to add the new entity failed. JSON Response { "success": false, "error": "An item with the same key has already been added. Key: ChannelName" } |
| 401 | Unauthorized | No response. |
Get Entity
Requests the value of an entity referenced by the session identifier of an active interaction for a particular tenant.
Important Points:
- Protected method: Yes.
- Include the authentication token from the Token Generation method in the request header.
Route:
/api/LynnService/GetEntity/{tenant}/{sessionId}/{entityName}
Metod: POST
Parameter Table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the tenant ID configured in Lynn. |
| sessionId | URL | Identifier of the interaction session. |
| entityName | URL | Name of the entity to retrieve. |
Responses
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | This is the current value of the entity in plain text, delivered in the response body. "WebSimulator" |
| 401 | Unauthorized | No response. |
Cancel Current Interaction
Cancels the current intent of the client, keeps the session active, and continues interacting, but with another context of responses.
Important Points:
- Protected Method: Yes.
- Include the authentication token method Authentication Token Generation in the request header.
Route: /api/LynnService/CancelCurrentInteraction/{tenant}/{sessionId}/{reason}
Metod: POST
Parameter Table
| Parámetro | Locación | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the configured tenant ID in Lynn. |
| sessionId | URL | Identifier of the session that is to be terminated. |
| reason | URL | Reason why the interaction is being terminated. |
Responses:
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | This is the current value of the entity in plain text, delivered in the response body. sessionId Identifier of the current session, generated at the time of session creation and whose validity will be equal to the timeout parameter established at the time of session creation. eventMessages List of objects corresponding to the message events established in the response for visual processing. id Identifier of the cancellation request. Json Response { "sessionId": "734a6c23-4ab8-4aff-8d99-fc6408664986", "eventMessages": [], "id": "00000000-0000-0000-0000-000000000000" } |
| 401 | Unauthorized | No response. |
End a session
All Lynn sessions can be unilaterally terminated by the Lynn interaction engine if the inactivity timeout used (inactivityTimeout) at the time of session creation is reached. Additionally, it is recommended that sessions that are no longer in use be terminated, which will increase Lynn's performance because it will not use resources to monitor unused sessions.
Important Points:
- Protected Method: Yes.
- Include the token generated by the Authentication Token Generation method in the request header.
Route: /api/LynnService/EndSession/{tenant}/{sessionId}
Metod: POST
Parameters Table
| Parameter | Location | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the configured tenant ID in Lynn. |
| sessionId | URL | Identifier of the session to be ended. |
Responses:
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | sessionId Identifier of the current session, generated at the time of session creation, and whose validity will be equal to the timeout parameter established at the time of session creation. messages List of messages that will be sent to the client before closing the session. intent Number of the requested intent, if its value is null it corresponds to the intent that was attempted to force does not exist. eventMessages List of objects corresponding to the events of the messages established in the response for visual processing. event Identifies the type of event associated with the message, there are 43 types of message events, to see the complete list go to Message Events. messageType Response message type: 1 Menu, 2 Event, 3 Text, is in each object of the eventMessages list. code Sub-event generated in the message response, the complete list can be found in Message Sub-Events. availableByVoice Boolean value indicating if the message event is available by voice. availableByText Boolean value indicating if the message event is available in text. Response JSON {
} |
| 401 | Unauthorized | Not Response. |
Get conversation history by session.
Key Points:
- Protected Method: Yes.
- Include in the request header the token of the method Authentication Token Generation
Route:
/api/LynnService/GetHistoricalDialoguesBySession/{tenant}/{sessionId}
Metod: POST
Parameter Table
| Parameters | Location | Description |
|---|---|---|
| Tenant | URL | Numeric value that relates to the tenant ID configured in Lynn. |
| SessionId | URL | Identifier of the session to be retrieved. |
Response:
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | [
] |
| 401 | Unauthorized | No response. |
Get conversation history by tenant
Key Points:
- Protected Method: Yes.
- Include in the request header the token of the method Authentication Token Generation
Route:
/api/LynnService/GetHistoricalDialoguesByTenant/{tenant}
Metod: POST
Parameter Table
| Parameters | Location | Description |
|---|---|---|
| Tenant | URL | Numeric value that relates to the tenant ID configured in Lynn. |
Response:
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | |
| 401 | Unauthorized | No response. |
| 500 | Internal Error | Internal Server Error. |
Send attached file
Attached files can be sent, which are stored in Lynn's memory to be shared between the client and the call center executive handling the interaction. If the session is being understood by a bot or in a waiting queue, this attached file is only delivered through a URL relative to Lynn's memory. If it is actually being handled by a call center agent, this file is transferred to the chat platform that supports such interaction.
Key Points:
- Protected Method: Yes.
- Include in the request header the token of the method Authentication Token Generation
Route: /api/LynnService/UploadFile
Metod: POST
Parameter Table
| Parámetro | Locación | Description |
|---|---|---|
| tenant | URL | Numeric value that relates to the tenant ID configured in Lynn. |
| sessionId | URL | Identifier of the session that is to be retrieved. |
| Content-Type: multipart/form-data | ||
| file | BODY | FileToUpload The name of the file. |
Response:
| HTTP Code | Description | Response Body |
|---|---|---|
| 200 | Success | Success Property indicating whether the file could be uploaded or not. sessionId GUID formatted session of the current customer interaction, generated when the chat is initiated. fileId GUID formatted identifier of the file on the platform to retrieve the file on the platform where it is stored. URL Web address where the file is located for downloading, the base of the address is provided by Lynn's installation address. Json Response { "success": true, "sessionId": "3dc84449-dd7b-46fe-963b-23c23330dec9", "fileId": "6593d153-f90b-4725-8e85-eae8cd74eb98", "url": "MobileApp/File?tenant=27&file=6593d153-f90b-4725-8e85-eae8cd74eb98", "message": null } |
| 401 | Unauthorized | No response. |
Note:📑 Downloading an attachment Files for download are notified to the client using the event: Data, using the following format:
FileID = [URL of the file to download]
This URL is relative to the address where Lynn is installed.
File Treatments
When a file is attached to a chat conversation by a WDE Agent, Lynn notifies the client through a Data event with the name: FileID and the Value is the URL to download the file.
Example:
{
` `"success": true,
` `"messages": [
` `{
` `"Code": 64,
` `"Data": {
` `"FileID": "http://172.17.233.15:8080/genesys/2/chat/Desarrollo/00008aE6BKVN17K0/file/01745C66A67BBF4C/download"
` `},
` `"Details": "",
` `"Event": 32,
` `"Source": "InduceDataEvent",
` `"ExtensionData": {},
` `"AvailableByText": true,
` `"AvailableByVoice": true,
` `"Capacities": [],
` `"ConversationId": "00000000-0000-0000-0000-000000000000",
` `"Correlation": 2,
` `"Date": "/Date(1550231169083)/",
` `"Description": null,
` `"Id": "76e605b3-345b-4ac1-9619-b50531b40f58",
` `"Intent": null,
` `"MessageType": 2,
` `"Part": 0,
` `"PartName": "Agent Name",
` `"SessionId": "6741df0b-4962-4c6e-aa35-47a9f8b4f93a"
` `}
` `],
` `"count": 2,
` `"awaitingType": "",
` `"awaitingText": true,
` `"awaitingMenu": false,
` `"awaitingValidation": null,
` `"supportCancelation": true,
` `"nonEventcount": 0
}
Message Events
Each of these events can be further broken down into sub-events that describe specific activity. To find out if an event has sub-event codes, see Message Sub-Events.
| Event Code | Event Name |
|---|---|
| 0 | UNKNOWN |
| 1 | Error |
| 2 | NEWSESSION |
| 3 | DELETEDSESSION |
| 4 | MENUMESSAGESENT |
| 5 | TEXTMESSAGESENT |
| 6 | MUSTFILLENTITY |
| 7 | EXECUTEDACTION |
| 8 | EXECUTINGACTIONERROR |
| 9 | EXECUTINGCONTEXTCHANGEERROR |
| 10 | EXECUTINGDIALOGERROR |
| 11 | CONVERSATIONEND |
| 12 | IGNOREDMESSAGE |
| 13 | INVALIDVALUE |
| 14 | SESSIONRESTARTED |
| 15 | ACTIONNOTIMPLEMENTEDFORVOICE |
| 16 | DISCARDEDIMAGESFORCHANNEL |
| 17 | RESPONSETEXTFROMCHANNEL |
| 18 | RESPONSEMENUFROMCHANNEL |
| 19 | CONVERSATIONSTART |
| 20 | INDUCEDMESSAGESENT |
| 21 | WEBREDIRECT |
| 22 | INTENTNOTFOUND |
| 23 | TRANSFERTOEXECUTIVE |
| 24 | INTENSIONCANCELED |
| 25 | TYPING |
| 26 | STOPTYPING |
| 27 | STARTBACKGROUNDWORK |
| 28 | STOPBACKGROUNDWORK |
| 29 | REQUIREDMENUSPECIFICATION |
| 30 | REQUIREDMENUSPECIFICATIONWITHOPTIONS |
| 31 | AMBIGUOUSTEXT |
| 32 | DATA |
| 33 | CHATCONVERSATIONEND |
| 34 | CHATAGENTCONNECTED |
| 35 | DEBUG |
| 36 | EXECUTINGACTIONJSONREQUESTERROR |
| 400 | ECO |
| 500 | ENTITYSETTOMEMORY |
| 600 | SESSIONBACKGROUNDWORKERSTART |
| 700 | REMEMORYENTITY |
Message Sub-Events
| Parent Event Code | Sub-Event Code | Event Name |
|---|---|---|
| 1 | 0 | TENANT NOT FOUND |
| 1 | UNKNOWN ERROR CREATING SESSION REST CLIENT | |
| 5 | ERROR END SESSION FROM REST CLIENT | |
| 6 | ERROR READ MESSAGES FROM REST CLIENT | |
| 8 | ERROR RESTARTING SESSION FROM REST CLIENT | |
| 11 | ERROR SENDMENURESPONSEMESSAGE REST CLIENT | |
| 15 | ERROR REQUIREDMENUSPECIFICATIONWITHOPTIONS REST CLIENT | |
| 16 | ERROR SET ENTITY REST CLIENT | |
| 17 | ERROR CANCELCURRENTINTERACTION REST CLIENT | |
| 20 | ERROR SENDTEXTMESSAGE REST CLIENT | |
| 22 | ERROR INDUCE MESSAGE REST CLIENT | |
| 25 | ERROR MULTICHANNELSESSION CANCELCURRENTINTENT | |
| 27 | ERROR MULTICHANNELSESSION _DAEMON_DOWORK | |
| 33 | ERROR MULTICHANNELSESSION _DAEMON_DOWORK ACTIONJSONREQUEST POST | |
| 34 | ERROR MULTICHANNELSESSION _DAEMON_DOWORK CONTEXT CHANGE | |
| 40 | ERROR MULTICHANNELSESSION SENDTEXTMESSAGE | |
| 42 | ERROR MULTICHANNELSESSION SENDTEXTMESSAGE | |
| 43 | ERROR MULTICHANNELSESSION SENDINDUCEDMESSAGE | |
| 44 | ERROR MULTICHANNELSESSION SENDTEXTMESSAGE | |
| 46 | ERROR MULTICHANNELSESSION SENDINDUCEDMESSAGE | |
| 48 | ERROR MULTICHANNELSESSION SENDANSWERTOMENU | |
| 49 | ERROR MULTICHANNELSESSION WAITFORMENU | |
| 62 | ERROR MULTICHANNELSESSION STARTCHATCONVERSATION | |
| 65 | ERROR MULTICHANNELSESSION INDUCEDATAEVENT | |
| 67 | ERROR SESSIONSTATUS SOAP | |
| 69 | ERROR SESSIONSTATUS SOAP | |
| 70 | ERROR CREATESESSION SOAP | |
| 72 | ERROR DELETESESSION SOAP | |
| 73 | ERROR READMESSAGE SOAP | |
| 75 | ERROR SESSIONRESTARTED SOAP | |
| 79 | ERROR SENDMENURESPONSEMESSAGE SOAP | |
| 83 | ERROR SENDMENURESPONSEBYLEVENSHTEINDISTANCE SOAP | |
| 84 | ERROR CANCELCURRENTINTERACTION SOAP | |
| 87 | ERROR SENDTEXTMESSAGE | |
| 89 | ERROR SENDINDUCEDMESSAGE | |
| 200 | ERROR EVALUATEEXTENDEDPROPERTIES EVALUATION | |
| 201 | ERROR MULTIPLE DEFINITIONS FOR THE SAME ENTITY GETPARAMETERSFORDELEGATIONCOMMAD | |
| 202 | ERROR ENTITY NOT FOUND IN DATABASE | |
| 203 | ERROR ENTITY NOT MENU IN EVALUATION OF ACTION CONDITION | |
| 204 | ERROR ENTITY EXTENDED PROPERTY EVALUATION OF ACTION CONDITION | |
| 205 | ERROR GENERIC EVALUATION OF ACTION CONDITION | |
| 206 | ERROR GENERIC EVALUATION OF ACTION CONDITION | |
| 207 | ERROR ACTIONJSONREQUEST EVALUATION PARAMETERS | |
| 208 | ERROR EVALUATING PARAMETERS FOR AUDIO DIALOG | |
| 209 | ERROR EVALUATING PARAMETERS FOR WEB REDIRECT | |
| 210 | ERROR GENERIC ERROR ON ACTIONS PREPARATION | |
| 211 | ERROR INTENT NOT FOUND IN DB CONVERSATIONINTENT. CREATEFROMID | |
| 212 | ERROR GENERIC CONVERSATIONINTENT.CREATEFROMID | |
| 213 | ERROR GENERIC STARTCHATCONVERSATION | |
| 214 | ERROR GENERIC GENERATEACTIONFROMDB | |
| 215 | ERROR CREATING SESSION MULTICHANNELSESSION CREATE | |
| 216 | ERROR FINALIZECHATCONVERZATION | |
| 217 | ERROR GENERIC SENDTEXTMESSAGE | |
| 2 | 2 | NEW SESSION FROM REST CLIENT SESSIONSTATUS |
| 3 | NEW SESSION FROM REST CLIENT CREATESESSION | |
| 68 | SESSIONSTATUS SOAP | |
| 69 | CREATESESSION SOAP | |
| 3 | 4 | END SESSION FROM REST CLIENT |
| 71 | FROM SOAP | |
| 218 | ||
| 4 | 9 | MESSAGE SENT FROM REST CLIENT |
| 76 | FROM SOAP | |
| 5 | 18 | TEXTMESSAGE SENT REST CLIENT |
| 85 | FROM SOAP | |
| 6 | 26 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 7 | 32 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 9 | 35 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 11 | 29 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 12 | 14 | IGNORE MESSAGE FROM REQUIREDMENUSPECIFICATIONWITHOPTIONS REST CLIENT |
| 23 | FROM MULTICHANNELSESSION | |
| 41 | FROM MULTICHANNELSESSION SENDTEXTMESSAGE | |
| 78 | FROM SENDMENURESPONSEMESSAGE SOAP | |
| 82 | FROM SENDMENURESPONSEBYLEVENSHTEINDISTANCE SOAP | |
| 13 | 47 | MULTICHANNELSESSION SENDANSWERTOMENU |
| 14 | 7 | SESSION RESTARTED FROM REST CLIENT |
| 74 | FROM SOAP | |
| 15 | 37 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 17 | 19 | RESPONSETEXTFROMCHANNEL FROM REST API |
| 86 | FROM SOAP | |
| 18 | 10 | RESPONSE MENU FROM CHANNEL REST CLIENT |
| 77 | FROM SOAP | |
| 19 | 45 | MULTICHANNELSESSION SENDTEXTMESSAGE |
| 20 | 21 | INDUCE MESSAGE SENT FROM REST CLIENT |
| 88 | FROM SOAP | |
| 21 | 36 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 22 | 28 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 214 | ERROR GENERIC GMS CHAT INTERNALLOGOUT | |
| 215 | ERROR GENERIC GMS CHAT SESSION CREATED | |
| 216 | ERROR GENERIC GMS WORKER PROCESS _WORKER_DOWORK | |
| 217 | ERROR GENERIC MULTICHANNELSESSION _DAEMON_DOWORK | |
| 24 | 24 | MULTICHANNELSESSION CANCELCURRENTINTENT |
| 27 | 50 | MULTICHANNELSESSION INDUCEBACKGROUNDWORKAGENT |
| 52 | MULTICHANNELSESSION INDUCEBACKGROUNDWORKBOT | |
| 54 | MULTICHANNELSESSION INDUCEBACKGROUNDWORKUSER | |
| 56 | MULTICHANNELSESSION INDUCETYPINGEVENTFOMBOT | |
| 58 | MULTICHANNELSESSION INDUCETYPINGEVENTFOMUSER | |
| 28 | 51 | MULTICHANNELSESSION INDUCEBACKGROUNDWORKAGENT |
| 53 | MULTICHANNELSESSION INDUCEBACKGROUNDWORKBOT | |
| 55 | MULTICHANNELSESSION INDUCEBACKGROUNDWORKUSER | |
| 57 | MULTICHANNELSESSION INDUCETYPINGEVENTFOMBOT | |
| 59 | MULTICHANNELSESSION INDUCETYPINGEVENTFOMUSER | |
| 29 | 12 | REQUIREDMENUSPECIFICATION FROM REST CLIENT |
| 82 | FROM SOAP | |
| 30 | 13 | REQUIREDMENUSPECIFICATIONWITHOPTIONS FROM REST CLIENT |
| 80 | FROM SOAP | |
| 31 | 30 | MULTICHANNELSESSION _DAEMON_DOWORK |
| 32 | 64 | MULTICHANNELSESSION INDUCEDATAEVENT |
| 63 | MULTICHANNELSESSION INDUCEDATAEVENT | |
| 33 | 60 | MULTICHANNELSESSION FINALIZECHATCONVERZATION |
| 34 | 66 | MULTICHANNELSESSION INDUCEGENERICCONNECTEVENT |
| 35 | 61 | MULTICHANNELSESSION STARTCHATCONVERSATION |
| 36 | 31 | MULTICHANNELSESSION _DAEMON_DOWORK |
Declared Limitations
Consumption Quotas
rate-limit-by-key methods have no rate-limit type limitation.
Quotas per Product
Basic Product: Activated by default when consuming the API. Allows:
- Periodo: 43.200 seconds (12 hours)
- Calls: 10.000
- Bandwidth: 102.400 kilobytes (100 megabytes)
Premium Product: Requires requesting it through partner Lynn or a sales advisor, who will provide a valid Ocp-Apim-Subscription-Key. Allows:
- Periodo: 43.200 seconds (12 hours).
- Calls: 20.000
- Bandwidth: 997.200 kilobytes (997.2 megabytes)
To execute a report with the Premium product, it is necessary to activate the Ocp-Apim-Subscription-Key parameter in the headers, as shown below:
Error Description
| Error code | Description |
|---|---|
| 403 | Out of bandwidth quota. Quota will be replenished in T |