Users API

Get List of Users by Role (0=Admin, 1=Trainer, 2=Operator, 3=SUpervisor, 4=QA

Method	GET
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users?userId=[Id]&start=0&count=10
Header	Authorization : Bearer [generatedToken] User Id : [id]
Body
Status	200
Response	{ “status”: “success”, “data”: { “id”: “[id]”, “owner”: “[owner_id]”, “createdDate”: 1594352833495, “createdBy”: “f1b380ced4477dd87e8d7ad842af7ae2”, “modifiedDate”: 1594383711729, “modifiedBy”: “f1b380ced4477dd87e8d7ad842af7ae2”, “active”: false, “blocked”: “0”, “changePassword”: false, “deleted”: true, “approved”: false, “group”: “[group_id]”, “email”: “[email]”, “firstName”: “Mira”, “identityNumber”: “[identityNumber]”, “ip”: “[ip]”, “language”: “Indonesia”, “lastName”: “Agustina”, “loginTime”: 1594355159525, “mobileSession”: false, “nickName”: “Tina”, “notificationEnabled”: true, “password”: “[password]”, “privilegeId”: “[privilegeId]”, “profileImage”: “”, “role”: “Supervisor”, “stopAutoAssign”: false, “updatePasswordTime”: 1594355159381, “userName”: “[username]”, “loginAttempt”: 0, “searchAll”: false, “mergeContacts”: false, “caseMandatory”: false, “tagMandatory”: false, “checker”: false, “telephonyEnabled”: false, “roomName”: “”, “roomChatWidget”: “”, “teamAuthToken”: “”, “ipInSession”: “{ipInSession}”, “remember”: false, “activeFiltered”: false }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get List of Available Agents

Method	GET
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/agents?start=0&count=10
Header	Authorization : Bearer [generatedToken]
Body
Status	200
Response	{ “status”: “success”, “data”: [], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Update Agent Availability Status

Method	PUT
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/agents/update/[AgentId]/available/[available]
Header	Authorization : Bearer [generatedToken] Agent Id : [agentId] Available : [available]
Body
Status	200
Response	{ “status”: “success”, “data”: { “id”: “[Id]”, “owner”: “[owner_id]”, “createdDate”: 1594352833495, “createdBy”: “f1b380ced4477dd87e8d7ad842af7ae2”, “modifiedDate”: 1598943588437, “modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”, “partial”: true, “active”: false, “blocked”: “0”, “changePassword”: false, “deleted”: true, “approved”: false, “group”: “[groupId]”, “email”: “[email]”, “firstName”: “Mira”, “identityNumber”: “[identityNumber]”, “ip”: “[ip]”, “language”: “Indonesia”, “lastName”: “Agustina”, “loginTime”: 1594355159525, “mobileSession”: false, “nickName”: “Tina”, “notificationEnabled”: true, “password”: “[password]”, “privilegeId”: “[privilegeId]”, “profileImage”: “”, “role”: “Supervisor”, “stopAutoAssign”: false, “updatePasswordTime”: 1594355159381, “userName”: “[username]”, “loginAttempt”: 0, “searchAll”: false, “mergeContacts”: false, “caseMandatory”: false, “tagMandatory”: false, “checker”: false, “available”: false, “telephonyEnabled”: false, “roomName”: “”, “roomChatWidget”: “”, “teamAuthToken”: “”, “ipInSession”: “{ipInSession}”, “remember”: false, “activeFiltered”: false }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Create Agent Dialog

Method	PUT
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/agents/dialog
Header	Authorization : Bearer [generatedToken]
Body
Status	200
Response	{ “status”: “success”, “data”: “{data}”, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Update User

Method	PUT
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/update/{user_id}
Header	Authorization : Bearer [generatedToken] User Id : [user_id]
Body
Status	200
Response	{ “status”: “success”, “data”: { “id”: “[Id]”, “owner”: “[owner_id]”, “createdDate”: 1594352833495, “createdBy”: “f1b380ced4477dd87e8d7ad842af7ae2”, “modifiedDate”: 1598943920435, “modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”, “partial”: true, “active”: false, “blocked”: “0”, “changePassword”: false, “deleted”: true, “approved”: false, “group”: “[groupId]”, “email”: “[email]”, “firstName”: “Mira”, “identityNumber”: “[identityNumber]”, “ip”: “[ip]”, “language”: “Indonesia”, “lastName”: “Agustina”, “loginTime”: 1594355159525, “mobileSession”: false, “nickName”: “Tina”, “notificationEnabled”: true, “password”: “[password]”, “privilegeId”: “[privilegeId]”, “profileImage”: “”, “role”: “Supervisor”, “stopAutoAssign”: false, “updatePasswordTime”: 1594355159381, “userName”: “[username]”, “loginAttempt”: 0, “searchAll”: false, “mergeContacts”: false, “caseMandatory”: false, “tagMandatory”: false, “checker”: false, “available”: false, “telephonyEnabled”: false, “roomName”: “”, “roomChatWidget”: “”, “teamAuthToken”: “”, “ipInSession”: “{ipInSession}”, “remember”: false, “activeFiltered”: false }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get User Credentials

Method	POST
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/login
Header	Authorization : Bearer [generatedToken]
Body	{ “email”: “[email]”, “password”: “[password]”, “action”: “[login,logout]” }
Status	200
Response	{ “status”: “success”, “data”: { “id”: “[Id]”, “changePassword”: false, “deleted”: false, “approved”: false, “loginTime”: 1598860643139, “notificationEnabled”: true, “stopAutoAssign”: false, “checker”: false, “telephonyEnabled”: false, “remember”: false, “telephonyCredentials”: [], “userPreferenceObj”: { “enableSound”: false, “dateFormat”: “dd MMMM yyyy”, “timeFormat”: “HH:mm:ss”, “enableTime”: true, “tablePreferences”: null, “sortingModel”: {}, “finalDateFormat”: “dd MMMM yyyy HH:mm:ss” }, “prettyLoginTime”: “1 day ago”, “statusStyle”: “netral-status”, “fullName”: “”, “activeFiltered”: false }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get User Credentials

Method	POST
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/mobile/session
Header	Authorization : Bearer [generatedToken]
Body	{ “email”: “[email]”, “password”: “[password]”, “action”: “[login,logout]” }
Status	200
Response	{ “status”: “success”, “data”: { “id”: “[Id]”, “owner”: “[owner_id]”, “createdDate”: 1584349901797, “createdBy”: “f1b380ced4477dd87e8d7ad842af7ae2”, “modifiedDate”: 1598948154558, “modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”, “partial”: true, “active”: false, “blocked”: “0”, “changePassword”: false, “deleted”: false, “approved”: false, “group”: “[groupId]”, “email”: “[email]”, “firstName”: “Tina”, “identityNumber”: “[identityNumber]”, “ip”: “[ip]”, “language”: “Indonesia”, “lastName”: “Operator”, “loginTime”: 1598860643139, “maxQueue”: 50, “mobileSession”: true, “nickName”: “Tina”, “notificationEnabled”: true, “password”: “[password]”, “privilegeId”: “[privilegeId]”, “profileImage”: “{profileImage}”, “role”: “Operator”, “stopAutoAssign”: false, “updatePasswordTime”: 1584349971350, “userName”: “[username]”, “loginAttempt”: 0, “searchAll”: false, “mergeContacts”: true, “caseMandatory”: false, “tagMandatory”: false, “checker”: false, “profile”: “overlay”, “telephonyCredential”: “[teleponyCredential]”, “telephonyEnabled”: false, “shiftId”: “[]” ], “roomName”: “”, “roomChatWidget”: “”, “teamAuthToken”: “”, “otpInSession”: “[otpInSession]”, “ipInSession”: “[ipInSession]”, “remember”: false, “activeFiltered”: false }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get User List Assignments

Method	POST
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/assign?start=0&count=1
Header	Authorization : Bearer [generatedToken]
Body	{ “action”: “{transfer,reassign,escalate}”, “ticketNumber”: “[ticketNumber]” }
Status	200
Response	{ “status”: “success”, “data”: [ { “id”: “[Id]”, “spell”: null, “owner”: “[owner_id]”, “createdDate”: 1597217701226, “createdBy”: “0cfa797dffff86a30d1331c99bb28351”, “modifiedDate”: 1597217701226, “modifiedBy”: “0cfa797dffff86a30d1331c99bb28351”, “partial”: null, “forms”: null, “groupName”: “b”, “deleted”: false, “publicGroup”: null, “groupPicture”: null } ], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Process Forgot Password

Method	POST
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/forgotPassword
Header	Authorization : Bearer [generatedToken]
Body	{ “email”: “[email]”, “password”: “[password]” }
Status	200
Response	{ “status”: “success”, “data”: { “baseName”: “[baseName]” }, “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }

Get List of Users by Group Id

Method	GET
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/group/[group_id]?start=0&count=1
Header	Authorization : Bearer [generatedToken]
Body
Status	200
Response	{ “status”: “success”, “data”: [ { “id”: “[Id]”, “owner”: “[owner_id]”, “createdDate”: 1563349330638, “createdBy”: “82ab0fd5cfd1e80d1ff97c0cfc9aa9e2”, “modifiedDate”: 1563349432321, “modifiedBy”: “40188d9c1e10d4dc15ff0a353136f5a8”, “active”: false, “blocked”: “0”, “changePassword”: false, “deleted”: false, “approved”: false, “group”: “[groupId]”, “email”: “[email]”, “firstName”: “Spv01”, “identityNumber”: “[identityNumber]”, “ip”: “[ip]”, “language”: “Indonesia”, “lastName”: “Spv01”, “loginTime”: 1563349386307, “nickName”: “Spv”, “notificationEnabled”: true, “password”: “[password]”, “privilegeId”: “[privilegeId]”, “profileImage”: “”, “role”: “Supervisor”, “stopAutoAssign”: false, “updatePasswordTime”: 1563349386235, “userName”: “[username]”, “loginAttempt”: 0, “checker”: false, “available”: false, “telephonyEnabled”: false, “remember”: false, “activeFiltered”: false } ], “hasMore”: true, “nextIndex”: 1, “prevIndex”: 0, “totalResults”: 90 }

Get Responsible Persons, Observers, Participants Users By Task Id

Method	GET
Media Type	application/json
URL	http://[server]/dolphin/apiv1/graph/users/task?taskId=[taskId]&type=[type]
Header	Authorization : Bearer [generatedToken] Task Id : [taskId] Type : [observer, participant, responsible_persons]
Body
Status	200
Response	{ “status”: “success”, “data”: [ { “id”: “[Id]”, “owner”: “[owner_id]”, “createdDate”: 1584349901797, “createdBy”: “f1b380ced4477dd87e8d7ad842af7ae2”, “modifiedDate”: 1598948154558, “modifiedBy”: “95bbbf64882dd7816c09996d56bbc1e2”, “active”: false, “blocked”: “0”, “changePassword”: false, “deleted”: false, “approved”: false, “group”: “[groupId]”, “email”: “[email]”, “firstName”: “Tina”, “identityNumber”: “[identityNumber]”, “ip”: “[ip]”, “language”: “Indonesia”, “lastName”: “Operator”, “loginTime”: 1598860643139, “maxQueue”: 50, “mobileSession”: true, “nickName”: “Tina”, “notificationEnabled”: true, “password”: “[password]”, “privilegeId”: “[privilegeId]”, “profileImage”: “{profileImage}”, “role”: “Operator”, “stopAutoAssign”: false, “updatePasswordTime”: 1584349971350, “userName”: “[username]”, “loginAttempt”: 0, “searchAll”: false, “mergeContacts”: true, “caseMandatory”: false, “tagMandatory”: false, “checker”: false, “profile”: “overlay”, “telephonyCredential”: “[teleponyCredential]”, “telephonyEnabled”: false, “shiftId”: [ “37d1a4a67700d6575b16b863c10f2999”, “c71d0acda4642a948e72c680d60eab69”, “a74532fbac76b8996f10e0f220276fdc” ], “roomName”: “”, “roomChatWidget”: “”, “teamAuthToken”: “”, “otpInSession”: “367750”, “ipInSession”: “{ipInSession}”, “remember”: false, “activeFiltered”: false } ], “hasMore”: false, “nextIndex”: 0, “prevIndex”: 0, “totalResults”: 0 }