Create Campaign

curl --request POST \
  --url https://api.voxo.co/v2/admin/call-campaigns/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 123,
  "name": "<string>",
  "tech": "VOICE",
  "dateStart": "<string>",
  "timeStart": "<string>",
  "dateEnd": "<string>",
  "timeEnd": "<string>",
  "callerId": "<string>",
  "recording": "yes",
  "numbers": [
    {
      "number": "<string>",
      "description": "<string>",
      "field1": "<string>",
      "field2": "<string>",
      "field3": "<string>",
      "field4": "<string>",
      "field5": "<string>",
      "field6": "<string>",
      "field7": "<string>",
      "field8": "<string>",
      "field9": "<string>",
      "disposition": "<string>"
    }
  ],
  "destinations": [
    {
      "id": 123,
      "type": "<string>"
    }
  ],
  "timezone": "<string>",
  "callFrequency": 123,
  "matchDestinations": [
    {
      "id": 123,
      "type": "<string>"
    }
  ],
  "notMatchDestinations": [
    {
      "id": 123,
      "type": "<string>"
    }
  ],
  "enableVMDetect": 0.5,
  "callHoursStart": "<string>",
  "callHoursEnd": "<string>"
}
'

import requests

url = "https://api.voxo.co/v2/admin/call-campaigns/"

payload = {
    "tenantId": 123,
    "name": "<string>",
    "tech": "VOICE",
    "dateStart": "<string>",
    "timeStart": "<string>",
    "dateEnd": "<string>",
    "timeEnd": "<string>",
    "callerId": "<string>",
    "recording": "yes",
    "numbers": [
        {
            "number": "<string>",
            "description": "<string>",
            "field1": "<string>",
            "field2": "<string>",
            "field3": "<string>",
            "field4": "<string>",
            "field5": "<string>",
            "field6": "<string>",
            "field7": "<string>",
            "field8": "<string>",
            "field9": "<string>",
            "disposition": "<string>"
        }
    ],
    "destinations": [
        {
            "id": 123,
            "type": "<string>"
        }
    ],
    "timezone": "<string>",
    "callFrequency": 123,
    "matchDestinations": [
        {
            "id": 123,
            "type": "<string>"
        }
    ],
    "notMatchDestinations": [
        {
            "id": 123,
            "type": "<string>"
        }
    ],
    "enableVMDetect": 0.5,
    "callHoursStart": "<string>",
    "callHoursEnd": "<string>"
}
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({
    tenantId: 123,
    name: '<string>',
    tech: 'VOICE',
    dateStart: '<string>',
    timeStart: '<string>',
    dateEnd: '<string>',
    timeEnd: '<string>',
    callerId: '<string>',
    recording: 'yes',
    numbers: [
      {
        number: '<string>',
        description: '<string>',
        field1: '<string>',
        field2: '<string>',
        field3: '<string>',
        field4: '<string>',
        field5: '<string>',
        field6: '<string>',
        field7: '<string>',
        field8: '<string>',
        field9: '<string>',
        disposition: '<string>'
      }
    ],
    destinations: [{id: 123, type: '<string>'}],
    timezone: '<string>',
    callFrequency: 123,
    matchDestinations: [{id: 123, type: '<string>'}],
    notMatchDestinations: [{id: 123, type: '<string>'}],
    enableVMDetect: 0.5,
    callHoursStart: '<string>',
    callHoursEnd: '<string>'
  })
};

