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

Treść żądania

from

string

wymagane

ringTimeout

integer

Treść odpowiedzi

string

wymagane

channelId

string

wymagane

from

string

wymagane

string

wymagane

status

string

wymagane

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

ringTimeout

integer

attemptPrice

object

Pokaż atrybuty podrzędne

attemptPrice.amount

integer

attemptPrice.exponent

integer

attemptPrice.currency

string

connectionPrice

object

Pokaż atrybuty podrzędne

connectionPrice.amount

integer

connectionPrice.exponent

integer

connectionPrice.currency

string

reason

string

duration

integer

createdAt

string

wymagane

updatedAt

string

wymagane

ringingAt

string

answeredAt

string

endedAt

string

Przykład kodu

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

Treść żądania

receivedCli

string

result

string

wymagane

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

Treść odpowiedzi

receivedCli

string

result

string

wymagane

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

Przykład kodu

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

Treść żądania

receivedCli

string

result

string

wymagane

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

Treść odpowiedzi

receivedCli

string

result

string

wymagane

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

Przykład kodu

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