Message Category

webrtc-signaling-server

sId

reserved word that the client needs to create an id on the server. This is a necessary step for signaling communication.

Message = {
    cmd: 'sId',
    sId: String
}

sId type is String.

Session

reserved word that the client needs to create a session on the server. This is a necessary step for communication 'call' request.

Message = {
    cmd: 'session',
    opponentId: String
}

opponentId represents the sId of the other to communicate with.

Call

reserved word that is required when the client makes a communication call request to the server.

Message = {
    cmd: 'call',
    offer: Object,
    sessionId, String
}

offer represents the sdp obtained using webrtc client API. sessionId indicates the id of created session.

Accept

reserved word that is required when the client makes a communication accept request to the server.

Message = {
    cmd: 'accept',
    answer: Object,
    sessionId: String
}

answer represents the sdp obtained using webrtc client API. sessionId indicates the id that was received.

Reject

reserved word that is required when the client makes a communication denial request to the server.

Message = {
    cmd: 'reject',
    sessionId: String
}

sessionId indicates the id that was received.

Stop

reserved word that is required when the client makes a communication stop request to the server.

Message = {
    cmd: 'stop',
    sessionId: String
}

sessionId indicates the id of the created or received.

Leave

reserved word that the server unilaterally sends to the client. Occurs when two clients are communicating and one client is disconnected due to various problems, (e.g. network outage) the other party receives this .

Message = {
    cmd: 'leave',
    sessionId: String
}

sessionId indicates the id of the created or received.

Icecandidate

reserved word that is required when a client sends an candidate returned from a turn server to the server.

Message = {
    cmd: 'icecandidate',
    icecandidate: Object
    sessionId: String
}

icecandidate indicates candidate returned from a turn server. sessionId indicates the id of the created or received.

Clu (client list update)

reserved word that server sends unilaterally to the client. Occurs when the client list is updated.

Message = {
    cmd: 'clu',
    list: Array
}

list indicates an array of objects containing the client's sId and state. state has a state value of 1 (WAIT), 2(CALLING). The client only receives and does not receive while in a call.

Ssu (session state update)

reserved word that occurs when a session created or received by the client is updated.

Message = {
    cmd: 'ssu',
    state: String,
    sessionId: String
}

state has state values of 1(NEW), 2(PENDING), 3(ACTIVE), 4(CLOSED).

1(NEW): occurs when session creation is successful.

2(PENDING): occurs when communication request(call) occurs.

3(ACTIVE): occurs when communication accepted.

4(CLOSED): occurs when communication is terminated(reject, stop) or disconnected(leave).

Notify

reserved word that the client needs to send a message to other clients.

Message = {
    cmd: 'notify',
    opponentId: String,
    type: String
}

type indicates the notification type to be transmitted. you can use it at will.

Error

reserved word when an error occurs on the server. The client will only receive it.

See the link below for the error code.

Message = {
    cmd: 'error',
    code: Integer
}

code indicates the error code that occurred.

Error code