RTCgate
RTCgate is the communication protocol in the websocket connection between wrtc_kit clients and the IXNX server.
These commands are sent and received by wrtc_kit. Below information is for description only, wrtc_kit API users cannot directly access nor alter these commands.
wcw layer
The wcw layer takes care of roaming and retransmissions.
Lines
The line layer takes care of managing multiple "phone lines", multiple calls made by the same client.
Commands
The RTCgate protocol consist of a number of commands sent between the client and the IXNX server through a websocket channel. The commands are string representation of JSON structures, with "type" indicating the type of command sent, followed by optional arguments:
"{type:…, …, …}"
| type | description |
|---|---|
| answer | SDP answering a call |
| bye | close line |
| chat | text message |
| esc | end call |
| escall | end all current calls |
| fack | file chunk reception acknowledge |
| file | transfer file |
| get_list | fetch list from IXNX server |
| Iam | register name |
| Iauth | authentication answer |
| ice_disconnected | ICE state disconnected |
| ice_restart | restart ICE connection |
| joingroup | connect group call |
| maintenance | maintenance message from server |
| mixer_io_control | request audio from voice bridge |
| multi_user_info | list of users at other end of call |
| mute | other end of call muted/unmuted mic or cam |
| newsdp | modified SDP offer during conversation |
| offer | SDP offer starting a call |
| pranswer | preliminary answer to call |
| presence_publish | publish your own SIP presence status |
| registertoken | app push notification token |
| rejected | command rejected by IXNX server |
| req_vid | request change of video bandwidth or quality |
| ringing | remote client started to ring |
| set_list | store list on IXNX server |
| sip_presence_notify | received SIP presence information |
| sip_presence_subscribe | subscribe to SIP presence information |
| sip_raw_info | raw SIP INFO packets |
| sipreg | SIP registration status |
| transfer | transfer call to other recipient |
| transfer_result | transfer results info |
| turn_auth | get TURN authentication credentials |
| unauthorised | authentication request or failure |
| welcome | authentication succeeded |
| who | who are online |
| wrtc_cmd | user defined command |
