From Bright Pattern Documentation
| Line 5: | Line 5: | ||
=== URL === | === URL === | ||
http[s]://<host>/configapi/v2/phone/user | http[s]://<host>/configapi/v2/phone/user | ||
| + | |||
| + | For example: | ||
| + | https://example.brightpattern.com/configapi/v2/phone/user | ||
=== HTTP Method === | === HTTP Method === | ||
GET | GET | ||
| + | |||
| + | === Body === | ||
| + | Empty. All you need is the URL with host. | ||
| + | |||
== Response == | == Response == | ||
| + | === Body === | ||
| + | User phone data (content-type: application/JSON). | ||
| + | |||
=== Parameters === | === Parameters === | ||
| + | In response to a successful request, some or all of the following parameters will be shown. | ||
| + | |||
{|border="1" style="border-collapse:collapse" cellpadding="5" | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| '''Parameters''' | | '''Parameters''' | ||
| '''Data Type''' | | '''Data Type''' | ||
| '''Description''' | | '''Description''' | ||
| + | | '''Example''' | ||
| + | |- | ||
| + | |extension | ||
| + | |string | ||
| + | |The phone extension of the user | ||
| + | |"1009" | ||
|- | |- | ||
|login_id | |login_id | ||
|string | |string | ||
|The user's login | |The user's login | ||
| − | | | + | |"diana.yeh" |
| − | |||
| − | |||
| − | |||
|- | |- | ||
|external | |external | ||
|string | |string | ||
| − | |Access number associated with the given ''extension'' (i.e., an external number assigned to this user for direct inward dialing (DID)) | + | |Access number associated with the given ''extension'' (i.e., an external number assigned to this user for direct inward dialing (DID)) |
| + | |"4151234567" | ||
|- | |- | ||
|firstName | |firstName | ||
|string | |string | ||
|The user's first name | |The user's first name | ||
| − | | | + | |"Diana" |
| − | |||
| − | |||
| − | |||
|- | |- | ||
|lastName | |lastName | ||
|string | |string | ||
|The user's last name | |The user's last name | ||
| + | |"Yeh" | ||
|- | |- | ||
|voiceMail | |voiceMail | ||
| − | | | + | |Boolean |
|Indicates whether this user has the [[Contact-center-administrator-guide/Users#Enable_voicemail|voicemail function]] enabled | |Indicates whether this user has the [[Contact-center-administrator-guide/Users#Enable_voicemail|voicemail function]] enabled | ||
| + | |"true" | ||
| + | |- | ||
| + | |greeting | ||
| + | |Boolean | ||
| + | |Indicates whether this user has a [[Contact-center-administrator-guide/Users#Use_this_voicemail_greeting|voicemail greeting]] set up | ||
| + | |"false" | ||
|} | |} | ||
| − | + | === Example Response === | |
| − | === | + | <syntaxhighlight lang="JSON"> |
| − | |||
| − | |||
| − | |||
[ | [ | ||
| − | + | { | |
| − | + | "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 | |
| − | + | } | |
| − | + | ] | |
| − | + | </syntaxhighlight> | |
| − | |||
| − | |||
| − | ] | ||
| − | |||
| − | |||
Latest revision as of 20:47, 14 March 2019
• 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
}
]