Flash Calling API

The Flash Call API is used to initiate a flash call within a specific workspace and channel.

This API enables users to leverage flash calls for quick and efficient number validation or authentication processes.

This API initiates a call to the destination number. If the call is answered, it will be immediately terminated.

Create flash call

post

Create a new channel flash call

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

channelIdstring · uuidRequired

The ID for a channel

Query parameters

Body

application/json

fromstringOptional

tostringRequired

ringTimeoutinteger · min: 3 · max: 120OptionalDefault: 30

Responses

202

Flash Call was accepted for processing

application/json

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

post

/workspaces/{workspaceId}/channels/{channelId}/flashcalls

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/flashcalls HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "from": "text",
  "to": "text",
  "ringTimeout": 30
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "from": "text",
  "to": "text",
  "status": "accepted",
  "ringTimeout": 1,
  "attemptPrice": {
    "amount": 1,
    "exponent": 1,
    "currency": "text"
  },
  "connectionPrice": {
    "amount": 1,
    "exponent": 1,
    "currency": "text"
  },
  "reason": "text",
  "duration": 1,
  "createdAt": "2025-12-08T08:36:12.560Z",
  "updatedAt": "2025-12-08T08:36:12.560Z",
  "ringingAt": "2025-12-08T08:36:12.560Z",
  "answeredAt": "2025-12-08T08:36:12.560Z",
  "endedAt": "2025-12-08T08:36:12.560Z"
}

To terminate a flash call resource, or update the result of the verification, user can do a POST to a flash call resource, using this endpoint.

End flash call

post

Completes the channel flash call

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

channelIdstring · uuidRequired

The ID for a channel

callIdstring · uuidRequired

The ID for a call

Body

application/json

receivedClistringOptional

resultstring · enumRequiredPossible values:

Responses

202

Hangup Flash Call was accepted for processing

application/json

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

post

/workspaces/{workspaceId}/channels/{channelId}/flashcalls/{callId}

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/flashcalls/{callId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "receivedCli": "text",
  "result": "unknown"
}

{
  "receivedCli": "text",
  "result": "unknown"
}

User can also chose to hangup calls, using a combination of From and To numbers:

End flash call

post

Completes the channel flash call

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The ID of the workspace

channelIdstring · uuidRequired

The ID for a channel

Body

application/json

anyOptional

or

Responses

202

Hangup Flash Call was accepted for processing

application/json

Responseany of

or

400

The request did not pass validation

application/json

404

The request did not pass validation

application/json

422

The request did not pass validation

application/json

post

/workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "receivedCli": "text",
  "result": "unknown"
}

{
  "receivedCli": "text",
  "result": "unknown"
}