VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Other Operations → Add Group Alias

AI-generated

Summary

Add a group alias to VICIdial by sending the required parameters to the API endpoint.

Inputs

  • baseURL (required) — Base VICIdial URL (no trailing /vicidial portion) - e.g., https://example.com.
  • function (required) — API function name, auto-filled as 'add_group_alias'.
  • user — Credentials username for the VICIdial API.
  • pass — Credentials password for the VICIdial API.
  • source — Source information, defaults to the value defined in the VICIdial credential.
  • caller_id_number (required) — The caller ID number to associate with the group alias.
  • group_alias_id — The ID for the group alias, which can be left blank for new entries.
  • group_alias_name — The name of the group alias being added.
  • caller_id_name — The caller ID name associated with the group alias.
  • active — Status of the group alias, defaults to active (Y).
  • requestOptions — Collection of options for the request, including batching, SSL handling, and timeout.

Output shape

no body — success/failure only

The operation returns no body on success or failure. Ensure to handle credentials securely.

Discussion