Prompt SIP UserAgent (prompt)

Table of Contents

Description
Parameters
Configuration example
See also

Description

Implements a service to connect to existing conversations for listening and suffixing.

Reserved and scaled in mode Active-Active.

Table 1. System Characteristics

Code	`prompt`
Mode of operation	`Service`
Backup mode	`Active-Active`
Types of sites	`Any`
Layer	`Business logic`
Placement	`Internal`
Saving and restoring state on reboot	`No`
appendix	`era_sip`

Parameters

Description of columns in the table

Table 2. Parameters
Name	Type	Default	Description
`name`	`str`	required	Name. May consist of Latin letters and numbers, must begin with a letter.
`roletype`	`str`	required	Role Type. Possible values: `"prompt"`.
`iface`	`str`	required	The alias of the server network interface on which the roles will interact internally with each other.
`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.
`roleid`	`int`	required	Role ID. Unique for the entire system, regardless of the site or server. Cannot be changed. Integer from `1` to `9999`.
`separate`	`bool`	required	An indication that the role has been allocated to a separate node.
`udp`	`int`	required	Local UDP port for SIP. The same port handles both TCP. For example: `5086`. Used for internal communication with other microservices of the system via protocol SIP. Raised only on the local interface to which the node is bound. Should not be used by other microservices executing on the same server.
`tcp`	`int`	required	Local TCP port for SIP. If a value other than UDP is specified, it will be raised additionally. For example: `5086`. Used for internal communication with other microservices of the system via protocol SIP. Raised only on the local interface to which the node is bound. Should not be used by other microservices executing on the same server.
`log_media`	`bool`	`true`	Media function logging switch `media`.
`log_mgct`	`bool`	`true`	Switch for logging the communication protocol with the MGC controller to the logger `mgct`.
`log_sip`	`bool`	`true`	Switch for logging dialog state machine trace to logs `sip`.
`log_trn`	`bool`	`true`	SIP traffic logging switch to log `trn`.
`payloads_audio_offer`	`array<str>`	`["PCMA/8000", "PCMU/8000","telephone-event/8000"]`	List of audio codec names used for call initiation (shoulder call). As value - a list containing names of audio codecs in format `"Name/Freq"`. The following codecs are supported (case-sensitive): `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`. The three basic formats, `PCMA/8000`, `PCMU/8000` and `telephone-event/8000` are automatically added to initiated calls at any field value.

Configuration example

The configuration is managed in an application available to master domain administrators. The application hides the full content of the configuration, but it is nevertheless accessible via the API.

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

Example node

{
  "name": "prompt1",
  "roletype": "prompt",
  "iface": "eth0",

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

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

Prompt SIP UserAgent (prompt)

Description

Parameters

Configuration example

See also