When to use it
Use Register Call when:- Your telephony (PBX, SIP provider, contact-center platform) receives the call first.
- You decide per call which agent should answer and which variables it needs.
- You need one call ID shared between your system and BlackBox for the complete call lifecycle.
How it works
- Your telephony receives the inbound call.
- You register the call:
POST /api/v1/calls/register?agentId=…. - BlackBox creates the call record and returns
callIdandsipUri(sip:{callId}@sip-reg.blackbox.dasha.ai). - You store
callIdand bridge the live call tosipUri. - BlackBox recognizes the registered call and starts the agent with your variables.
- The result reaches the agent’s result webhook with the same
callId.
The registration stays valid until
callDeadline (default 10 minutes, maximum 24 hours). If the call is not bridged by then, it is canceled and reported through the result webhook with status: "Canceled".Register a call
Bridge the call
Point your telephony atsipUri. Any system that can transfer or bridge a live call to a SIP URI works.
- Twilio (TwiML)
- Asterisk
- FreeSWITCH
Receive the result
Configure a result webhook on the agent. The payload carries the samecallId, your additionalData as callAdditionalData, the transcript, the recording URL and callType: "InboundAudio".
Webhook Events
Complete webhook payload reference
Check a registered call
DELETE /api/v1/calls/{callId}.