This document is for an older version of Kazoo (version 4.3) that is no longer supported. You should upgrade and read the current documentation.

Prepend CID

The cf_prepend_cid module can be used to prepend static values to the Caller ID Name and Number for a call in callflows.

Configuration Values

Schema

Validator for the prepend_cid callflow data object

KeyDescriptionTypeDefaultRequiredSupport Level
actionIf the action parameter is “reset” the caller-id-name and caller-id-number will be restored to their original values, if the value is “prepend” then the prepending will happen`string(‘reset''prepend’)`prependfalse
apply_toEither “original” or “current”, this specifies that the prefix’s should be applied to the current caller-id’s or the original values`string(‘original''current’)`currentfalse
caller_id_name_prefixThe prefix that should be applied to the caller-id-namestring()""false
caller_id_number_prefixThe prefix that should be applied to the caller-id-numberstring()""false
skip_moduleWhen set to true this callflow action is skipped, advancing to the wildcard branch (if any)boolean()false

Notes

  • After the callflow action is run, the original caller-id values will be stored in the original_cid_name and original_cid_number fields of the call.
  • When using “current” for the apply_to you can get into a situation where it will append the value multiple times if the callflow is included in a loop.

Example Configuration

"flow": {
    "data": {
        "action": "prepend",
        "caller_id_name_prefix": {PREFIX_NAME},
        "caller_id_number_prefix": {PREFIX_NUMBER},
        "apply_to": "original"
    },
    "module": "prepend_cid",
        "children": {
    }
}

On this page