Project: Messages API Lynn

Description: Provided by lynn.cx

Documentación en Postman

The Lynn Messages API provides access to most of the data processed by Lynn. You can access the API from the Lynn testing environment or Lynn production environment.

📁 Collection: Parameters

📁

New Request

Description: Method: GET

?endpoint=https://lynn-latam-testing-br-broker.azurewebsites.net/ Query Params

Param	value
endpoint	https://lynn-latam-testing-br-broker.azurewebsites.net/
null	https://lynn-latam-testing-br-broker.azurewebsites.net/

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

CreateToken

Description: One of the necessary requirements for the use of the Api Lynn is to verify that the consumer (user or service) has authorization to use the API; To do this, the first thing to do is obtain the authentication myToken.

Contact administrator Lynn to get the accessToken and accessSecret for your tenant. Method: POST

{{endpoint}}/api/LynnService/CreateToken Headers

Content-Type	Value
Content-Type	application/json

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

Body (raw)

{
    accessToken: {{accessToken}},
    accessTokenSecret: {{accessSecret}},
    tenant: {{tenant}}
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

GetStatsByTenant

Description: With this method you can observe the statistics active sessions, active bot, among others and in which, the payload depends on the genesys statistics. Method: POST

{{endpoint}}/api/LynnService/GetStatsByTenant/{{tenant}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

ReadMessages

Description: By executing all this function periodically, you can get the messages available in Lynn for the client. It is recommended that for voice environments the frequency of execution of this function must be at least one second. For chat environments this frequency must be configured in 4 seconds. Method: POST

{{endpoint}}/api/LynnService/ReadMessages/{{tenant}}/{{sessionId}}/{{capacity}}/{{clientID}}/{{date}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

EndSession

Description: All Lynn sessions can be terminated unilaterally by the Lynn interactions if the idle time used (inactivityTimeout) is reached at the time of create such a session. Additionally, it is recommended that the sessions that are no longer used be finished which will increase Lynn's performance because it will not use resources to monitor deprecated sessions. Method: POST

{{endpoint}}/api/LynnService/EndSession/{{tenant}}/{{sessionId}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

🔑 Authentication bearer

Param	value	Type
token	{{myToken}}	string

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SessionByCriteria

Description: Returns the information related to a session if it exists in memory. Even if it's checked to be removed by timeout. In case nothing is returned, the session would not be in the memory of Lynn. Method: POST

{{endpoint}}/api/LynnService/SessionByCriteria/{{criteria}}/{{value}}/{{inactivityTimeout}}/{{clientIdentifier}}/{{callIId}}/{{capacity}}/{{clientID}}/{{channelId}}/{{tenant}}/{{verbose}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

Body (raw)

{
    lang : ES,
    ChannelId : 20

}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

Ping deprecate

Description: Useful method when you want to validate that the service is active and / or if you want to know the number of active sessions a tenant has. Method: POST

{{endpoint}}/api/LynnService/Ping/{{tenant}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

GetDeflectionPossibilities

Description: This method allows you to obtain the available communication channels to which you can redirect customer communication according to tenant (Facebook, chat, email, among others). Method: POST

{{endpoint}}/api/LynnService/GetDeflectionPossibilities/{{tenant}}/{{clientIdentifier}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

StartDeflection

Description: Thanks to this method, the Lynn service is instructed to initiate the transfer of the interaction indicated in the requested task. Method: POST

{{endpoint}}/api/LynnService/StartDeflection/{{tenant}}/{{proposalId}}/{{method}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SendTextMessageWithIntent

Description: Using this function it is possible to induce in Lynn a certain intention without the respective text evaluation in the cognitive motor Method: POST

{{endpoint}}/api/LynnService/SendTextMessageWithIntent/{{tenant}}/{{sessionId}}/{{capacityType}}/{{clientId}}/{{intent}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SendTextMessage

Description: Using this function it is possible to induce in Lynn a certain intention without the respective text evaluation in the cognitive motor. Method: POST

{{endpoint}}/api/LynnService/SendTextMessage/{{tenant}}/{{mySessionID}}/{{capacityType}}/{{clientID}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

Body (raw)

Consulta de Saldo

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SendMenuResponseMessage

Description: Through this method the response of a menu can be sent. Method: POST

{{endpoint}}/api/LynnService/SendMenuResponseMessage/{{tenant}}/{{sessionId}}/{{capacityType}}/{{clientId}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

GetEntity

Description: Requests the value of an entity referenced by the session identifier of an active interaction for a particular tenant. Method: POST

{{endpoint}}/api/LynnService/GetEntity/{{tenant}}/{{sessionId}}/{{entityName}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SetEntity

Description: Entities are the variables that can be used during the execution of a session. Said variables are passed at the beginning of the session creation and are shared by all conversations that originate during the lifetime of the session. Also, when a conversation is created within a session as a product of a cognitive assessment, this conversation is also add all the entities that the cognitive engine has been able to infer using the text of evaluation. Using this function, extra entities (variables) can be added to a current session. Method: POST

{{endpoint}}/api/LynnService/SetEntity/{{tenant}}/{{sessionId}}/{{entityName}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

CancelCurrentInteraction

Description: Cancel the current intention of the client, the session is kept active and the interaction continues, but with another answer of answers. Method: POST

{{endpoint}}/api/LynnService/CancelCurrentInteraction/{{tenant}}/{{sessionId}}/{{reason}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

ExistsSessionByCriteria

Description: Returns the information related to a session if it exists in memory. Even if it's checked to be removed by timeout. In case nothing is returned, the session would not be in the memory of Lynn. Method: POST

{{endpoint}}/api/LynnService/ExistsSessionByCriteria/{{tenant}}/{{criteria}}/{{value}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SendMenuResponseByLevenshteinDistance

Description: For cases where Lynn offers a menu of options, but the answer requires being analyzed by approximation to an indicated text. This function should be used to answer that menu. In case Lynn is not waiting for a response to the menu then the execution of this function is ignored. Very useful to improve integrations with voice, where menus are included. Method: POST

{{endpoint}}/api/LynnService/SendMenuResponseByLevenshteinDistance/{{tenant}}/{{sessionId}}/{{capacityType}}/{{clientId}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

SendMenuResponseMessageInterpretacion

Description: Method: POST

{{endpoint}}/api/LynnService/SendMenuResponseMessageInterpretacion/{{tenant}}/{{sessionId}}/{{capacityType}}/{{clientId}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

WriteLevelLog

Description: Method: POST

{{endpoint}}/api/LynnService/WriteLevelLog/{{tenant}}/{{sessionId}}/{{level}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

StartCampaignExecution

Description: Method: POST

{{endpoint}}/api/LynnService/StartCampaignExecution/{{tenant}}/{{campaignId}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

StopCampaignExecution

Description: Method: POST

{{endpoint}}/api/LynnService/StopCampaignExecution/{{tenant}}/{{campaignId}} Headers

Content-Type	Value
Authorization	bearer {{myToken}}

Headers

Content-Type	Value
Ocp-Apim-Subscription-Key	premium-key

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

---

Author: bautistaj

Package: postman-to-markdown