Node-Red - Zenitel Action Nodes
From Zenitel Wiki
The Action nodes are used to perform operations on Zenitel Connect Pro. The information sent to Zenitel Connect Pro can be configured either statically in the node’s properties window or supplied dynamically by sending a msg.payload with the required data. A combination of static and dynamic values is also possible—for example, the audio message number can be set statically in the properties window, while the device directory number is provided dynamically through msg.payload.
If both static and dynamic values are present, the information in the properties window takes precedence over the msg.payload. The response from Zenitel Connect Pro, indicating the result of the action, is emitted through the node’s output.
Call Setup
Functional Description
With the Call Setup node a call can be setup between two devices.
Properties Window
 |
| Call Setup node |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Call setup node should connect to (e.g. 10.9.8.7:8086)
- From Dirno: This is the directory number where the call should originate from.
- To Dirno: This is the directory number of the receiving device.
- Priority: This is the priority for the call.
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"from_dirno": "101", "to_dirno": "102", "priority": 40
}
The items correspond with the fields in the properties window as follows:
- from_dirno - From Dirno
- to_dirno - To Dirno
- priority - Priority
Output Message
If the call setup is successful the output message is just an empty message.
Play Audio Message
Functional Description
With the Play Audio Message node an audio message can be played directly to a device.
Properties Window
 |
| Play Audio message node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Play audio message node should connect to (e.g. 10.9.8.7:8086)
- Audio message: This is the directory number of the audio message
- To Dirno: This is the directory number of the device where the audio message should be played
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"from_dirno": "101", "to_dirno": "102"
}
The items follow the fields in the properties window as follows:
- from_dirno - Audio message
- to_dirno - To Dirno
Output Message
If the audio message setup is successful the output message is just an empty message.
Door Opener
Functional Description
With the Door Opener node a door open action can be performed during an active call.
Properties Window
 |
| Door opener node nproperties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Door opener node should connect to (e.g. 10.9.8.7:8086)
- Door Dirno: This is the directory number of the operator station triggering the door opening on the other device in the call.
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"from_dirno": "101"
}
The items follow the fields in the properties window as follows:
- from_dirno - Door Dirno
Output Message
{
"from_dirno": "101"
}
The output message contains an echo of the directory number used.
GPO Trigger
Functional Description
With the GPO Trigger node any of the general purpose outputs on a device can be triggered.
Properties Window
 |
| GPO trigger node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the GPO trigger node should connect to (e.g. 10.9.8.7:8086)
- Dirno. This is the directory number where the GPO should be triggered on.
- Output. This is a drop down menu with the option to select the output
- Action. This is a drop down menu with the possible actions Set (On), Clear (Off), Set timed, Slow blink, and Fast blink
- On Time. Is the time the output is turned on if the Action is chosen to be Set Timed
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "204", "id": "relay1", "operation": "set_timed", "time": 3
}
The items follow the fields in the properties window as follows:
- dirno - Dirno
- id - Output
- operation - Action
- time - On Time
Output Message
The GPO trigger node reponds with an empty message if the command was successful.
Key Press
Functional Description
With the Key Press node a key press can be simulated on a device. The actions that can be performed are Press, Release and Tap. A tap is a press and release in a single command. For all keys except the M-key the press and tap behave the same, for the m-key you have to follow the press command with a release command.
Properties Window
 |
| Key press node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Key press node should connect to (e.g. 10.9.8.7:8086).
- Dirno: This is the directory number where the button press should be simulated.
- Button: This is a dropdown with possible buttons.
- Action: This is a dropdown with how the options for Press, Release, and Tap.
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno":"201", "id": "p1", "edge": "press"
}
The items follow the fields in the properties window as follows:
- dirno - Dirno
- id - Button
- edge - Action
Output Message
{
"action":"tap", "dirno":"202", "edge":"tap", "id":"p2", "rpc_uri":"com.zenitel.device.key.post"
}
Zenitel Connect Pro responds with the message shown above. The fields have the following meaning:
- action: The action as send to Zenitel Connect Pro.
- dirno: The directory number the key press simulation was performed on.
- edge: The action performed by Zenitel Connect Pro.
- id: the Identification of the button.
- rpc_uri: The called WAMP URI.
Setup Call Forwarding
Functional Description
With the Setup Call Forwarding node a call forwarding rule can be setup for a device. If a rule already exists it is updated, if the rule is new it is created. The rule can also be enabled or disabled.
Properties Window
 |
