call

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

If the called subscriber is outside the conference, they will receive a call in the form of a video call. If they are a conference owner, they will receive a notification of the request to participate. Some identifiers may be converted to a different format and then used for calling within the application. Therefore, to find out the final version of the identifier 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 - unique identifier of a user (TrueConf ID) to whom you need to make a call. Applicability:

  • PeerId - supported. Inside the application, it is automatically converted to CallId and the command is executed with it. In this case, the call will go to all users with this identifier on all their devices.

  • CallId - supported. The call will go to all users with this identifier on all their devices.

  • InstanceId - supported. The call will go to a specific application instance.

• pin — the password for joining the conference (an optional parameter)

• requestId - unique request identifier. More details can be found here

See also:

• reject
• prepareCallIdForCall
• hangUp
• createConference
• prepareCallIdForCall