VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Phone DID Management → Add Fpg Phone

AI-generated

Summary

Add a new Fpg phone number to the VICIdial system.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion) for API requests.
  • function (required) — API function name to execute, which is 'add_fpg_phone'.
  • user — Username from the VICIdial credential.
  • pass — Password from the VICIdial credential.
  • source — Source identifier from the VICIdial credential.
  • phone_number (required) — The phone number to be added (must be 6-16 digits).
  • group (required) — The group identifier associated with the phone.
  • requestOptions — Additional options for the request, including batching, SSL settings, and timeout.

Output shape

no body — success/failure only

A successful execution will return a success or failure response but no additional data.

Examples

Example 1: Add a new Fpg phone number to the VICIdial system for a given group.

Base URL: 'https://example.com', Phone Number: '123456', Group: 'Sales'.

Discussion