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

Create a new channel flash call

post

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

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

channelIdstring · uuidrequired

The ID for a channel

Query parameters

pricingstring · enum[]

Pricing to include in the request

Body

fromstring

tostringrequired

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

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/flashcalls' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "from": "text",
    "to": "text",
    "ringTimeout": 30
  }'

202

400

404

422

202

{
  "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-03-08T22:18:23.434Z",
  "updatedAt": "2025-03-08T22:18:23.434Z",
  "ringingAt": "2025-03-08T22:18:23.434Z",
  "answeredAt": "2025-03-08T22:18:23.434Z",
  "endedAt": "2025-03-08T22:18:23.434Z"
}

Flash Call was accepted for processing

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

Completes the channel flash call

post

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

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

channelIdstring · uuidrequired

The ID for a channel

callIdstring · uuidrequired

The ID for a call

Body

receivedClistring

resultstring · enumrequired

Options: unknown, verified, canceled, timeout, wrong_cli

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/flashcalls/{callId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "receivedCli": "text",
    "result": "unknown"
  }'

202

400

404

422

202

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

Hangup Flash Call was accepted for processing

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

End flash call

Completes the channel flash call

post

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

Authorizations

useraccessKey

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

channelIdstring · uuidrequired

The ID for a channel

Body

any of

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "receivedCli": "text",
    "result": "unknown"
  }'

202

400

404

422

202

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

Hangup Flash Call was accepted for processing