Create a campaign
curl --request POST \
--url https://api.openmic.ai/v2/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Q1 Sales Blitz",
"type": "outbound",
"agent_uid": "agent_abc123",
"from_number": "+12025551234",
"contact_list_id": 42,
"time_start": "09:00",
"time_end": "17:00",
"timezone": "America/New_York",
"days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
}
'import requests
url = "https://api.openmic.ai/v2/campaigns"
payload = {
"name": "Q1 Sales Blitz",
"type": "outbound",
"agent_uid": "agent_abc123",
"from_number": "+12025551234",
"contact_list_id": 42,
"time_start": "09:00",
"time_end": "17:00",
"timezone": "America/New_York",
"days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
}
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({
name: 'Q1 Sales Blitz',
type: 'outbound',
agent_uid: 'agent_abc123',
from_number: '+12025551234',
contact_list_id: 42,
time_start: '09:00',
time_end: '17:00',
timezone: 'America/New_York',
days: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday']
})
};
fetch('https://api.openmic.ai/v2/campaigns', 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.openmic.ai/v2/campaigns",
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([
'name' => 'Q1 Sales Blitz',
'type' => 'outbound',
'agent_uid' => 'agent_abc123',
'from_number' => '+12025551234',
'contact_list_id' => 42,
'time_start' => '09:00',
'time_end' => '17:00',
'timezone' => 'America/New_York',
'days' => [
'Monday',
'Tuesday',
'Wednesday',
'Thursday',
'Friday'
]
]),
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.openmic.ai/v2/campaigns"
payload := strings.NewReader("{\n \"name\": \"Q1 Sales Blitz\",\n \"type\": \"outbound\",\n \"agent_uid\": \"agent_abc123\",\n \"from_number\": \"+12025551234\",\n \"contact_list_id\": 42,\n \"time_start\": \"09:00\",\n \"time_end\": \"17:00\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\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.openmic.ai/v2/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Q1 Sales Blitz\",\n \"type\": \"outbound\",\n \"agent_uid\": \"agent_abc123\",\n \"from_number\": \"+12025551234\",\n \"contact_list_id\": 42,\n \"time_start\": \"09:00\",\n \"time_end\": \"17:00\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openmic.ai/v2/campaigns")
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 \"name\": \"Q1 Sales Blitz\",\n \"type\": \"outbound\",\n \"agent_uid\": \"agent_abc123\",\n \"from_number\": \"+12025551234\",\n \"contact_list_id\": 42,\n \"time_start\": \"09:00\",\n \"time_end\": \"17:00\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"type": "outbound",
"agent_uid": "<string>",
"from_number": "<string>",
"contact_list_id": 123,
"time_start": "09:00",
"time_end": "17:00",
"timezone": "America/New_York",
"days": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"success": true,
"message": "<string>",
"error": "<string>",
"retryAfter": 123
}{
"error": "<string>",
"details": "<string>"
}Campaigns
Create a campaign
Creates a new outbound dialing campaign.
The campaign will begin dialing contacts within the time_start–time_end window on the specified days. If timezone is omitted the organization’s default timezone is used.
POST
/
v2
/
campaigns
Create a campaign
curl --request POST \
--url https://api.openmic.ai/v2/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Q1 Sales Blitz",
"type": "outbound",
"agent_uid": "agent_abc123",
"from_number": "+12025551234",
"contact_list_id": 42,
"time_start": "09:00",
"time_end": "17:00",
"timezone": "America/New_York",
"days": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday"
]
}
'import requests
url = "https://api.openmic.ai/v2/campaigns"
payload = {
"name": "Q1 Sales Blitz",
"type": "outbound",
"agent_uid": "agent_abc123",
"from_number": "+12025551234",
"contact_list_id": 42,
"time_start": "09:00",
"time_end": "17:00",
"timezone": "America/New_York",
"days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
}
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({
name: 'Q1 Sales Blitz',
type: 'outbound',
agent_uid: 'agent_abc123',
from_number: '+12025551234',
contact_list_id: 42,
time_start: '09:00',
time_end: '17:00',
timezone: 'America/New_York',
days: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday']
})
};
fetch('https://api.openmic.ai/v2/campaigns', 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.openmic.ai/v2/campaigns",
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([
'name' => 'Q1 Sales Blitz',
'type' => 'outbound',
'agent_uid' => 'agent_abc123',
'from_number' => '+12025551234',
'contact_list_id' => 42,
'time_start' => '09:00',
'time_end' => '17:00',
'timezone' => 'America/New_York',
'days' => [
'Monday',
'Tuesday',
'Wednesday',
'Thursday',
'Friday'
]
]),
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.openmic.ai/v2/campaigns"
payload := strings.NewReader("{\n \"name\": \"Q1 Sales Blitz\",\n \"type\": \"outbound\",\n \"agent_uid\": \"agent_abc123\",\n \"from_number\": \"+12025551234\",\n \"contact_list_id\": 42,\n \"time_start\": \"09:00\",\n \"time_end\": \"17:00\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\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.openmic.ai/v2/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Q1 Sales Blitz\",\n \"type\": \"outbound\",\n \"agent_uid\": \"agent_abc123\",\n \"from_number\": \"+12025551234\",\n \"contact_list_id\": 42,\n \"time_start\": \"09:00\",\n \"time_end\": \"17:00\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openmic.ai/v2/campaigns")
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 \"name\": \"Q1 Sales Blitz\",\n \"type\": \"outbound\",\n \"agent_uid\": \"agent_abc123\",\n \"from_number\": \"+12025551234\",\n \"contact_list_id\": 42,\n \"time_start\": \"09:00\",\n \"time_end\": \"17:00\",\n \"timezone\": \"America/New_York\",\n \"days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"name": "<string>",
"type": "outbound",
"agent_uid": "<string>",
"from_number": "<string>",
"contact_list_id": 123,
"time_start": "09:00",
"time_end": "17:00",
"timezone": "America/New_York",
"days": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"error": "<string>",
"details": "<string>"
}{
"success": true,
"message": "<string>",
"error": "<string>",
"retryAfter": 123
}{
"error": "<string>",
"details": "<string>"
}Authorizations
API key obtained from the OpenMic dashboard.
Body
application/json
Required string length:
1 - 255Available options:
outbound E.164 format.
Pattern:
^\+[1-9]\d{1,14}$HH:MM format.
Pattern:
^([0-1][0-9]|2[0-3]):[0-5][0-9]$Example:
"09:00"
HH:MM format.
Pattern:
^([0-1][0-9]|2[0-3]):[0-5][0-9]$Example:
"17:00"
Example:
"America/New_York"
Available options:
Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday Response
Campaign created.
Available options:
outbound Available options:
Running, Scheduled, Stopped, Completed, Failed, Expired, Paused HH:MM (24-hour) daily window start.
Example:
"09:00"
HH:MM (24-hour) daily window end.
Example:
"17:00"
Example:
"America/New_York"
Available options:
Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday Was this page helpful?
⌘I