fetch('https://api.voxo.co/v2/admin/call-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.voxo.co/v2/admin/call-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([
    'tenantId' => 123,
    'name' => '<string>',
    'tech' => 'VOICE',
    'dateStart' => '<string>',
    'timeStart' => '<string>',
    'dateEnd' => '<string>',
    'timeEnd' => '<string>',
    'callerId' => '<string>',
    'recording' => 'yes',
    'numbers' => [
        [
                'number' => '<string>',
                'description' => '<string>',
                'field1' => '<string>',
                'field2' => '<string>',
                'field3' => '<string>',
                'field4' => '<string>',
                'field5' => '<string>',
                'field6' => '<string>',
                'field7' => '<string>',
                'field8' => '<string>',
                'field9' => '<string>',
                'disposition' => '<string>'
        ]
    ],
    'destinations' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ],
    'timezone' => '<string>',
    'callFrequency' => 123,
    'matchDestinations' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ],
    'notMatchDestinations' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ],
    'enableVMDetect' => 0.5,
    'callHoursStart' => '<string>',
    'callHoursEnd' => '<string>'
  ]),
  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.voxo.co/v2/admin/call-campaigns/"

	payload := strings.NewReader("{\n  \"tenantId\": 123,\n  \"name\": \"<string>\",\n  \"tech\": \"VOICE\",\n  \"dateStart\": \"<string>\",\n  \"timeStart\": \"<string>\",\n  \"dateEnd\": \"<string>\",\n  \"timeEnd\": \"<string>\",\n  \"callerId\": \"<string>\",\n  \"recording\": \"yes\",\n  \"numbers\": [\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"field1\": \"<string>\",\n      \"field2\": \"<string>\",\n      \"field3\": \"<string>\",\n      \"field4\": \"<string>\",\n      \"field5\": \"<string>\",\n      \"field6\": \"<string>\",\n      \"field7\": \"<string>\",\n      \"field8\": \"<string>\",\n      \"field9\": \"<string>\",\n      \"disposition\": \"<string>\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"timezone\": \"<string>\",\n  \"callFrequency\": 123,\n  \"matchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"notMatchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"enableVMDetect\": 0.5,\n  \"callHoursStart\": \"<string>\",\n  \"callHoursEnd\": \"<string>\"\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.voxo.co/v2/admin/call-campaigns/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tenantId\": 123,\n  \"name\": \"<string>\",\n  \"tech\": \"VOICE\",\n  \"dateStart\": \"<string>\",\n  \"timeStart\": \"<string>\",\n  \"dateEnd\": \"<string>\",\n  \"timeEnd\": \"<string>\",\n  \"callerId\": \"<string>\",\n  \"recording\": \"yes\",\n  \"numbers\": [\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"field1\": \"<string>\",\n      \"field2\": \"<string>\",\n      \"field3\": \"<string>\",\n      \"field4\": \"<string>\",\n      \"field5\": \"<string>\",\n      \"field6\": \"<string>\",\n      \"field7\": \"<string>\",\n      \"field8\": \"<string>\",\n      \"field9\": \"<string>\",\n      \"disposition\": \"<string>\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"timezone\": \"<string>\",\n  \"callFrequency\": 123,\n  \"matchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"notMatchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"enableVMDetect\": 0.5,\n  \"callHoursStart\": \"<string>\",\n  \"callHoursEnd\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voxo.co/v2/admin/call-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  \"tenantId\": 123,\n  \"name\": \"<string>\",\n  \"tech\": \"VOICE\",\n  \"dateStart\": \"<string>\",\n  \"timeStart\": \"<string>\",\n  \"dateEnd\": \"<string>\",\n  \"timeEnd\": \"<string>\",\n  \"callerId\": \"<string>\",\n  \"recording\": \"yes\",\n  \"numbers\": [\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"field1\": \"<string>\",\n      \"field2\": \"<string>\",\n      \"field3\": \"<string>\",\n      \"field4\": \"<string>\",\n      \"field5\": \"<string>\",\n      \"field6\": \"<string>\",\n      \"field7\": \"<string>\",\n      \"field8\": \"<string>\",\n      \"field9\": \"<string>\",\n      \"disposition\": \"<string>\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"timezone\": \"<string>\",\n  \"callFrequency\": 123,\n  \"matchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"notMatchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"enableVMDetect\": 0.5,\n  \"callHoursStart\": \"<string>\",\n  \"callHoursEnd\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "tenantId": 123,
  "name": "<string>",
  "type": "<string>",
  "dateStart": "<string>",
  "dateEnd": "<string>",
  "callerId": "<string>",
  "callDelay": 123,
  "state": "<string>",
  "lastrun": "2023-11-07T05:31:56Z",
  "dialtimeout": 123,
  "tech": "<string>",
  "message": "<string>",
  "timeStart": "<string>",
  "timeEnd": "<string>",
  "timezone": "<string>",
  "callFrequency": 123,
  "callHoursStart": "<string>",
  "callHoursEnd": "<string>",
  "recording": "<string>",
  "numbers": [
    {
      "number": "<string>",
      "description": "<string>",
      "disposition": "<string>"
    }
  ],
  "destinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123,
      "name": "<string>",
      "number": "<string>"
    }
  ],
  "enableVMDetect": 123,
  "matchDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123,
      "name": "<string>",
      "number": "<string>"
    }
  ],
  "notMatchDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123,
      "name": "<string>",
      "number": "<string>"
    }
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "code": 123,
  "validationErrors": [
    "<string>"
  ]
}

