Get Phone Line
This request returns the information of a phone line.
Resource
GET /phonelines/<OID>
Where OID
is the object ID of the phone line.
Parameters
Name | Type | Description |
---|---|---|
|
[String] |
Include fields to the result. |
Payload
None
Response
Context
Authorization |
Administrator(full) or User(managed line) |
Errors
Example
Request
GET https://xelion.nl/api/v1/master/phonelines/1033697
Response
{
"object": {
"allowedNumbers": [
{
"externalNumber": "",
"orderNumber": 1,
"oid": "1740727",
"objectType": "XCCAllowedNumber"
}
],
"externalNumber": "",
"callername": testline,
"extensions": [
{
"commonName": "432",
"addressType": "Telephone",
"address": "432",
"label": "",
"orderNumber": 1,
"oid": "10317821",
"objectType": "TelecomAddress"
}
],
"users": [
{
"user": {
"commonName": "wes",
"oid": "1651218",
"objectType": "UserProfile"
},
"lineOrder": 1,
"skillNumber": 0,
"incoming": true,
"outgoing": false,
"editable": "INCOMINGANDOUTGOING",
"oid": "2010408",
"objectType": "XCCConnectedUser"
}
],
"phones": [
{
"phone": {
"permissions": "ReadWriteRemove",
"commonName": "Softphone van Gebruiker A",
"oid": "1651587",
"objectType": "XCCPhone"
},
"lineOrder": 1,
"oid": "10317682",
"objectType": "XCCConnectedPhone"
}
],
"lineHuntingPolicy": "linear",
"lineHuntingTimeout": 0,
"ringLastTalkedToFirst": false,
"associatedAddressable": {
"permissions": "ReadWriteRemove",
"commonName": "1234",
"oid": "4338838",
"objectType": "Person"
},
"dayNightMode": {
"enableDayNightMode": true,
"oneOffOverrideDateTime": "2017-07-21 12:00:00",
"oneOffOverrideMode": "overrideNext",
"switchTime": [
{
"day": "tuesday",
"switchTime": "",
"status": "available",
"statusIcon": "statusGreen",
"oid": "1726619",
"objectType": "XCCDayNightModeSwitch"
}
],
"overrides": [
{
"overrideActive": true,
"startOverrideDateTime": "2017-07-21 15:36:00",
"endOverrideDateTime": "2017-07-28 15:38:00",
"overrideStatus": "available",
"overrideStatusIcon": "statusGreen",
"oid": "1726623",
"objectType": "XCCDayNightModeOverride"
}
],
"oid": "1726618",
"objectType": "XCCDayNightMode"
},
"forwardCallerIdMap": [
{
"addressStart": "0800",
"orderNumber": 1,
"oid": "12342353",
"objectType": "XCCCallerIdMapping"
}
],
"autoAttendantOn": true,
"autoAttendant": {
"allowDirectNumber": false,
"action1": {
"permissions": "ReadWriteRemove",
"commonName": "Telefoonaansluiting Arno Brugman",
"oid": "1651130",
"objectType": "XCCPhoneLine"
},
"voicemail1": true,
"oid": "1740740",
"objectType": "XCCDayNightMode"
},
"defaultFallback": {
"permissions": "ReadWriteRemove",
"commonName": "Telefoonaansluiting Arno Brugman",
"oid": "1651130",
"objectType": "XCCPhoneLine"
},
"userPhoneLine": {
"message": "uhuh",
"timeout": 10,
"doNotDisturb": false,
"anonymous": false,
"redirection": "",
"redirectionActive": false,
"redirectionTimeout": 10,
"fallbackActive": false,
"voicemailActive": false,
"listeners": [
{
"user": {
"permissions": "ReadWriteRemove",
"commonName": "arno",
"oid": "1651120",
"objectType": "UserProfile"
},
"oid": "1743972",
"objectType": "XCCPhoneLineListener"
}
],
"userStatus": "available",
"permissions": "ReadWriteRemove",
"commonName": "",
"oid": "1723049",
"objectType": "XCCUserPhoneLine"
},
"voicemailRecipientAddress": {
"commonName": "jan@janssen.nl",
"addressType": "Email",
"address": "jan@janssen.nl",
"label": "",
"orderNumber": 0,
"oid": "1825242",
"objectType": "TelecomAddress"
},
"enableVoicemailToEmail": false,
"hideInPhoneList": false,
"showWaitingQueue": true,
"processQueueInOrder": true,
"maxQueueLength": 0,
"dtmfBreakoutEnabled": false,
"callQueueWrapupTime": 0,
"saveCallRecording": true,
"doNotRecordInternalCalls": true,
"voicemailDeliveryNumber": "",
"enableVoicemailDelivery": false,
"voicemailDeliveryTimeout": 0,
"unlimitedChannelCount": false,
"announcementEnabled": false,
"callerAnnouncementEnabled": false,
"hideNumbers": false,
"isChatable": false,
"chatHuntingTimeout": 0,
"chatIdleTimeout": 0,
"chatEndedTimeout": 0,
"chatHeartbeatInterval": 0,
"chatHeartbeatMessage": "10",
"chatNoAgentsAvailableMessage": "",
"chatAutoReplies": [
{
"xelionStatus": "dont_disturb",
"xelionStatusIcon": "statusDND",
"message": "sorry, maar stoor me niet",
"oid": "2202839",
"objectType": "XCCChatAutoReply"
}
],
"groupChatActive": false,
"enableVoicemailSms": false,
"isConferenceRoom": false,
"conferenceRoomCallerId": "",
"conferenceRoomListenOnly": false,
"manualWrapUp": false,
"connectFirstAvailable": false,
"enableVoicemailTranscribe": false,
"musicOnHoldCategory": {
"permissions": "ReadWriteRemove",
"commonName": "wachtrij",
"oid": "1743966",
"objectType": "XCCMusicOnHoldCategory"
},
"answerWithMusicOnHold": {
"permissions": "ReadWriteRemove",
"commonName": "wachtrij",
"oid": "1743966",
"objectType": "XCCMusicOnHoldCategory"
},
"positionReportPolicy": "betweenMessages",
"positionReportTime": 0,
"wallboardResetTime": "",
"onlyExternalCalls": false,
"missedCallThreshold": 0,
"durationThresholdMin": 0,
"durationThreshold": 0,
"agentShowInbound": true,
"agentShowOutbound": true,
"agentShowTotal": true,
"wallboardEntries": [
{
"parameter": "TOTAL_CALLS",
"direction": "INCOMINGANDOUTGOING",
"threshold1": 0,
"threshold2": 0,
"orderNr": 1,
"oid": "1676309",
"objectType": "XCCWallboardEntry"
}
],
"voicemailDeliveryMessage": {
"originalLocation": "x-sd-hotdesking-activated.wav",
"mimeType": "audio/wav",
"size": 0,
"commonName": "HotDesking1 en_UK",
"oid": "1744012",
"objectType": "Attachment"
},
"limitAccessToCallRecording": true,
"callRecordingUsers": [
{
"permissions": "ReadWriteRemove",
"commonName": "wes",
"oid": "1651218",
"objectType": "UserProfile"
}
],
"callLogUsers": [
{
"permissions": "ReadWriteRemove",
"commonName": "arno",
"oid": "1651120",
"objectType": "UserProfile"
}
],
"managers": [
{
"user": {
"permissions": "ReadWriteRemove",
"commonName": "arnon",
"oid": "1651565",
"objectType": "UserProfile"
},
"oid": "1756113",
"objectType": "XCCPhoneLineManager"
}
],
"trafficClasses": [
{
"trafficClass": {
"permissions": "ReadWriteRemove",
"commonName": "Xelion verkeersklasse west europa toegestaan",
"oid": "1797858",
"objectType": "XCCTrafficClass"
},
"orderNumber": 6,
"oid": "1799167",
"objectType": "XCCTrafficClassPhoneLine"
}
],
"wallboard": {
"permissions": "ReadWriteRemove",
"commonName": "<Onbekend> <XCCWallboard>",
"accessRights": "readWrite",
"domain": [
{
"writeObject": true,
"domain": {
"permissions": "ReadWriteRemove",
"commonName": "wes",
"oid": "1651218",
"objectType": "UserProfile"
},
"oid": "1933726",
"objectType": "SecurityAttributes"
}
],
"oid": "1933721",
"objectType": "XCCWallboard"
},
"permissions": "ReadWriteRemove",
"commonName": "testline1234",
"oid": "10317660",
"objectType": "XCCPhoneLine"
},
"links": [
{
"rel": "self",
"href": "http://sip.xelion.nl/api/v1/master/phonelines/10317660",
"method": "GET"
}
]
}