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”: […]
Articles Tagged: v3
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 […]
Login
Description: Authenticates a user and gives his/her profile information back if successful. URL: v3/api/login Method: POST Response Format: JSON Parameters : Name Data Type Required / Optional Description user_name String Required Username of the Agent password String Required Password of the Agent Success Response : { “success”: true, “data”: { “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGkvbG9naW4iLCJpYXQiOjE1MTg2MDI1NTAsImV4cCI6MTUxODYwMjc5MCwibmJmIjoxNTE4NjAyNTUwLCJqdGkiOiJpTjFMSkl5M0U2UXB5aUpaIn0.QrXxRYlowT4v2BayTNvapnHUe1vMJ_NlXydgJoS7y1E”, “user”: […]
Refresh Token
URL: v3/api/refresh Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required Old token Success Response { “success”: true, “data”: { “token”: “eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hcGt3uPtvQARsvo” } }
Logout
URL: v3/api/logout Method: get Response Format: JSON Parameters: Name Data Type Required / Optional Description token String Required token Success Response { “success”: true, “message”: “Successfully logged out” }
Social login redirect
URL: v3/api/social/login/redirect/{provider} Method: get Response Format: Redirect Description: Provider name has to be provided by frontend for the backend to authenticate based on the given provider. Parameters: None
Social login
URL: social/login/{provider} Method: get Response Format: JSON Description: Gets redirected by the provider to this route, which in change redirects to ‘/social/auth?token=’, from which token has to be obtained. Parameters: None