Get User Preferences Setting

Retrieves the preferences of the current user, including the presence settings and the call forwarding rules.

Request URL

GET {base_url}/uc-cconfig/api/v1/users/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<User_Preferences>	The preferences of the current user.

User_Preferences


Parameter	Type	Description
id	String	The ID of the user.
extension	String	The extension number of the user.
firstName	String	The first name of the user.
lastName	String	The last name of the user.
email	String	The email address of the user.
mobile	String	The mobile number of the user.
currentPresence	String	The current presence status of the user: `AVAILABLE` `AWAY` `DND` `LUNCH` `BUSINESS_TRIP` `OFF_WORK`
presences	Array<Presence_Config>	The presence configuration list of the user.

Presence_Config


Parameter	Type	Description
presence	String	The presence status: `AVAILABLE` `AWAY` `DND` `LUNCH` `BUSINESS_TRIP` `OFF_WORK`
config	Object<Presence_Setting>	The configuration that takes effect when the presence status is active.

Presence_Setting


Parameter	Type	Description
callForwarding	Object<Call_Forwarding>	The call forwarding configuration.
ringStrategy	Object<Ring_Strategy>	The ring strategy configuration.
ringTimeout	Integer	The ring timeout, in seconds.
information	String	The additional presence information.

Call_Forwarding


Parameter	Type	Description
internal	Object<Forward_Rules>	The call forwarding rules for internal calls.
external	Object<Forward_Rules>	The call forwarding rules for external calls.

Forward_Rules


Parameter	Type	Description
always	Object<Forward_Rule>	The rule for forwarding all calls.
noAnswer	Object<Forward_Rule>	The rule for forwarding calls when there is no answer.
whenBusy	Object<Forward_Rule>	The rule for forwarding calls when the line is busy.

Forward_Rule


Parameter	Type	Description
enabled	Boolean	Whether the forwarding rule is enabled. `true`: Enabled. `false`: Disabled.
destinationType	String	The type of the forwarding destination, such as `USER_VOICEMAIL` and `USER`.
destinationValue	String	The value of the forwarding destination.
repeatCount	Integer	The repeat count for the forwarding.

Ring_Strategy


Parameter	Type	Description
firstPriority	Array<String>	The list of client types that ring first, such as `SIP`, `MOBILE`, `DESKTOP`, and `WEB`.
secondPriority	Array<String>	The list of client types that ring second.

Example

Request example

