Get Tags - Early Access

Resource

https://api.infobip.com/ccaas/1/tags

Parameters

Use this method to get a list of tags with pagination and filtering option. Using a filter is optional. The result can be filtered only by conversation Id so result list will be tagged for a specific conversation.

Property name Type Description
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.
conversationId string Optional filter to get only tags on specific conversation

Request Example 

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

Response 

					{
    "tags": [
        {
            "name": "This is demo TAG1"
        },
        {
    	    "name": "This is demo TAG2"
        }
    ],
    "pagination": {
        "totalItems": 2,
        "page": 0,
        "limit": 10,
        "orderBy": "id:ASC"
    }
}
					
				
					{
    "statusCode": "ERROR",
    "message": "Page size must not be less than one!"
}

Additional example

Request example: Searching for tags with result sorted by tag name in ascending order, page limit is 3 results.

  • JSON
GET /ccaas/1/tags?limit=3&orderBy=name:asc HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Response:

  • JSON
{
    "tags": [
        {
    	    "name": "This is demo TAG1"
        },
        {
    	    "name": "This is demo TAG2"
        },
        {
    	    "name": "This is demo TAG3"
        }
    ],
    "pagination": {
        "totalItems": 3,
        "page": 0,
        "limit": 3,
        "orderBy": "name:ASC"
    }
}