POST

admin

call-campaigns

Create Campaign

curl --request POST \
  --url https://api.voxo.co/v2/admin/call-campaigns/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 123,
  "name": "<string>",
  "tech": "VOICE",
  "dateStart": "<string>",
  "timeStart": "<string>",
  "dateEnd": "<string>",
  "timeEnd": "<string>",
  "callerId": "<string>",
  "recording": "yes",
  "numbers": [
    {
      "number": "<string>",
      "description": "<string>",
      "field1": "<string>",
      "field2": "<string>",
      "field3": "<string>",
      "field4": "<string>",
      "field5": "<string>",
      "field6": "<string>",
      "field7": "<string>",
      "field8": "<string>",
      "field9": "<string>",
      "disposition": "<string>"
    }
  ],
  "destinations": [
    {
      "id": 123,
      "type": "<string>"
    }
  ],
  "timezone": "<string>",
  "callFrequency": 123,
  "matchDestinations": [
    {
      "id": 123,
      "type": "<string>"
    }
  ],
  "notMatchDestinations": [
    {
      "id": 123,
      "type": "<string>"
    }
  ],
  "enableVMDetect": 0.5,
  "callHoursStart": "<string>",
  "callHoursEnd": "<string>"
}
'

import requests

url = "https://api.voxo.co/v2/admin/call-campaigns/"

payload = {
    "tenantId": 123,
    "name": "<string>",
    "tech": "VOICE",
    "dateStart": "<string>",
    "timeStart": "<string>",
    "dateEnd": "<string>",
    "timeEnd": "<string>",
    "callerId": "<string>",
    "recording": "yes",
    "numbers": [
        {
            "number": "<string>",
            "description": "<string>",
            "field1": "<string>",
            "field2": "<string>",
            "field3": "<string>",
            "field4": "<string>",
            "field5": "<string>",
            "field6": "<string>",
            "field7": "<string>",
            "field8": "<string>",
            "field9": "<string>",
            "disposition": "<string>"
        }
    ],
    "destinations": [
        {
            "id": 123,
            "type": "<string>"
        }
    ],
    "timezone": "<string>",
    "callFrequency": 123,
    "matchDestinations": [
        {
            "id": 123,
            "type": "<string>"
        }
    ],
    "notMatchDestinations": [
        {
            "id": 123,
            "type": "<string>"
        }
    ],
    "enableVMDetect": 0.5,
    "callHoursStart": "<string>",
    "callHoursEnd": "<string>"
}
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({
    tenantId: 123,
    name: '<string>',
    tech: 'VOICE',
    dateStart: '<string>',
    timeStart: '<string>',
    dateEnd: '<string>',
    timeEnd: '<string>',
    callerId: '<string>',
    recording: 'yes',
    numbers: [
      {
        number: '<string>',
        description: '<string>',
        field1: '<string>',
        field2: '<string>',
        field3: '<string>',
        field4: '<string>',
        field5: '<string>',
        field6: '<string>',
        field7: '<string>',
        field8: '<string>',
        field9: '<string>',
        disposition: '<string>'
      }
    ],
    destinations: [{id: 123, type: '<string>'}],
    timezone: '<string>',
    callFrequency: 123,
    matchDestinations: [{id: 123, type: '<string>'}],
    notMatchDestinations: [{id: 123, type: '<string>'}],
    enableVMDetect: 0.5,
    callHoursStart: '<string>',
    callHoursEnd: '<string>'
  })
};

