Callflow Dynamic CID

About Dynamic CID

The Dynamic CID callflow enables you to dynamically change the Caller ID (CID). There are different methods for doing that:

manual: dial the new Caller ID on the keypad when prompted, this way you can set the Caller ID number only. This works with and without a capture group
list: setting Caller ID name and number based on the configuration on the specified document in the database. This requires a capture group
lists: almost the same as list mode but you can use account’s lists feature to configure entries
static set the caller id to a value in a caller_id.name and caller_id.number property in the data object. This works with and without a capture group

Callflow fields

Schema

Validator for the dynamic_cid callflow data object

Key	Description	Type	Default	Required	Support Level
`action`	What action to perform	`string(‘list'	'lists'	'manual'	'static’)`
`caller_id.name`	Caller ID Name	`string()`		`false`
`caller_id.number`	Caller ID Number	`string()`		`false`
`caller_id`	Static Caller ID settings	`object()`		`false`
`enforce_call_restriction`	Check classification restrictions against endpoint	`boolean()`	`true`	`false`
`id`	List ID for caller IDs when ‘action’ is ‘list’	`string()`		`false`
`idx_name`	Named capture group to use	`string()`		`false`
`interdigit_timeout`	How long, in seconds, to wait for keypresses	`integer()`		`false`
`max_digits`	Max number of digits allowed when collecting Caller ID Number	`integer()`		`false`
`media_id`	Prompt to play to caller to enter Caller ID Number	`string()`		`false`
`min_digits`	Minimum number of digits that must match the regex to collected DTMF	`integer()`		`false`
`permit_custom_callflow`	Permit a custom callflow to be accepted instead of restricting to no_match only when looking up callflows	`boolean()`	`false`	`false`
`skip_module`	When set to true this callflow action is skipped, advancing to the wildcard branch (if any)	`boolean()`		`false`
`whitelist_regex`	Regex to match collected Caller ID Number	`string()`		`false`

Manual action mode

In this method user is prompted to dial a new Caller ID number. The length of the dialed new Caller ID is checked to be in the default(or configured) boundary and it is also matched against the default(or configured) regex, if these checks are passed the call will proceed.

Notes You can only set the Caller ID number with this method.

Example Scenario

User dial *212223332222 (assuming you set the feature code to *2 by setting callflow patterns to "^\\*2([0-9]{2,})$") and prompted to dial the new Caller ID number, then the call will send onto real destination which in this case is 12223332222.

Manual callflow settings

You may want to customize manual behavior in system_configs/callflow.dynamic_cid.

Schema

Schema for callflow.dynamic_cid system_config

Key	Description	Type	Default	Required
`accept_prompt`	callflow.dynamic_cid accept prompt	`string()`	`tone_stream://%(250,50,440)`	`false`
`default_prompt`	callflow.dynamic_cid default prompt	`string()`	`dynamic-cid-enter_cid`	`false`
`max_digits`	callflow.dynamic_cid max digits	`integer()`	`10`	`false`
`min_digits`	callflow.dynamic_cid min digits	`integer()`	`10`	`false`
`reject_prompt`	callflow.dynamic_cid reject prompt	`string()`	`dynamic-cid-invalid_using_default`	`false`
`whitelist_regex`	callflow.dynamic_cid whitelist regex	`string()`	`\d+`	`false`

List action mode

In this method you have flexibility to define multiple Caller ID, each assign to a specific number using account’s list. You can set both the Caller ID name and number in a document in database. This callflow’s module use that information to set new Caller ID. You can create your list and list’s entries using List Crossbar API.

This done by first getting group capture which populate by callflow automatically (feature code is removed from the beginning) then get a specific length of numbers starting from the beginning of the dialed number (by default 2 numbers). This number is it the key (or index) in a list of Caller ID entry list. For and example how this works, see the example section.

This behavior is exactly same as lists action, the only difference is that you can define the index of the matching number (entry index) in the callflow data in idx_name.

Notes You can set both the Caller ID number and name with this method.

List of contacts document fields

Schema

Schema for a list of contacts

