POST Client/Request/KickParticipant
Kick a participant in Conference
Request Information
URI Parameters
None.
Body Parameters
ResultAudioConferenceParticipantName | Description | Type | Additional information |
---|---|---|---|
participantId | integer |
None. |
|
inviterName | string |
None. |
|
participantStatusCodeId | integer |
None. |
|
participantTypeCodeId | integer |
None. |
|
secondRequest | ResultAudioConferenceSecondRequest |
None. |
|
providerName | string |
None. |
|
clientName | string |
None. |
|
RegionAbbre | string |
None. |
|
phoneNumber | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "participantId": 1, "inviterName": "sample string 2", "participantStatusCodeId": 3, "participantTypeCodeId": 4, "secondRequest": { "RequestStatusCodeId": 1, "RequestId": 1, "providerList": [ { "ProviderName": "sample string 1", "RequestProviderId": 1, "ProviderAccepted": true, "LSPProviderId": 1, "FromLanguageId": 1, "FromLanguage": "sample string 2", "ToLanguageId": 1, "ToLanguage": "sample string 3", "onlineStatus": true }, { "ProviderName": "sample string 1", "RequestProviderId": 1, "ProviderAccepted": true, "LSPProviderId": 1, "FromLanguageId": 1, "FromLanguage": "sample string 2", "ToLanguageId": 1, "ToLanguage": "sample string 3", "onlineStatus": true } ], "qualifiedProviderList": [ { "ProviderName": "sample string 1", "LSPProviderId": 1, "OperatingRoutingStatusCodeId": 1, "OperatingRoutingStatus": "sample string 2" }, { "ProviderName": "sample string 1", "LSPProviderId": 1, "OperatingRoutingStatusCodeId": 1, "OperatingRoutingStatus": "sample string 2" } ], "waitingMsg": "sample string 1", "AudioConferenceSessionAudioParticipantId": 1, "ToLanguageId": 1, "ToLanguage": "sample string 2", "additionalInfo": "sample string 3", "backupButtonEnabled": true, "Error": "sample string 5", "routedToBackup": true, "MergePopText": "sample string 7", "CancelButtonInstruction": "sample string 8", "CancelPopTextConfirm1": "sample string 9", "CancelPopTextConfirm2": "sample string 10", "CancelPopTextConfirm3": "sample string 11" }, "providerName": "sample string 5", "clientName": "sample string 6", "RegionAbbre": "sample string 7", "phoneNumber": "sample string 8" }
application/xml, text/xml
Sample:
<ResultAudioConferenceParticipant xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <RegionAbbre>sample string 7</RegionAbbre> <clientName>sample string 6</clientName> <inviterName>sample string 2</inviterName> <participantId>1</participantId> <participantStatusCodeId>3</participantStatusCodeId> <participantTypeCodeId>4</participantTypeCodeId> <phoneNumber>sample string 8</phoneNumber> <providerName>sample string 5</providerName> <secondRequest> <AudioConferenceSessionAudioParticipantId>1</AudioConferenceSessionAudioParticipantId> <CancelButtonInstruction>sample string 8</CancelButtonInstruction> <CancelPopTextConfirm1>sample string 9</CancelPopTextConfirm1> <CancelPopTextConfirm2>sample string 10</CancelPopTextConfirm2> <CancelPopTextConfirm3>sample string 11</CancelPopTextConfirm3> <Error>sample string 5</Error> <MergePopText>sample string 7</MergePopText> <RequestId>1</RequestId> <RequestStatusCodeId>1</RequestStatusCodeId> <ToLanguage>sample string 2</ToLanguage> <ToLanguageId>1</ToLanguageId> <additionalInfo>sample string 3</additionalInfo> <backupButtonEnabled>true</backupButtonEnabled> <providerList> <ResultRequestProvider> <FromLanguage>sample string 2</FromLanguage> <FromLanguageId>1</FromLanguageId> <LSPProviderId>1</LSPProviderId> <ProviderAccepted>true</ProviderAccepted> <ProviderName>sample string 1</ProviderName> <RequestProviderId>1</RequestProviderId> <ToLanguage>sample string 3</ToLanguage> <ToLanguageId>1</ToLanguageId> <onlineStatus>true</onlineStatus> </ResultRequestProvider> <ResultRequestProvider> <FromLanguage>sample string 2</FromLanguage> <FromLanguageId>1</FromLanguageId> <LSPProviderId>1</LSPProviderId> <ProviderAccepted>true</ProviderAccepted> <ProviderName>sample string 1</ProviderName> <RequestProviderId>1</RequestProviderId> <ToLanguage>sample string 3</ToLanguage> <ToLanguageId>1</ToLanguageId> <onlineStatus>true</onlineStatus> </ResultRequestProvider> </providerList> <qualifiedProviderList> <ResultRequestQualifiedProvider> <LSPProviderId>1</LSPProviderId> <OperatingRoutingStatus>sample string 2</OperatingRoutingStatus> <OperatingRoutingStatusCodeId>1</OperatingRoutingStatusCodeId> <ProviderName>sample string 1</ProviderName> </ResultRequestQualifiedProvider> <ResultRequestQualifiedProvider> <LSPProviderId>1</LSPProviderId> <OperatingRoutingStatus>sample string 2</OperatingRoutingStatus> <OperatingRoutingStatusCodeId>1</OperatingRoutingStatusCodeId> <ProviderName>sample string 1</ProviderName> </ResultRequestQualifiedProvider> </qualifiedProviderList> <routedToBackup>true</routedToBackup> <waitingMsg>sample string 1</waitingMsg> </secondRequest> </ResultAudioConferenceParticipant>
Response Information
Resource Description
HttpResponseMessageName | 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. |