Get Tenant Preferences

Retrieve the system preferences of a tenant.

Request URL

GET {base_url}/uc-cconfig/api/v1/preferences

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Preference_Setting>	The system preferences of the tenant.

Preference_Setting


Parameter	Type	Description
tenantCode	String	The tenant name.
country	String	The country or region where the tenant is located.
toneRegion	String	The short code of the tone region used to apply the default dial tone, busy tone, and ring tone.
loginCredentialValidityDays	Integer	The validity period of the login QR code and link for NovoOne Clients.
nameDisplayFormat	String	The format used to display names. `fls`: First Name Last Name with Space Inbetween `lfs`: Last Name First Name with Space Inbetween `lf`: Last Name First Name without Space Inbetween
callerIdResolution	Array<String>	The sources used to resolve the Caller ID name. `system_contacts`: Display the matched contact name when an incoming call matches an internal user or external contact. `caller_id_name`: Display the name carried in the From header of the SIP message.
displayCallFeature	Boolean	Whether the call feature name is included in the Caller ID Name for incoming calls routed through a ring group, queue, or IVR.
displayDidName	Boolean	Whether the associated DID name is displayed when receiving incoming calls through a DID number.
displayCountryCode	String	The format used to display phone numbers. `INTERNATIONAL`: Display numbers in international format, starting with a plus sign (`+`) followed by the country code, area code, and local number. `DOMESTIC`: Display numbers in domestic format, using the area code and local number without the country code.
extensionRanges	Array<Extension_Range>	The extension number ranges.
timeZone	String	The time zone.
daylightSavingTime	String	Whether daylight saving time is enabled. `Disabled`: Daylight saving time is disabled. `Automatic`: Daylight saving time is applied automatically.
dateDisplayFormat	String	The date display format. `yyyy/mm/dd`: Year/Month/Day `mm/dd/yyyy`: Month/Day/Year `dd/mm/yyyy`: Day/Month/Year
timeDisplayFormat	String	The time display format. `hh:mm:ss A`: 12-hour format. `HH:mm:ss`: 24-hour format.

Extension_Range


Parameter	Type	Description
featureType	String	The feature module type. `USER` `CALL_PARKING` `GROUP_VOICEMAIL` `IVR` `RING_GROUP` `QUEUE`
rangeStart	String	The start of the number range.
rangeEnd	String	The end of the number range.

Example

Request example

GET /uc-cconfig/api/v1/preferences HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDYwNzMxNywiaWF0IjoxNzkwNTg1NzE3LCJqdGkiOiIxNzZkY2NhMy1hNTYyLTQ2MzctYjU3Ny0yNzRiZTQ2Y2U4NDAiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.KPxN1ik0LSRbC1j4uU2OEYu4itse9qv3DVgCi_uFJvteI2b231kCk2iW-PRAA9rl_WwC7-_1sAjT6XUgwb_szdSbeSAyeerlEnYN0FFZf7AOnKgYj8I480i3lqcEXUOEtxLZJM7vAdPoXvCf_irwSlBOTcYTV1ZxFVpmamI39wUDnaw0J2GQlUo_yNiB1m1sFR6V8QmFz84ohcJGFfud9N6VwIS8NU618BH3dSnfri8HO9Ebv5qZ5WXDqGxto3wa-l5n3uqqUocDRe49-GG79Kv_bb3hoeVNzEe8DUUkEAX23X4vWTYvJwEjCatSvzKsW78qU7F1uib-mq6WEJfmUQ
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "cd5d037ed577fc8dbc2a8fcf593ae683",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "tenantCode": "jint",
    "country": "Aland Islands",
    "nameDisplayFormat": "fls",
    "toneRegion": "us",
    "timeZone": "UTC-8 US/Pacific",
    "daylightSavingTime": "Disabled",
    "dateDisplayFormat": "mm/dd/yyyy",
    "timeDisplayFormat": "HH:mm:ss",
    
    
    "displayCountryCode": "DOMESTIC",
    "callerIdResolution": [
      "system_contacts",
      "caller_id_name"
    ],
    "displayCallFeature": true,
    "displayDidName": true,
    "extensionRanges": [
      {
        "featureType": "USER",
        "rangeStart": "1000",
        "rangeEnd": "5999"
      },
      {
        "featureType": "CALL_PARKING",
        "rangeStart": "6000",
        "rangeEnd": "6099"
      },
      {
        "featureType": "GROUP_VOICEMAIL",
        "rangeStart": "6100",
        "rangeEnd": "6199"
      },
      {
        "featureType": "IVR",
        "rangeStart": "6200",
        "rangeEnd": "6299"
      },
      {
        "featureType": "RING_GROUP",
        "rangeStart": "6300",
        "rangeEnd": "6399"
      },
      {
        "featureType": "QUEUE",
        "rangeStart": "6400",
        "rangeEnd": "6499"
      },
      {
        "featureType": "CONFERENCE",
        "rangeStart": "6500",
        "rangeEnd": "6599"
      },
      {
        "featureType": "PAGING",
        "rangeStart": "6600",
        "rangeEnd": "6699"
      },
      {
        "featureType": "AI_RECEPTIONIST",
        "rangeStart": "6700",
        "rangeEnd": "6799"
      },
      {
        "featureType": "CALL_FLOW",
        "rangeStart": "6900",
        "rangeEnd": "6999"
      }
    ],
    
    "loginCredentialValidityDays": 1
  }
}