Subscriber feature code (featurecode)

Description

Subscriber feature code (abbr. SFC) is an internal phone number that determines access to various internal service functions: IVR, conference, call pickup, etc.
It is part of the call routing process and is applied at its final stage. Some SFCs can restart the routing process with changed parameters and new attributes.

Limitations

  • The collection is unavailable in the master domain.

Fields

Entity structure
{
  "id": uuid,
  "prefix": str,
  "type": str,
  "extension": str,
  "priority": int,
  "opts": {
    "title": str,
    "comment": str
  },
  "ext": {
    "ct": date,
    "lwt": date
  }
}
Table 1. Fields
Specification Description

Field: id
Mode: inout
Type: uuid
Default: generated

Identifier. Can be specified at creation, otherwise generated by the system.

Field: prefix
Mode: in
Type: str
Default: required

SFC number prefix.
When a call reaches an SFC, all SFCs whose prefix matches the dialed number are searched. If their priorities are equal, the SFC with the longer prefix is applied (long-hunting).

Field: type
Mode: in
Type: str
Default: required

Subscriber feature code type.
Most SFC types use parameters.
The remainder parameter is calculated as the ending of the dialed number after the SFC number. For example, if 123456 is dialed and the SFC’s own number is 123, its parameter is 456.

Field: extension
Mode: in
Type: str
Default: empty

Additional parameter. For type ivr, the IVR script code; for type hunt, the hunt number used with priority over the remainder; for type replace, the set of additional options.

Field: priority
Mode: in
Type: int
Default: 1000

Subscriber feature code priority.
Applied when several different SFCs match the number. A lower value means higher priority.

Field: opts
Mode: in
Type: object
Compound field

Field: opts.title
Mode: in
Type: str
Default: empty

Arbitrary title

Field: opts.comment
Mode: in
Type: str
Default: empty

Arbitrary comment

Field: ext
Mode: inout
Type: object
Compound field

Allows extending the compound with arbitrary keys and values

Field: ext.ct
Mode: out
Type: date
Default: generated

Object creation time

Field: ext.lwt
Mode: out
Type: date
Default: generated

Time of last modification of the object

Subscriber feature code type

Table 2. Subscriber feature code type
Value Description

"pickup"

Pickup of a call arriving at the account available by the specified number.
The number is calculated as the remainder. The 'extension' field is not used.

"grouppickup"

Call pickup based on the presence of the called SIP user account and the picking-up SIP user account in the same group number.
Any call in the subscriber calling state is subject to pickup, even if it arrived individually rather than to the group number.
Neither the remainder nor the 'extension' field is used.

"conference"

Routing to the conference service.
The conference room number is calculated as the remainder. The 'extension' field is not used.

Behavior modification options:

  • If the value 'stop' is placed in the 'extension' field of the object, the feature code call behaves like the 'stopconf' feature code.

Conference factory (ad-hoc):

  • If the feature code is dialed without a postfix, the server forwards the call to the conference room number. The conference room is determined by the rule below.
    This dialing method is used for subscriber devices that implement Ad-hoc Network Conference collection and independently transfer all currently held subscribers to the conference factory number.

  • If the '*' postfix is added to the feature code, the server also forwards the call to the number of a conference room, and also initiates and performs transfer of subscribers of all calls held by the initiator to the same place. This mode is available only for non-transferred calls, that is, when the initiator dials the number themselves (directly or through their CTI panel).
    This dialing method is used for subscriber devices that do not have a conference collection function or do not independently implement transfer of held subscribers to the conference factory number.

Rule for determining the conference room number when calling the factory

When the factory number is called, the conference room is determined relative to the subscriber who performed the transfer of this call. That is, if subscriber A, talking to subscriber B, transfers subscriber B to the factory number (feature code without a postfix or with the '*' postfix), the conference number is determined relative to subscriber A. If subscriber B dials the factory number themselves, the conference number is determined relative to subscriber B.
In this case:

  1. If the determining subscriber is already holding a conversation with any conference, that conference room becomes the target. The factory is not used. This is how new subscribers are added to an active conference from a device using the conference factory feature code.

  2. If the determining subscriber has no active conversation with any conference on hold, a new ad-hoc conference is created with a room of the format 'SubscriberNumber!RoomNumber', thereby binding this conference to the creator subscriber and providing them with further management capabilities: stopping the conference from the phone, disconnecting participants, viewing and managing participants through client application tools.

