Create Phone Line
This request creates a phone line.
Resource
POST /phonelines
Where OID is the object ID of the phone line.
Parameters
Payload
Response
The phone line object. Created sub-objects are updated with their object ID.
Context
| Authorization |
Administrator |
Errors
Example
Request
POST https://xelion.nl/api/v1/master/phonelines
Payload
The phones are newly created relations with a Base Phone. The Base Phone should be created seperatly.
The extensions can only be new Telecom Addresses, you cannot use an existing address for this.
The day night mode , user phone line, work schedule and auto attendant subobjects are created automaticly when configured.
{
"externalNumber": "",
"callerName": "testline",
"extensions": [
{
"address": "435",
"objectType": "TelecomAddress"
}
],
"users": [
{
"user": {
"commonName": "wes",
"oid": "1651218",
"objectType": "UserProfile"
},
"lineOrder": 1,
"skillNumber": 0,
"incoming": true,
"outgoing": false,
"editable": "INCOMINGANDOUTGOING",
"objectType": "XCCConnectedUser"
}
],
"phones": [
{
"phone":
{
"oid": "1651587",
"objectType": "XCCBasePhone"
},
"objectType": "XCCConnectedPhone"
}
],
"associatedAddressable": {
"oid": "4338838",
"objectType": "Person"
},
"dayNightMode": {
"enableDayNightMode": true,
"oneOffOverrideDateTime": "2017-08-30 12:00:00",
"oneOffOverrideMode": "overrideNext",
"switchTime": [
{
"day": "monday",
"switchTime": "12:00"
}
],
"overrides": [
{
"overrideActive": true,
"startOverrideDateTime": "2017-07-21 15:36:00",
"endOverrideDateTime": "2017-08-30 15:38:00"
}
]
},
"forwardCallerIdMap": [
{
"addressStart": "0800",
"objectType": "XCCCallerIdMapping"
}
],
"userPhoneLine": {
"timeout": 10,
"redirectionTimeout": 10,
"fallbackActive": false,
"voicemailActive": false,
"listeners": [
{
"user": {
"permissions": "ReadWriteRemove",
"commonName": "arno",
"oid": "1651120",
"objectType": "UserProfile"
},
"oid": "1743972",
"objectType": "XCCPhoneLineListener"
}
],
"workSchedule": {
"enabled": true,
"times": [
{
"day": "monday",
"switchTime": "09:00",
"status": "available"
}
],
"overrides": [
{
"overrideActive": true,
"startOverrideDateTime": "2017-07-21 15:36:00",
"endOverrideDateTime": "2017-08-30 15:38:00"
}
]
},
"userStatus": "available",
"objectType": "XCCUserPhoneLine"
},
"musicOnHoldCategory": {
"permissions": "ReadWriteRemove",
"commonName": "wachtrij",
"oid": "1743966",
"objectType": "XCCMusicOnHoldCategory"
},
"saveCallRecording": true,
"doNotRecordInternalCalls": true,
"allowedNumbers": [
{
"externalNumber": "",
"objectType": "XCCAllowedNumber"
},
{
"externalNumber": "0157630958",
"objectType": "XCCAllowedNumber"
}
],
"voicemailDeliveryNumber": "0612345678",
"voicemailDeliveryMessage":
{
"audioMessage": {
{
"originalLocation": "xcc_audio8228483372635530249.wav",
"commonName": "xcc_audio8228483372635530249.wav",
"mimeType": "audio/wav",
"contentsB64String": "+y/0sA5ABzAd0BJQJhAocCrgLiAh4DOgNbA3UDZANBAwsDxw...."
}
},
},
"processQueueInOrder": true,
"maxQueueLength": 0,
"dtmfBreakoutEnabled": false,
"callQueueWrapupTime": 0,
"lineHuntingPolicy": "linear",
"lineHuntingTimeout": 0,
"ringLastTalkedToFirst": false,
"showWaitingQueue": true,
"wallboardResetTime": "",
"onlyExternalCalls": false,
"missedCallThreshold": 0,
"durationThresholdMin": 0,
"durationThreshold": 0,
"agentShowInbound": true,
"agentShowOutbound": true,
"agentShowTotal": true,
"enableVoicemailTranscribe": false,
"wallboardEntries": [
{
"parameter": "TOTAL_CALLS",
"direction": "INCOMINGANDOUTGOING",
"threshold1": 0,
"threshold2": 0,
"orderNr": 1,
"objectType": "XCCWallboardEntry"
}
],
"autoAttendantOn": true,
"autoAttendant": {
"allowDirectNumber": false,
"action1": {
"permissions": "ReadWriteRemove",
"commonName": "Telefoonaansluiting Arno Brugman",
"oid": "1651130",
"objectType": "XCCPhoneLine"
},
"voicemail1": true,
"objectType": "AutoAttendant"
},
"limitAccessToCallRecording": true,
"callRecordingUsers": [
{
"oid": "1651218",
"objectType": "UserProfile"
}
],
"callLogUsers": [
{
"oid": "1651120",
"objectType": "UserProfile"
}
],
"managers": [
{
"user": {
"oid": "1651565",
"objectType": "UserProfile"
},
"objectType": "XCCPhoneLineManager"
}
],
"afterCallTypes": [
{
"type": {
"oid": "2047851",
"objectType": "AfterCallType"
},
"objectType": "relAfterCallTypePhoneLine"
}
],
"wallboard": {
"accessRights": "Secured",
"domain": [
{
"domain":
{
"oid": "1651218",
"objectType": "Domain"
},
"objectType": "SecurityAttributes",
"writeObject": true
}
]
},
"commonName": "testline1234",
"objectType": "XCCPhoneLine"
}Response
{
"object": {
"externalNumber": "",
"allowedNumbers": [
{
"externalNumber": "",
"objectType": "XCCAllowedNumber"
},
{
"externalNumber": "0157630958",
"objectType": "XCCAllowedNumber"
}
],
"callerName": "testline",
"extensions": [
{
"address": "435",
"objectType": "TelecomAddress"
}
],
"users": [
{
"user": {
"commonName": "wes",
"oid": "1651218",
"objectType": "UserProfile"
},
"lineOrder": 1,
"skillNumber": 0,
"incoming": true,
"outgoing": false,
"editable": "INCOMINGANDOUTGOING",
"objectType": "XCCConnectedUser",
"oid": "134587"
}
],
"phones": [
{
"phone": {
"oid": "1651587",
"objectType": "XCCBasePhone"
},
"lineOrder": 0,
"objectType": "XCCConnectedPhone"
}
],
"lineHuntingPolicy": "linear",
"lineHuntingTimeout": 0,
"ringLastTalkedToFirst": false,
"associatedAddressable": {
"oid": "4338838",
"objectType": "Person"
},
"autoAttendantOn": true,
"autoAttendant": {
"allowDirectNumber": false,
"action1": {
"permissions": "ReadWriteRemove",
"commonName": "Telefoonaansluiting Arno Brugman",
"oid": "1651130",
"objectType": "XCCPhoneLine"
},
"voicemail1": true,
"oid": "1744215",
"objectType": "AutoAttendant"
},
"userPhoneLine": {
"timeout": 10,
"redirectionTimeout": 10,
"fallbackActive": false,
"voicemailActive": false,
"listeners": [
{
"user": {
"permissions": "ReadWriteRemove",
"commonName": "arno",
"oid": "1651120",
"objectType": "UserProfile"
},
"oid": "1743972",
"objectType": "XCCPhoneLineListener"
}
],
"userStatus": "available",
"workSchedule": {
"enabled": true,
"times": [
{
"day": "monday",
"switchTime": "09:00",
"status": "available",
"objectType": "WorkScheduleSwitch"
}
],
"oid": "1744217",
"objectType": "WorkSchedule"
},
"oid": "1744216",
"objectType": "XCCUserPhoneLine"
},
"dayNightMode": {
"enableDayNightMode": true,
"oneOffOverrideDateTime": "2017-08-30 12:00:00",
"oneOffOverrideMode": "overrideNext",
"switchTime": [
{
"day": "monday",
"switchTime": "12:00",
"objectType": "XCCDayNightModeSwitch"
}
],
"overrides": [
{
"overrideActive": true,
"startOverrideDateTime": "2017-07-21 15:36:00",
"endOverrideDateTime": "2017-08-30 15:38:00",
"objectType": "XCCDayNightModeOverride"
}
],
"oid": "1744204",
"objectType": "XCCDayNightMode"
},
"showWaitingQueue": true,
"processQueueInOrder": true,
"maxQueueLength": 0,
"dtmfBreakoutEnabled": false,
"callQueueWrapupTime": 0,
"saveCallRecording": true,
"voicemailDeliveryNumber": "0612345678",
"voicemailDeliveryMessage": {
"originalLocation": "xcc_audio8228483372635530249.wav",
"mimeType": "audio/wav",
"size": 0,
"commonName": "xcc_audio8228483372635530249.wav",
"oid": "1856721",
"objectType": "Attachment"
},
"forwardCallerIdMap": [
{
"addressStart": "0800",
"objectType": "XCCCallerIdMapping"
}
],
"musicOnHoldCategory": {
"permissions": "ReadWriteRemove",
"commonName": "wachtrij",
"oid": "1743966",
"objectType": "XCCMusicOnHoldCategory"
},
"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,
"objectType": "XCCWallboardEntry"
}
],
"limitAccessToCallRecording": true,
"callRecordingUsers": [
{
"oid": "1651218",
"objectType": "UserProfile"
}
],
"callLogUsers": [
{
"oid": "1651120",
"objectType": "UserProfile"
}
],
"managers": [
{
"user": {
"oid": "1651565",
"objectType": "UserProfile"
},
"oid": "1756113",
"objectType": "XCCPhoneLineManager"
}
],
"afterCallTypes": [
{
"type": {
"permissions": "ReadWriteRemove",
"commonName": "Complaint",
"oid": "2047851",
"objectType": "AfterCallType"
},
"oid": "2047888",
"objectType": "relAfterCallTypePhoneLine"
}
],
"commonName": "testline1234",
"oid": "1744192",
"objectType": "XCCPhoneLine"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/api/v1/master/phonelines/1744192",
"method": "GET"
}
]
}