Agent Sessions API
Parameters full description
Note
You can find below the full description of Parameters for each POST/PATCH/GET/DELETE methods and also what parameters you can expect from the API responses.
If you want to play with the API, please see the Agent sessions API playground.
POST - Create a new agentSession
POST - Create a new agentSession
Parameters:
agentUid String
Uid of the agent to link to
externalUserId String
User Id from external system
userEmail String
email address format user identifier. Deprecated. Prefer using externalId instead.
tags String[]
Array of tags (max 10). You will be able to view reports based grouping or filtering of activity according to the tags applied when creating the session.
contextUids String[]
Array of existing context Uids (max 30)
GET - Query the list of agentSessions
GET - Query the list of agentSessions
Parameters:
startAfter - Querying for “the next page” String
Use the startAfter parameter and provide the createdAt string of the last agent session in the current results set
When there are no more results you will receive an empty array in the response and a 404 status code
externalUserId String
Filter results to a specific externalUserId
userEmail String
Filter results to a specific email address format user identifier. Deprecated. Prefer using externalId.
contextUid String
Filter results to a specific contextUid
agentUid String
Filter results to a specific agentUid
DELETE - Delete an agentSession by providing its uid
DELETE - Delete an agentSession by providing its uid
RESPONSE DATA
RESPONSE DATA
You will get the same response data when calling POST or GET.
Note: When retrieving a collection of agentSessions, the response will be an array of objects.
uid String
Mindset internal agentSession uid
agentSessionUid String
Unique Identifier of the agentSession you have to use with the Mindset Agents SDK.
humanUid String
Mindset internal humanUid uid of the user who the agentSession was created for.
externalUserId Boolean
User Id from your system you provided.
userEmail Boolean
User email from your system you provided.
agentUid Boolean
agentUid of the agent linked to the agentSession.
tags Boolean
Array of tags provided when creating the agentSession.
contextUids Boolean
Array of context Uids provided when creating the agentSession.
createdAt ISO timestamp
Label creation date
lastUsedAt ISO timestamp
Last time the agentSession was used. This is updated each time a message is sent or received in the agentSession.