Place a test outbound call and hang up when accepted

This endpoint documentation is generated directly from openapi.yaml.

Endpoint

POST /bird/voice/calls/test-outbound

Operation

Operation ID: birdTestOutboundVoiceCall

Calls +45 42 33 11 28 and hangs up when the call reaches accepted/ongoing state.

Authentication

Security requirements:

Scheme	Scopes
BearerAuth	-

Parameters

Name	In	Required	Type	Description
workspaceId	query	no	string	Bird Workspace identifier (falls back to module configuration if omitted)
channelId	query	no	string	Bird Channel identifier (falls back to module configuration if omitted)

Request Body

Required: no.

Content type: application/json

{
  "additionalProperties": true,
  "properties": {
    "from": {
      "description": "Caller E.164 number to use for the test call",
      "example": "+4599988877",
      "type": "string"
    },
    "hangupCause": {
      "description": "Optional hangup cause passed through to Bird",
      "type": "string"
    },
    "maxPollSeconds": {
      "description": "Max time to wait before timing out",
      "example": 30,
      "minimum": 5,
      "type": "integer"
    },
    "pollIntervalSeconds": {
      "description": "Poll interval while waiting for accepted status",
      "example": 2,
      "minimum": 1,
      "type": "integer"
    }
  },
  "type": "object"
}
        

Responses

Status	Description	Content Types
200	Test call created and either hung up or timed out	application/json

Schema for response 200 (application/json):

{
  "$ref": "#/components/schemas/BirdTestOutboundCallResponse"
}
        

17 March 2026