Prompt SIP UserAgent (prompt)

Description

Implements the service for connecting to existing conversations for listening and whispering.

Made redundant and scaled in Active-Active mode.

Table 1. System characteristics

Code

prompt

Operation mode

Service

Redundancy mode

Active-Active

Site types

Any

Layer

Business logic

Placement

Internal

State preservation and recovery on restart

No

Application

era_sip

Parameters

Table 2. Parameters
Name Type Default Description

name

str

required

Name. May consist of Latin letters and digits and must start with a letter.

roletype

str

required

Role type. Possible values: "prompt".

ext

json

empty

Additional role options. Contains a JSON object or list.

enabled

bool

empty

Role activity flag. When set to false, the role does not participate in validation and is not started.

limit_of_cores

int

empty

Limit on the number of CPU logical cores used. Default: 0 - unlimited.

logging_default_level

int

empty

Default logging level set specifically for the role instance (microservice type). More

allow_divergence

bool

false

Flag allowing parameter differences in roles of the same group. Default: false - not allowed.

roleid

int

required

Role identifier.
Unique across the entire system, regardless of site or server. Cannot be changed.
An integer from 1 to 9999.

separate

bool

required

Flag indicating whether the role is allocated to a separate node.

udp

int

required

Local UDP port for SIP. The same port also handles TCP.
For example: 5086.
Used for internal interaction with other system microservices over SIP.
Listens only on the local interface to which the node is bound.
Must not be used by other microservices running on the same server.

tcp

int

required

Local TCP port for SIP. If a value different from UDP is specified, it is opened additionally.
For example: 5086.
Used for internal interaction with other system microservices over SIP.
Listens only on the local interface to which the node is bound.
Must not be used by other microservices running on the same server.

log_closure

bool

true

Switch for logging Call-ID closures of different legs/dialogs to build sequence diagrams. When this log is enabled, the retention time of links in node memory (sip_stat_timeout_closure) can be reduced to save memory: volume estimate.

log_media

bool

true

Switch for logging media functions to the media log.

log_mgct

bool

true

Switch for logging the MGC controller interaction protocol to the mgct log.

log_sip

bool

true

Switch for logging the dialog state machine trace to the sip log.

log_trn

bool

true

Switch for logging SIP traffic to the trn log.

payloads_audio_offer

array<str>

empty

List of audio codec names used to initiate a call (leg call).

The value is a list of audio codec names in "Name/Freq" format.
The following codecs are supported (case-insensitive):

  • telephone-event/8000,

  • PCMU/8000,

  • PCMA/8000,

  • GSM/8000,

  • G722/8000,

  • G729/8000,

  • CN/8000,

  • speex/8000,

  • speex/16000,

  • speex/32000,

  • G726-16/8000,

  • G726-24/8000,

  • G726-32/8000,

  • G726-40/8000,

  • iLBC/8000,

  • opus/48000/2.

Codecs are offered in list order. The base PCMU/8000, PCMA/8000, and telephone-event/8000, if not listed, are added after the listed ones. The - prefix excludes a codec from those added (-PCMU/8000; - — all unlisted base codecs); the -- prefix additionally excludes it from the SDP of the incoming call passed to the other leg (-- — all unlisted incoming codecs; the offer is built in list order). CN/8000 and telephone-event/8000 are placed at the end. For example, ["G722/8000", "PCMA/8000", "-PCMU/8000"] — G722, PCMA, telephone-event; ["PCMA/8000", "-*"] — only PCMA. See Codecs and media negotiation.

log_cdr

bool

true

Switch for logging events to the cdr log.

payloads_video_offer

array<str>

empty

List of video codec names used to initiate a call (leg call).

The value is a list of video codec names in "Name/Freq" format.
The following codecs are supported (case-insensitive):

  • H263/90000,

  • H263-1998/90000,

  • H264/90000,

  • VP8/90000,

  • VP9/90000.

sip_internal_port

int

empty

Additional local SIP port (UDP/TCP) for interaction with other system microservices. The listener is raised if the value differs from the udp and tcp options.

Configuration example

Configuration management is performed in an application available to master domain administrators. The application hides the full configuration content, but it is still available through the API.

The configuration contains a section describing all instances of all roles. Parameters are defined for each specific role instance.

Node example
{
  "name": "prompt1",
  "roletype": "prompt",

  "roleid": 11370,
  "separate": true,
  "udp": 5098,
  "tcp": 5098,

  "log_trn": true,
  "log_sip": true,
  "log_media": true
}

See also