POST Client/Request/StartRoomVideoCallWithRegion
Start the video process. Since every video call requires a confirmation from the listener before the video call can be made, it needs to inform the server that it is ready to make video call. Once this function is called, the caller needs to call GetVideoEngineAccounts in order to get the account info to make the video call.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
ResultConferenceCallName | Description | Type | Additional information |
---|---|---|---|
ConferenceCallTypeCodeId | integer |
None. |
|
ConferenceRoomName | string |
None. |
|
ConferenceEngineId | integer |
None. |
|
CallPartyStr | string |
None. |
|
EnableInvitaion | boolean |
None. |
|
InvitationReplaceDTMF | string |
None. |
|
EnablePSTNInvitation | boolean |
None. |
|
OperatorModelEnabled | boolean |
None. |
|
ControlPanelInitialDisplay | boolean |
None. |
|
ControlPanelTimeOut | integer |
None. |
|
VideoImageName | string |
None. |
|
Editable | boolean |
None. |
|
PersonSignalRegion | string |
None. |
|
ProviderSignalRegion | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "ConferenceCallTypeCodeId": 1, "ConferenceRoomName": "sample string 1", "ConferenceEngineId": 1, "CallPartyStr": "sample string 2", "EnableInvitaion": true, "InvitationReplaceDTMF": "sample string 3", "EnablePSTNInvitation": true, "OperatorModelEnabled": true, "ControlPanelInitialDisplay": true, "ControlPanelTimeOut": 1, "VideoImageName": "sample string 4", "Editable": true, "PersonSignalRegion": "sample string 5", "ProviderSignalRegion": "sample string 6" }
application/xml, text/xml
Sample:
<ResultConferenceCall xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <CallPartyStr>sample string 2</CallPartyStr> <ConferenceCallTypeCodeId>1</ConferenceCallTypeCodeId> <ConferenceEngineId>1</ConferenceEngineId> <ConferenceRoomName>sample string 1</ConferenceRoomName> <ControlPanelInitialDisplay>true</ControlPanelInitialDisplay> <ControlPanelTimeOut>1</ControlPanelTimeOut> <Editable>true</Editable> <EnableInvitaion>true</EnableInvitaion> <EnablePSTNInvitation>true</EnablePSTNInvitation> <InvitationReplaceDTMF>sample string 3</InvitationReplaceDTMF> <OperatorModelEnabled>true</OperatorModelEnabled> <PersonSignalRegion>sample string 5</PersonSignalRegion> <ProviderSignalRegion>sample string 6</ProviderSignalRegion> <VideoImageName>sample string 4</VideoImageName> </ResultConferenceCall>