POST Public/VoiceStatus

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Public.DTOs.Request.VoiceStatusRequest

Name	Type	Additional information
APIKey	globally unique identifier	Required
Username	string	Required
VoiceCallId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "eb046058-5ed3-4245-97ce-4719afd56021",
  "Username": "sample string 2",
  "VoiceCallId": 3
}

application/xml, text/xml

Sample:

<VoiceStatusRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs.Request">
  <APIKey xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">eb046058-5ed3-4245-97ce-4719afd56021</APIKey>
  <Username xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">sample string 2</Username>
  <VoiceCallId>3</VoiceCallId>
</VoiceStatusRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Public.DTOs.Response.VoiceStatusResponse

Name	Type	Additional information
CallId	integer	None.
CallStatus	string	None.
CallTime	date	None.
CallDuration	integer	None.
Errors	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "CallId": 1,
  "CallStatus": "sample string 2",
  "CallTime": "2024-09-30T10:55:34.044321+01:00",
  "CallDuration": 1,
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<VoiceStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs.Response">
  <CallDuration>1</CallDuration>
  <CallId>1</CallId>
  <CallStatus>sample string 2</CallStatus>
  <CallTime>2024-09-30T10:55:34.044321+01:00</CallTime>
  <Errors 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>
  </Errors>
</VoiceStatusResponse>