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 a new channel flash call
The ID of the workspace
The ID for a channel
30
POST /workspaces/{workspaceId}/channels/{channelId}/flashcalls HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"from": "text",
"to": "text",
"ringTimeout": 30
}
{
"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-07-10T01:53:18.072Z",
"updatedAt": "2025-07-10T01:53:18.072Z",
"ringingAt": "2025-07-10T01:53:18.072Z",
"answeredAt": "2025-07-10T01:53:18.072Z",
"endedAt": "2025-07-10T01:53:18.072Z"
}
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.
Completes the channel flash call
The ID of the workspace
The ID for a channel
The ID for a call
POST /workspaces/{workspaceId}/channels/{channelId}/flashcalls/{callId} HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"receivedCli": "text",
"result": "unknown"
}
{
"receivedCli": "text",
"result": "unknown"
}
User can also chose to hangup calls, using a combination of From and To numbers:
Completes the channel flash call
The ID of the workspace
The ID for a channel
POST /workspaces/{workspaceId}/channels/{channelId}/flashcalls/hangup HTTP/1.1
Host:
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"receivedCli": "text",
"result": "unknown"
}
{
"receivedCli": "text",
"result": "unknown"
}
Last updated
Was this helpful?