Handling widgets

Faveo widgets allow admin to add social media icons and custom footer widgets in the client panel. The APIs are exclusively accessible by Admin users. Both social media icons and footer widgets can be accessed via the same API by just passing type slug to inform the system which widget record we want to access. Get widget […]

Read More

Sla CRUD

Get SLA URL : v3/api/get-enforcer/sla/{slaId} Method : GET Response : { “success”: true, “data”: { “sla”: { “id”: 84, “name”: “Test Sla”, “status”: 1, “order”: 1, “matcher”: “all”, “is_default”: 0, “internal_notes”: “”, “created_at”: “2019-12-09 11:12:15”, “updated_at”: “2019-12-09 11:12:15”, “sla_meta”: [{ “id”: 14, “ticket_sla_id”: 14, “priority_id”: 1, “respond_within”: “diff::1~hour”, “resolve_within”: “diff::1~hour”, “business_hour_id”: 1, “send_email_notification”: 1, “send_app_notification”: […]

Read More

SLA reminders

NOTE: These API is going to change in near future. Not meant for extenal purpose for now Gets SLA Reminders URL : v3/api/admin/sla-reminders/slaId Method : GET Response : { “id”: 58, “reminders”: { “approach”: [{ “id”: 1, “reminder_delta”: 10, “reminder_receivers”: { “agents”: [{ “id”: 1, “name”: “demo admin” }], “agent_types”: [{ “id”: 1, “name”: “Department […]

Read More

Get Logged In Agent Information

URL: api/agent-info Method: GET Description : Fetches logged in agent/admin information Success Response : {  “success”: true,  “data”: { “agent”: [   {     “id”: 99,     “first_name”: “Krishna”,     “last_name”: “Vishwakarma”,     “user_name”: “krishna”,     “location”: “bangalore”,     “role”: “agent”,     “email”: “krishna@faveo.com”,     “ext”: “080”,     “country_code”: 91,     “mobile”: “9853453453”,     “phone_number”: […]

Read More

Form Group

URL : v3/api/post-form-group Method : POST Query Parameters : None Body Parameters :   Parameter Type Possible values Optional/Required Description name string Required Name of the form group form-fields array Array of objects Required Form fields which are updated or newly created. Please read below for detailed explanation help_topic_ids array Optional array of help topic […]

Read More

Create Update Department

URL: api/admin/department/ Method: POST Description : Creates or Updates a department Parameters: Parameter Type Optional/Required Description name string Required Department name type_id integer Required 0 or 1, public = 1, private = 0 outgoing_email_id integer Optional Email id business_hour_id integer Optional Business Hour id department_sign string Optional Department Sign manager_ids integer Optional Agent or Admin […]

Read More

Edit Department

URL: api/admin/department/{id} Method: GET Description : Fetches existing department data Parameters: Parameter Type Optional/Required Description id integer Required Department id Success Response : {  “success”: true,  “data”: {    “department”: {      “id”: 1,      “name”: “support”,      “type”: {        “id”: 1,        “name”: “Public”      },      “department_sign”: “Faveo”,      “is_default”: 0,      “created_at”: “2018-11-16 06:43:39”,      “updated_at”: “2018-11-16 07:00:46”,      “managers”: [        {          “id”: […]

Read More

Get Department Agents

URL: api/admin/department-agents/ Method: GET Description : Gets department members by passing department id, otherwise all active admins and agents are listed for making manager. Parameters: Parameter Type Optional/Required Description id integer Optional Department id search_query string Optional String to be searched Success Response without departmentId : {  “success”: true,  “data”: {    “members”: [     { […]

Read More

Delete Department

URL: api/admin/delete-department/{id} Method: DELETE Description : Delete a department. Parameters: Parameter Type Optional/Required Description id integer Required Department id of the department to be deleted. Success Response : { “success”:true, “Message”:”Department deleted successfully” } OR { “success”:true, “Message”:{ “tickets”:”Department : London Hoppe, Tickets have been                                                                                                                                                                                                                                         moved to default department”, “users”:”Department : London Hoppe, Users have […]

Read More

Get Departments List

URL: api/admin/departments-list/ Method: GET Description : Fetches existing departments and provides search support Parameters: Parameter Type Optional/Required Description search_query string Optional String that is required to be searched. limit integer Optional No.  of records to be fetched. sort_order string Optional Records to be ordered in asc or desc. sort_field string Optional Department attribute based on […]

Read More