From Bright Pattern Documentation
| (One intermediate revision by the same user not shown) | |||
| Line 4: | Line 4: | ||
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host>/phone/user | + | http[s]://<host>/admin/ws/t/<tenant_url>/phone/user |
=== HTTP Method === | === HTTP Method === | ||
| Line 17: | Line 17: | ||
|- | |- | ||
|login_id | |login_id | ||
| − | | | + | |string |
|The user's login | |The user's login | ||
|- | |- | ||
|extension | |extension | ||
| − | | | + | |string |
|The phone extension of the user | |The phone extension of the user | ||
|- | |- | ||
|external | |external | ||
| − | | | + | |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)) | ||
|- | |- | ||
|firstName | |firstName | ||
| − | | | + | |string |
|The user's first name | |The user's first name | ||
|- | |- | ||
|greeting | |greeting | ||
| − | | | + | |boolean |
|Indicates whether this user has a [[Contact-center-administrator-guide/Users#Use_this_voicemail_greeting|voicemail greeting]] set up | |Indicates whether this user has a [[Contact-center-administrator-guide/Users#Use_this_voicemail_greeting|voicemail greeting]] set up | ||
|- | |- | ||
|lastName | |lastName | ||
| − | | | + | |string |
|The user's last name | |The user's last name | ||
|- | |- | ||
|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 | ||
|} | |} | ||
Latest revision as of 00:30, 20 November 2018
• 3.18
Contents
- Introduction
- API Specification
- Clear User Lock State
- Create User
- Export Access Numbers
- 1 Export User Phone Numbers
- Get User Data
- Get User Lock State
- Update User
User Management API Specification
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>/admin/ws/t/<tenant_url>/phone/user
HTTP Method
GET
Response
Parameters
| Parameters | Data Type | Description |
| login_id | string | The user's login |
| extension | string | The phone extension of the user |
| external | string | Access number associated with the given extension (i.e., an external number assigned to this user for direct inward dialing (DID)) |
| firstName | string | The user's first name |
| greeting | boolean | Indicates whether this user has a voicemail greeting set up |
| lastName | string | The user's last name |
| voiceMail | boolean | Indicates whether this user has the voicemail function enabled |
Body
User phone data (content-type: application/JSON)
Example
[
{
"login_id" : "kelli.simmon",
"extension": "2021",
"firstName": "Kelli",
"lastName": "Simmon",
"external": "1234567889",
"voiceMail": false,
"greeting": false
},
{
"login_id" : "ajenks",
"extension": "2022",
"firstName": "Alan",
"lastName": "Jenks",
"external": "1234567890",
"voiceMail": true,
"greeting": true
},
{
"login_id" : "tony.cobb",
"extension": "2023",
"firstName": "Tony",
"lastName": "Cobb",
"external": "1234567889",
"voiceMail": false,
"greeting": false
}
]