call

Description: call a user or send a conference join request.

If the called party is outside the conference, they will receive a call as a video call. If they are the conference owner, they will receive a notification about the participation request. Some identifiers may be converted into another format and then used for calls within the application. To find out the final version of the identifier being used, you can execute the method prepareCallIdForCall.

Request example:

{
    "method" : "call",
    "requestId" : "1",
    "peerId" : "user1@some.server",
    "pin" : "1111"
}

Response example:

{
    "method" : "call",
    "requestId" : "1",
    "result" : true
}

Parameter description:

peerId - a unique identifier of the user (TrueConf ID) to call. Applicability:
- PeerId is supported. Within the application, it is automatically converted to CallId, and the command is executed with it. In this case, the call will be directed to all users with this identifier on all their devices.
- CallId - supported. The call will be sent to all users with this identifier on all their devices.
- InstanceId is supported. The call will be directed to a specific instance of the application.
pin — the password for joining the conference (an optional parameter)
requestId - a unique request identifier. You can find more details about it here.

See also: