MyChat Integration API: MCIAPI_CS_MediaCall, make a media call
Making a force call of a certain type. The initiator and responder must be online.
Syntax
{
"cmd" : "001D",
"ServerKey" : "iddqd",
"APIStype" : "mydata",
"UINFrom" : 17,
"UINTo" : 94,
"Type" : 1,
"FullScreen" : true
}
Parmeters
|
Parameter |
Type |
Value |
|
cmd |
string |
"001D", number of the command MCIAPI_CS_MediaCall; |
|
ServerKey |
string |
Integration API key; set in the server's settings; |
|
APIStype |
string |
integration type. Can be arbitrary string; |
|
context |
string |
optional parameter, any text that returns in a response command; |
|
UINFrom |
integer |
UIN of the call initiator; more than a zero; must be online; |
|
UINTo |
integer |
UIN of a user that receives the call; above zero; must be online; |
|
CallType |
integer |
call type; if this parameter is not specified, then a program performs a voice call; |
|
FullScreen |
boolean |
if the call type is video or screen sharing, then it is possible to "force" a recipient to extend the call window to full screen by specifying FullScreen=true. Otherwise, this parameter is ignored. |
Work result
{
"cmd" : "001D",
"context" : "myfunc",
"UINFrom" : 17,
"UINTo" : 94,
"CallType" : 1
}
|
Field |
Type |
Value |
|
cmd |
string |
HEX numbe rof a command that was successfully executed. |
|
context |
string |
random text transferred to the server in the request command; |
|
UINFrom |
integer |
call initiator ID; |
|
UINTo |
integer |
recipient ID; |
|
CallType |
integer |
call type. |
Possible errors
#5, MCIAPI_Error_WrongIntegrationKey
#37, MCIAPI_Error_UINMustBeGreaterThanZero
#39, MCIAPI_Error_InvalidMediaCallType
#40, MCIAPI_Error_NotEnoughRightsToMakeMediaCall
#41, MCIAPI_Error_NotEnoughRightsToReceiveMediaCall
See also
Intercepting media calls attempts with MyChat Server scripting language