Get Users in Domain

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Body

array of:

domain

string

required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (*).

<= 64 characters

Examples:

example.commyDomaintest.12123

Match pattern:

^[A-Za-z0-9._-]+|\*

user

string

required

This is the main user extension for the user account.

Examples:

1000200

name-first-name

string

required

This is the first name for the user

name-last-name

string

required

This is the last name for the user

string

optional

This is the login for the user used to access the portals and other applications. The default will be [user]@[domain] if not set otherwise. This value is required to be unique across the entire system so 409 will be returned if not unique.

email-address

string <email>

required

This is the email adresses or list of email addresses sepertaed with a semi-colon.

user-scope

enum<string>

required

Will link this resource with a User Scope granting it certain permisionf to the system for use in API and Portal.

Allowed values:

Basic UserSimple UserAdvanced UserCall Center AgentSite ManagerCall Center SupervisorOffice ManagerResellerSuper UserNDPNo Portal

Default:

Basic User

department

string

optional

This is the depertment that user belongs to in the domain. Can be any string to group users, a department is not require to be setup before in order to set it for a user.

site

string

optional

This is the site or location for this user. The site will group users that are at the same phyiscal location, but can be used for other grouping purposes as well. New users will inherit some settings from the site if the site was previously setup. If the site is not previously created then a new site will be created with the value given on new user create assuming the domain's max sites setting has remaining sites.

time-zone

enum<string>

optional

This is the time zone that the user is primarily located in

Allowed values:

US/AlaskaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificAfrica/Addis_AbabaAfrica/AlgiersAfrica/BrazzavilleAfrica/CairoAfrica/CasablancaAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/JohannesburgAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/NairobiAfrica/TimbuktuAfrica/TripoliAfrica/TunisAmerica/AntiguaAmerica/ArubaAmerica/BelizeAmerica/BogotaAmerica/Buenos_AiresAmerica/CancunAmerica/CaracasAmerica/CaymanAmerica/ChihuahuaAmerica/Costa_RicaAmerica/DenverAmerica/DetroitAmerica/EdmontonAmerica/El_SalvadorAmerica/EnsenadaAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/HavanaAmerica/IndianapolisAmerica/JamaicaAmerica/JuneauAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/LouisvilleAmerica/MartiniqueAmerica/MazatlanAmerica/MendozaAmerica/MenomineeAmerica/MeridaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontrealAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/PanamaAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/ReginaAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ThuleAmerica/Thunder_BayAmerica/TijuanaAmerica/TorontoAmerica/VancouverAmerica/WinnipegAmerica/YellowknifeAntarctica/South_PoleArctic/LongyearbyenAsia/AmmanAsia/BaghdadAsia/BahrainAsia/BangkokAsia/BeirutAsia/BruneiAsia/CalcuttaAsia/ColomboAsia/DaccaAsia/DamascusAsia/DhakaAsia/DubaiAsia/GazaAsia/Hong_KongAsia/IstanbulAsia/JakartaAsia/JerusalemAsia/KabulAsia/KatmanduAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/ManilaAsia/MuscatAsia/Phnom_PenhAsia/RangoonAsia/RiyadhAsia/SaigonAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/TaipeiAsia/TehranAsia/Tel_AvivAsia/ThimphuAsia/TokyoAsia/Ulan_BatorAsia/VientianeAsia/VladivostokAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaeroeAtlantic/ReykjavikAustralia/ACTAustralia/AdelaideAustralia/BrisbaneAustralia/CanberraAustralia/DarwinAustralia/LHIAustralia/MelbourneAustralia/NorthAustralia/NSWAustralia/PerthAustralia/QueenslandAustralia/SouthAustralia/SydneyAustralia/TasmaniaAustralia/VictoriaAustralia/WestCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificCanada/SaskatchewanCanada/YukonCubaEtc/GMTEtc/GMT+1Etc/GMT+10Etc/GMT+11Etc/GMT+12Etc/GMT+2Etc/GMT+3Etc/GMT+4Etc/GMT+5Etc/GMT+6Etc/GMT+7Etc/GMT+8Etc/GMT+9Etc/GMT-1Etc/GMT-10Etc/GMT-11Etc/GMT-12Etc/GMT-13Etc/GMT-14Etc/GMT-2Etc/GMT-3Etc/GMT-4Etc/GMT-5Etc/GMT-6Etc/GMT-7Etc/GMT-8Etc/GMT-9Etc/GreenwichEurope/AmsterdamEurope/AthensEurope/BelfastEurope/BelgradeEurope/BerlinEurope/BrusselsEurope/BucharestEurope/BudapestEurope/CopenhagenEurope/DublinEurope/HelsinkiEurope/IstanbulEurope/KievEurope/LisbonEurope/LjubljanaEurope/LondonEurope/MadridEurope/MaltaEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PragueEurope/RomeEurope/SofiaEurope/StockholmEurope/ViennaEurope/WarsawEurope/ZurichGreenwichPacific/AucklandPacific/EasterPacific/FijiPacific/GalapagosPacific/GambierPacific/GuamPacific/HonoluluPacific/MarquesasPacific/MidwayPacific/PalauPacific/RarotongaPacific/Tahiti

