Parameters full description
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
Uid of the agent to link to
User Id from external system
email address format user identifier. Deprecated. Prefer using externalId instead.
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.
Array of existing context Uids (max 30)
GET - Query the list of agentSessions
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
Filter results to a specific externalUserId
Filter results to a specific email address format user identifier. Deprecated. Prefer using externalId.
Filter results to a specific contextUid
Filter results to a specific agentUid
DELETE - Delete an agentSession by providing its uid
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.
Mindset internal agentSession uid
Unique Identifier of the agentSession you have to use with the Mindset Agents SDK.
Mindset internal humanUid uid of the user who the agentSession was created for.
User Id from your system you provided.
User email from your system you provided.
agentUid of the agent linked to the agentSession.
Array of tags provided when creating the agentSession.
Array of context Uids provided when creating the agentSession.
Label creation date
Last time the agentSession was used. This is updated each time a message is sent or received in the agentSession.