Create Campaigns Calls
curl --request POST \
--url https://api-qa.interactly.ai/campaigns/v1/schedule/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"name": "<string>",
"callType": "common",
"campaignType": "single",
"timezone": "America/New_York",
"startHours": 9,
"endHours": 17,
"reportEmails": [
"<string>"
],
"maxParallelCalls": 2,
"isReviewRequired": true,
"validateOnUpload": false,
"reviewEmails": [
"<string>"
],
"maxRetries": 0,
"uidExtension": "datetime",
"schedule": [
{}
],
"assistantNumbers": [
"<string>"
],
"webhook": {
"enabled": false,
"url": "<string>",
"secret": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"sensitive": false
}
],
"events": []
},
"retryPolicy": {
"enabled": false,
"maxNumberOfRetries": 2,
"maxRetriesPerDay": 2,
"rules": [
{
"ruleId": "<string>",
"outcome": "<string>",
"delayStartInMinutes": 123,
"delayEndInMinutes": 123
}
]
},
"callProcessingTimeoutInMinutes": 6000,
"preCallMessage": {
"enabled": false,
"scheduledBefore": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"messageType": "<string>",
"message": "<string>"
},
"afterCallMessages": {
"enabled": false,
"callAnswered": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"callNotAnswered": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"callDeclined": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"voicemail": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"callDropped": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
}
},
"tags": [
"<string>"
]
},
"data": [
{}
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Campaign Bulk Calls
Create Campaigns Calls
Create a new campaign call configuration in bulk.
- body: The campaign call configuration data.
- config: Configuration options for the campaign call.
- data: List of campaign call data to be processed in bulk.
POST
/
campaigns
/
v1
/
schedule
/
calls
Create Campaigns Calls
curl --request POST \
--url https://api-qa.interactly.ai/campaigns/v1/schedule/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"config": {
"name": "<string>",
"callType": "common",
"campaignType": "single",
"timezone": "America/New_York",
"startHours": 9,
"endHours": 17,
"reportEmails": [
"<string>"
],
"maxParallelCalls": 2,
"isReviewRequired": true,
"validateOnUpload": false,
"reviewEmails": [
"<string>"
],
"maxRetries": 0,
"uidExtension": "datetime",
"schedule": [
{}
],
"assistantNumbers": [
"<string>"
],
"webhook": {
"enabled": false,
"url": "<string>",
"secret": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>",
"sensitive": false
}
],
"events": []
},
"retryPolicy": {
"enabled": false,
"maxNumberOfRetries": 2,
"maxRetriesPerDay": 2,
"rules": [
{
"ruleId": "<string>",
"outcome": "<string>",
"delayStartInMinutes": 123,
"delayEndInMinutes": 123
}
]
},
"callProcessingTimeoutInMinutes": 6000,
"preCallMessage": {
"enabled": false,
"scheduledBefore": "<string>",
"scheduledAt": "2023-11-07T05:31:56Z",
"messageType": "<string>",
"message": "<string>"
},
"afterCallMessages": {
"enabled": false,
"callAnswered": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"callNotAnswered": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"callDeclined": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"voicemail": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
},
"callDropped": {
"enabled": false,
"messageType": "<string>",
"message": "<string>"
}
},
"tags": [
"<string>"
]
},
"data": [
{}
]
}
'{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Body
application/json
Response
Successful Response
⌘I