Caller ID

Replaces the name displayed on the phones called further on in the plan, with text, with variables, or with both at once.

In brief

How it works

The module writes the caller's displayed name. The text is used as is, {{variable}} entries are replaced by their value at the time it passes through, and line breaks as well as quotation marks are stripped. From that point on, any phone rung further along the path sees this name.

The caller's number, on the other hand, is not touched: only the name changes.

The module's position in the plan is what matters. Placed after Call or Queue, it changes nothing for what has already rung. Place it right before instead.

If its output is not connected to anything, the call is hung up on the spot, right after the name is set.

What to fill in

The field offers the list of variables available in the plan: the built-in variables, those set earlier by a Variable module or a DTMF entry, and those coming from Odoo or an API request. A variable unknown at this point is replaced with blank, without warning.

Steps

1. Place the Caller ID module right before the one that rings the phones, usually a Call or a Queue.
2. Connect the previous node to its input.
3. Open it and write your text in Free text, for example [Support] {{caller}}.
4. Do not leave the field empty: empty text clears the displayed name instead of leaving it as is.
5. If you use a variable, make sure the module that sets it is indeed placed before this one in the path.
6. Connect the output to the rest of the path.
7. Click Apply changes.
8. Call the number from a mobile and check what the rung phone shows before you answer.

If it doesn't work

The phone shows an empty name, or just the number. Free text is empty, or the variable it contains does not exist at this point in the plan: an unknown variable is replaced with blank, with no error message. Check its spelling and the position of the module that sets it.

The text changes nothing on the phone. The module is placed after the one that rings. It only acts on the rest of the path: move it up to right before the Call or the Queue.

The window shows a warning about an old option. This module still carries the "replace with the number called" option, which makes the text ineffective. The displayed name stays the number called until this option has been converted.

A variable is displayed as is, in braces, on the phone. The name written between braces does not match any variable set on this path: a typo, or a module that sets it placed after this one instead of before. Add a Debugging module right before to display the actual value, then read the debug log.

The call is hung up right after. The module's output is not connected to anything.