POST api/grp/AutoAttendant?locationAccountNumber={locationAccountNumber}

Request Information

URI Parameters

Name	Description	Type	Additional information
locationAccountNumber		string	Required

Body Parameters

AutoAttendantEditDTO

Name	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.
TimeZones	Dictionary of string [key] and string [value]	None.
HolidaySchedules	Collection of ScheduleKeyDTO	None.
TimeSchedules	Collection of ScheduleKeyDTO	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
    },
    "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"
        }
      }
    ]
  },
  "AfterHoursMenu": {
    "EnableFirstMenuLevelExtensionDialing": true,
    "AnnouncementSelection": 2,
    "AudioFile": {
      "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"
        }
      }
    ]
  },
  "HolidayMenu": {
    "EnableFirstMenuLevelExtensionDialing": true,
    "AnnouncementSelection": 2,
    "AudioFile": {
      "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"
        }
      }
    ]
  },
  "HolidaySchedule": {
    "Name": "sample string 1",
    "Type": 0,
    "Level": 0
  },
  "BusinessHours": {
    "Name": "sample string 1",
    "Type": 0,
    "Level": 0
  },
  "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
    }
  ]
}

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>
    <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>
  </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>
    <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>
  </BusinessHoursMenu>
  <CallingLineIdFirstName>sample string 4</CallingLineIdFirstName>
  <CallingLineIdLastName>sample string 5</CallingLineIdLastName>
  <ExtensionDialingScope>7</ExtensionDialingScope>
  <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>
    <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>
  </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>
  <Name>sample string 3</Name>
  <NameDialingScope>8</NameDialingScope>
  <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:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	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.