voicemail-login-pin

string

optional

This is the numberic pin that would be used by the user validating their account when connecting into voice IVR to check voicemail.

privacy

enum<string>

optional

This setting when enable will request caller id blocking on outbound calls requesting privacy settings. This may lower the ability to connect certain calls if not setup properly to support privacy settings.

Allowed values:

yesno

Default:

dial-plan

string

optional

This is the dial plan set for the user. Dial plans are used to control action and forward options that will be used when dialing out from the user.

dial-policy

string

optional

This value is the dial policy/permission for this user whch will control the destinations this user can dial. Generally dial policys are preconfigured at system level and selected at user level.

status-message

string

optional

This is is a value that is often set by the end user to show their current status, often a away message of some kind.

Examples:

Im at lunchPTO till 3/15

user-presence-status

string

read-onlyoptional

This is a read only presence status for the user that will be calculated by the core system based on registration, answer rules and active call status.

directory-name-number-dtmf-mapping

integer

optional

This is a 3 digit numberic mapping that correlates to the first 3 digits of a user's first or last name for dial by name directory. Example Smith would be "764" translating the letters to numbers using the normal phone number mappings.

>= 100<= 999

voicemail-user-control-enabled

enum<string>

optional

When enabled this setting will turn on voicemail for the user.

Allowed values:

yesno

Default:

yes

phone-numbers-to-allow-enabled

enum<string>

optional

This setting will allow access to the "Accept Number" answer rules feature.

Allowed values:

yesno

Default:

yes

phone-numbers-to-reject-enabled

enum<string>

optional

This setting will allow access to the "Reject Number" answer rules feature.

Allowed values:

yesno

Default:

yes

call-screening-enabled

enum<string>

optional

This setting will allow access to the "Call Screen" answer rules feature.

Allowed values:

yesno

Default:

yes

ring-no-answer-timeout-seconds

integer

optional

This time setting in seconds will controll how long a inbound call attempt will attempt to connect the call before stopping and attempting the next option which might be a forward setting in answer rules or voicemail if enabled.

>= 0<= 3600

language-token

string

optional

This is the language that is set for the user to be used for portal viewing.

Default:

en_US

Examples:

ca_FRes_MXen_UK

limits-max-data-storage-kilobytes

integer

optional

This is the maximum value in kilobytes that is allowed to be stored in the user's voicemail, audio greetings and fax storage.

>= 0

limits-max-active-calls-total

integer

optional

This is the maximum number of active calls allowed for the user.

>= 0<= 3600

directory-annouce-in-dial-by-name-enabled

enum<string>

optional

When enabled this setting will include the user in the dial by name direcctory. When disabled the user will not be given as an option in the dial by name directory.

Allowed values:

yesno

Default:

yes

