POST api/usr/VirtualNumber?serviceNumber={serviceNumber}&pbxUserId={pbxUserId}

Request Information

URI Parameters

Name	Description	Type	Additional information
serviceNumber		string	None.
pbxUserId		string	None.

Body Parameters

VirtualNumbersDTO

Name	Type	Additional information
DistinctiveRing	boolean	None.
AlternateEntry01	AlternateNumberEntryDTO	None.
AlternateEntry02	AlternateNumberEntryDTO	None.
AlternateEntry03	AlternateNumberEntryDTO	None.
AlternateEntry04	AlternateNumberEntryDTO	None.
AlternateEntry05	AlternateNumberEntryDTO	None.
AlternateEntry06	AlternateNumberEntryDTO	None.
AlternateEntry07	AlternateNumberEntryDTO	None.
AlternateEntry08	AlternateNumberEntryDTO	None.
AlternateEntry09	AlternateNumberEntryDTO	None.
AlternateEntry10	AlternateNumberEntryDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "DistinctiveRing": true,
  "AlternateEntry01": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry02": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry03": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry04": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry05": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry06": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry07": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry08": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry09": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  },
  "AlternateEntry10": {
    "Description": "sample string 1",
    "Extension": "sample string 2",
    "PhoneNumber": "sample string 3",
    "RingPattern": 1
  }
}

application/xml, text/xml

Sample:

<VirtualNumbersDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.User">
  <AlternateEntry01>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry01>
  <AlternateEntry02>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry02>
  <AlternateEntry03>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry03>
  <AlternateEntry04>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry04>
  <AlternateEntry05>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry05>
  <AlternateEntry06>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry06>
  <AlternateEntry07>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry07>
  <AlternateEntry08>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry08>
  <AlternateEntry09>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry09>
  <AlternateEntry10>
    <Description>sample string 1</Description>
    <Extension>sample string 2</Extension>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RingPattern>1</RingPattern>
  </AlternateEntry10>
  <DistinctiveRing>true</DistinctiveRing>
</VirtualNumbersDTO>

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.