Released: 2024-06-12
Changelog (from v2)
- Adding is not breaking 🚨
- From this version and onwards, new fields may be introduced to JSON data models over time and is not considered a breaking change. Integrators must ensure that their integrations ignore unknown fields by default.
- Added support for accessing a user’s personal phone numbers (outside of the pbx), if any
- New field: independentNumbers in User
Data Model
Request format
{
"uri": ENDPOINT,
"method": "POST",
"headers": {
"Content-Type": "application/json",
"Authorization": `Bearer ${SECRET}`
},
"body": {
"users": [USERS],
"deletedUsers": [DELETEDUSERS],
"blockedUsers": [BLOCKEDUSERS],
"company": COMPANY,
"completeSync": false // True when a sync is triggered
}
}
Information
Field | Type | Description |
---|---|---|
id | number | Name of the information field, e.g. ”Office location” |
options | string[] | Name of the option(s), e.g. ”Stockholm” |
Weekday
Field | Type | Description |
---|---|---|
active | boolean | Is workday enabled for this day of the week? |
lunchEnd | string | hour : minute |
lunchStart | string | hour : minute |
workEnd | string | hour : minute |
workStart | string | hour : minute |
Workday
When workday is active it will try to change a users activity according to the following rules. They will only be applied if the current day in the workdays array is also active.
- workStartActive
- true: Workday will look at the settings for the current day, if today is active it will change the current users activity to the activity set as workStartActivity when the clock hits workStart in the users timezone.
- false: Workday will not change activity, workStart in weekday can be ignored.
- lunchActive
- true: Workday will look at the settings for the current day, if today is active it will change the current users activity to the activity set as lunchActivity when the clock hits lunchStart in the users timezone. When lunch ends it will go back to “Available”.
- false: Workday will not change activity, lunchStart & lunchEnd in weekday can be ignored.
- workEndActive
- true: Workday will look at the settings for the current day, if today is active it will change the current users activity to the activity set as workEndActivity when the clock hits workEnd in the users timezone.
- false: Workday will not change activity, workEnd in weekday can be ignored.
Field | Type | Description |
---|---|---|
active | boolean | Work day enabled for user |
lunchActive | boolean | Activity changes during lunch |
lunchActivity | string | Name of the activity triggered |
workEndActive | boolean | Activity changes when users work day ends |
workEndActivity | string | Name of the activity triggered |
workStartActive | boolean | Activity changes when users work day starts |
workStartActivity | string | Name of the activity triggered |
workdays | Weekday[7] | One entry for each day of the week, 0 is Sunday 6 is Saturday |
User
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the user |
displayName | string | Users display name |
firstName | string | Users first name |
lastName | string | Users last name |
internalOutboundNumber | string | Number shown when user makes internal calls |
outboundNumber | string | Number shown when user makes external calls |
timezone | string | Users time zone |
phoneNumbers | string[] | List of all the user’s numbers |
independentNumbers | string[] | List of all the user’s personal phone numbers (outside of the pbx) |
emails | string[] | List of all the users emails |
roles | string[] | List of all the users roles |
information | Information[] | See the fields above |
activityEndTime | number | null | Timestamp showing when the current activity ends |
activityName | string | Name of the users current activity |
activityNote | string | Note on the activity |
available | boolean | Is the user flagged as Available? |
availableInAnswerGroups | boolean | Is the user available for calls in Answer Groups? |
lineStateBusy | boolean | Does the user have a busy line state? |
workday | Workday | See the fields above |
Deleted Users
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the user |
deleted | true |
Blocked Users
Field | Type | Description |
---|---|---|
id | string | Unique identifier for the user |
deleted | true |
Field | Type | Description |
---|---|---|
id | number | Name of the information field, e.g. ”Office location” |
options | string[] | Name of the option(s), e.g. ”Stockholm” |
ContactInfo
Field | Type | Description |
---|---|---|
address | string | Street address |
city | string | Name of the city |
displayName | string | Can be a shorter version of the legal company name (e.g. excluding “AB” or “Inc”) |
zip | string | The postal code |
Company
Field | Type | Description |
---|---|---|
contactInfo | ContactInfo | See the fields above |
name | string | The legal company name |
orgNumber | string | The legal organisation number |
owner | string | The display name for the user set as owner of the company account |
timezone | string | The default time zone for the company |
welcomeMessage | string | Suggested greeting phrase to be used by operators when answering a call (e.g. “Welcome to Acme Inc”). Max 1000 chars. |
additionalInformation | string | General information that can be useful for an operator (e.g. “Never hand out a user’s mobile number to a caller.”) Max 1000 chars. |