User Created and User Changed (Async)
Table of Contents
- User Created
- User Changed
- Request Object
- User Object
- Sample Request Body for User Created
- Sample Request Body for User Changed
User Created
When a user is created, an object is sent to your site, encoded in JSON.
User Changed
When a user’s details change, an object is sent to your site, encoded in JSON.
Request Object
| Name | Type | Description |
|---|---|---|
| new | object | A user object. |
| old | null or object | Null if created otherwise a user object. |
| timestamp | string | Time of user creation in ISO 8601 format. |
User Object
| Name | Type | Description |
|---|---|---|
| contactPhone | string | Admin or supervisor type user’s contact phone number. |
| string | User’s email address. | |
| extension | string | User’s extension number. |
| hourly | integer | User’s hourly salary. |
| isAgent | boolean | User’s type is agent: -true -false |
| messageLists | array | Admin or supervisor type user’s notification type preference: -technical -marketing -current balance |
| mobilePhone | string | User’s mobile app phone number. |
| mobileProjectId | integer | User’s mobile app project ID. |
| monthly | integer | User’s monthly wage. |
| name | string | User’s full name. |
| outboundPhone | string | Agent type user’s outbound phone number. |
| password | string | User’s newly entered password. Optional: we send the password key only when a new password is entered and encryption is enabled. |
| privGroup | integer | Which group user belongs to. |
| redistribution | integer | Shared callback distribution is enabled: -1 -0 |
| registerTransport | string | User’s registration protocol: -global -sip-tcp -sip-udp -encrypted-dip |
| sampleRate | string | User’s sample rate frequency. |
| state | string | User’s status: -active -inactive |
| userid | integer | User’s unique identifier. |
| username | string | User’s login name, used to identify and allow user to log in. |
Sample Request Body for User Created
{
"old": null,
"new": {
"userId": 180,
"extension": "189",
"name": "Rachel Smith",
"email": "rachel.smith@company.com",
"username": "rachel_smith",
"isAgent": true,
"privGroup": 4,
"redistribution": 0,
"monthly": 0,
"hourly": 0,
"state": "active",
"registerTransport": "sip-tcp",
"sampleRate": "global",
"outboundPhone": "3617777777",
"contactPhone": "3618888888",
"messageLists": [],
"mobileProjectId": null,
"mobilePhone": null
},
"timestamp": "2017-06-06T10:53:43+02:00"
}
Sample Request Body for User Changed
{
"old": {
"userId": 180,
"extension": "189",
"name": "Rachel Smith",
"email": "rachel.smith@company.com",
"username": "rachel_smith",
"isAgent": true,
"privGroup": 4,
"redistribution": 0,
"monthly": 0,
"hourly": 0,
"state": "active",
"registerTransport": "sip-tcp",
"sampleRate": "global",
"outboundPhone": "3617777777",
"contactPhone": "",
"messageLists": [],
"mobileProjectId": null,
"mobilePhone": null
},
"new": {
"userId": 180,
"extension": "189",
"name": "Rachel Smith",
"email": "rachel.smith@company.com",
"username": "rachel_smith",
"isAgent": true,
"privGroup": 4,
"redistribution": 1,
"monthly": 0,
"hourly": 0,
"state": "active",
"registerTransport": "sip-tcp",
"sampleRate": "global",
"outboundPhone": "3617777777",
"contactPhone": "",
"messageLists": [],
"mobileProjectId": null,
"mobilePhone": null
},
"timestamp": "2017-06-06T10:44:18+02:00"
}
Comments
Can’t find what you need? Use the comment section below to connect with others, get answers from our experts, or share your ideas with us.
There are no comments yet.