Revision as of 17:05, 16 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>/phone/ext

HTTP Method

GET

Response

Parameters

Parameters	Data Type	Description
displayName	String	If using a device, the name configured to display on the device
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	Integer	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 used if SMS/MMS is enabled
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 >

@@ Line 16: / Line 16: @@
 | '''Description'''
 |-
-|number
+|displayName
-|Integer
-|The phone number of the user
-|-
-|media
 |String
-|The media type of the interaction (e.g., text, voice)
+|If using a device, the name configured to display on the device
-|-
-|type
-|String
-|If using a device, the type of device used (e.g., softphone, hardphone)
 |-
 |extension
@@ Line 32: / Line 24: @@
 |The phone extension(s) of the user
 |-
-|textOutService
+|firstName
+|String
+|The user's first name
+|-
+|lastName
 |String
-|The name of the service used if SMS/MMS is enabled
+|The user's last name
 |-
-|scenario
+|loginId
 |String
-|The name of the scenario the interaction was processed in
+|The user's login
 |-
-|displayName
+|media
 |String
-|If using a device, the name configured to display on the device
+|The media type of the interaction (e.g., text, voice)
+|-
+|number
+|Integer
+|The phone number of the user
 |-
-|loginId
+|scenario
 |String
-|The user's login
+|The name of the scenario the interaction was processed in
 |-
-|firstName
+|textOutService
 |String
-|The user's first name
+|The name of the service used if SMS/MMS is enabled
 |-
-|lastName
+|type
 |String
-|The user's last name
+|If using a device, the type of device used (e.g., softphone, hardphone)
 |}

Navigation menu