VICIdialInstall

Summary

Adds a new phone configuration in VICIdial's Phone DID Management system.

Inputs

• baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
• function (required) — API function name, set to 'add_phone'.
• user — Comes from the VICIdial credential.
• pass — Comes from the VICIdial credential.
• source — Defaults to the source defined in the VICIdial credential.
• extension (required) — The extension number for the phone.
• dialplan_number (required) — Number associated with the dial plan.
• voicemail_id (required) — ID for voicemail.
• phone_login (required) — Login name for the phone.
• phone_pass (required) — Password for the phone.
• server_ip (required) — Server IP address.
• protocol (required) — Protocol for the phone connection (options: IAX2, SIP, Zap, EXTERNAL).
• registration_password (required) — Registration password for the phone.
• phone_full_name (required) — Full name for the phone.
• outbound_cid (required) — Caller ID for outbound calls.
• local_gmt — Local GMT offset.
• phone_context — Context for the phone settings.
• email — Email associated with the phone.
• is_webphone — Indicates if it is a web phone (options: Y, N, Y_API_LAUNCH).
• template_id — ID for the template used.
• requestOptions — Options for the request handling.

Output shape

no body — success/failure only

Ensure that all required parameters are provided; otherwise, the operation will fail.

Examples

Example 1: Add a new phone with basic settings.

Set up with 'baseURL', 'extension', 'dialplan_number', etc.