Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST outbounds

Ostatnia modyfikacja 2024-11-20 13:20:36
Dodaje kampanie.

URL

https://your-system-name.thulium.com/api/outbounds

Parametry

id

opcjonalny

Pięcioznakowy identyfikator kampanii. Przykładowa wartość: 00001
name

wymagany

Nazwa tworzonej kampanii. Przykładowa wartość: Kampania sprzedażowa 2015
dialer

wymagany

Typ dialera dla tworzonej kampanii . Przykładowa wartość: preview
crm

wymagany

Określa sposób zasilania kampanii: CRM lub CSV. Przykładowa wartość: true
active

opcjonalny

Określa czy kampania ma być aktywna po utworzeniu. Domyślnie aktywna. Przykładowa wartość: true
start_date

opcjonalny

Data rozpoczęcia kampanii. Domyślnie dzisiejszy dzień. Przykładowa wartość: 2015-10-05
end_date

opcjonalny

Data zakończenia kampanii. Przykładowa wartość: 2015-10-25
order

opcjonalny

Kolejność kampanii, wartość z zakresu 1-99999. Domyślnie 50 Przykładowa wartość: 50
parity

opcjonalny

Parytet kampanii, wartość z zakresu 1-100. Domyślnie 50 Przykładowa wartość: 50
parameters

opcjonalny

Obiekt parametrów które będą ustawione dla kampanii. Przykładowa wartość: { "caller_id": "123456789" }
group_id

opcjonalny

Id grupy kampani. Przykładowa wartość: 15

Uwagi

Pole parameters musi zawierać mapę gdzie kluczem jest nazwa parametru a wartością treść, którą chcemy ustawić.
Obsługiwane parametry:
  • caller_id - numer którym będzie się prezentować kampania
  • preview_timeout - liczba sekund jakie agent ma na zapoznanie z rekordem
  • predictive_max_calls - maksymalna wartość współczynnika naddzwaniania
  • predictive_min_calls - minimalna wartość współczynnika naddzwaniania
Pole dialer posiada mozliwość wybrania jednego z poniższych dialerów:
  • predictive
  • progressive
  • preview

Przykładowy request

POST https://your-system-name.thulium.com/api/outbounds
Dane {"id":"09098","name":"Some outbound name","start_date":"2015-09-10","end_date":"2015-09-12","dialer":"predictive","crm":true,"parameters":{"caller_id":"1234"}}

Przykładowy response

{
    "id": "09098","outbound_id": "21"
}

Przykładowe wywołanie


PHP 

<?php
$data = '{"id":"09098","name":"Some outbound name","start_date":"2015-09-10","end_date":"2015-09-12","dialer":"predictive","crm":true,"parameters":{"caller_id":"1234"}}';

$request = curl_init('https://your-system-name.thulium.com/api/outbounds');
curl_setopt($request, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json; charset=utf-8',
    'Content-Length: ' . mb_strlen($data)
));
curl_setopt($request, CURLOPT_USERPWD, 'api_user:api_pass');
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($request, CURLOPT_POSTFIELDS, $data);

$response = curl_exec($request);
if ($response) {
    $httpCode = curl_getinfo($request, CURLINFO_HTTP_CODE);
    if ($httpCode == 200){
        print_r(json_decode($response));
    } else {
        echo $response;
    }
} else {
    trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);
JAVA 

public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.post("https://your-system-name.thulium.com/api/outbounds", "{\"id\":\"09098\",\"name\":\"Some outbound name\",\"start_date\":\"2015-09-10\",\"end_date\":\"2015-09-12\",\"dialer\":\"predictive\",\"crm\":true,\"parameters\":{\"caller_id\":\"1234\"}}");
        System.out.println(response);
    }
}

CURL 

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{"id":"09098","name":"Some outbound name","start_date":"2015-09-10","end_date":"2015-09-12","dialer":"predictive","crm":true,"parameters":{"caller_id":"1234"}}' "https://your-system-name.thulium.com/api/outbounds"

HTTPie 

echo '{"id":"09098","name":"Some outbound name","start_date":"2015-09-10","end_date":"2015-09-12","dialer":"predictive","crm":true,"parameters":{"caller_id":"1234"}}' | http -a api_user:api_pass POST https://your-system-name.thulium.com/api/outbounds