From Bright Pattern Documentation
| Line 1: | Line 1: | ||
<translate>= Export Access Numbers = | <translate>= Export Access Numbers = | ||
| − | + | Exports users' access number data, including the number, media type (voice), extension, name of the scenario used, and display name. | |
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | + | http[s]://<host>/phone/ext | |
=== HTTP Method === | === HTTP Method === | ||
| Line 10: | Line 10: | ||
== Response == | == Response == | ||
| + | === Parameters === | ||
| + | {|border="1" style="border-collapse:collapse" cellpadding="5" | ||
| + | | '''Parameters''' | ||
| + | | '''Data Type''' | ||
| + | | '''Description''' | ||
| + | |- | ||
| + | |number | ||
| + | |Integer | ||
| + | |The phone number of the user | ||
| + | |- | ||
| + | |media | ||
| + | |String | ||
| + | |The media type of the interaction (e.g., text, voice) | ||
| + | |- | ||
| + | |type | ||
| + | |String | ||
| + | |If using a device, the type of device used (e.g., softphone, hardphone) | ||
| + | |- | ||
| + | |extension | ||
| + | |Integer | ||
| + | |The phone extension(s) of the user | ||
| + | |- | ||
| + | |textOutService | ||
| + | |String | ||
| + | |The name of the service used if SMS/MMS is enabled | ||
| + | |- | ||
| + | |scenario | ||
| + | |String | ||
| + | |The name of the scenario the interaction was processed in | ||
| + | |- | ||
| + | |displayName | ||
| + | |String | ||
| + | |If using a device, the name configured to display on the device | ||
| + | |- | ||
| + | |loginId | ||
| + | |String | ||
| + | |The user's login | ||
| + | |- | ||
| + | |firstName | ||
| + | |String | ||
| + | |The user's first name | ||
| + | |- | ||
| + | |lastName | ||
| + | |String | ||
| + | |The user's last name | ||
| + | |} | ||
| + | |||
=== Body === | === Body === | ||
| − | + | Access number data (content-type: application/JSON) | |
==== Example ==== | ==== Example ==== | ||
| Line 79: | Line 126: | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 16:56, 16 November 2018
• 3.18
Contents
- Introduction
- API Specification
- Clear User Lock State
- Create User
- 1 Export Access Numbers
- Export User Phone Numbers
- Get User Data
- Get User Lock State
- Update User
User Management API Specification
Export Access Numbers
Exports users' access number data, including the number, media type (voice), extension, name of the scenario used, and display name.
Request
URL
http[s]://<host>/phone/ext
HTTP Method
GET
Response
Parameters
| Parameters | Data Type | Description |
| number | Integer | The phone number of the user |
| media | String | The media type of the interaction (e.g., text, voice) |
| type | String | If using a device, the type of device used (e.g., softphone, hardphone) |
| extension | Integer | The phone extension(s) of the user |
| textOutService | String | The name of the service used if SMS/MMS is enabled |
| scenario | String | The name of the scenario the interaction was processed in |
| displayName | String | If using a device, the name configured to display on the device |
| loginId | String | The user's login |
| firstName | String | The user's first name |
| lastName | String | The user's last name |
Body
Access number data (content-type: application/JSON)
Example
[
{
"number": "1234567890",
"media": "voice_text",
"type": "softphone",
"extension": "2022",
"textOutService": "Customer Service Chat, chat test",
"loginId": "alan.jenks",
"firstName": "Alan",
"lastName": "Jenks"
},
{
"number": "1234567891",
"media": "voice",
"type": "scenario",
"scenario": "Survey"
},
{
"number": "1234567892",
"media": "text",
"type": "scenario",
"scenario": "Mobile Chat"
},
{
"number": "1234567893",
"media": "voice",
"type": "scenario",
"scenario": "After Hours"
},
{
"number": "1234567897",
"media": "voice",
"type": "unassigned"
},
{
"number": "1234567898",
"media": "voice",
"type": "phone",
"extension": "3001",
"displayName": "Test phone 01"
},
{
"number": "1234567899",
"media": "voice",
"type": "scenario",
"extension": "6003, 6000, 6001",
"scenario": "Support-Service"
},
{
"number": "4156558090",
"media": "voice",
"type": "scenario",
"extension": "8002",
"scenario": "Maintenance Renewal"
},
{
"number": "8008082134",
"media": "voice",
"type": "scenario",
"extension": "8001",
"scenario": "Support-Service"
}
]