"stopconf"

Execution of the command to end the current conference.
Only conferences initiated by the user on the fly (ad-hoc) are eligible. Such conference rooms have a special number format: SubscriberNumber!AdHocRoomNumber
Use case: a subscriber created a three-party or larger ad-hoc conference and wants to end it by disconnecting all participants; to do this, they put the conference on hold and call the number of this subscriber function.

Behavior modification options:

  • If the '*' postfix is added to the feature code, all active ad-hoc conferences initiated by the user are ended, including those in which they no longer participate.

  • If any other postfix is added to the feature code, the participant with the specified number is disconnected from the user’s current ad-hoc conference, if found.

If the command is successfully discovered and executed, a '410 Gone' response is returned, and the connection is not established under any scenario.

This feature code can be replaced by the 'conference' feature code with the 'extension' field set to 'stop'.

"ivr"

Routing to the IVR service.
The IVR script code is specified in the SFC 'extension' field. The remainder is not used.

"queue"

Routing to a personal queue.
The subscriber number is taken as the remainder. The 'extension' field is not used.

"hunt"

Routing to the hunt group and queue service.
The hunt group number ('phonenumber') is specified in the SFC 'extension' field; if it is empty, it is taken as the remainder.

"hotdesking"

Hot-Desk. User authorization from a phone with simultaneous account linking and assignment of the user’s phone number to the device (sipuser account).
The service allows linking and unlinking.

To link, dial "{Featurecode}{UserNumber}*{UserPincode}" as the number. In this case:

  • if the user is linked to another sipuser account, they will be unlinked there first.

  • if another user is already linked to the current account from which the call is made, they will also be unlinked first.

The user’s phone number and PIN code are set in the properties of the user account.
When using the Hot-Desk subscriber function, one user can be linked to only one sipuser account.

To unlink, dial "{FeatureCode}" and any number of zeros at the end, including no zeros.

When unlinking, the sipuser account is assigned an empty number (phonenumber) and an empty user (iduser).

"voicemail"

Voicemail box management and listening to voice messages.
The voicemail box number is calculated as the remainder. The 'extension' field is not used.
Calling the number without appending the box number is not serviced, and a notification is played.

The voicemail service number together with the box number appended as a remainder can be specified when configuring MWI (Message-waiting indicator) on the subscriber’s phone.
In this case the phone will subscribe, and the server will notify the phone when new messages arrive in the corresponding voicemail box.

To listen to voice messages, call the voicemail box management service number with the mailbox number appended.
If there are unread messages, they are played sequentially. After a message is played, it is automatically moved to the read messages category.
If there are no new messages, the service offers to play old (previously listened to) messages.
During message playback, the service can be controlled by sending DTMF signals:
2 - go to listened messages (only when playing new messages);
4 - play the previous message;
5 - replay the current message;
6 - go to the next message;
8 - delete the current message;
9 - clear the box (separately for new messages and previously listened messages);
0 - call the subscriber who sent the message;
# - go to the beginning (when playing previously listened messages, check for new messages and go to their playback);
* - play the section management instructions.

The service is implemented using a built-in hidden IVR script with the predefined code voicemail, containing the 'Voicemail' and 'Playback' components.
The script uses audio files located in the :SYNC/common/voicemail directory.

The service can be customized by creating an IVR script with the code voicemail in the domain.
Each domain uses its own script; if absent, the parent domain or ancestor script; and if absent up to the master domain, the built-in hidden script.

To restrict access to other users' boxes, 3 schemes are available:
* Restriction by call routing rules that distinguish fromnumber and extension. Configuration examples for the voicemail management service number '92':
to_number ⇒ '*92{F}' - match against the dialed number.
fromnumber ⇒ '{tab:a}', tonumber ⇒ '*92{tab:a}', in table 'a' ⇒ /reg/^.
$ - match parts of numbers from two fields.
* fromnumber ⇒ '{tab:a}', tonumber ⇒ '*92{tab:b}', in table 'a' ⇒ /reg/%.$, 'b' ⇒ '/tab/a' - match parts of numbers from two fields;
* Organizing box management through a custom script with flexible filters and access rules.
* Creating individual routing rules for box numbers (not optimal for a large number of boxes).
In any case, it is recommended to assign users voicemail boxes matching their personal numbers.