Key	Description	Type	Default	Required
`capture_group.key`	The number which is used to select this contact, length should be same as `capture_group_length`	`string()`		`false`
`capture_group.length`	Length of the numbers in the contacts for which it used to select desire Caller ID	`integer()`		`false`
`capture_group`	The capture group information	`object()`	`{}`	`false`
`contacts`	A list of contact information	`array([#/definitions/contacts](#contacts))`		`true`
`favorite`	Whether the contact is a favorite	`boolean()`	`false`	`false`
`first_name`	The first name of the contact	`string()`		`true`
`history`	The history of contact usage	`array([#/definitions/history](#history))`	`[]`	`false`
`last_name`	The last name of the contact	`string()`		`false`
`organization.name`	The name of the organization	`string()`		`false`
`organization`	The organization this entity belongs to	`object()`	`{}`	`false`
`pattern`	Match pattern	`string()`		`false`
`tags.[]`		`string()`		`false`
`tags`	Tags that contact belong to	`array(string())`		`false`

contacts

Schema for a contact.

Key	Description	Type	Required
`contact`	The phone number or email associated with the contact (Ex: +14158867903, user@2600hz.com)	`string()`	`true`
`device_type`	The type of the device	`string('work', 'home', 'mobile', 'personal', 'fax')`	`false`
`email_type`	The type of the email	`string('work', 'home')`	`false`
`ext`	The extension of the user (Ex: 356, 622)	`string()`	`false`
`primary`	If this is the primary contact for this contact type.	`boolean()`	`true`
`type`	The type of this contact	`string('voice', 'email', 'sms')`	`true`

history

Schema for a history.

Key	Description	Type	Required
`contact`	The contact that was used	#/definitions/contacts	`true`
`notes`	Notes from the communication	`string()`	`false`
`timestamp`	The gregorian timestamp	`integer()`	`false`

Example 1: Two digits as CID selector

Consider that the user wants to call number 5149072508 using the caller id 16139999999. We assume that callflow patterns set as follow:

    "patterns": [
        "^\\*2([0-9]{2,})$"
    ]

and the list of contacts document is:

{
    "capture_group": {
            "key": "01",
            "length": 2
    },
    "contacts": [
            {
                "type": "voice",
                "contact": "19058888888",
                "primary": "true"
            }
    ],
    "first_name": "Awesome Inc."
}

These are the steps will happen if a user dial *2015149072508 in handset:

This pattern above means that *2 is the “feature code”. Callflow will use this module to handle the call
01 will be used to select the Caller ID with number “19058888888” and name “Awesome Inc.”. Consider that it’s length is 2 digits as specified in capture_group_length field
Selected CID will be set for the call
5149072508 becomes +15149072508 and gets dialed as such

Example 2: One digits as CID selector

Another example which uses number with length of 1 to select the Caller ID:

{
    "capture_group": {
            "key": "0",
            "length": 1
    },
    "contacts": [
            {
                "type": "voice",
                "contact": "16139999999",
                "primary": "true"
            }
    ],
    "first_name": "Awesome Co."
}

Dialing number *205149072508 will cause number “5149072508” gets dialed with CID number set to “16139999999” CID name to “Awesome Co.”.

Lists action mode

Almost the same as list mode using account’s lists feature to configure entries.

Static action mode

In this method the new Caller ID number and name would be set to caller_id value sets in the callflow Data object.

Example Callflow Data

{
    "data": {
        "action": "static",
        "caller_id": {
            "name": "CALL_ME",
            "number": "5555555555"
        }
    },
    "module": "dynamic_cid"
}

Permit Custom Callflow

The config parameter permit_custom_callflow is used in the lists action type case. When attempting to fetch the callflow, the default behavior is to reject any callflow returned which is not the no_match callflow. If a callflow is defined which matches the resultant destination number, this setting allows that callflow to be used, bypassing the no_match restriction.

Callflow Dynamic CID

About Dynamic CID

Callflow fields

Schema

Manual action mode

Example Scenario

Manual callflow settings

Schema

List action mode

List of contacts document fields

Schema

contacts

history

Example 1: Two digits as CID selector

Example 2: One digits as CID selector

Lists action mode

Static action mode

Example Callflow Data

Permit Custom Callflow

On this page