From Bright Pattern Documentation
Jump to: navigation, search
(Created page with "<translate>= Export Access Numbers = Returns users' access number data, including the number, media type (voice), extension, name of the scenario used, and display name. == R...")
 
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<translate>= Export Access Numbers =
 
<translate>= Export Access Numbers =
−
Returns users' access number data, including the number, media type (voice), extension, name of the scenario used, and display name.
+
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>/configapi/v2/phone/ext
+
  http[s]://<host>/admin/ws/t/<tenant_url>/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'''
 +
|-
 +
|displayName
 +
|string
 +
|If using a hardphone, the configured [[Contact-center-administrator-guide/Hardphones#Caller_ID|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 [[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)
 +
|}
 +
 
=== Body ===
 
=== Body ===
−
User data (content-type: application/JSON)
+
Access number data (content-type: application/JSON)
  
 
==== Example ====
 
==== Example ====
Line 79: Line 126:
  
  
−
=== 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 if texts are sent out
 
−
|-
 
−
|scenario
 
−
|String
 
−
|The name of the scenario the interaction was processed in
 
−
|-
 
−
|displayName
 
−
|String
 
−
|If using a phone, 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
 
−
|}
 
  
  

Latest revision as of 00:30, 20 November 2018

• 3.18

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"
    }
]




< Previous | Next >
Retrieved from "https://help3x.brightpattern.com/index.php?title=3.18:User-management-api-specification/ExportAccessNumbers&oldid=27877"