"voicemail_send"

Recording and sending a voice message.
The voicemail box number is calculated as the remainder. The 'extension' field is not used.
Calling the number without appending the box number is not serviced, and a notification is played.

To send a voice message, call the voice message sending service number with the recipient’s mailbox number appended.
After the sound signal, dictate the message. Recording can be interrupted by sending any DTMF signal or by waiting for automatic completion by the silence analyzer (3 seconds).

The service is implemented using a built-in hidden IVR script with the predefined code voicemail_send, containing the 'Voicemail' and 'Playback' components.
The script uses audio files located in the :SYNC/common/voicemail directory.

The service can be customized by creating an IVR script with the code voicemail_send in the domain.
Each domain uses its own script; if absent, the parent domain or ancestor script; and if absent up to the master domain, the built-in hidden script.

"parking_put"

Placing a call on parking.
The parking slot number is calculated as the remainder. The 'extension' field is not used.
If the parking slot number is not passed as a number remainder, or the parking slot is occupied, the service offers to enter the parking slot number using DTMF.

To park a subscriber, put the call on hold and call the parking service number with the parking slot number appended.
Wait for confirmation that the call is parked, then perform a transfer by replacement.

The service is implemented using built-in hidden IVR scripts with the predefined codes parking_put and parking_wait, containing the 'Parking' and 'Playback' components.
The 'parking_put' script determines the parking slot number and places the call on parking, then passes control to the parking_wait script, which plays hold music.
The scripts use audio files located in the :SYNC/common/parking directory.

The service can be customized by creating an IVR script with the corresponding code in the domain.
For example, to replace the hold music, it is enough to create an IVR script with the code parking_wait in the domain.
Each domain uses its own script; if absent, the parent domain or ancestor script; and if absent up to the master domain, the built-in hidden script.

"parking_get"

Retrieving a call from parking.
The parking slot number is calculated as the remainder. The 'extension' field is not used.
If the parking slot number is not passed as a number remainder, or the parking slot is occupied, the service offers to enter the parking slot number using DTMF.

To retrieve a subscriber from parking, call the parking retrieval service number with the parking slot number appended.
If a call waiting in parking is successfully discovered, the call is automatically transferred to the waiting subscriber.

The service is implemented using a built-in hidden IVR script with the predefined code parking_get.
The scripts use audio files located in the :SYNC/common/parking directory.

The service can be customized by creating an IVR script with the code parking_get in the domain.
Each domain uses its own script; if absent, the parent domain or ancestor script; and if absent up to the master domain, the built-in hidden script.

"intercom"

