VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Phone DID Management → Add Did

AI-generated

Summary

Add a new Direct Inward Dialing (DID) number to VICIdial's management system.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion); Example: https://example.com
  • function (required) — API function name (auto-filled); defaults to 'add_did'.
  • user — User credential from VICIdial.
  • pass — Password credential from VICIdial.
  • source — Source defined in the VICIdial credential.
  • did_pattern (required) — The DID number pattern to be added.
  • did_description — Description for the DID number.
  • active — Sets whether the DID is active or not; defaults to 'Y'.
  • did_route — The routing type for the DID; defaults to 'EXTEN'.
  • record_call — Indicates if the calls should be recorded; defaults to 'Y'.
  • extension — The extension number associated with the DID.
  • group — The group associated with the DID.
  • menu_id — Optional menu ID for routing.
  • server_ip — Server IP address.
  • requestOptions — Collection of request options including batching.

Output shape

no body — success/failure only

Response may contain success or failure status, depending on the operation result.

Discussion