Voice Firewall API Guide

The Voice Firewall APIs let you programmatically manage call blocking across your Cisco infrastructure. All endpoints are documented in the API Reference — this guide covers the most common workflows to get you started.

Authentication

All requests require an API token in the Authorization header. See the Authentication Guide for setup.

curl -s https://your-server/api/org/1/... \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

API Endpoint Groups

API Group	Endpoints	Description
Global Block List	/api/org/{org_id}/blocklist	Centralized block list shared across all policies
Watch Lists	/api/org/{org_id}/watch-lists	Threshold-based monitoring for suspicious patterns
Watch List Violations	/api/org/{org_id}/watch-list-violations	Records of numbers exceeding watch list thresholds
TDoS Rules	/api/org/{org_id}/tdos-rules	Telecommunications Denial of Service rate limiting
End User Portal	/api/portal/blocklist	User self-service block lists (JWT auth)

For full request/response schemas, query parameters, and all available fields, see the API Reference.

Quick Start: Block a Number

The most common API operation — add a number to the global block list:

curl -s -X POST https://your-server/api/org/1/blocklist \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"calling_number": "5559876543", "description": "Robocaller"}'

Block with Auto-Expiration

Temporarily block a number (useful for aggressive but potentially legitimate callers):

curl -s -X POST https://your-server/api/org/1/blocklist \
  -H "Authorization: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "calling_number": "5559876543",
    "expires": true,
    "expires_datetime": "2026-03-01T00:00:00Z",
    "description": "Temporary block - review in 2 weeks"
  }'

Bulk Import via CSV

Import multiple numbers at once:

POST /api/org/{org_id}/blocklist/import

The CSV should contain calling_number and optionally called_number and description columns.

Related Resources

• Authentication Guide — API tokens and session auth
• API Reference — Complete auto-generated reference for all endpoints
• Global Block List — Web UI guide
• Watch Lists — Watch list configuration
• TDoS Protection — TDoS setup and thresholds