VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Phone DID Management → Update Phone

AI-generated

Summary

Update the configuration of a designated phone in VICIdial.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion).
  • function (required) — API function name (auto-filled).
  • 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 phone extension to update.
  • server_ip (required) — Server IP address.
  • dialplan_number — Dialplan number.
  • voicemail_id — Voicemail ID.
  • phone_login — Phone login.
  • phone_pass — Phone password.
  • protocol — Protocol used (IAX2, SIP, Zap, EXTERNAL).
  • phone_full_name — Full name of the phone.
  • outbound_cid — Outbound caller ID.
  • delete_phone — Flag to indicate whether to delete the phone (Y/N).
  • requestOptions — Optional settings for batch requests and SSL handling.

Output shape

no body — success/failure only

The operation updates a phone's configuration, returning no data on success.

Discussion