v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

Sites

List Sites in Domain

get/domains/{domain}/sites/list

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com

Response

synchronous'yes' | 'no'

When synchronous is requested with "yes" the response will be a 200 on success and will contain a valid JSON representiation of the new resource. If no or left off request a 202 "Accepted" will be given in a success case and this can be considered a success. Synchronous responses will be a little slower as the API will process the geo replication request and wait till the local copy has been written and can be read back berfore sending a response.

sitestring required

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.

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

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.

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'

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'

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'

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'

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

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

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"

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

[
  {
    "language-token": "ca_FR",
    "caller-id-number": "18585551234"
  }
]