fetch('https://api.voxo.co/v2/admin/call-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.voxo.co/v2/admin/call-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([
    'tenantId' => 123,
    'name' => '<string>',
    'tech' => 'VOICE',
    'dateStart' => '<string>',
    'timeStart' => '<string>',
    'dateEnd' => '<string>',
    'timeEnd' => '<string>',
    'callerId' => '<string>',
    'recording' => 'yes',
    'numbers' => [
        [
                'number' => '<string>',
                'description' => '<string>',
                'field1' => '<string>',
                'field2' => '<string>',
                'field3' => '<string>',
                'field4' => '<string>',
                'field5' => '<string>',
                'field6' => '<string>',
                'field7' => '<string>',
                'field8' => '<string>',
                'field9' => '<string>',
                'disposition' => '<string>'
        ]
    ],
    'destinations' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ],
    'timezone' => '<string>',
    'callFrequency' => 123,
    'matchDestinations' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ],
    'notMatchDestinations' => [
        [
                'id' => 123,
                'type' => '<string>'
        ]
    ],
    'enableVMDetect' => 0.5,
    'callHoursStart' => '<string>',
    'callHoursEnd' => '<string>'
  ]),
  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.voxo.co/v2/admin/call-campaigns/"

	payload := strings.NewReader("{\n  \"tenantId\": 123,\n  \"name\": \"<string>\",\n  \"tech\": \"VOICE\",\n  \"dateStart\": \"<string>\",\n  \"timeStart\": \"<string>\",\n  \"dateEnd\": \"<string>\",\n  \"timeEnd\": \"<string>\",\n  \"callerId\": \"<string>\",\n  \"recording\": \"yes\",\n  \"numbers\": [\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"field1\": \"<string>\",\n      \"field2\": \"<string>\",\n      \"field3\": \"<string>\",\n      \"field4\": \"<string>\",\n      \"field5\": \"<string>\",\n      \"field6\": \"<string>\",\n      \"field7\": \"<string>\",\n      \"field8\": \"<string>\",\n      \"field9\": \"<string>\",\n      \"disposition\": \"<string>\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"timezone\": \"<string>\",\n  \"callFrequency\": 123,\n  \"matchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"notMatchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"enableVMDetect\": 0.5,\n  \"callHoursStart\": \"<string>\",\n  \"callHoursEnd\": \"<string>\"\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.voxo.co/v2/admin/call-campaigns/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tenantId\": 123,\n  \"name\": \"<string>\",\n  \"tech\": \"VOICE\",\n  \"dateStart\": \"<string>\",\n  \"timeStart\": \"<string>\",\n  \"dateEnd\": \"<string>\",\n  \"timeEnd\": \"<string>\",\n  \"callerId\": \"<string>\",\n  \"recording\": \"yes\",\n  \"numbers\": [\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"field1\": \"<string>\",\n      \"field2\": \"<string>\",\n      \"field3\": \"<string>\",\n      \"field4\": \"<string>\",\n      \"field5\": \"<string>\",\n      \"field6\": \"<string>\",\n      \"field7\": \"<string>\",\n      \"field8\": \"<string>\",\n      \"field9\": \"<string>\",\n      \"disposition\": \"<string>\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"timezone\": \"<string>\",\n  \"callFrequency\": 123,\n  \"matchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"notMatchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"enableVMDetect\": 0.5,\n  \"callHoursStart\": \"<string>\",\n  \"callHoursEnd\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voxo.co/v2/admin/call-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  \"tenantId\": 123,\n  \"name\": \"<string>\",\n  \"tech\": \"VOICE\",\n  \"dateStart\": \"<string>\",\n  \"timeStart\": \"<string>\",\n  \"dateEnd\": \"<string>\",\n  \"timeEnd\": \"<string>\",\n  \"callerId\": \"<string>\",\n  \"recording\": \"yes\",\n  \"numbers\": [\n    {\n      \"number\": \"<string>\",\n      \"description\": \"<string>\",\n      \"field1\": \"<string>\",\n      \"field2\": \"<string>\",\n      \"field3\": \"<string>\",\n      \"field4\": \"<string>\",\n      \"field5\": \"<string>\",\n      \"field6\": \"<string>\",\n      \"field7\": \"<string>\",\n      \"field8\": \"<string>\",\n      \"field9\": \"<string>\",\n      \"disposition\": \"<string>\"\n    }\n  ],\n  \"destinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"timezone\": \"<string>\",\n  \"callFrequency\": 123,\n  \"matchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"notMatchDestinations\": [\n    {\n      \"id\": 123,\n      \"type\": \"<string>\"\n    }\n  ],\n  \"enableVMDetect\": 0.5,\n  \"callHoursStart\": \"<string>\",\n  \"callHoursEnd\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "tenantId": 123,
  "name": "<string>",
  "type": "<string>",
  "dateStart": "<string>",
  "dateEnd": "<string>",
  "callerId": "<string>",
  "callDelay": 123,
  "state": "<string>",
  "lastrun": "2023-11-07T05:31:56Z",
  "dialtimeout": 123,
  "tech": "<string>",
  "message": "<string>",
  "timeStart": "<string>",
  "timeEnd": "<string>",
  "timezone": "<string>",
  "callFrequency": 123,
  "callHoursStart": "<string>",
  "callHoursEnd": "<string>",
  "recording": "<string>",
  "numbers": [
    {
      "number": "<string>",
      "description": "<string>",
      "disposition": "<string>"
    }
  ],
  "destinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123,
      "name": "<string>",
      "number": "<string>"
    }
  ],
  "enableVMDetect": 123,
  "matchDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123,
      "name": "<string>",
      "number": "<string>"
    }
  ],
  "notMatchDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123,
      "name": "<string>",
      "number": "<string>"
    }
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "code": 123,
  "validationErrors": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

