Skip to main content

Service API v2.3.0

  • Added a new API endpoint to remove the "current" Agent from a conversation.
  • The GET /messages endpoint will return null for the (root) agent key denoting that no agent is currently actively handling this conversation.

New agent behaviour

Before, the GET /messages endpoint would always return the last Agent that communicated with client, but you might want to remove this Agent from the data if that Agent is done with this conversation.

GET /messages result on the Client API

{
"data": [
{
...
"message": "hi!",
"agent": {
...
"name": "Agent 1",
}
}
],
"agent": {
...
"name": "Agent 1"
}
"notifications": [],
"status": "SUCCESS",
...
}

Now if you call the new PUT /users/{userId}/agent/unset, on the Service API, the client will receive the following:

GET /messagesresult on the Client API after unsetting the Agent

{
"data": [
{
...
"message": "hi!",
"agent": {
...
"name": "Agent 1",
}
}
],
"agent": null
"notifications": [],
"status": "SUCCESS",
...
}

More information on this new endpoint: https://api.parley.nu/serviceApi/v2.3/doc/#operation/PutAgentUnset