Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP GET

GET outbounds/:id/records/:phone_number

Ostatnia modyfikacja 2025-11-07 13:34:16
Zwraca informacje o rekordzie w kampanii.

URL

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

Parametry

id

wymagany

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

wymagany

Numer telefonu dodany do kampanii. Przykładowa wartość: 333444555
include_record_fields

opcjonalny

Flaga odpowiedzialna za pokazywanie pól kampanii. Przykładowa wartość: true
search_in_additional_numbers

opcjonalny

Flaga odpowiedzialna za wyszukiwanie w numerach dodatkowych. Przykładowa wartość: true

Uwagi

W celu dołączenia pól zdefiniowanych w kampanii należy użyć flagi include_record_fields. Przyjmuje ona wartości true/false. Domyślnie jest ustawiona na false.
Przykładowe wywołanie: outbounds/00001/records/333444555?include_record_fields=true
W celu wyszukania po wszystkich numerach - łącznie z dodatkowymi należy użyć flagi search_in_additional_numbers. Przyjmuje ona wartości true/false. Domyślnie jest ustawiona na false.
Przykładowe wywołanie: outbounds/00001/records/333444555?search_in_additional_numbers=true
Pole system_status:
  • TO_CALL Do dzwonienia (świeżo dodane rekordy)
  • IN_PROGRESS Obrabiane
  • CALL Dzwonić
  • MY_RECORD Mój rekord
  • NO_CALL Nie dzwonić
  • ABANDONED_AFTER_N_TRIES Odrzucony po n próbach
  • CALL_NO_SOONER_THAN Kontakt nie wcześniej niż
  • CALL_PROGRESSIVE Dzwonić w trybie progressive (np. dla spadów w trybie predictive)

Przykładowy request

GET https://your-system-name.thulium.com/api/outbounds/00001/records/333444555

Przykładowy response

{
    "record_id": 228,
    "phone_number": "333444555",
    "system_status": "NO_CALL",
    "status": "Do not call",
    "status_id": 5,
    "call_date": "2016-10-19 14:02",
    "create_date": "2016-10-18 12:02",
    "next_call_date": "",
    "agent_name": "",
    "agent_login": "",
    "last_note": "Last note for record",
    "identifier": "1234567890",
    "order": ""
}

Przykładowe wywołanie


PHP 

<?php
$request = curl_init('https://your-system-name.thulium.com/api/outbounds/00001/records/333444555');
curl_setopt($request, CURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($request, CURLOPT_USERPWD, "api_user:api_pass");
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);

$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.get("https://your-system-name.thulium.com/api/outbounds/00001/records/333444555");
        System.out.println(response);
    }
}

CURL 

curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://your-system-name.thulium.com/api/outbounds/00001/records/333444555"

HTTPie 

http -a api_user:api_pass GET https://your-system-name.thulium.com/api/outbounds/00001/records/333444555 Accept:application/json