directory-override-order-duplicate-dtmf-mapping

integer

optional

This value can be used in cases where multiple users have the same value for directory-name-number-dtmf-mapping, if they are the same then use this setting to set the order low to high for playback in dial by name directory menu.

>= 0<= 100

voicemail-greeting-index

integer

optional

This is the index of the greeting that is enabled currently for the user. Greeting 0 is the generic "[name] is not available" message will be played.

>= 0

voicemail-enabled

enum<string>

optional

This is a admin setting to control if voicemail is allowed for this user's account. The user will have access to control voicemail as well with voicemail-user-control-enabled, but both need to be enabled to have voicemail.

Allowed values:

yesno

Default:

yes

voicemail-receive-broadcast-enabled

enum<string>

optional

When enabled this setting will allow this user to recieve broadcast mesages from other users in the domain.

Allowed values:

yesno

Default:

yes

reject-anonymous-calls-enabled

enum<string>

optional

When enabled this setting will cause any anonymous callerid calls to be rejected and not reach the user.

Allowed values:

yesno

Default:

voicemail-playback-announce-datetime-received

enum<string>

optional

When enabled this will cause the voicemail IVR to play back the date and time the voicemail was left when playing each message back.

Allowed values:

yesno

Default:

voicemail-playback-announce-caller-id

enum<string>

optional

When enabled this will cause the voicemail IVR to play back the caller id of the voicemail when playing each message back.

Allowed values:

yesno

Default:

voicemail-playback-sort-newest-to-oldest

enum<string>

optional

When enabled this will play the newest voicemail first when playing back voicemail in the voicemail IVR.

Allowed values:

yesno

Default:

yes

email-send-alert-new-voicemail-cc-list-csv

string

optional

This list of user's which will be forward copies of new voicemails left on that user.

Example:

1001,1002,3000

email-send-alert-new-voicemail-behavior

enum<string>

optional

This is the behavior that the voicemail logic will take after a voicmail is left. The options include ability to send with attachements or hyperlinks.

Allowed values:

noyesattnewattsaveatttrashbriefbriefattnewbriefattsavebriefatttrash

Default:

email-send-alert-new-voicemail-enabled

enum<string>

optional

When enabled this will trigger email notifications on new vociemails being left for this user

Allowed values:

yesno

Default:

email-send-alert-new-missed-call-enabled

enum<string>

optional

When enabled this will trigger email notifications when a inbound call is missed by the user.

Allowed values:

yesno

Default:

email-send-alert-data-storage-limit-reached-enabled

enum<string>

optional

When enabled this will trigger email notifications when the user's data limit it hit.

Allowed values:

yesno

Default:

caller-id-number

integer

optional

This is the main caller id number for the user to be used for outbound calls outside of the domain.

>= 10

Example:

18005551234

caller-id-name

string

optional

This is the main caller id name for the user to be used for outbound calls outside of the domain.

caller-id-number-emergency

integer

optional

This is the main caller id that will be used for emergency calls when placed by the user.

>= 10

Example:

18005551234

area-code

integer

optional

This is a area code for the user. I will be used when user dial's 7 digits to translate it to full 10 or 11 digit number.

>= 100<= 999

directory-name-visible-in-list-enabled

enum<string>

optional

This setting when enabled will casue the user to be available in visibile intra domain user lookups and directories.

Allowed values:

yesno

Default:

yes

service-code

string

optional

Service codes are for internal use that allow user's to be tagged for billing and tracking purposes. Any service code starting with "system-" will be hidden by default in the portals and not count as regular users.

voicemail-transcription-enabled

enum<string>

optional

Enable this setting and select a vendor if you wish to have voicemails transcripted after a voicemail is recorded.

Allowed values:

noDeepgramGoogleMutareVoicebase

Default:

emergency-address-id

string

optional

Value will need to be an exact match to an address-id which links to a address for DLR (dynamic location routing) for emergency calling

call-recordings-hide-from-others-enabled

enum<string>

optional

