DocumentaciónEngagement Platform API
Sign inGet started
Guides
API

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
Cuerpo de la solicitud
from
string
to
string
obligatorio
ringTimeout
integer
Cuerpo de la respuesta
id
string
obligatorio
channelId
string
obligatorio
from
string
obligatorio
to
string
obligatorio
status
string
obligatorio
Possible values: accepted, starting, ringing, ongoing, completed, busy, no-answer, failed, cancelled, scheduled
ringTimeout
integer
attemptPrice
object
Mostrar atributos secundarios
attemptPrice.amount
integer
attemptPrice.exponent
integer
attemptPrice.currency
string
connectionPrice
object
Mostrar atributos secundarios
connectionPrice.amount
integer
connectionPrice.exponent
integer
connectionPrice.currency
string
reason
string
duration
integer
createdAt
string
obligatorio
updatedAt
string
obligatorio
ringingAt
string
answeredAt
string
endedAt
string
Ejemplo de código
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
Cuerpo de la solicitud
receivedCli
string
result
string
obligatorio
Possible values: unknown, verified, canceled, timeout, wrong_cli
Cuerpo de la respuesta
receivedCli
string
result
string
obligatorio
Possible values: unknown, verified, canceled, timeout, wrong_cli
Ejemplo de código
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
Cuerpo de la solicitud
receivedCli
string
result
string
obligatorio
Possible values: unknown, verified, canceled, timeout, wrong_cli
Cuerpo de la respuesta
receivedCli
string
result
string
obligatorio
Possible values: unknown, verified, canceled, timeout, wrong_cli
Ejemplo de código
curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'