Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

A Campaign Agent is a reusable bundle of webhook configuration — the Answer URL, the Hangup URL, and any static SIP headers — that one or more campaigns share. Create the agent once and you can launch a hundred campaigns against it without re‑typing those URLs.
URL
https://console.vobiz.ai/app/campaigns/agents

​
The Agents list

Campaign Agents page subtitled Reusable webhook configurations shared across campaigns, showing two agent cards (API Test Agent 2 and test) each listing the Answer URL with POST method badge, the Hangup URL or Not configured, and Static SIP Headers (None for both)
Each Agent card shows:
SectionWhat it contains
HeaderFriendly name (e.g. API Test Agent 2) and the creation date.
AnswerThe URL Vobiz POSTs (or GETs) when a campaign call connects — your server’s IVR / AI flow lives here.
HangupWhere Vobiz POSTs the final call result. Shown as Not configured if you skipped it.
Static SIP HeadersCustom headers Vobiz attaches to every campaign call placed through this agent (none by default).
The pencil/trash icons on each card let you edit or delete the Agent. Deleting an Agent only succeeds if no active campaigns reference it — pause those campaigns first.

​
Create a new Agent

Click + New Agent in the top‑right.
New Agent side panel with fields for Name (filled in with Appointment Reminder Agent), Answer URL with POST method dropdown, Hangup URL with POST method dropdown, and a Static SIP Headers section with an Add header link, plus Cancel and orange Create Agent buttons at the bottom
FieldRequiredNotes
Name✅Something descriptive — “Appointment Reminder Agent”, “Q4 Survey Bot”. You’ll pick this from a dropdown when creating campaigns.
Answer URL✅Method (POST recommended) + URL. Vobiz hits this when a campaign call is answered. Same XML conventions as a normal XML application.
Hangup URL–Optional. Vobiz POSTs the call result here when the call ends. Recommended in production — most analytics depend on it.
Static SIP Headers–Click + Add header to attach key/value pairs that Vobiz sends with every outgoing INVITE. Use for tagging traffic (X-Campaign-Source: q4-reminders) or routing hints.
Click Create Agent.

​
Static SIP Headers — when to use them

The headers you add here are attached to every INVITE Vobiz sends on behalf of campaigns that use this agent. Common patterns:
  • X-Campaign-Source — tag for your downstream PBX or CRM to know the source.
  • P-Asserted-Identity — carrier‑specific identity routing (check with your trunk provider first).
  • X-RingTime — pass a max ring time hint to the receiving system.
Static headers apply to every call from every campaign that uses this agent. If you need per‑call values, set them in your Answer URL XML response with <SipHeader> instead.

​
Use the Agent in a campaign

Open Campaigns → + New Campaign — the Agent dropdown lists every agent on your account. Pick the one you just made and the rest of the form takes over from there.

​
What’s next

Launch a campaign

Wire this agent into a real outbound run.

XML reference

The XML your Answer URL should return.