const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpoint: '<string>',
additionalData: {},
priority: 1,
callDeadline: null,
timezone: null,
overrideOutboundConfig: {phoneNumber: null, credentialsId: null, displayName: null}
})
};
fetch('https://blackbox.dasha.ai/api/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://blackbox.dasha.ai/api/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endpoint": "<string>",
"additionalData": {},
"priority": 1,
"callDeadline": null,
"timezone": null,
"overrideOutboundConfig": {
"phoneNumber": null,
"credentialsId": null,
"displayName": null
}
}
'import requests
url = "https://blackbox.dasha.ai/api/v1/calls"
payload = {
"endpoint": "<string>",
"additionalData": {},
"priority": 1,
"callDeadline": None,
"timezone": None,
"overrideOutboundConfig": {
"phoneNumber": None,
"credentialsId": None,
"displayName": None
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"endpoint": "<string>",
"callId": "<string>",
"orgId": "<string>",
"agentId": "<string>",
"createdTime": "2023-11-07T05:31:56Z",
"status": "Unknown",
"nextScheduleTime": "2023-11-07T05:31:56Z",
"direction": "Outbound",
"additionalData": {},
"priority": 123,
"callDeadline": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"overrideOutboundConfig": {
"phoneNumber": null,
"credentialsId": null,
"displayName": null
},
"toNumber": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Create call
Schedules a new outbound voice call with an AI agent. The system assigns a unique call ID and calculates the schedule time based on the provided deadline and timezone.
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
endpoint: '<string>',
additionalData: {},
priority: 1,
callDeadline: null,
timezone: null,
overrideOutboundConfig: {phoneNumber: null, credentialsId: null, displayName: null}
})
};
fetch('https://blackbox.dasha.ai/api/v1/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://blackbox.dasha.ai/api/v1/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"endpoint": "<string>",
"additionalData": {},
"priority": 1,
"callDeadline": null,
"timezone": null,
"overrideOutboundConfig": {
"phoneNumber": null,
"credentialsId": null,
"displayName": null
}
}
'import requests
url = "https://blackbox.dasha.ai/api/v1/calls"
payload = {
"endpoint": "<string>",
"additionalData": {},
"priority": 1,
"callDeadline": None,
"timezone": None,
"overrideOutboundConfig": {
"phoneNumber": None,
"credentialsId": None,
"displayName": None
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"endpoint": "<string>",
"callId": "<string>",
"orgId": "<string>",
"agentId": "<string>",
"createdTime": "2023-11-07T05:31:56Z",
"status": "Unknown",
"nextScheduleTime": "2023-11-07T05:31:56Z",
"direction": "Outbound",
"additionalData": {},
"priority": 123,
"callDeadline": "2023-11-07T05:31:56Z",
"timezone": "<string>",
"overrideOutboundConfig": {
"phoneNumber": null,
"credentialsId": null,
"displayName": null
},
"toNumber": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Call Scheduling
Calls are scheduled based on:- Deadline: Target time for call completion (ISO 8601 format)
- Timezone: Timezone for scheduling (default: UTC)
- Priority: Call priority level (affects queue ordering)
Required Fields
- Agent ID (query parameter)
- Destination endpoint (phone number or SIP URI)
- Call deadline
Response
The response includes the created call with assigned call ID and calculated next schedule time.Query Parameters
Agent identifier
Body
Call configuration
Configuration for enqueueing an outbound call. Specifies the destination endpoint, scheduling parameters, and optional SIP configuration overrides for making automated calls to customers or external phone numbers.
Phone number or SIP endpoint to call. The format depends on your SIP configuration and the type of call being made.
1Data for variable interpolation in agent prompts. Values can be referenced in prompts using {{variableName}} syntax. Merge with agent's AdditionalData.
Show child attributes
Show child attributes
Call priority for queue ordering. Lower numbers are dialed first: 0-1 is high, 2-4 is normal, and 5 or more is low. Defaults to 1 when omitted. Calls with the same priority are dialed in deadline order, earliest first. Use a low number for urgent calls or VIP customers.
Deadline for completing the call attempt. If the call has not been successfully connected by this time, it will be marked as canceled. When not specified, defaults to current time plus 1 day, giving the system 24 hours to complete the call.
Timezone identifier for call scheduling (e.g., "America/New_York", "Europe/London"). Used to interpret scheduled call times in the recipient's local timezone. When not specified, the agent's timezone is used.
Override SIP configuration for this specific call. Allows using different outbound SIP settings, caller ID, or trunk configuration than the agent's default configuration. Useful for routing calls through specific carriers or presenting different caller IDs.
Show child attributes
Show child attributes
Response
Call created successfully
Response after successfully enqueueing a call. Contains all call parameters from the request plus system-assigned identifiers, status, and scheduling information for tracking the call's lifecycle.
Phone number or SIP endpoint to call. The format depends on your SIP configuration and the type of call being made.
1Unique identifier for this call. Use this ID to query call status, retrieve call details, or cancel the call before it completes.
1Organization that owns this call. Used for access control and resource tracking.
1Agent that will handle this call. References the agent configuration used for the conversation logic, voice settings, and tool availability.
1Timestamp when the call was enqueued and entered the system.
Current status of the call. Possible values: Created (just enqueued), Pending (waiting to be processed), Queued (in call queue), Running (call in progress), Completed (successfully finished), Failed (error occurred), Canceled (manually canceled).
Unknown, Created, Pending, Queued, Completed, Failed, Canceled, Running, Registered Next scheduled time when the system will attempt to initiate this call. For immediate calls, this is typically very close to the creation time. For scheduled calls or retries, this reflects the next planned attempt.
Direction of the call. Outbound calls are dialed by the scheduler. Inbound calls were registered through the register-call endpoint and bridged by your telephony.
Outbound, Inbound Data for variable interpolation in agent prompts. Values can be referenced in prompts using {{variableName}} syntax. Merge with agent's AdditionalData.
Show child attributes
Show child attributes
Call priority for queue ordering. Lower numbers are dialed first: 0-1 is high, 2-4 is normal, and 5 or more is low. Defaults to 1 when omitted. Calls with the same priority are dialed in deadline order, earliest first. Use a low number for urgent calls or VIP customers.
Deadline for completing the call attempt. If the call has not been successfully connected by this time, it will be marked as canceled. When not specified, defaults to current time plus 1 day, giving the system 24 hours to complete the call.
Timezone identifier for call scheduling (e.g., "America/New_York", "Europe/London"). Used to interpret scheduled call times in the recipient's local timezone. When not specified, the agent's timezone is used.
Override SIP configuration for this specific call. Allows using different outbound SIP settings, caller ID, or trunk configuration than the agent's default configuration. Useful for routing calls through specific carriers or presenting different caller IDs.
Show child attributes
Show child attributes
For registered inbound calls, the number that received the original call. Null for outbound calls.
Was this page helpful?