MyChat Integration API: MCIAPI_CS_MediaCall, make a media call

MyChat Integration API: MCIAPI_CS_MediaCall, make a media call

"For developers", "Integration API", "Integration API command description", "Calls", "MCIAPI_CS_MediaCall".

 

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;

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;

Type

integer

call type;

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"

}

 

Field

Type

Value

cmd

string

HEX numbe rof a command that was successfully executed.

 

Possible errors

#19, MCIAPI_Error_UINNotFound

#37, MCIAPI_Error_UINMustBeGreaterThanZero

#38, MCIAPI_Error_UserOffline

#39, MCIAPI_Error_InvalidMediaCallType

#40, MCIAPI_Error_NotEnoughRightsToMakeMediaCall

#41, MCIAPI_Error_NotEnoughRightsToReceiveMediaCall

 

Ещё посмотреть

Перехват попыток медиазвонков скриптовым движком MyChat Server