Create Campaign Calls Bulk
curl --request POST \
--url https://api-prod.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
}
]
},
"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": [
{
"phone_number": "<string>",
"override_assistant_id": "<string>",
"override_timezone": "<string>",
"override_schedule": [
{
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
'import requests
url = "https://api-prod.interactly.ai/campaigns/v1/schedule/calls"
payload = {
"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
}
]
},
"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": [
{
"phone_number": "<string>",
"override_assistant_id": "<string>",
"override_timezone": "<string>",
"override_schedule": [
{
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
}
]
},
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: [
{
phone_number: '<string>',
override_assistant_id: '<string>',
override_timezone: '<string>',
override_schedule: [{startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'}]
}
]
})
};
fetch('https://api-prod.interactly.ai/campaigns/v1/schedule/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-prod.interactly.ai/campaigns/v1/schedule/calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
],
'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' => [
[
'phone_number' => '<string>',
'override_assistant_id' => '<string>',
'override_timezone' => '<string>',
'override_schedule' => [
[
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/campaigns/v1/schedule/calls"
payload := strings.NewReader("{\n \"config\": {\n \"name\": \"<string>\",\n \"callType\": \"common\",\n \"campaignType\": \"single\",\n \"timezone\": \"America/New_York\",\n \"startHours\": 9,\n \"endHours\": 17,\n \"reportEmails\": [\n \"<string>\"\n ],\n \"maxParallelCalls\": 2,\n \"isReviewRequired\": true,\n \"validateOnUpload\": false,\n \"reviewEmails\": [\n \"<string>\"\n ],\n \"maxRetries\": 0,\n \"uidExtension\": \"datetime\",\n \"schedule\": [\n {}\n ],\n \"assistantNumbers\": [\n \"<string>\"\n ],\n \"webhook\": {\n \"enabled\": false,\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": false\n }\n ],\n \"events\": []\n },\n \"retryPolicy\": {\n \"enabled\": false,\n \"maxNumberOfRetries\": 2,\n \"maxRetriesPerDay\": 2,\n \"rules\": [\n {\n \"ruleId\": \"<string>\",\n \"outcome\": \"<string>\",\n \"delayStartInMinutes\": 123,\n \"delayEndInMinutes\": 123\n }\n ]\n },\n \"preCallMessage\": {\n \"enabled\": false,\n \"scheduledBefore\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"afterCallMessages\": {\n \"enabled\": false,\n \"callAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callNotAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDeclined\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"voicemail\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDropped\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n },\n \"data\": [\n {\n \"phone_number\": \"<string>\",\n \"override_assistant_id\": \"<string>\",\n \"override_timezone\": \"<string>\",\n \"override_schedule\": [\n {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-prod.interactly.ai/campaigns/v1/schedule/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"name\": \"<string>\",\n \"callType\": \"common\",\n \"campaignType\": \"single\",\n \"timezone\": \"America/New_York\",\n \"startHours\": 9,\n \"endHours\": 17,\n \"reportEmails\": [\n \"<string>\"\n ],\n \"maxParallelCalls\": 2,\n \"isReviewRequired\": true,\n \"validateOnUpload\": false,\n \"reviewEmails\": [\n \"<string>\"\n ],\n \"maxRetries\": 0,\n \"uidExtension\": \"datetime\",\n \"schedule\": [\n {}\n ],\n \"assistantNumbers\": [\n \"<string>\"\n ],\n \"webhook\": {\n \"enabled\": false,\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": false\n }\n ],\n \"events\": []\n },\n \"retryPolicy\": {\n \"enabled\": false,\n \"maxNumberOfRetries\": 2,\n \"maxRetriesPerDay\": 2,\n \"rules\": [\n {\n \"ruleId\": \"<string>\",\n \"outcome\": \"<string>\",\n \"delayStartInMinutes\": 123,\n \"delayEndInMinutes\": 123\n }\n ]\n },\n \"preCallMessage\": {\n \"enabled\": false,\n \"scheduledBefore\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"afterCallMessages\": {\n \"enabled\": false,\n \"callAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callNotAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDeclined\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"voicemail\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDropped\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n },\n \"data\": [\n {\n \"phone_number\": \"<string>\",\n \"override_assistant_id\": \"<string>\",\n \"override_timezone\": \"<string>\",\n \"override_schedule\": [\n {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/campaigns/v1/schedule/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"name\": \"<string>\",\n \"callType\": \"common\",\n \"campaignType\": \"single\",\n \"timezone\": \"America/New_York\",\n \"startHours\": 9,\n \"endHours\": 17,\n \"reportEmails\": [\n \"<string>\"\n ],\n \"maxParallelCalls\": 2,\n \"isReviewRequired\": true,\n \"validateOnUpload\": false,\n \"reviewEmails\": [\n \"<string>\"\n ],\n \"maxRetries\": 0,\n \"uidExtension\": \"datetime\",\n \"schedule\": [\n {}\n ],\n \"assistantNumbers\": [\n \"<string>\"\n ],\n \"webhook\": {\n \"enabled\": false,\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": false\n }\n ],\n \"events\": []\n },\n \"retryPolicy\": {\n \"enabled\": false,\n \"maxNumberOfRetries\": 2,\n \"maxRetriesPerDay\": 2,\n \"rules\": [\n {\n \"ruleId\": \"<string>\",\n \"outcome\": \"<string>\",\n \"delayStartInMinutes\": 123,\n \"delayEndInMinutes\": 123\n }\n ]\n },\n \"preCallMessage\": {\n \"enabled\": false,\n \"scheduledBefore\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"afterCallMessages\": {\n \"enabled\": false,\n \"callAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callNotAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDeclined\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"voicemail\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDropped\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n },\n \"data\": [\n {\n \"phone_number\": \"<string>\",\n \"override_assistant_id\": \"<string>\",\n \"override_timezone\": \"<string>\",\n \"override_schedule\": [\n {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"campaignId": "<string>",
"campaignName": "<string>",
"callIds": [
"<string>"
],
"requestId": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"message": "<string>"
}Campaign Bulk Calls
Create Campaign Calls Bulk
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 Campaign Calls Bulk
curl --request POST \
--url https://api-prod.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
}
]
},
"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": [
{
"phone_number": "<string>",
"override_assistant_id": "<string>",
"override_timezone": "<string>",
"override_schedule": [
{
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
'import requests
url = "https://api-prod.interactly.ai/campaigns/v1/schedule/calls"
payload = {
"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
}
]
},
"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": [
{
"phone_number": "<string>",
"override_assistant_id": "<string>",
"override_timezone": "<string>",
"override_schedule": [
{
"startAt": "2023-11-07T05:31:56Z",
"endAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
}
]
},
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: [
{
phone_number: '<string>',
override_assistant_id: '<string>',
override_timezone: '<string>',
override_schedule: [{startAt: '2023-11-07T05:31:56Z', endAt: '2023-11-07T05:31:56Z'}]
}
]
})
};
fetch('https://api-prod.interactly.ai/campaigns/v1/schedule/calls', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-prod.interactly.ai/campaigns/v1/schedule/calls",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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
]
]
],
'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' => [
[
'phone_number' => '<string>',
'override_assistant_id' => '<string>',
'override_timezone' => '<string>',
'override_schedule' => [
[
'startAt' => '2023-11-07T05:31:56Z',
'endAt' => '2023-11-07T05:31:56Z'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/campaigns/v1/schedule/calls"
payload := strings.NewReader("{\n \"config\": {\n \"name\": \"<string>\",\n \"callType\": \"common\",\n \"campaignType\": \"single\",\n \"timezone\": \"America/New_York\",\n \"startHours\": 9,\n \"endHours\": 17,\n \"reportEmails\": [\n \"<string>\"\n ],\n \"maxParallelCalls\": 2,\n \"isReviewRequired\": true,\n \"validateOnUpload\": false,\n \"reviewEmails\": [\n \"<string>\"\n ],\n \"maxRetries\": 0,\n \"uidExtension\": \"datetime\",\n \"schedule\": [\n {}\n ],\n \"assistantNumbers\": [\n \"<string>\"\n ],\n \"webhook\": {\n \"enabled\": false,\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": false\n }\n ],\n \"events\": []\n },\n \"retryPolicy\": {\n \"enabled\": false,\n \"maxNumberOfRetries\": 2,\n \"maxRetriesPerDay\": 2,\n \"rules\": [\n {\n \"ruleId\": \"<string>\",\n \"outcome\": \"<string>\",\n \"delayStartInMinutes\": 123,\n \"delayEndInMinutes\": 123\n }\n ]\n },\n \"preCallMessage\": {\n \"enabled\": false,\n \"scheduledBefore\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"afterCallMessages\": {\n \"enabled\": false,\n \"callAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callNotAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDeclined\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"voicemail\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDropped\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n },\n \"data\": [\n {\n \"phone_number\": \"<string>\",\n \"override_assistant_id\": \"<string>\",\n \"override_timezone\": \"<string>\",\n \"override_schedule\": [\n {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-prod.interactly.ai/campaigns/v1/schedule/calls")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"config\": {\n \"name\": \"<string>\",\n \"callType\": \"common\",\n \"campaignType\": \"single\",\n \"timezone\": \"America/New_York\",\n \"startHours\": 9,\n \"endHours\": 17,\n \"reportEmails\": [\n \"<string>\"\n ],\n \"maxParallelCalls\": 2,\n \"isReviewRequired\": true,\n \"validateOnUpload\": false,\n \"reviewEmails\": [\n \"<string>\"\n ],\n \"maxRetries\": 0,\n \"uidExtension\": \"datetime\",\n \"schedule\": [\n {}\n ],\n \"assistantNumbers\": [\n \"<string>\"\n ],\n \"webhook\": {\n \"enabled\": false,\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": false\n }\n ],\n \"events\": []\n },\n \"retryPolicy\": {\n \"enabled\": false,\n \"maxNumberOfRetries\": 2,\n \"maxRetriesPerDay\": 2,\n \"rules\": [\n {\n \"ruleId\": \"<string>\",\n \"outcome\": \"<string>\",\n \"delayStartInMinutes\": 123,\n \"delayEndInMinutes\": 123\n }\n ]\n },\n \"preCallMessage\": {\n \"enabled\": false,\n \"scheduledBefore\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"afterCallMessages\": {\n \"enabled\": false,\n \"callAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callNotAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDeclined\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"voicemail\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDropped\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n },\n \"data\": [\n {\n \"phone_number\": \"<string>\",\n \"override_assistant_id\": \"<string>\",\n \"override_timezone\": \"<string>\",\n \"override_schedule\": [\n {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/campaigns/v1/schedule/calls")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"config\": {\n \"name\": \"<string>\",\n \"callType\": \"common\",\n \"campaignType\": \"single\",\n \"timezone\": \"America/New_York\",\n \"startHours\": 9,\n \"endHours\": 17,\n \"reportEmails\": [\n \"<string>\"\n ],\n \"maxParallelCalls\": 2,\n \"isReviewRequired\": true,\n \"validateOnUpload\": false,\n \"reviewEmails\": [\n \"<string>\"\n ],\n \"maxRetries\": 0,\n \"uidExtension\": \"datetime\",\n \"schedule\": [\n {}\n ],\n \"assistantNumbers\": [\n \"<string>\"\n ],\n \"webhook\": {\n \"enabled\": false,\n \"url\": \"<string>\",\n \"secret\": \"<string>\",\n \"headers\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\",\n \"sensitive\": false\n }\n ],\n \"events\": []\n },\n \"retryPolicy\": {\n \"enabled\": false,\n \"maxNumberOfRetries\": 2,\n \"maxRetriesPerDay\": 2,\n \"rules\": [\n {\n \"ruleId\": \"<string>\",\n \"outcome\": \"<string>\",\n \"delayStartInMinutes\": 123,\n \"delayEndInMinutes\": 123\n }\n ]\n },\n \"preCallMessage\": {\n \"enabled\": false,\n \"scheduledBefore\": \"<string>\",\n \"scheduledAt\": \"2023-11-07T05:31:56Z\",\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"afterCallMessages\": {\n \"enabled\": false,\n \"callAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callNotAnswered\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDeclined\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"voicemail\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"callDropped\": {\n \"enabled\": false,\n \"messageType\": \"<string>\",\n \"message\": \"<string>\"\n }\n },\n \"tags\": [\n \"<string>\"\n ]\n },\n \"data\": [\n {\n \"phone_number\": \"<string>\",\n \"override_assistant_id\": \"<string>\",\n \"override_timezone\": \"<string>\",\n \"override_schedule\": [\n {\n \"startAt\": \"2023-11-07T05:31:56Z\",\n \"endAt\": \"2023-11-07T05:31:56Z\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"data": {
"campaignId": "<string>",
"campaignName": "<string>",
"callIds": [
"<string>"
],
"requestId": "<string>"
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"message": "<string>"
}Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Body
application/json
Response
Successful Response
⌘I