From Bright Pattern Documentation
| (5 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host>/phone/ext | + | http[s]://<host>/admin/ws/t/<tenant_url>/phone/ext |
=== HTTP Method === | === HTTP Method === | ||
| Line 16: | Line 16: | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| − | | | + | |displayName |
| − | | | + | |string |
| − | + | |If using a hardphone, the configured [[Contact-center-administrator-guide/Hardphones#Caller_ID|Caller ID]] | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |If using a | ||
|- | |- | ||
|extension | |extension | ||
| − | | | + | |integer |
|The phone extension(s) of the user | |The phone extension(s) of the user | ||
|- | |- | ||
| − | | | + | |firstName |
| − | | | + | |string |
| − | |The name | + | |The user's first name |
|- | |- | ||
| − | | | + | |lastName |
| − | | | + | |string |
| − | |The name | + | |The user's last name |
| − | |||
| − | |||
| − | |||
| − | |||
|- | |- | ||
|loginId | |loginId | ||
| − | | | + | |string |
|The user's login | |The user's login | ||
|- | |- | ||
| − | | | + | |media |
| − | | | + | |string |
| − | |The user | + | |The media type of the interaction (e.g., text, voice) |
| + | |- | ||
| + | |number | ||
| + | |string | ||
| + | |The phone number of the user | ||
| + | |- | ||
| + | |scenario | ||
| + | |string | ||
| + | |The name of the scenario the interaction was processed in | ||
| + | |- | ||
| + | |textOutService | ||
| + | |string | ||
| + | |The name of the service that receives [[Contact-center-administrator-guide/AccessNumbers#How_to_Specify_Where_Unsolicited_Inbound_Messages_Go|unsolicited inbound messages]] | ||
|- | |- | ||
| − | | | + | |type |
| − | | | + | |string |
| − | | | + | |If using a device, the type of device used (e.g., softphone, hardphone) |
|} | |} | ||
Latest revision as of 00:30, 20 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>/admin/ws/t/<tenant_url>/phone/ext
HTTP Method
GET
Response
Parameters
| Parameters | Data Type | Description |
| displayName | string | If using a hardphone, the configured Caller ID |
| extension | integer | The phone extension(s) of the user |
| firstName | string | The user's first name |
| lastName | string | The user's last name |
| loginId | string | The user's login |
| media | string | The media type of the interaction (e.g., text, voice) |
| number | string | The phone number of the user |
| scenario | string | The name of the scenario the interaction was processed in |
| textOutService | string | The name of the service that receives unsolicited inbound messages |
| type | string | If using a device, the type of device used (e.g., softphone, hardphone) |
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"
}
]