| Setup Call Forwarding node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Setup Call forwarding node should connect to (e.g. 10.9.8.7:8086).
- Dirno - This is the directory number where the call forwarding should should be set up on.
- To Dirno - This is the directory number where to forward to.
- Rule - This is a dropdown menu with to pick between the rules for Unconditional, Busy, and Timeout.
- Enable - To enable or disable the rule.
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "101", "fwd_type": "unconditional", "fwd_to": "300", "enabled": true }
The items follow the fields in the properties window as follows:
- dirno - Dirno
- fwd_type - Rule and can be unconditional, busy or timeout.
- fwd_to - To Dirno
- enabled - Enable
Output Message
When successful Zenitel Connect Pro will return a summary of how many errors there were and how many have been updated.
{
"error_cnt": 0, "update_cnt": 1, "errors": [ null ]
}
Zenitel Connect Pro responds with counts of the amounts of errors and updated forwarding rules. If there are erros they are described in the errors array.
Button Test
Functional Description
With the Button Test node a button test can be activated on a single device or group of devices. The result can be received with the Extended state node.
Properties Window
 |
| Button test node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Button test node should connect to (e.g. 10.9.8.7:8086)
- Dirno: This is the directory number where the button test should be performed on. This can both be a single device or a groupnumber.
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "700"
}
The items follow the fields in the properties window as follows:
- dirno - Dirno
Output Message
The Button test responds with an empty message as all responses are expected to be received on the extended state node.
Tone Test
Functional Description
With the Button Test node a tone test can be activated on a single device or group of devices. The result can be received with the Extended state node.
Properties Window
 |
| Tone test node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Tone test node should connect to (e.g. 10.9.8.7:8086)
- Dirno: This is the directory number where the tone test should be performed on. This can both be a single device or a groupnumber.
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "700"
}
The items follow the fields in the properties window as follows:
- dirno - Dirno
Output Message
The Tone test responds with an empty message as all responses are expected to be received on the extended state node.
Call End
Functional Description
With the Call End node an ongoing call on a device can be ended.
Properties Window
 |
| Call End node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Call end node should connect to (e.g. 10.9.8.7:8086)
- Dirno: This is the directory number where the call should be terminated
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "1001",
}
The items follow the fields in the properties window as follows:
- dirno - Dirno
Output Message
{
"call_id": 12345
}
Zenitel Connect Pro responds with the call_id. This is the internal used id of the call that has been terminated.
Audio Message End
Functional Description
This Audio message end node is used to terminate an ongoing audio message. When an audio message with repetitions set to zero is triggered with the play audio message node it will play on an endless loop. The audio message end node is needed to end that loop.
Properties Window
 |
| Audio Message End node properties window |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Audio message end node should connect to (e.g. 10.9.8.7:8086)
- Audio message - This is the directory number of the audio message that should be terminated
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "1001",
}
The items follow the fields in the properties window as follows:
- dirno - Audio message
Output Message
{
"call_id": 12345
}
Zenitel Connect Pro responds with the call_id. This is the internal used id of the audio message call that has been terminated.
Delete Call Forwarding
Functional Description
With the Delete Call Forwarding node an existing forwarding rule for a station can be deleted.
Properties Window
 |
| Call Setup node |
This node as the following properties:
- ZCP Link: The IP address and port number of the ZCP that the Delete Call forwarding node should connect to (e.g. 10.9.8.7:8086)
- Dirno: This is the directory number where the call forwarding will be deleted
- Rule: This is a drop down menu with the options for All, Unconditional, Busy, or Time out
- Name: Any descriptive name.
Input Message
Below is an example of the msg.payload JSON object.
{
"dirno": "1001", "fwd_type": "unconditional",
}
The items follow the fields in the properties window as follows:
- dirno - Dirno
- fwd_type - Rule
Output Message
{
"delete_cnt": 1
}
If successful Zenitel Connect Pro will return a count of how many rules have been deleted.
Zenitel WAMP Out
The WAMP Out node is a more generic node and has no filter options. It only provides a drop down menu with all the options for the different URI's available in the Zenitel Connect Pro WAMP API. Some of these options do not have dedicated nodes as described above as they are less used and only for very specific cases.
 |
| WAMP Out node properties window |
When using this node refer to the swagger page of your Zenitel Connect Pro to find documentation on the URI.