From Bright Pattern Documentation
| Line 5: | Line 5: | ||
=== URL === | === URL === | ||
http[s]://<host>/configapi/v2/phone/ext | http[s]://<host>/configapi/v2/phone/ext | ||
| + | |||
| + | For example: | ||
| + | https://example.brightpattern.com/configapi/v2/phone/ext | ||
=== HTTP Method === | === HTTP Method === | ||
GET | GET | ||
| + | |||
| + | === Body === | ||
| + | Empty. All you need is the URL with host. | ||
| + | |||
== Response == | == Response == | ||
| + | === Body === | ||
| + | Access number 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''' | ||
|- | |- | ||
|displayName | |displayName | ||
|string | |string | ||
|If using a hardphone, the configured [[Contact-center-administrator-guide/Hardphones#Caller_ID|Caller ID]] | |If using a hardphone, the configured [[Contact-center-administrator-guide/Hardphones#Caller_ID|Caller ID]] | ||
| + | |"Best Business" | ||
|- | |- | ||
|extension | |extension | ||
|integer | |integer | ||
|The phone extension(s) of the user | |The phone extension(s) of the user | ||
| + | |"8002" | ||
|- | |- | ||
|firstName | |firstName | ||
|string | |string | ||
|The user's first name | |The user's first name | ||
| + | |"Sheila" | ||
|- | |- | ||
|lastName | |lastName | ||
|string | |string | ||
|The user's last name | |The user's last name | ||
| + | |"Thomas" | ||
|- | |- | ||
|loginId | |loginId | ||
|string | |string | ||
|The user's login | |The user's login | ||
| + | |"sheila.thomas" | ||
|- | |- | ||
|media | |media | ||
|string | |string | ||
|The media type of the interaction (e.g., text, voice) | |The media type of the interaction (e.g., text, voice) | ||
| + | |"voice_text" | ||
|- | |- | ||
|number | |number | ||
|string | |string | ||
|The phone number of the user | |The phone number of the user | ||
| + | |"4151234567" | ||
|- | |- | ||
|scenario | |scenario | ||
|string | |string | ||
|The name of the scenario the interaction was processed in | |The name of the scenario the interaction was processed in | ||
| + | |"Queue to agent" | ||
|- | |- | ||
|textOutService | |textOutService | ||
|string | |string | ||
|The name of the service that receives [[Contact-center-administrator-guide/AccessNumbers#How_to_Specify_Where_Unsolicited_Inbound_Messages_Go|unsolicited inbound messages]] | |The name of the service that receives [[Contact-center-administrator-guide/AccessNumbers#How_to_Specify_Where_Unsolicited_Inbound_Messages_Go|unsolicited inbound messages]] | ||
| + | |"Maintenance renewal SMS" | ||
|- | |- | ||
|type | |type | ||
|string | |string | ||
| − | |If using a device, the type of device used | + | |If using a device, the type of device used |
| + | |"softphone" | ||
|} | |} | ||
| − | === | + | === Example Response === |
| − | + | <syntaxhighlight lang="JSON"> | |
| − | |||
| − | |||
[ | [ | ||
| − | + | { | |
| − | + | "number":"14151234567", | |
| − | + | "media":"voice_text", | |
| − | + | "type":"scenario", | |
| − | + | "scenario":"Queue to agent", | |
| − | + | "textOutService":"Maintenance renewal SMS" | |
| − | + | }, | |
| − | + | ||
| − | + | { | |
| − | + | "number":"16501234567", | |
| − | + | "media":"voice_text", | |
| − | + | "type":"scenario", | |
| − | + | "extension":"8002", | |
| − | + | "scenario":"My Conversational IVR", | |
| − | + | "textOutService":"Pacific Chat" | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
] | ] | ||
| − | + | </syntaxhighlight > | |
| − | |||
| − | |||
| − | |||
Revision as of 20:33, 14 March 2019
• 5.2
<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
URL
http[s]://<host>/configapi/v2/phone/ext
For example:
https://example.brightpattern.com/configapi/v2/phone/ext
HTTP Method
GET
Body
Empty. All you need is the URL with host.
Response
Body
Access number 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 |
| displayName | string | If using a hardphone, the configured Caller ID | "Best Business" |
| extension | integer | The phone extension(s) of the user | "8002" |
| firstName | string | The user's first name | "Sheila" |
| lastName | string | The user's last name | "Thomas" |
| loginId | string | The user's login | "sheila.thomas" |
| media | string | The media type of the interaction (e.g., text, voice) | "voice_text" |
| number | string | The phone number of the user | "4151234567" |
| scenario | string | The name of the scenario the interaction was processed in | "Queue to agent" |
| textOutService | string | The name of the service that receives unsolicited inbound messages | "Maintenance renewal SMS" |
| type | string | If using a device, the type of device used | "softphone" |
Example Response
[
{
"number":"14151234567",
"media":"voice_text",
"type":"scenario",
"scenario":"Queue to agent",
"textOutService":"Maintenance renewal SMS"
},
{
"number":"16501234567",
"media":"voice_text",
"type":"scenario",
"extension":"8002",
"scenario":"My Conversational IVR",
"textOutService":"Pacific Chat"
}
]
</translate>