Flash Calling API

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.

POST

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

Create a new channel flash call

Payload permintaan

from

string

wajib

ringTimeout

integer

Payload respons

string

wajib

channelId

string

wajib

from

string

wajib

string

wajib

status

string

wajib

Possible values: accepted, starting, ringing, ongoing, completed, busy, no-answer, failed, cancelled, scheduled

ringTimeout

integer

attemptPrice

object

Tampilkan atribut turunan

attemptPrice.amount

integer

attemptPrice.exponent

integer

attemptPrice.currency

string

connectionPrice

object

Tampilkan atribut turunan

connectionPrice.amount

integer

connectionPrice.exponent

integer

connectionPrice.currency

string

reason

string

duration

integer

createdAt

string

wajib

updatedAt

string

wajib

ringingAt

string

answeredAt

string

endedAt

string

Contoh kode

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/flashcalls' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

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.

POST

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

Completes the channel flash call

Payload permintaan

receivedCli

string

result

string

wajib

Possible values: unknown, verified, canceled, timeout, wrong_cli

Payload respons

receivedCli

string

result

string

wajib

Possible values: unknown, verified, canceled, timeout, wrong_cli

Contoh kode

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/flashcalls/{callId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

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

POST

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

Completes the channel flash call

Payload permintaan

receivedCli

string

result

string

wajib

Possible values: unknown, verified, canceled, timeout, wrong_cli

Payload respons

receivedCli

string

result

string

wajib

Possible values: unknown, verified, canceled, timeout, wrong_cli

Contoh kode

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'