Informacje

Uwierzytelnianie	wymagane
Format odpowiedzi	json
Metoda HTTP	POST

POST outbounds/:id/records

Ostatnia modyfikacja 1970-01-02 01:00:00

Dodanie rekordu do kampanii.

Za pomocą API nie można dodawać zduplikowanych numerów.

URL

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

Parametry

id wymagany	Pięcioznakowy identyfikator kampanii. Przykładowa wartość: `00001`
phone_number wymagany	Numer telefonu, na który będą wykonywane połączenia. Przykładowa wartość: `333444555`
status_id opcjonalny	Identyfikator statusu rekordu w kampanii. Przykładowa wartość: `8`
dictionary_status_id opcjonalny	Identyfikator statusu słownikowego. Przykładowa wartość: `8`
identifier opcjonalny	Unikalny identyfikator rekordu. Przykładowa wartość: `1234567890`
agent_login opcjonalny	Login agenta do którego zostanie przypisany rekord. Wymagane dla statusu systemowego MY_RECORD. Przykładowa wartość: `j.doe`
next_call_date opcjonalny	Data następnego kontaktu w formacie YYYY-MM-DD hh:mm. Wymagane dla statusu systemowego MY_RECORD i CALL_NO_SOONER_THAN. Przykładowa wartość: `2018-05-24 12:24`
record_fields opcjonalny	Obiekt z wartościami struktury kampanii. Przykładowa wartość: `{"field1":"value1","field2":"value2"}`
order opcjonalny	Kolejność rekordu. Przykładowa wartość: `50`

Uwagi

Pole record_fields musi zawierać mapę pól struktury kampanii gdzie kluczem jest tekstowa nazwa pola a wartością treść którą chcemy ustawić.
W obiekcie możemy przekazać tylko te pola, których wartości chcemy ustawić. Jeśli przekazana wartość pola kampanii będzie pusta zawartość pola zostanie usunięta.
W przypadku gdy pole specjalne nie istnieje zostanie zwrócony błąd walidacji.
Wartości pól kampanii możemy ustalać tylko w kampaniach nie CRM.

Przykładowy request

POST	`https://your-system-name.thulium.com/api/outbounds/00001/records`
Dane	`{ "phone_number": "111222333", "status_id": "3", "record_fields": { "field1": "value1", "field2": "value2" } }`

Przykładowy response

{
    "record_id": "231"
}

Przykładowe wywołanie

PHP

<?php
$data = '{
    "phone_number": "111222333",
    "status_id": "3",
    "record_fields": {
        "field1": "value1",
        "field2": "value2"
    }
}';

$request = curl_init('https://your-system-name.thulium.com/api/outbounds/00001/records');
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/00001/records", "{
    \"phone_number\": \"111222333\",
    \"status_id\": \"3\",
    \"record_fields\": {
        \"field1\": \"value1\",
        \"field2\": \"value2\"
    }
}");
        System.out.println(response);
    }
}

ThuliumRestClient.java (Wymaga biblioteki httpclient w wersji 4.3.5, httpcore w wersji 4.3.2, commons-codec w wersji 1.9, commons-logging w wersji 1.2)

CURL

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{
    "phone_number": "111222333",
    "status_id": "3",
    "record_fields": {
        "field1": "value1",
        "field2": "value2"
    }
}' "https://your-system-name.thulium.com/api/outbounds/00001/records"

HTTPie

echo '{
    "phone_number": "111222333",
    "status_id": "3",
    "record_fields": {
        "field1": "value1",
        "field2": "value2"
    }
}' | http -a api_user:api_pass POST https://your-system-name.thulium.com/api/outbounds/00001/records