GET /uc-cconfig/api/v1/users/preferences HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyMTI4NiwiaWF0IjoxNzkzNTk5Njg2LCJqdGkiOiI3ZmM2ZmZiMC02NTBlLTQyZjYtOGJmOC0wZmE3ZWFmYjY3YjgiLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImE0NDVkYjRhLTNkMjEtNGRlMi1hYmI2LWEwZmY5NjNmZjY3OCIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.Fetld7VQ6Vu5239kNE05a_-VVdNIHOHwZ3v-GTUmh47xxyKXPtbihGCEMR8-PDS2w1RzMGQKD-3ehpmojGyyh5GaaWl4yBnWg7zZlxrYciXtqsuCAcKre4fr_UViOQAVNkj3huuKEtUUjQtbbsb8WOv6w2rhfKJthJma4XRwoA3iDR8Snr5wT5cUa3kVEomSf1VQtAIMyEWrPXlt5kSPX11ZK3lB-JZtstKa84MIpgrHMlthJDiyYbOlRKDcq570kDQI4BrYCX1sIjACnUHiyvd_7qxK9rNcihnXgbTOC2sEvEJJDwdudoNBENZgH-tKV7wR_8jpaKxa6Djkf_x1sA
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "cbb98df5545fe853cbd8061762594612",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "id": "338136731335409664",
    "extension": "1000",
    "firstName": "Leo",
    "lastName": "Ball",
    "email": "leo@sample.com",
    "mobile": "+8615880123456",
    "currentPresence": "AVAILABLE",
    "presences": [
      {
        "presence": "BUSINESS_TRIP",
        "config": {
          "callForwarding": {
            "internal": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            },
            "external": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            }
          },
          "ringStrategy": {
            "firstPriority": [
              "SIP",
              "MOBILE",
              "DESKTOP",
              "WEB"
            ],
            "secondPriority": []
          },
          "ringTimeout": 30,
          "information": ""
        }
      },
      {
        "presence": "OFF_WORK",
        "config": {
          "callForwarding": {
            "internal": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            },
            "external": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            }
          },
          "ringStrategy": {
            "firstPriority": [
              "SIP",
              "MOBILE",
              "DESKTOP",
              "WEB"
            ],
            "secondPriority": []
          },
          "ringTimeout": 30,
          "information": ""
        }
      },
      {
        "presence": "AVAILABLE",
        "config": {
          "callForwarding": {
            "internal": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            },
            "external": {
              "always": {
                "enabled": false,
                "destinationType": "USER",
                "destinationValue": "338855950145581056",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            }
          },
          "ringStrategy": {
            "firstPriority": [
              "SIP"
            ],
            "secondPriority": [
              "MOBILE",
              "WEB"
            ]
          },
          "ringTimeout": 30,
          "information": "Meeting Now"
        }
      },
      {
        "presence": "AWAY",
        "config": {
          "callForwarding": {
            "internal": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            },
            "external": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            }
          },
          "ringStrategy": {
            "firstPriority": [
              "SIP",
              "MOBILE",
              "DESKTOP",
              "WEB"
            ],
            "secondPriority": []
          },
          "ringTimeout": 30,
          "information": ""
        }
      },
      {
        "presence": "DND",
        "config": {
          "callForwarding": {
            "internal": {
              "always": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": null,
              "whenBusy": null
            },
            "external": {
              "always": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": null,
              "whenBusy": null
            }
          },
          "ringStrategy": null,
          "ringTimeout": 0,
          "information": ""
        }
      },
      {
        "presence": "LUNCH",
        "config": {
          "callForwarding": {
            "internal": {
              "always": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            },
            "external": {
              "always": {
                "enabled": false,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "noAnswer": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              },
              "whenBusy": {
                "enabled": true,
                "destinationType": "USER_VOICEMAIL",
                "destinationValue": "",
                "repeatCount": 0
              }
            }
          },
          "ringStrategy": {
            "firstPriority": [
              "SIP",
              "MOBILE",
              "DESKTOP",
              "WEB"
            ],
            "secondPriority": []
          },
          "ringTimeout": 30,
          "information": ""
        }
      }
    ],
    "onlineStatus": {
      "sip": {
        "status": "SIP_UNAVAILABLE",
        "source": [],
        "isRegistered": false
      },
      "mobile": {
        "status": "MOBILE_ONLINE",
        "source": [
          {
            "address": "112.48.19.183",
            "platform": "IOS",
            "isRegistered": false,
            "regCallId": ""
          }
        ],
        "isRegistered": false
      },
      "desktop": {
        "status": "DESKTOP_OFFLINE",
        "source": [],
        "isRegistered": false
      },
      "web": {
        "status": "WEB_OFFLINE",
        "source": [],
        "isRegistered": false
      },
      "userOnlineStatus": "USER_ONLINE"
    },
    "createdAt": "1784685279030",
    "updatedAt": "1793598080073",
    "registrationAddress": {
      "domainProxy": "jint",
      "outboundProxy": "sip.cn-0.test.novo-one.com",
      "udpTcpPort": 5060,
      "tlsPort": 5061
    },
    "username": "1000@jint",
    "voicemail": {
      "enabled": true,
      "pinAuthEnabled": true,
      "playDateTime": false,
      "timeDisplayFormat": "TIME_FORMAT_FOLLOW_SYSTEM",
      "playCallerId": false,
      "playMessageDuration": false,
      "playForwardedFrom": true,
      "emailNotificationEnabled": false,
      "attachVoicemail": true,
      "afterNotificationAction": "AFTER_NOTIFICATION_NO_ACTION",
      "emailSendTo": "EMAIL_SEND_TO_USER_EMAIL",
      "emailAddress": "",
      "greetingConfig": {
        "defaultGreeting": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_SYSTEM"
        },
        "available": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_DEFAULT"
        },
        "away": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_DEFAULT"
        },
        "dnd": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_DEFAULT"
        },
        "lunch": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_DEFAULT"
        },
        "businessTrip": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_DEFAULT"
        },
        "offWork": {
          "enabled": true,
          "selector": "GREETING_SELECTOR_FOLLOW_DEFAULT"
        }
      }
    },
    "language": {
      "systemPromptLanguage": "332348858387890176",
      "voicemailLanguage": ""
    },
    "callerIdCallHandling": {
      "rules": []
    },
    "functionKeys": {
      "items": [
        {
          "keyType": "park_retrieve",
          "value": "6000",
          "label": "Park - 6000",
          "isDefaultLabel": 0,
          "valueType": "extension"
        },
        {
          "keyType": "intercom",
          "value": "1001",
          "label": "INT - Terrell Smith",
          "isDefaultLabel": 0,
          "valueType": "extension"
        },
        {
          "keyType": "agent_login_logout",
          "value": "6400",
          "label": "Q: Login/Logout",
          "isDefaultLabel": 0,
          "valueType": "extension"
        },
        {
          "keyType": "agent_pause_unpause",
          "value": "6401",
          "label": "Q: Pause/Unpause",
          "isDefaultLabel": 0,
          "valueType": "extension"
        },
        {
          "keyType": "blf",
          "value": "1002",
          "label": "Philip Huff",
          "isDefaultLabel": 0,
          "valueType": "extension"
        }
      ]
    },
    "aiTranscription": {
      "callTranscription": {
        "inScope": true,
        "automaticTranscriptionEnabled": false,
        "showTranscriptionTextAfterCall": false,
        "language": "follow_system",
        "summaryTemplateId": "follow_system"
      },
      "voicemailTranscription": {
        "inScope": true,
        "automaticVoicemailTranscriptionEnabled": true,
        "language": "follow_system"
      }
    },
    "clientConfig": {
      "clients": [
        {
          "clientType": "CLIENT_TYPE_MOBILE",
          "enabled": true,
          "callWaitingEnabled": true
        },
        {
          "clientType": "CLIENT_TYPE_DESKTOP",
          "enabled": false,
          "callWaitingEnabled": false
        },
        {
          "clientType": "CLIENT_TYPE_WEB",
          "enabled": true,
          "callWaitingEnabled": true
        }
      ]
    },
    "avatarUrl": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/platform/jint/user_avatar/1786586611608/1.png",
    "endpointsCallRule": {
      "allBusyModeEnabled": false,
      "allRejectModeEnabled": false
    },
    "emergencyOutboundCallerId": {
      "didId": "0",
      "customNumber": "8888"
    },
    "outboundCallerIdList": {
      "items": [
        {
          "id": "350577965521420288",
          "didId": "349095413464047619",
          "pos": 0
        }
      ]
    }
  }
}

Note:

The response is condensed.