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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

channelId*string (uuid)

The ID for a channel

Query parameters

Body

application/json

fromstring

to*string

ringTimeoutinteger

Response

202400404422

Flash Call was accepted for processing

Body

application/json

id*Id-2 (string (uuid))

channelId*ChannelId (string (uuid))

from*string

to*string

status*Status-4 (enum)

acceptedstartingringingongoingcompletedno-answerbusyfailedcancelledscheduled

ringTimeoutinteger

attemptPriceobject

connectionPriceobject

reasonstring

durationinteger

createdAt*string (date-time)

updatedAt*string (date-time)

ringingAtstring (date-time)

answeredAtstring (date-time)

endedAtstring (date-time)

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/flashcalls', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "to": "text"
    }),
});
const data = await response.json();

Response

202400404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channelId": "123e4567-e89b-12d3-a456-426614174000",
  "from": "text",
  "to": "text",
  "status": "accepted",
  "ringTimeout": 0,
  "attemptPrice": {
    "amount": 0,
    "exponent": 0,
    "currency": "text"
  },
  "connectionPrice": {
    "amount": 0,
    "exponent": 0,
    "currency": "text"
  },
  "reason": "text",
  "duration": 0,
  "createdAt": "2025-01-29T20:10:09.892Z",
  "updatedAt": "2025-01-29T20:10:09.892Z",
  "ringingAt": "2025-01-29T20:10:09.892Z",
  "answeredAt": "2025-01-29T20:10:09.892Z",
  "endedAt": "2025-01-29T20:10:09.892Z"
}

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}

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

channelId*string (uuid)

The ID for a channel

callId*string (uuid)

The ID for a call

Body

application/json

receivedClistring

result*enum

unknownverifiedcanceledtimeoutwrong_cli

Response

202400404422

Hangup Flash Call was accepted for processing

Body

application/json

receivedClistring

result*enum

unknownverifiedcanceledtimeoutwrong_cli

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/flashcalls/{callId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "result": "unknown"
    }),
});
const data = await response.json();

Response

202400404422

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

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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

channelId*string (uuid)

The ID for a channel

Body

application/json

HangupFlashCallFromTo (any of)

ChannelFlashCallHangupobject

Response

202400404422

Hangup Flash Call was accepted for processing

Body

application/json

HangupFlashCallFromTo (any of)

ChannelFlashCallHangupobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "result": "unknown"
    }),
});
const data = await response.json();

Response

202400404422

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