Skip to main content

Post Flash Call – Webhook

The Flash Call Webhook endpoint allows you to receive and process status updates for previously initiated flash calls. This endpoint enables your system to be notified when a flash call has been completed successfully or has failed.

Configure the API Endpoint​

https://api.betatel.com/api/v1/connect-hub/call/flash/webhook
  • Method: POST

Set Up the Headers​

ParamValueDescription
Content-typeapplication/jsonSpecifies the payload format.
x-api-key{{x-api-key}}API key for authorization.
x-account-id{{x-account-id}}User identifier for added security and tracking.

Craft the Request Body​

Design the JSON payload to include the flash call UUID and the status of the verification process.

Example of body
{
"uuid": "01JV5V54KPYK9GB29265EQRZ2P",
"status": "Success"
}
FieldTypeRequiredDescription
uuidstringYesThe unique identifier of the flash call received in the initial response.
statusstringYesThe status of the flash call. Allowed values: Success, Failed, Incomplete, WrongNumber.

Code Snippets​

Example - cURL
curl --location 'https://api.betatel.com/api/v1/connect-hub/call/flash/webhook' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'x-account-id: YOUR_ACCOUNT_ID' \
--data '{
"uuid":"01JV5V54KPYK9GB29265EQRZ2P",
"status":"Success"
}'

Understanding the Response​

Once the API processes your request, it returns a response containing the unique identifier, status, and a message indicating the result of the webhook processing.

JSON Schema:

{
"uuid": "01JV5V54KPYK9GB29265EQRZ2P",
"status": "Success",
"message": "OK"
}
  • uuid: The unique identifier for the flash call.
  • status: The status of the flash call ("Success" or "Failed").
  • message: Indicates the result of the webhook processing.

Error Handling​

  • 400 - Bad Request: Invalid parameters or malformed request
  • 401 - Unauthorized: Authentication failed
  • 404 - Not Found: The specified flash call UUID does not exist
  • 500 - Internal Server Error: An unexpected error occurred on the server