Calling a subscriber in intercom mode (task #127).
The target number is taken from the 'extension' field, or, if absent, calculated as the remainder. Then a new routing iteration is initiated.
In intercom mode, only calls according to rules with action = inside and insidepbx are allowed.
If forwarding is reached, the call is blocked immediately to avoid surprises.

"barge"

Barge-in to a busy subscriber (task #141).
The target number is taken from the 'extension' field, or, if absent, calculated as the remainder. Then a new routing iteration is initiated.
If the target subscriber is in a conversation state, an intercom call occurs (as a consequence, the current conversation is automatically put on hold); if the target subscriber is free, a regular call occurs.
If the device has intercom priority configured, the current call is put on hold and the barge-in call becomes active.
Unlike the 'intercom' subscriber feature code, when the called subscriber is free, an intercom call is not used.

"callwaiting"

Routing to the subscriber’s personal number without applying their limit on the number of simultaneous calls.
The subscriber number is taken as the remainder. The 'extension' field is not used.

"replace"

Leg replacement (task #163).
Initiates routing to the specified number with a Replaces header added to the INVITE for replacement.
The 'extension' field contains a comma-separated list of strategies for discovering the replaced call and leg:
* num - the dialog is searched by subscriber number as one of the subscriber’s active conversations. The number is taken as the remainder (extension). The subscriber account is calculated by the number (through routing without forwarding), and an active conversation is discovered for the subscriber.
* callid - the dialog is searched by the callid of the active call/leg (an alternative to searching by number). The callid value can be specified as a number extension (including base64 encoding), or in the Replaces or X-Era-Dest-Call-Id header.
* base64 - the CallID value is specified in base64 encoding.
* opposite - the other leg of the discovered dialog is taken as the replaced one, rather than the specified subscriber/leg.
* allsites - the conversation is searched on all system sites. Otherwise only on the current site.

"monitor"

Monitoring. Connecting to an existing conversation in listen-only mode: the initiator hears both subscribers, and none of the conversation participants hears them.
All subscribers connected to monitoring one conversation hear each other. They also hear the hold music of the original conversation.
The 'extension' field contains a comma-separated list of strategies for discovering the replaced call and leg:
* num - the dialog is searched by subscriber number as one of the subscriber’s active conversations. The number is taken as the remainder (extension). The subscriber account is calculated by the number (through routing without forwarding), and an active conversation is discovered for the subscriber.
* callid - the dialog is searched by the callid of the active call/leg (an alternative to searching by number). The callid value can be specified as a number extension (including base64 encoding), or in the X-Era-Dest-Call-Id header.
* base64 - the CallID value is specified in base64 encoding.
* allsites - the conversation is searched on all system sites. Otherwise only on the current site.
IMPORTANT! The ability to connect to a conversation is determined by the routing table: access to the subscriber function number. The availability of the subscriber number for a call is not a criterion for the right to connect.

"prompt"

Whisper. Connecting to an existing conversation in whisper mode: the initiator hears both subscribers, and only one conversation participant (the whispered-to party) hears them.
All subscribers connected to monitoring one conversation hear each other. They also hear the hold music of the original conversation.
The 'extension' field contains a comma-separated list of strategies for discovering the replaced call and leg:
* num - the dialog is searched by subscriber number as one of the subscriber’s active conversations. The number is taken as the remainder (extension). The subscriber account is calculated by the number (through routing without forwarding), and an active conversation is discovered for the subscriber.
* callid - the dialog is searched by the callid of the active call/leg (an alternative to searching by number). The callid value can be specified as a number extension (including base64 encoding), or in the X-Era-Dest-Call-Id header.
* base64 - the CallID value is specified in base64 encoding.
* opposite - the other leg of the discovered dialog is taken as the whispered-to subscriber, rather than the specified subscriber/leg.
* allsites - the conversation is searched on all system sites. Otherwise only on the current site.
IMPORTANT! The ability to connect to a conversation is determined by the routing table: access to the subscriber function number. The availability of the subscriber number for a call is not a criterion for the right to connect.

"mesh"

Connecting to an existing conversation in conference mode: the initiator hears both subscribers, and both conversation participants hear them.
All subscribers connected to monitoring one conversation hear each other. They also hear the hold music of the original conversation.
The 'extension' field contains a comma-separated list of strategies for discovering the replaced call and leg:
* num - the dialog is searched by subscriber number as one of the subscriber’s active conversations. The number is taken as the remainder (extension). The subscriber account is calculated by the number (through routing without forwarding), and an active conversation is discovered for the subscriber.
* callid - the dialog is searched by the callid of the active call/leg (an alternative to searching by number). The callid value can be specified as a number extension (including base64 encoding), or in the X-Era-Dest-Call-Id header.
* base64 - the CallID value is specified in base64 encoding.
* allsites - the conversation is searched on all system sites. Otherwise only on the current site.
IMPORTANT! The ability to connect to a conversation is determined by the routing table: access to the subscriber function number. The availability of the subscriber number for a call is not a criterion for the right to connect.

"fax_to_email"

Receiving a fax and sending it to email.
Effectively routing to the fax receiving and email sending service implemented in IVR, which can be replaced within the domain.
The list of recipient mailboxes and sender parameters are specified in domain settings in the fax_to_email parameter.

Additional options for the 'replace' SFC type

Table 3. Additional options for the 'replace' SFC type
Value Description

"num"

The dialog is discovered by the subscriber who owns the dialed number

"callid"

The dialog is discovered by CallId, which is calculated similarly to the number as the remainder after cutting off the SFC number. If the value is empty, the content of the X-R-Replaces-Call-Id header of the INVITE request is analyzed.

"opposite"

Flag for replacing the opposite leg relative to the one found by the specified number/CallId

"allsites"

Flag for searching the call on all sites

"base64"

Flag indicating the CallId from username is Base64-encoded

See also

Logical roles

  • b2b performs routing and SFC application.

  • mdc and sdc search for SFCs.