From Bright Pattern Documentation
(Created page with "<translate>= Export User Phone Numbers = Returns users' phone extension, login ID, first name, last name, whether voicemail is activated, and whether a voicemail greeting is p...") |
|||
| Line 1: | Line 1: | ||
<translate>= Export User Phone Numbers = | <translate>= 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 == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host> | + | http[s]://<host>/phone/user |
=== HTTP Method === | === HTTP Method === | ||
| Line 10: | Line 10: | ||
== Response == | == Response == | ||
| + | === Parameters === | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameters''' | ||
| + | | '''Data Type''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | |login_id | ||
| + | |String | ||
| + | |The user's login | ||
| + | |- | ||
| + | |extension | ||
| + | |Integer | ||
| + | |The phone extension of the user | ||
| + | |- | ||
| + | |external | ||
| + | |Integer | ||
| + | |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 [[Contact-center-administrator-guide/Users#Use_this_voicemail_greeting|voicemail greeting]] set up | ||
| + | |- | ||
| + | |lastName | ||
| + | |String | ||
| + | |The user's last name | ||
| + | |- | ||
| + | |voiceMail | ||
| + | |Boolean | ||
| + | |Indicates whether this user has the [[Contact-center-administrator-guide/Users#Enable_voicemail|voicemail function]] enabled | ||
| + | |} | ||
| + | |||
| + | |||
=== Body === | === Body === | ||
| − | User data (content-type: application/JSON) | + | User phone data (content-type: application/JSON) |
==== Example ==== | ==== Example ==== | ||
| Line 22: | Line 58: | ||
"external": "1234567889", | "external": "1234567889", | ||
"voiceMail": false, | "voiceMail": false, | ||
| − | "greeting": | + | "greeting": false |
}, | }, | ||
{ | { | ||
| Line 44: | Line 80: | ||
} | } | ||
] | ] | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 17:13, 16 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>/phone/user
HTTP Method
GET
Response
Parameters
| Parameters | Data Type | Description |
| login_id | String | The user's login |
| extension | Integer | The phone extension of the user |
| external | Integer | 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
}
]