From Bright Pattern Documentation
Jump to: navigation, search
This page contains changes which are not marked for translation.

• 5.2

Export User Phone Numbers

Exports users' phone number data, including phone extension, login ID, first name, last name, whether voicemail is activated, and whether a voicemail greeting is present.

Request

URL

http[s]://<host>/configapi/v2/phone/user

For example:

https://example.brightpattern.com/configapi/v2/phone/user

HTTP Method

GET

Body

Empty. All you need is the URL with host.


Response

Body

User phone data (content-type: application/JSON).

Parameters

In response to a successful request, some or all of the following parameters will be shown.

Parameters Data Type Description Example
extension string The phone extension of the user "1009"
login_id string The user's login "diana.yeh"
external string Access number associated with the given extension (i.e., an external number assigned to this user for direct inward dialing (DID)) "4151234567"
firstName string The user's first name "Diana"
lastName string The user's last name "Yeh"
voiceMail Boolean Indicates whether this user has the voicemail function enabled "true"
greeting Boolean Indicates whether this user has a voicemail greeting set up "false"

Example Response

 [
 {
 "extension":"1000",
 "loginId":"admin",
 "firstName":"admin",
 "lastName":"admin",
 "voiceMail":false,
 "greeting":false
 },
 {
 "extension":"1009",
 "loginId":"diana.yeh",
 "firstName":"Diana",
 "lastName":"Yeh",
 "voiceMail":false,
 "greeting":false
 },
 {
 "extension":"1012",
 "loginId":"christy.borden",
 "firstName":"Christy",
 "lastName":"Borden",
 "voiceMail":false,
 "greeting":false
 }
 ]



< Previous | Next >