When enabled this setting will hide this user's recordings from any other user even if they have higher level privileges like Office Manager.

Allowed values:

yesno

Default:

music-on-hold-randomized-enabled

enum<string>

optional

When enabled this will randomize the music on hold so that it will playback a random file first and then proceed from there through all the rest of the music files.

Allowed values:

yesno

Default:

music-on-hold-comfort-message-repeat-interval-seconds

integer

optional

This interval will control how frequently the music on hold would be interupted and have messages played. Should be used when using music on hod and custom messages.

>= 0<= 3600

active-calls-total-current

integer

read-onlyoptional

This read only setting is the current active call count for this user.

recording-configuration

enum<string>

optional

Option whether to record calls or not. Available options are "yes", "yes-with-transcription", "yes-with-transcription-and-sentiment", or "no"

Allowed values:

yesyes-with-transcriptionyes-with-transcription-and-sentimentno

Default:

account-status

enum<string>

read-onlyoptional

This status is read only and is calcuated to suggest special states that can be relayed to the end user or manager views. Status's include when a user is new, the user has been reset or pasword needs to be set.

Allowed values:

standardresetnewpwd reset

created-datetime

string <date-time>

read-onlyoptional

This datetime is when the user was created.

last-modified-datetime

string <date-time>

read-onlyoptional

This datetime is when the user was last modified.

Example

[
  {
    "domain": "example.com",
    "user": "1000",
    "name-first-name": "string",
    "name-last-name": "string",
    "login-username": "string",
    "email-address": "user@example.com",
    "user-scope": "Basic User",
    "department": "string",
    "site": "string",
    "time-zone": "US/Alaska",
    "voicemail-login-pin": "string",
    "privacy": "no",
    "dial-plan": "string",
    "dial-policy": "string",
    "status-message": "Im at lunch",
    "user-presence-status": "string",
    "directory-name-number-dtmf-mapping": 100,
    "voicemail-user-control-enabled": "yes",
    "phone-numbers-to-allow-enabled": "yes",
    "phone-numbers-to-reject-enabled": "yes",
    "call-screening-enabled": "yes",
    "ring-no-answer-timeout-seconds": 0,
    "language-token": "en_US",
    "limits-max-data-storage-kilobytes": 0,
    "limits-max-active-calls-total": 0,
    "directory-annouce-in-dial-by-name-enabled": "yes",
    "directory-override-order-duplicate-dtmf-mapping": 0,
    "voicemail-greeting-index": 0,
    "voicemail-enabled": "yes",
    "voicemail-receive-broadcast-enabled": "yes",
    "reject-anonymous-calls-enabled": "no",
    "voicemail-playback-announce-datetime-received": "no",
    "voicemail-playback-announce-caller-id": "no",
    "voicemail-playback-sort-newest-to-oldest": "yes",
    "email-send-alert-new-voicemail-cc-list-csv": "1001,1002,3000",
    "email-send-alert-new-voicemail-behavior": "no",
    "email-send-alert-new-voicemail-enabled": "no",
    "email-send-alert-new-missed-call-enabled": "no",
    "email-send-alert-data-storage-limit-reached-enabled": "no",
    "caller-id-number": 18005551234,
    "caller-id-name": "string",
    "caller-id-number-emergency": 18005551234,
    "area-code": 100,
    "directory-name-visible-in-list-enabled": "yes",
    "service-code": "string",
    "voicemail-transcription-enabled": "no",
    "emergency-address-id": "string",
    "call-recordings-hide-from-others-enabled": "no",
    "music-on-hold-randomized-enabled": "no",
    "music-on-hold-comfort-message-repeat-interval-seconds": 0,
    "active-calls-total-current": 0,
    "recording-configuration": "no",
    "account-status": "standard",
    "created-datetime": "2019-08-24T14:15:22Z",
    "last-modified-datetime": "2019-08-24T14:15:22Z"
  }
]

🟠404Record not found

🟠400Bad Request

🟠401Authentication Required

Request

Request samples

Responses