Get Notes

Get all notes from the conversation with pagination.

Resource

https://api.infobip.com/ccaas/conversations/{conversationId}/notes

Path Params

Property name Type
conversationId string

 

Query Params

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

Request Example

					GET /ccaas/1/conversations/9F1F21C198025CC026956A7E2E9C560F/notes HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
					
				

Response

					{
    "notes": [
    		{
            "id": "22457B6EE7558AAD2F7D8235696ED4E6",
						"conversationId": "9F1F21C198025CC026956A7E2E9C560F",
  					"agentId":"F66D67327326FCCB027BEAA916B94542",
  					"content": "Sample Note content",
  					"createdAt": "2019-04-11T10:40:38.059+0000",
  					"updatedAt": "2019-04-11T10:40:38.059+0000"
				}
    ],
    "pagination": {
        "totalItems": 1,
        "page": 0,
        "limit": 10,
        "orderBy": "id:ASC"
    }
}
					
				
					{
  "statusCode": "ERROR",
  "message": "Invalid id '9F1F21C198025CC026956A7E2E9C560F' given! No such entity exists."
}
					
				
					{
    "statusCode": "ERROR",
    "message": "Page size must not be less than one!"
}
					
				

Use this method to get a list of notes from one conversation with pagination.

Parameters

Property name Type Description
conversationId string Required - Conversations id to get notes from
limit string 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.