SIP user (sipuser)
Description
Internal telephony subscriber account. Used for registration, authentication, routing, determining call parameters, and organizing queues. Each SIP user account has an internal number in the domain; dialing it calls all devices registered under this account.
Allows registering several devices under one account. In this case, dialing the account number calls all devices registered under it at once. The number of devices that can be registered simultaneously is determined by the 'lic.devices' parameter. When a new registration arrives after the entire volume of licensed connections is exhausted, the availability of registered devices is checked by sending an OPTIONS request. If an unresponsive device is found, the registration is made in its place. Devices can register under an account using the same or different credentials (login and password).
The primary login for authentication matches the account’s logical username (the 'login' field), and the primary password (the 'pwd' field) applies to them. If necessary, additional authentication data can be specified in the 'credentials' field.
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 number of devices simultaneously registered under the account.
Fields
{
"id": uuid,
"name": str,
"login": str,
"pwd": str,
"credentials": array<object>,
"phonenumber": str,
"reg": intbool,
"devices": array<object>,
"iduser": uuid,
"timezone": float | "default",
"lic": object,
"opts": {
"title": str,
"comment": str,
"ap_device_model": str,
"ap_mac_address": str,
"calltimesec": int,
"modextout": str,
"modextin": str,
"trunks": int,
"minexpires": int,
"maxexpires": int,
"dlgtimesec": int
},
"ext": {
"ct": date,
"lwt": date
}
}
| Specification | Description |
|---|---|
Field: |
Identifier. Can be specified at creation, otherwise generated by the system. |
Logical name (username) and primary login for authorization. |
|
Password for the primary login. |
|
Additional authentication data.
Used exclusively for Digest authorization.
The same requirements as for the primary entity’s 'login' and 'pwd' fields apply to the values. To use specific authorization data when configuring a device, both the primary logical name must be entered in the corresponding field and the specific login and password in the authorization data fields. Secret (element |
|
Display name. Substituted into the username URI of the From header in SIP requests. A DisplayName modifier may be specified, |
|
Subscriber phone number within the domain. If the phone number is empty, the account cannot be called in any way. Accounts with empty numbers can be used for Hot-Desk. |
|
Registration mode: |
|
List of devices connected without registration and their connection points, more. |
|
Identifier of the system user. One user can have several sipuser accounts. Linking the user to the device account can be done both statically and within the Hot-Desk subscriber feature. |
|
User time zone. |
|
Set of licenses transferred from the domain. The parameters are expected to include the number of allowed devices for registration, for example |
|
Field: |
|
Field: |
Arbitrary title |
Field: |
Arbitrary comment |
Devices to connect for autoprovision. Object fields in the list: Each element represents a separate device with a unique MAC address and additional settings for the autoprovision service. |
|
Device MAC address for autoprovision. |
|
Device model for determining the autoprovision template. If the template directory contains the file "Yealink SIP-T20.cfg", then "Yealink SIP-T20" must be specified in the field to use it directly. |
|
CoS (class of service) group code. Used to configure group access restriction policies. More in the article CoS/CoR group access restriction. |
|
CoR (class of restrictions) group code. Used to configure group access restriction policies. More in the article CoS/CoR group access restriction. |
|
Account call duration in seconds when a call arrives to it |
|
Maximum conversation duration in seconds. |
|
Sets the representation mode for internal calls within the domain (user → user).
|
|
Maximum number of simultaneous calls. Affects the ability to make a call to this account when there are other active calls.
|
|
Minimum allowed registration time |
|
Maximum allowed registration time |
|
Extension calculator modifier before accepting a call for processing. |
|
Extension modifier for an outgoing call. |
|
List of parallel call numbers. Each number can be specified as an object with Applied when sending a call to the account, provided absolute forwarding did not trigger. The following number types can be specified as parallel: Cascade mode when expanding parallel numbers is disabled. When calling parallel numbers, information about the primary account is set in CDR and Remote-Party. The primary account number is also used when calculating recording and transcription rules. |
|
List of number masks allowed to be set in the device as the forwarding number. The following can be used as a mask:
Evaluating a large number of regular expressions reduces overall system performance. |
|
Switch allowing simultaneous registrations from several directions. By default it is disabled, meaning that when a new registration from the same device is detected (mainly TCP, contact option +sip.instance), the previous registration is automatically removed. When configuring a client device for SIMULTANEOUS REGISTRATIONS mode, this option should be enabled; then registrations will exist simultaneously. |
|
Field: |
Allows extending the compound with arbitrary keys and values |
Field: |
Object creation time |
Field: |
Time of last modification of the object |
Parameters for substitution into the BLF section of the autoprovision configuration. Example: [
{
"key": 1,
"label": "asdf",
"pickup": "**",
"value": "Test"
},
{
"key": 2,
"label": "qwer",
"module": 2,
"value": "Abc"
}
]
|
|
String with override data. A line separator is supported. Each line is a key and an overridden value: "aaa.def = 3\naaa.asd = 4\naaa.qwe = 5\nbbb.zxc = 6" |
DisplayName modifier modes
| Mode | Description |
|---|---|
|
The source value passes through the specified modifier character by character with accumulation.
For example,- value: |
|
The Pattern template with Opts options is applied to the source value, and the found block(s) are replaced with the Replace template. General structure of the regex modifier value: Options can be omitted or contain any combination of the characters:
For example,- value: When forming the Pattern and Replace templates, all standard regular expression rules can be used, including capture groups, backreferences, named group substitution, etc. |
Extension modifier modes
| Mode | Description |
|---|---|
|
The source value passes through the specified modifier character by character with accumulation.
For example,- value: |
|
Identical to the DisplayName "Regex" modifier mode described above |
See also
Logical roles
-
b2b performs routing and applies the account to organize forks to its associated devices.