Skip to content

Call Management Api

The Call Management Api provides a simple interface for programmatically initiating and terminating outbound calls within the Buzzeasy platform. It is designed for developers who need to integrate call management capabilities — such as triggering calls from external systems or automating call workflows — directly into their own applications.

Authentication

All endpoints require a valid JWT Bearer token. Include it in the Authorization header of every request:

Authorization: Bearer <your_token>

Capabilities

The API exposes two operations:

MethodEndpointDescription
POST/sipconnector/api/v1/calls/initiateInitiate an outbound call to a specified phone number
DELETE/sipconnector/api/v1/calls/{conversationId}/dropDrop (terminate) an active call by its conversation ID

Initiating a call requires the unique identifier of the agent (agentId) a destination phone number (toNumber). At least one of channelId or agentWorkspaceId must also be provided to identify the channel used to place the call. The channelId can be omitted if the agent workspace has a default outbound channel configured.

Dropping a call terminates an active call identified by its conversationId. A 204 No Content response confirms the call was dropped; a 404 is returned if no matching call is found.

Swagger Reference