Get User Presence Settings

Retrieves the presence settings of a user, including the call forwarding rules and the ring strategy for each presence status.

Request URL

GET {base_url}/uc-cconfig/api/v1/users/{id}/presence-settings

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.
Path parameters
Parameter Required Type Description
id Yes String The ID of the user. You can obtain the ID using the Search Users 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.
results Array<Presence_Setting_Item> The list of presence settings of the user.
Presence_Setting_Item
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/338136731335409664/presence-settings 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": "7ca6ce27e97e31792671ffca0293225f",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "results": [
    {
      "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": ""
      }
    },
    {
      "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": ""
      }
    }
  ]
}
Note:

The response is condensed.