Phone Line Search Parameters

User Guide > Resources > Phone Line Search Parameters

Phone line search parameters

Name Type Description

where

Where-clause
"where=member=value"
seperate by comma if you want to include multiple fields

Following where filters are available where=[selected filters]
-extension=[pattern] : match phone lines with phone extension that match this pattern. See note below.
-isChatable=[boolean] : search if phone line is chatable (true) or not (false).
-isCreatedForGroupChat=[boolean] : filter out lines that are created for group chats (true) or not (false).
-showWaitingQueue=[boolean] : filter out lines that have enabled wallboards (true) or not (false).
-isUserLine=[boolean] : filter out lines that are user lines (true) or not (false).
-autoAttendantOn=[boolean] : filter out lines that have auto attendant enabled (true) or not (false).
-processQueueInOrder=[boolean] : filter out lines that have queue enabled (true) or not (false).
-voicemailActive=[boolean] : filter out lines that have voicemail enabled (true) or not (false).
-redirectionActive=[boolean] : filter out lines that have redirection enabled (true) or not (false).
-enableDayNightMode=[boolean] : filter out lines that have a schedule enabled (true) or not (false).
-forwardCallerIdMap=[boolean] : filter out lines that have automatic transfers filled (true) or not (false).
-doNotDisturb=[boolean] : filter out lines that have do not disturb enabled (true) or not (false).
-questionaireEnabled=[boolean] : filter out lines that have a questionaire enabled (true) or not (false).

include (users)

[String]
seperate by comma if you want to include multiple fields

Include fields to the result. include=[included fields]
-associatedAddressable → associated addressable
-associatedAddressable.iconId → associated addressable icon id
-callerName → caller name of the line
-externalNumber → the external number
-unreadRecentContactsCount → unread recent contacts count -activeTodoListItemsCount → active todo list items count

include (only administrators)

[String]
seperate by comma if you want to include multiple fields

Include fields to the result. include=[included fields]
-autoAttendantOn → is auto attendand on
-saveCallRecording → save call recording
-answerWithMusicOnHold → queue music
-defaultFallback → default fallback line
-associatedAddressable → associated addressable
-dayNightMode.enableDayNightMode → is day night mode enabled
-dayNightMode.manualNightMode → manual night mode line
-userPhoneLine.redirectionActive → is redirection enabled
-userPhoneLine.redirection → redirection number
-userPhoneLine.doNotDisturb → is do not disturb enabled
-userPhoneLine.voicemailActive → is voicemail active
-userPhoneLine.fallbackActive → is fallback active
-userPhoneLine.fallback → fallback line
-users → users of the line (including incoming, outgoing, editable, …​)
-users.user.person → person object if the user
-users.user.active → is the user active
-users.user.userName → the user name
-users.user.userLicense → does the user have a user license
-users.user.loginDate → login date of the user
-users.user.logoutDate → logout date of the user
-users.user.primaryLine → line of the user profile
-phones → (additional) phones of the line
-phones.phone.active → is phone active
-phones.phone.doNotDisturb → is phone on do not disturb
-phones.phone.user → the phone user
-phones.phone.users → phone softphone users
-phones.phone.isRegistered → phone softphone users
-phones.phone.phoneNumber → smartphone number
-extensions → phone line extensions

The where-clause where=extenion=[pattern] filters phone lines that have a phone extension that matches the pattern.

The pattern is matched against the Xelion’s normalized format of a phone number. The Xelion normalized phone number format is the international phone number format where all the delimiters are dropped. For example, the phone number 0152511411 may be normalized as +31152511411.

The pattern may include the wildcard character asterisk ('*'). This character matches zero or more characters.

Note that the plus character ('+') must be escaped in the query as %2B.