URL : v3/api/dependency/{type} Description : Type can be any of the following help-topics priorities organizations users user-types types sources statuses sla-plans agents teams agents-teams(for getting both agents as well as teams) labels tags departments languages rating-types country-codes locations client-tickets(for getting client tickets) ticket-status-tabs (for getting client tickets status details) Method : GET Query Parameters: […]
Articles Tagged: v3
Ticket-Suggestions by subject and ticket number
URL : v3/api/agent/ticket-suggestions Method : GET Query Parameters: Parameter Type Optional/Required Possible values Description category string Optional all, inbox, mytickets, closed, unassigned, followup, deleted, unapproved ‘all’ can be used to get all the tickets irrespective of which category they belongs. Rest of the category will give only tickets from that category. By default it gives […]
Ticket-details
URl : v3/api/agent/ticket-details/{ticketId} Method : GET Query Parameters : None Response : { “success”: true, “data”: { “ticket”: { “id”: 10394, “ticket_number”: “AAA-TICKET-NUMBER”, “isoverdue”: “0”, “isanswered”: “0”, “status”: { “id”: 1, “name”: “Open” }, “type”: { “id”: 1, “name”: “Question” }, […]
Ticket-threads
URL : v3/api/agent/ticket-threads/{ticketId} Method : GET Query Parameters : Parameter Type Optional/Required Description page integer Optional To get any page’s data. If not passed then current page will be 1. limit integer Optional Number of records that is needed to be fetched from DB. If it is not passed, first 10 records will be returned. […]
Ticket Filters List
URL: v3/api/agent/ticket-filter Method : GET Parameters: none Response: { “success”: true, “data”:{ “own”: [{ “id”: 50, “name”: “First filter” }], “shared”: [{ “id”: 51, “name”: “Second filter” }] } }
Ticket Filters Show
URL : v3/api/agent/ticket-filter/{ticketFilter} Method : GET Parameters: none Response: { “success”: true, “data”: { “fields”: [{ “key”: “assign_to”, “value”: 338 },{ “key”: “assign_to”, “value”: 339 }], “is_shareable”: false, “departments”: [ { “id”: 2250, “name”: “some department name”, } ], “agents”: [ { “id”: 2250, “name”: […]
Ticket Filters Store / Update
URL: v3/api/agent/ticket-filter Method : POST Parameters: Parameter Type Optional/Required Description id Integer Optional Ticket filter id. Required for update. name string Required Ticket filter name. Max 255 char. fields array Required Ticket filter fields. Must be an associative array where key will be field name and value will be field value. Field value can be […]
Ticket Filters Delete
URL : v3/api/agent/ticket-filter/{ticketFilter} Method : DELETE Parameters: none Response: { “success”: true, “Message”: “Filter successfully removed” }
Canned Response
URL: api/agent/canned Method : GET Parameters : none Response : { “success”:true, “data”:[ { “id”:18, “title”:”eum” }, { “id”:20, “title”:”unde” } ] }
Response Formats
Available Response Formats The HTTP API currently supports the following response formats: XML JSON Basic Conventions for Response Json responses are divided into 3 fields: “success:” whenever a request results in a success, its value is going to be true else false “message:” this field will have the message(if any) “data”: this field will have […]