tenantId

number

required

Tenant ID this campaign belongs to

name

string

required

Campaign name

Minimum string length: 3

tech

enum<string>

required

Campaign technology type

Available options:

VOICE

dateStart

string

required

Start date (YYYY-MM-DD)

Pattern: ^([1-9]\d{3})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])$

timeStart

string

required

Start time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$

dateEnd

string

required

End date (YYYY-MM-DD)

Pattern: ^([1-9]\d{3})-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])$

timeEnd

string

required

End time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$

callerId

string

required

Caller ID phone number

Pattern: ^[1-9]\d{9}$

recording

required

Enable call recording (yes/no)

Available options:

yes

numbers

object[]

required

Phone numbers to call

Show child attributes

destinations

object[]

required

Routing destinations on connect

Show child attributes

timezone

string

required

IANA timezone identifier

callFrequency

number

required

Call frequency in seconds (minimum 10)

matchDestinations

object[]

required

VM detect match destinations

Show child attributes

notMatchDestinations

object[]

required

VM detect no-match destinations

Show child attributes

enableVMDetect

number

required

Enable voicemail detection (1 = yes, 0 = no)

Required range: 0 <= x <= 1

callHoursStart

string

required

Calling hours start time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$

callHoursEnd

string

required

Calling hours end time (HH:MM)

Pattern: ^([01]\d|2[0-3]):([0-5]\d)$

state

enum<string>

Initial campaign state

Available options:

READY,

PAUSED

message

string

Campaign message

Response

Created campaign

number

required

Campaign ID

tenantId

number

required

Tenant ID

name

string

required

Campaign name

type

string

required

Campaign type

dateStart

string | null

required

Start date

dateEnd

string | null

required

End date

callerId

string | null

required

Caller ID phone number

callDelay

number | null

required

Delay between calls in ms

state

string | null

required

Campaign state

lastrun

string<date-time> | null

required

Last run timestamp

dialtimeout

number | null

required

Dial timeout in seconds

tech

string | null

required

Technology type

message

string | null

required

Campaign message

timeStart

string | null

required

Start time

timeEnd

string | null

required

End time

timezone

string | null

required

IANA timezone

callFrequency

number | null

required

Call frequency in seconds

callHoursStart

string | null

required

Calling hours start

callHoursEnd

string | null

required

Calling hours end

recording

string | null

required

Recording enabled (yes/no)

numbers

object[]

required

Campaign phone numbers

Show child attributes

destinations

object[]

required

Routing destinations

Show child attributes

enableVMDetect

number

required

VM detection enabled (1/0)

matchDestinations

object[]

required

VM detect match destinations

Show child attributes

notMatchDestinations

object[]

required

VM detect no-match destinations

Show child attributes

List Campaigns Get Campaign

⌘I

Getting started

API

Webhooks

Create Campaign

Authorizations

Body

Response