rtcomm - Real-Time Communications (rtcomm)

Defines the configuration that is related to the Rtcomm feature and all its related components. All the real-time capabilities associated with the Rtcomm feature are configured under this single entity.

NameTypeDefaultDescription
rtcommTopicPathstring/rtcomm/The MQTT topic path that is associated with this feature. All Rtcomm topic names configured within Rtcomm Options are prepended with this path. To create a unique name space for this Rtcomm instance within a message broker, modify this path to be unique.
messageServerHoststringlocalhostThe host of the MQTT broker. The specified host can be an IP address or domain name server (DNS) hostname.
messageServerPortint1883The port the MQTT broker listens on. The port is any valid port number.
sslEnabledbooleanfalseUses SSL between the Rtcomm feature and the MQTT broker.
sslRefA reference to top level ssl element (string).ID of the SSL configuration to be used to connect to the SSL-enabled MQTT broker.
sharedSubscriptionPathstringSpecifies the shared subscription path that is prepended to the topic path. This path is required by message brokers when using shared subscriptions.
alternateEndpointRoutingEnabledbooleanfalseEnables the alternate endpoint routing option. Administrators that want to control endpoint routing must enable this option.

iceServerURL

Specifies the Interactive Connectivity Establishment (ICE) Server URL(s) available for client use. The client can request the list of ICE Server URL(s) for use with WebRTC by using an Rtcomm service query. This following is an example format for an ICE Server URL: - stun:hostname:port.

callQueue

Defines a single instance of a call queue. This instance fully encapsulates all the configuration related to a single queue.

NameTypeDefaultDescription
idstringA unique configuration ID.
callQueueIDstringcallQueueIDThe name that is associated with the call queue topic. This is the destination endpoint ID that a caller uses to call into a specific queue.
descriptionstringSpecifies the description of this call queue instance. This description is returned in service query responses and can be used to better inform the client about the queue.
timeoutA period of time with second precision600sThe number of seconds to wait before terminating a call that is waiting in this queue. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.

gateway

A WebRTC gateway that provides connectivity from Rtcomm to SIP networks

NameTypeDefaultDescription
externalPRstringHost:port address of a SIP Proxy/Registrar. If assigned, all outgoing SIP messages are forwarded to this address
sipContainerbooleanfalseOutgoing SIP messages are routed to SIP applications installed locally
allowFromSipEndpointRefList of references to top level sipEndpoint elements (comma-separated string).defaultSipUAEndpointList of SIP endpoints for this connector.

gateway > allowFromSipEndpoint

List of SIP endpoints for this connector.

NameTypeDefaultDescription
idstringA unique configuration ID.
tcpOptionsRefA reference to top level tcpOptions element (string).defaultTCPOptionsDefines TCP protocol settings
sslOptionsRefA reference to top level sslOptions element (string).Defines SSL protocol settings
sipTCPPortint5060The TCP port number
sipUDPPortint5060The UDP port number
sipTLSPortint5061The TLS port number
bindRetriesint60The number of retries that are attempted when port binding is unsuccessful.
bindRetryDelayA period of time with millisecond precision5000msThe delay between retries in milliseconds. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
hoststringlocalhostThe IP of the endpoint host

gateway > allowFromSipEndpoint > tcpOptions

Defines TCP protocol settings

NameTypeDefaultDescription
inactivityTimeoutA period of time with millisecond precision60sAmount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.
soReuseAddrbooleantrueEnables immediate rebind to a port with no active listener.

gateway > allowFromSipEndpoint > sslOptions

Defines SSL protocol settings

NameTypeDefaultDescription
sessionTimeoutA period of time with second precision1dAmount of time to wait for a read or write request to complete on a socket. This value is overridden by protocol-specific timeouts. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), or seconds (s). For example, specify 30 seconds as 30s. You can include multiple values in a single entry. For example, 1m30s is equivalent to 90 seconds.
suppressHandshakeErrorsbooleanfalseDisable logging of SSL handshake errors. SSL handshake errors can occur during normal operation, however these messages can be useful when SSL is behaving unexpectedly.
sslRefA reference to top level ssl element (string).The default SSL configuration repertoire. The default value is defaultSSLSettings.
sslSessionTimeoutA period of time with millisecond precision8640msThe timeout limit for an SSL session that is established by the SSL Channel. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.