v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

Users

Get My User

get/domains/~/users/~

Response

domainstring 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 (*).

userstring required

This is the main user extension for the user account.

name-first-namestring required

This is the first name for the user

name-last-namestring required

This is the last name for the user

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-addressstring email required

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

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

departmentstring

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.

sitestring

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.

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

voicemail-login-pinstring

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

privacy'yes' | 'no'

dial-planstring

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-policystring

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-messagestring

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.

user-presence-statusstring

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-mappinginteger

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.

voicemail-user-control-enabled'yes' | 'no'

phone-numbers-to-allow-enabled'yes' | 'no'

phone-numbers-to-reject-enabled'yes' | 'no'

call-screening-enabled'yes' | 'no'

ring-no-answer-timeout-secondsinteger

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.

language-tokenstring

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

limits-max-data-storage-kilobytesinteger

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

limits-max-active-calls-totalinteger

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

directory-annouce-in-dial-by-name-enabled'yes' | 'no'

directory-override-order-duplicate-dtmf-mappinginteger

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.

voicemail-greeting-indexinteger

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.

voicemail-enabled'yes' | 'no'

voicemail-receive-broadcast-enabled'yes' | 'no'

reject-anonymous-calls-enabled'yes' | 'no'

voicemail-playback-announce-datetime-received'yes' | 'no'

voicemail-playback-announce-caller-id'yes' | 'no'

voicemail-playback-sort-newest-to-oldest'yes' | 'no'

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

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

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.

email-send-alert-new-voicemail-enabled'yes' | 'no'

email-send-alert-new-missed-call-enabled'yes' | 'no'

email-send-alert-data-storage-limit-reached-enabled'yes' | 'no'

caller-id-numberstring phonenumber

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

caller-id-namestring

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

area-codeinteger

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.

directory-name-visible-in-list-enabled'yes' | 'no'

service-codestring

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'no' | 'Deepgram' | 'Google' | 'Mutare' | 'Voicebase'

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

emergency-address-idstring

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'yes' | 'no'

music-on-hold-randomized-enabled'yes' | 'no'

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

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.

active-calls-total-currentinteger

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

recording-configuration'yes' | 'yes-with-transcription' | 'yes-with-transcription-and-sentiment' | 'no'

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

account-status'standard' | 'reset' | 'new' | 'pwd reset'

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.

created-datetimestring date-time

This datetime is when the user was created.

last-modified-datetimestring date-time

This datetime is when the user was last modified.

Example response

{
  "domain": "example.com",
  "user": "1000",
  "status-message": "Im at lunch",
  "language-token": "ca_FR",
  "email-send-alert-new-voicemail-cc-list-csv": "1001,1002,3000",
  "caller-id-number": "18585551234"
}