Get Agent Conversations

Use this method to get a list of conversations, an agent is assigned on, with pagination.

Resource

https://api.infobip.com/ccaas/agents/{agentId}/conversations

Path Params

Property name Type
agentId string

 

Query Params

Property name Type Description
limit int (10) Size of the result page
page int (0) Index of the result page
orderBy array_string (id:ASC) property, direction(ASC, DESC)

Request Example

					GET /ccaas/1/agents/F66D67327326FCCB027BEAA916B94542/conversations HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
					
				

Response

					{
    "conversations": [
        {
            "id": "37B93F4D2BA3C58B58526EAEAA1AB35C",
            "topic": "Conversation topic demo",
            "summary": null,
            "status": "OPEN",
            "priority": "NORMAL",
            "queueId": null,
            "agentId": "F66D67327326FCCB027BEAA916B94542",
            "createdAt": "2019-06-04T08:26:21.144+0000",
            "updatedAt": "2019-06-04T10:51:45.997+0000",
            "channel": "SMS"
        },
        {
            "id": "9F1F21C198025CC026956A7E2E9C560F",
            "topic": "API help",
            "summary": null,
            "status": "OPEN",
            "priority": "HIGH",
            "queueId": "FBDDA7F8B33417374ACC02F5265527E6",
            "agentId": "F66D67327326FCCB027BEAA916B94542",
          	"createdAt": "2019-05-02T11:57:03.607+0000",
            "updatedAt": "2019-05-21T14:30:47.527+0000",
            "channel": "SMS
        }
    ],
    "pagination": {
        "totalItems": 2,
        "page": 0,
        "limit": 10,
        "orderBy": "id:ASC"
    }
}
					
				
					{
  "statusCode": "ERROR",
  "message": "Invalid id 'F66D67327326FCCB027BEAA916B94542' given! No such entity exists."
}
					
				
					{
    "statusCode": "ERROR",
    "message": "Page size must not be less than one!"
}
					
				

Use this method to get a list of conversations, an agent is assigned on, with pagination.

Parameters

Property name Type Description
agentId string Required - Agent id to get conversations
limit integer Size of the result page. If a limit count is given, no more than that many rows will be returned (but possibly less, if the query itself yields fewer rows). The default value is 10, the max value is 999.
page integer This parameter says to skip that many rows before beginning to return rows. If both page and limit appear, then page rows are skipped before starting to count the limit rows that are returned. The default value is 0.
orderBy string This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties.. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.