SIP telephony provider (provider)
Description
SIP telephony provider account through which the «Incoplax» system connects to external SIP networks.
This can be an external telephone network connected through providers, or corporate PBXs located above or at the same level in the number plan as the «Incoplax» system.
The ESG role registers and maintains the communication channel with external equipment specified in the provider account. Any call that results in an outside call always goes through it. Any call arriving from outside into the system can be accepted, authorized, and serviced only by the ESG role defined in the provider account.
Determining which account an incoming call belongs to is based on a set of conditions:
- an account with registration in the "To:" or "Contact:" header of the SIP INVITE request contains "username@domain", where "username" matches the account’s "username" field value and "domain" matches one of the account addresses;
- an account without registration in the "Contact:" header of the SIP INVITE request contains "username@domain", where "username" matches the account’s "username" field value and "domain" matches one of the account addresses;
- an account without registration in the "Contact:" header of the SIP INVITE request contains "username@domain", where "domain" matches one of the account addresses and the account’s "username" field value is empty.
In any case, the sender address from which the request arrived at the ESG role SIP port must be known from the account description (the set of "domain", "proxyaddr"/"alternative_proxies", "extaddrs" fields).
Read more about working with telephony providers.
Limitations
-
The collection is unavailable in the master domain.
-
If the license field is changed in the DB, after the domain reload the object will not be loaded; a hash check applies.
-
Licensed by a quantitative parameter: a license is consumed for the allowed simultaneous number of active trunks.
Fields
{
"id": uuid,
"code": str,
"enabled": intbool,
"username": str,
"login": str,
"pwd": str,
"domain": str,
"proxyaddr": str,
"proxyport": int,
"transport": str,
"alternative_proxies": str,
"extaddrs": array<str>,
"serveridxs": array<int>,
"reg": bool,
"expires": int,
"pingmode": str,
"pingsrv": str,
"pingtimeout": int,
"localdomain": str,
"media": intbool,
"reinvite": intbool,
"translit": intbool,
"lic": object,
"trunksout": int,
"opts": {
"title": str,
"comment": str,
"agat_port_id": uuid,
"agat_chassis_id": uuid,
"agat_lm_id": uuid
},
"ext": {
"ct": date,
"lwt": date
}
}
| Specification | Description |
|---|---|
Identifier. Can be specified at creation, otherwise generated by the system. |
|
Account code. |
|
Account switch. |
|
Username. |
|
Login for authorization. If absent, authorization is based on To avoid rejection in response to INVITE and re-INVITE requests, use one of the following methods:
|
|
Password for authorization. |
|
SIP server. Domain name substituted into the To header when sending requests from the system to external equipment. |
|
Address of the Outbound Proxy server to which requests from the system to external equipment are actually sent. When using parallel account servicing on several esg instances, the value applies only to redundant instances that have no values in the opts.edge_proxies list. |
|
Port of the Outbound Proxy server to which requests from the system to external equipment are actually sent. When using parallel account servicing on several esg instances, the value applies only to redundant instances that have no values in the opts.edge_proxies list. |
|
Transport protocol for the primary proxy. Allowed values: When using parallel account servicing on several esg instances, the value applies only to redundant instances that have no values in the opts.edge_proxies list. |
|
Certificate for connecting to the provider over TLS. |
|
List of alternative Proxy servers. Used: When using parallel account servicing on several esg instances, the value applies only to redundant instances that have no values in the opts.edge_proxies list. |
|
Additional possible addresses or address masks for account identification and sender validation when receiving requests from outside, comma-separated. The following value formats can be used as masks:
Using masks (rather than constants) incurs additional computational cost. Therefore, in all cases masks are checked only if other simpler checks do not pass:
From a performance standpoint, specifying one or more subnets or ranges is most efficient, compared with regular expressions or masks with special characters, as well as long lists of constants. |
|
List of esg role instances in descending priority order that are responsible for working with the account. Roles are specified by RoleId values from the role configuration. |
|
Mode with registration ( |
|
Re-registration period in seconds |
|
Address of external equipment for availability checking. When using parallel account servicing on several esg instances, the value applies only to redundant instances that have no values in the opts.edge_proxies list. |
|
Availability check period, in seconds |
|
Value of the domain field in the From header when sending requests from the system to external equipment. |
|
Switch for using the border media gateway. |
|
Switch for transparent re-INVITE pass-through to the outside. Can be disabled only if
|
|
Switch for REFER processing mode on the border gateway servicing the provider account.
The 'forward' mode is used for test cases of subscriber emulation by the system. |
|
Switch for transliteration of the display name when sending requests and responses outside |
|
Set of licenses transferred from the domain. The parameters are expected to include the maximum number of simultaneous calls using the account, e.g. |
|
Maximum number of trunks used for outgoing calls. |
|
Field: |
|
Field: |
Arbitrary title |
Field: |
Arbitrary comment |
CoS (class of service) group code. Used to configure group access restriction policies. More in the article CoS/CoR group access restriction. |
|
List of additional provider names identifying the account. |
|
Account support for the graceful server decommissioning mode. If the account has registration, esg microservice instances switched to graceful decommissioning stop registration. If the account has no registration, esg microservice instances switched to graceful decommissioning reject primary INVITE requests from the provider with the 'deservice_sipcode' response code. |
|
Response code sent by the esg microservice to primary INVITE requests from the provider. |
|
Number of ESG microservice instances simultaneously servicing the account. For example, the parameter can be used if a P2P account (without registration) needs to receive INVITE at one of several addresses in a multi-server system. If some servers are in graceful decommissioning mode, the behavior and distribution of servicing instances correspond to the 'deservice_response' parameter description. |
|
List of alternative Proxy servers for parallel esg instances when servicing the account simultaneously on several instances (instance_count). Each list element is a string in the format: The first list element applies to the first parallel instance, the second to the second, etc. The specified address is also used:
Each parallel esg instance servicing the account may have a different composition and number of edge proxies. |
|
Switch for applying Diversion on calls from upstream that are forwarded or smart-routed back to upstream (RFC-5806). If the call did not come from upstream, or the account has Diversion mode disabled, the INVITE request parameters are formed on a general basis on behalf of the system account according to normalization rules. When a call arrives from subscriber A from upstream within an account with Diversion mode enabled to number B, each INVITE request sent to upstream to number C through any account with Diversion mode enabled places subscriber A as the From URI and additionally places a Diversion header with the URI of number B. |
|
Switch for applying billing to calls made in either direction through the current account. |
|
Switch for dialog recovery mode when a node with the esg microservice servicing call signaling fails. Possible variants:
The recovery service is activated in the sip_restore_enabled configuration setting of the callstore microservice. |
|
Additional filter for incoming INVITE requests. The value format matches the 'filter' parameter format when reading a collection (more). The filter is applied to an object formed from the key parameters of the INVITE request and the current account object. {
"ruri": {
"user": username from INVITE's request line,
"domain": domain from INVITE's request line
},
"from": {
"user": username from INVITE's From header,
"domain": domain from INVITE's From header
},
"to": {
"user": username from INVITE's To header,
"domain": domain from INVITE's To header
},
"contact": {
"user": username from INVITE's Contact header,
"domain": domain from INVITE's Contact header,
"port": port from INVITE's Contact header
},
"proto": "tcp" | "udp" | "tls",
"remote": {
"addr": ip-address of INVITE's sender,
"port": port of INVITE's sender
},
"local": {
"addr": ...,
"port": ...
},
"account": {
"id": ...,
"code": ...,
...
}
}
The additional filter can solve, for example, the following task. Several accounts are serviced by one esg instance. These accounts are P2P (without registration) for the same provider but with different credentials. Each account is multi-number, that is, it can supply calls to a large number of different numbers. The provider server address is the same, but the ports on the provider server are different for different accounts. One way to solve this task is to write the entire list of possible numbers into the opts.extusernames property of these accounts. The second way is to bind these accounts to different esg instances. Then incoming INVITEs from the provider will not overlap. However, if there are dozens or hundreds of such accounts rather than two or three, multiplying roles for them becomes inconvenient and stops being optimal to maintain during modifications. With an additional filter [
"equals",
["property", "remote", "port"],
["property", "account", "proxyport"]
]
accounts can be distinguished by matching the sender port with the port specified in the account. In this case it is not necessary to split across different esg instances, nor to list the entire pool of numbers in 'opts.extusernames'. It is enough to leave username empty so that each of these accounts, according to the binding algorithm (step 2.2.), satisfies the basic check conditions, and the filter does the rest. |
|
Switch for sending a set of codecs in responses to INVITE.
More — Codecs and media negotiation. |
|
List of audio codec names used for traffic exchange with the provider. If the list is empty:
If the list is not empty:
More — Codecs and media negotiation. The value is a list of audio codec names in
|
|
Field: |
Allows extending the compound with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Availability check modes
| Value | Description |
|---|---|
|
Disable availability check |
|
Send an empty |
|
Send a SIP OPTIONS request, expecting a 200 OK SIP response |
|
Send an unscheduled SIP REGISTER request, expecting a 200 OK SIP response |
|
Send a STUN request |
See also
-
Article: Telephony providers
-
Collection: Number normalization rules