This v1 API  will be deprecated from 15th March 2020

Description:

To fetch all agents in Faveo.

URL : api/v1/helpdesk/agents

          (Replace this URL with you helpdesk URL)

Parameters :

Name Data Type Required / Optional Description
api_key String optional An alphanumeric code that can be used to authenticate your API calls
ip String Optional IP address of the Customer/location where API call is being made from
token String Required Token generated for a user

HTTP Method : GET         

  •   URL Request Example:

https://www.stablehelpdesk.faveodemo.com/api/v1/helpdesk/agents?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImlzcyI6Imh0dHA6Ly9wcm9kdWN0ZGVtb3VybC5jb20vc2FyZnJhei9wdWJsaWMvYXBpL3YxL2F1dGhlbnRpY2F0ZSIsImlhdCI6MTUzNDc1OTg5MiwiZXhwIjoxNTM0NzYwMTMyLCJuYmYiOjE1MzQ3NTk4OTIsImp0aSI6IlhBdzNrNGhwZXNUVWNFeVQifQ.TpuZ6Vwo9oMlt_LKRZYv2cU5UY8YBKqe06-66ioZA24

Response

  •   Response Format : JSON
  •   Returns JSON which contains below response

Sample JSON Success Response :

{

   "result": [

       {

           "id": 1,

           "user_name": "snaju",

           "first_name": "Sanjay",

           "last_name": "Patil",

           "gender": 0,

           "email": "sanjay@gmail.com",

           "ban": 0,

           "active": 1,

           "is_delete": 0,

           "ext": "",

           "country_code": "",

           "phone_number": "",

           "mobile": "Not available",

           "agent_sign": "",

           "account_type": "",

           "account_status": "",

           "assign_group": null,

           "primary_dpt": 1,

           "agent_tzone": "81",

           "daylight_save": "",

           "limit_access": "",

           "directory_listing": "",

           "vacation_mode": "",

           "company": "",

           "role": "agent",

           "internal_note": "",

           "profile_pic": "https://secure.gravatar.com/avatar/bb90dcb0ceabfc8bf10c550f1ee95ee7?s=80&r=g&d=identicon",

           "fcm_token": "eXp6AdnAdJE:APA91bHy68rbNdw3HBfBsmpqTlKfgRMfvTE2HBAs2eJkMQHb9EMd25ZH9jrFbKC535eAy7MJIUj2k9eyo7s9IAuPVOGimU0QGJ0BhG8kEiXnpqPd_rF2D_CYxR3iZtO1ITTqXAp_7J69",

           "i_token": "fGqes_LDLKM:APA91bFzWUEveWX2r8xeiYTIBWkFv6OVpM7Nc0iUB-84pzqf0L0nIFN8mQYC_jl_g_hLRqD_02NageB_HYIzx12xTDy54yJAvmPr3tdRzttGVVCXDy1g_IGXvUWYw0cwRz8E6JykbwTt",

           "created_at": "2018-03-08 04:49:30",

           "updated_at": "2018-03-12 11:00:37",

           "user_language": null,

           "mobile_otp_verify": "1",

           "email_verify": "1",

           "location": "",

           "is_login": 0,

           "not_accept_ticket": 0

       },

       {

           "id": 2,

           "user_name": "pranali",

           "first_name": "Pranali",

           "last_name": "Ole",

           "gender": 1,

           "email": "pranali@gmail.com",

           "ban": 0,

           "active": 1,

           "is_delete": 0,

           "ext": "",

           "country_code": "",

           "phone_number": "",

           "mobile": "Not available",

           "agent_sign": "",

           "account_type": "",

           "account_status": "",

           "assign_group": null,

           "primary_dpt": 1,

           "agent_tzone": "81",

           "daylight_save": "",

           "limit_access": "",

           "directory_listing": "",

           "vacation_mode": "",

           "company": "",

           "role": "Admin",

           "internal_note": "",

           "profile_pic": "https://secure.gravatar.com/avatar/bb90dcb0ceabfc8bf10c550f1ee95ee7?s=80&r=g&d=identicon",

           "fcm_token": "eXp6AdnAdJE:APA91bHy68rbNdw3HBfBsmpqTlKfgRMfvTE2HBAs2eJkMQHb9EMd25ZH9jrFbKC535eAy7MJIUj2k9eyo7s9IAuPVOGimU0QGJ0BhG8kEiXnpqPd_rF2D_CYxR3iZtO1ITTqXAp_7J69",

           "i_token": "fGqes_LDLKM:APA91bFzWUEveWX2r8xeiYTIBWkFv6OVpM7Nc0iUB-84pzqf0L0nIFN8mQYC_jl_g_hLRqD_02NageB_HYIzx12xTDy54yJAvmPr3tdRzttGVVCXDy1g_IGXvUWYw0cwRz8E6JykbwTt",

           "created_at": "2018-03-08 04:49:30",

           "updated_at": "2018-03-12 11:00:37",

           "user_language": null,

           "mobile_otp_verify": "1",

           "email_verify": "1",

           "location": "",

           "is_login": 0,

           "not_accept_ticket": 0

       },

    

   ]

}

Description: It will return result array which contains all list of agents and admin details from your helpdesk.
Parameter Description
id It is the unique id of an Agent or an Admin
user_name It is the username of the Agent or Admin
first_name It is the first name of the Agent or Admin
last_name It is the last name of the Agent or Admin
gender It is the gender of the Agent or Admin
email It is the email of the Agent or Admin
ban It tells that an Agent or Admin is banned or not (Example: If ban=0 then it is not banned and if ban=1 then that agent is banned)
active It tells that an Agent or Admin is active or not (Example: If active=0 then it is not active and if active=1 then that agent is active)
is_delete It tells that an Agent or Admin is deactivated or not (Example: If is_delete=0 then it is not deactivated and if is_delete=1 then that agent is deactivated)
country_code It is a code of country given by agent or admin at the time of his registration.
phone_number It is the phone number given by agent or admin at the time of his registration.
mobile It is the mobile number given by agent or admin at the time of his registration.
assign_group It is the name of the group which agent or admin belongs to.
primary_dpt It is the name of the primary department which agent or admin is assigned.
agent_tzone It is the timezone of the agent or admin.
company It is the name of the company of the agent or admin.
role It is the role of that agent.
profile_pic It profiles picture of an Agent or Admin
fcm_token An alphanumeric code that is generated from Firebase when he is logged into the app.
created_at It is the time when an agent or admin profile is created.
updated_at It is the time when the agent or admin profile is updated.
user_language It is the user language of the agent or admin
location It is the location of the agent or admin
email_verify It tells that an agent or admin is verified from email. (Example: If email_verify=0 then it is not verified and if email_verify=1 then it is verified.)

Possible Errors/Failures:

     Please check the responses for some common errors

Leave a Reply

Your email address will not be published. Required fields are marked *