v1

latestOpenAPI 3.1.0MIT License2026-07-17121547.4 KB

Call Management

Initiate Outbound Call

Initiate a new outbound call to the specified phone number.

This endpoint:
- Validates the phone number format
- Generates a unique call ID
- Emits a call initiation event through the V1 event system
- Returns immediately with call status

The actual call establishment is handled asynchronously through Azure Communication Services.

post/api/v1/calls/initiate

Request body

target_numberstring required

Phone number to call in E.164 format (e.g., +1234567890)

caller_idstring nullable

Caller ID to display (optional, uses system default if not provided)

contextobject nullable

Additional call context metadata

Example request

{
  "caller_id": "+1987654321",
  "context": {
    "customer_id": "cust_12345",
    "department": "support"
  },
  "target_number": "+1234567890"
}

Response

Call initiation successful

call_idstring required

Unique call identifier

statusstring required

Current call status

target_numberstring required

Target phone number

messagestring required

Human-readable status message

Example response

{
  "call_id": "call_abc12345",
  "message": "Call initiation requested for +1234567890",
  "status": "initiating",
  "target_number": "+1234567890"
}