CallsRtc#

callsRtc is a WebSocket connection that carries everything related to a call except commands:

• the server reports what is happening to the call: dialing has started, an incoming call has arrived, the conversation has started, the call has ended;
• the application and the server agree on audio transmission using WebRTC technology.

Open the connection before you call any of the calls methods and keep it open for the entire call. The callsDial, callsAccept, callsReject and callsHangUp methods return 200 OK. What happens to the call next can only be seen from the messages in this connection.

Connection#

To receive call messages, you have to establish a websocket connection at:

{{apiUrl}}/waInstance{{idInstance}}/callsRtc/{{apiTokenInstance}}

The address is the same as for the other methods, only the scheme is different: wss is specified instead of https.

For apiUrl, idInstance and apiTokenInstance websocket connection parameters, refer to Before you start section.

Message format#

Messages are sent in JSON format. Each message has a type field, and the other fields depend on its value: apart from type, a message contains no more than one data field, and some messages have none at all. The sets of messages in the two directions are different — there is no single format for both sides.

Messages from the server#

Messages from the application#

A message of type stop is sent without additional fields — {"type": "stop"} — and means that the application no longer transmits audio.

Call state#

The state object describes what is currently happening to the call.

info object#

Reasons for ending a call#

The value of the reason field is the server's word on why the call ended. Known values:

The list is open: if you receive a value that is not in the table, display it as is instead of discarding it.

Errors#

The server reports an error with a message of type error, the error text is in the message field.

{
    "type": "error",
    "message": "no active call"
}

Apart from error messages, the server may close the connection. The close code shows whether you should reconnect:

Message examples#

Dialing of an outgoing call has started:

{
    "type": "state",
    "state": {
        "state": "out-call"
    }
}

The call has ended because the call was hung up:

{
    "type": "state",
    "state": {
        "state": "idle",
        "reason": "hangup"
    }
}

The application reports that it no longer transmits audio:

{
    "type": "stop"
}