POST api/grp/AutoAttendant/{menuName}?serviceUserId={serviceUserId}&locationAccountNumber={locationAccountNumber}

Request Information

URI Parameters

Name	Type	Additional information
menuName	string	Required
serviceUserId	string	Required
locationAccountNumber	string	Required

Body Parameters

AutoAttendantMenuDTO

Name	Type	Additional information
EnableFirstMenuLevelExtensionDialing	boolean	None.
AnnouncementSelection	integer	None.
AudioFile	AnnouncementFileKeyDTO	None.
AudioFiles	Collection of AnnouncementFileKeyDTO	None.
KeyConfigurations	Collection of AutoAttendantKeyConfigurationDTO	None.
Schedule	ScheduleKeyDTO	None.
Schedules	Collection of ScheduleKeyDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "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
    }
  ]
}

application/xml, text/xml

Sample:

<AutoAttendantMenuDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.Group">
  <AnnouncementSelection>2</AnnouncementSelection>
  <AudioFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:Level>3</d2p1:Level>
    <d2p1:MediaFileType>2</d2p1:MediaFileType>
    <d2p1:Name>sample string 1</d2p1:Name>
  </AudioFile>
  <AudioFiles xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:AnnouncementFileKeyDTO>
      <d2p1:Level>3</d2p1:Level>
      <d2p1:MediaFileType>2</d2p1:MediaFileType>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:AnnouncementFileKeyDTO>
    <d2p1:AnnouncementFileKeyDTO>
      <d2p1:Level>3</d2p1:Level>
      <d2p1:MediaFileType>2</d2p1:MediaFileType>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:AnnouncementFileKeyDTO>
  </AudioFiles>
  <EnableFirstMenuLevelExtensionDialing>true</EnableFirstMenuLevelExtensionDialing>
  <KeyConfigurations>
    <AutoAttendantKeyConfigurationDTO>
      <Entry>
        <Action>1</Action>
        <AudioFile xmlns:d5p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
          <d5p1:Level>3</d5p1:Level>
          <d5p1:MediaFileType>2</d5p1:MediaFileType>
          <d5p1:Name>sample string 1</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
          <d5p1:Level>3</d5p1:Level>
          <d5p1:MediaFileType>2</d5p1:MediaFileType>
          <d5p1:Name>sample string 1</d5p1: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: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>
  </Schedule>
  <Schedules 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>
  </Schedules>
</AutoAttendantMenuDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AutoAttendantMenuDTO'.

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.