POST api/usr/BroadWorksAnywhere/Phonenumber?serviceNumber={serviceNumber}&pbxUserId={pbxUserId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| serviceNumber | string |
None. |
|
| pbxUserId | string |
None. |
Body Parameters
BroadWorksAnywherePhoneNumberDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| PhoneNumber | string |
None. |
|
| Description | string |
None. |
|
| OutboundAlternateNumber | string |
None. |
|
| UseDiversionInhibitor | boolean |
None. |
|
| AnswerConfirmRequired | boolean |
None. |
|
| BroadWorksCallControl | boolean |
None. |
|
| CriteriaList | Collection of BroadWorksAnywhereCriteriaDTO |
None. |
|
| NewPhoneNumber | string |
None. |
|
| IsActive | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"PhoneNumber": "sample string 1",
"Description": "sample string 2",
"OutboundAlternateNumber": "sample string 3",
"UseDiversionInhibitor": true,
"AnswerConfirmRequired": true,
"BroadWorksCallControl": true,
"CriteriaList": [
{
"IsActive": true,
"Description": "sample string 2",
"BroadWorksAnywhere": true,
"CallsFrom": "sample string 4"
},
{
"IsActive": true,
"Description": "sample string 2",
"BroadWorksAnywhere": true,
"CallsFrom": "sample string 4"
}
],
"NewPhoneNumber": "sample string 7",
"IsActive": true
}
application/xml, text/xml
Sample:
<BroadWorksAnywherePhoneNumberDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.User">
<AnswerConfirmRequired>true</AnswerConfirmRequired>
<BroadWorksCallControl>true</BroadWorksCallControl>
<CriteriaList>
<BroadWorksAnywhereCriteriaDTO>
<BroadWorksAnywhere>true</BroadWorksAnywhere>
<CallsFrom>sample string 4</CallsFrom>
<Description>sample string 2</Description>
<IsActive>true</IsActive>
</BroadWorksAnywhereCriteriaDTO>
<BroadWorksAnywhereCriteriaDTO>
<BroadWorksAnywhere>true</BroadWorksAnywhere>
<CallsFrom>sample string 4</CallsFrom>
<Description>sample string 2</Description>
<IsActive>true</IsActive>
</BroadWorksAnywhereCriteriaDTO>
</CriteriaList>
<Description>sample string 2</Description>
<IsActive>true</IsActive>
<NewPhoneNumber>sample string 7</NewPhoneNumber>
<OutboundAlternateNumber>sample string 3</OutboundAlternateNumber>
<PhoneNumber>sample string 1</PhoneNumber>
<UseDiversionInhibitor>true</UseDiversionInhibitor>
</BroadWorksAnywherePhoneNumberDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
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. |