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

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceNumber

string

None.

pbxUserId

string

None.

Body Parameters

PushToTalkDTO
NameDescriptionTypeAdditional information
AccessListSelection

integer

None.

AllowAutoAnswer

boolean

None.

OutgoingConnectionSelection

integer

None.

AvailableUsers

Collection of UserAssignDTO

None.

SelectedUsers

Collection of UserAssignDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "AccessListSelection": 1,
  "AllowAutoAnswer": true,
  "OutgoingConnectionSelection": 3,
  "AvailableUsers": [
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    },
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    }
  ],
  "SelectedUsers": [
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    },
    {
      "UserId": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Phone_Number": "sample string 4",
      "Extension": "sample string 5",
      "Department": "sample string 6",
      "DisplayName": "sample string 3,sample string 2(sample string 1)"
    }
  ]
}

application/xml, text/xml

Sample:
<PushToTalkDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MSPApi.DTO.User">
  <AccessListSelection>1</AccessListSelection>
  <AllowAutoAnswer>true</AllowAutoAnswer>
  <AvailableUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
  </AvailableUsers>
  <OutgoingConnectionSelection>3</OutgoingConnectionSelection>
  <SelectedUsers xmlns:d2p1="http://schemas.datacontract.org/2004/07/MSPApi.DTO">
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
    <d2p1:UserAssignDTO>
      <d2p1:Department>sample string 6</d2p1:Department>
      <d2p1:Extension>sample string 5</d2p1:Extension>
      <d2p1:FirstName>sample string 2</d2p1:FirstName>
      <d2p1:LastName>sample string 3</d2p1:LastName>
      <d2p1:Phone_Number>sample string 4</d2p1:Phone_Number>
      <d2p1:UserId>sample string 1</d2p1:UserId>
    </d2p1:UserAssignDTO>
  </SelectedUsers>
</PushToTalkDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.