POST api/grp/AutoAttendant?locationAccountNumber={locationAccountNumber}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| locationAccountNumber | string |
Required |
Body Parameters
AutoAttendantEditDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceUserId | string |
None. |
|
| Active | boolean |
None. |
|
| Name | string |
None. |
|
| CallingLineIdFirstName | string |
None. |
|
| CallingLineIdLastName | string |
None. |
|
| TimeZone | string |
None. |
|
| ExtensionDialingScope | integer |
None. |
|
| NameDialingScope | integer |
None. |
|
| BusinessHoursMenu | AutoAttendantMenuDTO |
None. |
|
| AfterHoursMenu | AutoAttendantMenuDTO |
None. |
|
| HolidayMenu | AutoAttendantMenuDTO |
None. |
|
| HolidaySchedule | ScheduleKeyDTO |
None. |
|
| BusinessHours | ScheduleKeyDTO |
None. |
|
| Department | GroupDepartmentOption |
None. |
|
| NetworkClassOfService | string |
None. |
|
| Language | string |
None. |
|
| NameDialingEntries | integer |
None. |
|
| EnableVideo | boolean |
None. |
|
| FirstDigitTimeoutSeconds | integer |
None. |
|
| TimeZones | Dictionary of string [key] and string [value] |
None. |
|
| HolidaySchedules | Collection of ScheduleKeyDTO |
None. |
|
| TimeSchedules | Collection of ScheduleKeyDTO |
None. |
|
| Languages | Dictionary of string [key] and string [value] |
None. |
|
| NetworkClassOfServices | Dictionary of string [key] and string [value] |
None. |
|
| Departments | Collection of GroupDepartmentOption |
None. |
Request Formats
application/json, text/json
Sample:
{
"ServiceUserId": "sample string 1",
"Active": true,
"Name": "sample string 3",
"CallingLineIdFirstName": "sample string 4",
"CallingLineIdLastName": "sample string 5",
"TimeZone": "sample string 6",
"ExtensionDialingScope": 7,
"NameDialingScope": 8,
"BusinessHoursMenu": {
"EnableFirstMenuLevelExtensionDialing": true,
"AnnouncementSelection": 2,
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"AudioFiles": [
{
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
{
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
}
],
"KeyConfigurations": [
{
"Key": 1,
"Entry": {
"Action": 1,
"Description": "sample string 2",
"PhoneNumber": "sample string 3",
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"SubmenuId": "sample string 4"
}
},
{
"Key": 1,
"Entry": {
"Action": 1,
"Description": "sample string 2",
"PhoneNumber": "sample string 3",
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"SubmenuId": "sample string 4"
}
}
],
"Schedule": {
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
"Schedules": [
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
}
]
},
"AfterHoursMenu": {
"EnableFirstMenuLevelExtensionDialing": true,
"AnnouncementSelection": 2,
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"AudioFiles": [
{
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
{
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
}
],
"KeyConfigurations": [
{
"Key": 1,
"Entry": {
"Action": 1,
"Description": "sample string 2",
"PhoneNumber": "sample string 3",
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"SubmenuId": "sample string 4"
}
},
{
"Key": 1,
"Entry": {
"Action": 1,
"Description": "sample string 2",
"PhoneNumber": "sample string 3",
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"SubmenuId": "sample string 4"
}
}
],
"Schedule": {
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
"Schedules": [
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
}
]
},
"HolidayMenu": {
"EnableFirstMenuLevelExtensionDialing": true,
"AnnouncementSelection": 2,
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"AudioFiles": [
{
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
{
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
}
],
"KeyConfigurations": [
{
"Key": 1,
"Entry": {
"Action": 1,
"Description": "sample string 2",
"PhoneNumber": "sample string 3",
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"SubmenuId": "sample string 4"
}
},
{
"Key": 1,
"Entry": {
"Action": 1,
"Description": "sample string 2",
"PhoneNumber": "sample string 3",
"AudioFile": {
"Name": "sample string 1",
"MediaFileType": 2,
"Level": 3
},
"SubmenuId": "sample string 4"
}
}
],
"Schedule": {
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
"Schedules": [
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
}
]
},
"HolidaySchedule": {
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
"BusinessHours": {
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
"Department": {
"ServiceProviderId": "sample string 1",
"GroupId": "sample string 2",
"Name": "sample string 3"
},
"NetworkClassOfService": "sample string 9",
"Language": "sample string 10",
"NameDialingEntries": 11,
"EnableVideo": true,
"FirstDigitTimeoutSeconds": 13,
"TimeZones": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"HolidaySchedules": [
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
}
],
"TimeSchedules": [
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
},
{
"Name": "sample string 1",
"Type": 0,
"Level": 0
}
],
"Languages": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"NetworkClassOfServices": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"Departments": [
{
"ServiceProviderId": "sample string 1",
"GroupId": "sample string 2",
"Name": "sample string 3"
},
{
"ServiceProviderId": "sample string 1",
"GroupId": "sample string 2",
"Name": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<AutoAttendantEditDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Group">
<Active>true</Active>
<AfterHoursMenu>
<AnnouncementSelection>2</AnnouncementSelection>
<AudioFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</AudioFile>
<AudioFiles xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d3p1:AnnouncementFileKeyDTO>
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</d3p1:AnnouncementFileKeyDTO>
<d3p1:AnnouncementFileKeyDTO>
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</d3p1:AnnouncementFileKeyDTO>
</AudioFiles>
<EnableFirstMenuLevelExtensionDialing>true</EnableFirstMenuLevelExtensionDialing>
<KeyConfigurations>
<AutoAttendantKeyConfigurationDTO>
<Entry>
<Action>1</Action>
<AudioFile xmlns:d6p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d6p1:Level>3</d6p1:Level>
<d6p1:MediaFileType>2</d6p1:MediaFileType>
<d6p1:Name>sample string 1</d6p1:Name>
</AudioFile>
<Description>sample string 2</Description>
<PhoneNumber>sample string 3</PhoneNumber>
<SubmenuId>sample string 4</SubmenuId>
</Entry>
<Key>1</Key>
</AutoAttendantKeyConfigurationDTO>
<AutoAttendantKeyConfigurationDTO>
<Entry>
<Action>1</Action>
<AudioFile xmlns:d6p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d6p1:Level>3</d6p1:Level>
<d6p1:MediaFileType>2</d6p1:MediaFileType>
<d6p1:Name>sample string 1</d6p1:Name>
</AudioFile>
<Description>sample string 2</Description>
<PhoneNumber>sample string 3</PhoneNumber>
<SubmenuId>sample string 4</SubmenuId>
</Entry>
<Key>1</Key>
</AutoAttendantKeyConfigurationDTO>
</KeyConfigurations>
<Schedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</Schedule>
<Schedules xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d3p1:ScheduleKeyDTO>
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</d3p1:ScheduleKeyDTO>
<d3p1:ScheduleKeyDTO>
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</d3p1:ScheduleKeyDTO>
</Schedules>
</AfterHoursMenu>
<BusinessHours xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d2p1:Level>ServiceProvider</d2p1:Level>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>Holiday</d2p1:Type>
</BusinessHours>
<BusinessHoursMenu>
<AnnouncementSelection>2</AnnouncementSelection>
<AudioFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</AudioFile>
<AudioFiles xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d3p1:AnnouncementFileKeyDTO>
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</d3p1:AnnouncementFileKeyDTO>
<d3p1:AnnouncementFileKeyDTO>
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</d3p1:AnnouncementFileKeyDTO>
</AudioFiles>
<EnableFirstMenuLevelExtensionDialing>true</EnableFirstMenuLevelExtensionDialing>
<KeyConfigurations>
<AutoAttendantKeyConfigurationDTO>
<Entry>
<Action>1</Action>
<AudioFile xmlns:d6p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d6p1:Level>3</d6p1:Level>
<d6p1:MediaFileType>2</d6p1:MediaFileType>
<d6p1:Name>sample string 1</d6p1:Name>
</AudioFile>
<Description>sample string 2</Description>
<PhoneNumber>sample string 3</PhoneNumber>
<SubmenuId>sample string 4</SubmenuId>
</Entry>
<Key>1</Key>
</AutoAttendantKeyConfigurationDTO>
<AutoAttendantKeyConfigurationDTO>
<Entry>
<Action>1</Action>
<AudioFile xmlns:d6p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d6p1:Level>3</d6p1:Level>
<d6p1:MediaFileType>2</d6p1:MediaFileType>
<d6p1:Name>sample string 1</d6p1:Name>
</AudioFile>
<Description>sample string 2</Description>
<PhoneNumber>sample string 3</PhoneNumber>
<SubmenuId>sample string 4</SubmenuId>
</Entry>
<Key>1</Key>
</AutoAttendantKeyConfigurationDTO>
</KeyConfigurations>
<Schedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</Schedule>
<Schedules xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d3p1:ScheduleKeyDTO>
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</d3p1:ScheduleKeyDTO>
<d3p1:ScheduleKeyDTO>
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</d3p1:ScheduleKeyDTO>
</Schedules>
</BusinessHoursMenu>
<CallingLineIdFirstName>sample string 4</CallingLineIdFirstName>
<CallingLineIdLastName>sample string 5</CallingLineIdLastName>
<Department xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d2p1:GroupId>sample string 2</d2p1:GroupId>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:ServiceProviderId>sample string 1</d2p1:ServiceProviderId>
</Department>
<Departments xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d2p1:GroupDepartmentOption>
<d2p1:GroupId>sample string 2</d2p1:GroupId>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:ServiceProviderId>sample string 1</d2p1:ServiceProviderId>
</d2p1:GroupDepartmentOption>
<d2p1:GroupDepartmentOption>
<d2p1:GroupId>sample string 2</d2p1:GroupId>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:ServiceProviderId>sample string 1</d2p1:ServiceProviderId>
</d2p1:GroupDepartmentOption>
</Departments>
<EnableVideo>true</EnableVideo>
<ExtensionDialingScope>7</ExtensionDialingScope>
<FirstDigitTimeoutSeconds>13</FirstDigitTimeoutSeconds>
<HolidayMenu>
<AnnouncementSelection>2</AnnouncementSelection>
<AudioFile xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</AudioFile>
<AudioFiles xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d3p1:AnnouncementFileKeyDTO>
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</d3p1:AnnouncementFileKeyDTO>
<d3p1:AnnouncementFileKeyDTO>
<d3p1:Level>3</d3p1:Level>
<d3p1:MediaFileType>2</d3p1:MediaFileType>
<d3p1:Name>sample string 1</d3p1:Name>
</d3p1:AnnouncementFileKeyDTO>
</AudioFiles>
<EnableFirstMenuLevelExtensionDialing>true</EnableFirstMenuLevelExtensionDialing>
<KeyConfigurations>
<AutoAttendantKeyConfigurationDTO>
<Entry>
<Action>1</Action>
<AudioFile xmlns:d6p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d6p1:Level>3</d6p1:Level>
<d6p1:MediaFileType>2</d6p1:MediaFileType>
<d6p1:Name>sample string 1</d6p1:Name>
</AudioFile>
<Description>sample string 2</Description>
<PhoneNumber>sample string 3</PhoneNumber>
<SubmenuId>sample string 4</SubmenuId>
</Entry>
<Key>1</Key>
</AutoAttendantKeyConfigurationDTO>
<AutoAttendantKeyConfigurationDTO>
<Entry>
<Action>1</Action>
<AudioFile xmlns:d6p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
<d6p1:Level>3</d6p1:Level>
<d6p1:MediaFileType>2</d6p1:MediaFileType>
<d6p1:Name>sample string 1</d6p1:Name>
</AudioFile>
<Description>sample string 2</Description>
<PhoneNumber>sample string 3</PhoneNumber>
<SubmenuId>sample string 4</SubmenuId>
</Entry>
<Key>1</Key>
</AutoAttendantKeyConfigurationDTO>
</KeyConfigurations>
<Schedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</Schedule>
<Schedules xmlns:d3p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d3p1:ScheduleKeyDTO>
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</d3p1:ScheduleKeyDTO>
<d3p1:ScheduleKeyDTO>
<d3p1:Level>ServiceProvider</d3p1:Level>
<d3p1:Name>sample string 1</d3p1:Name>
<d3p1:Type>Holiday</d3p1:Type>
</d3p1:ScheduleKeyDTO>
</Schedules>
</HolidayMenu>
<HolidaySchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d2p1:Level>ServiceProvider</d2p1:Level>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>Holiday</d2p1:Type>
</HolidaySchedule>
<HolidaySchedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d2p1:ScheduleKeyDTO>
<d2p1:Level>ServiceProvider</d2p1:Level>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>Holiday</d2p1:Type>
</d2p1:ScheduleKeyDTO>
<d2p1:ScheduleKeyDTO>
<d2p1:Level>ServiceProvider</d2p1:Level>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>Holiday</d2p1:Type>
</d2p1:ScheduleKeyDTO>
</HolidaySchedules>
<Language>sample string 10</Language>
<Languages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Languages>
<Name>sample string 3</Name>
<NameDialingEntries>11</NameDialingEntries>
<NameDialingScope>8</NameDialingScope>
<NetworkClassOfService>sample string 9</NetworkClassOfService>
<NetworkClassOfServices xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</NetworkClassOfServices>
<ServiceUserId>sample string 1</ServiceUserId>
<TimeSchedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Enterprise">
<d2p1:ScheduleKeyDTO>
<d2p1:Level>ServiceProvider</d2p1:Level>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>Holiday</d2p1:Type>
</d2p1:ScheduleKeyDTO>
<d2p1:ScheduleKeyDTO>
<d2p1:Level>ServiceProvider</d2p1:Level>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Type>Holiday</d2p1:Type>
</d2p1:ScheduleKeyDTO>
</TimeSchedules>
<TimeZone>sample string 6</TimeZone>
<TimeZones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</TimeZones>
</AutoAttendantEditDTO>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |