Skip to main content
POST
/
v1
/
voice
/
placeoutboundcall
/
{workspaceId}
/
{assistantId}
Place Phone Call
curl --request POST \
  --url https://catalystapi.superdashhq.com/api/v1/voice/placeoutboundcall/{workspaceId}/{assistantId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "fromNumber": "<string>",
  "toNumber": "<string>",
  "priority": 123,
  "attributes": {
    "customField1": "<string>",
    "customField2": "<string>",
    "customField3": "<string>",
    "customField4": "<string>",
    "customField5": "<string>",
    "customField6": "<string>",
    "customField7": "<string>",
    "customField8": "<string>"
  }
}
'
{
"msg": "Call placed to {toNumber}",
"status": "placed",
"callId": "The queueId of the call"
}

​
Authorizations

​
x-api-key
string
required

​
Path Parameters

​
workspaceId
string
required
The ID associated with a workspace.
​
assistantId
string
required
The ID associated with an assistant.

​
Body Parameters

​
fromNumber
string
required
The number from which the call will be placed and it should be linked to the assistant.
​
toNumber
string
required
The number to which the call will be placed
​
priority
number
default:1
Indicates the priority level assigned to the call.
Allowed Values: 0, 1, 2.
Where,
0 = Low Priority
1 = Medium Prioriry
2 = High Priority
​
attributes
object
Additional attributes for the call

​
Response

​
msg
string
Confirmation message indicating the call was placed
​
status
string
The status of the call
​
callId
string
A newly created Id for the call
{
"msg": "Call placed to {toNumber}",
"status": "placed",
"callId": "The queueId of the call"
}

Retrieve Call Properties Post-Call

By adding a webhook, all call properties—such as summary, transcript, callStartTime, and more—are automatically sent via the webhook. Additionally, you can extract custom variables using the extraction option available in the Dashboard Modules section and include them in the same webhook. Note: Webhooks are triggered at the end of the call.