Informacje

Autentykacja wymagana
Format odpowiedzi json
Metoda HTTP GET

GET crm_outbounds/:id/records

Ostatnia modyfikacja 2017-09-21 17:31:54

Zwraca listę rekordów w kampanii wraz z podstawowymi parametrami w kolejności dodawania do kampanii.

Parametr count zwraca liczbę znalezionych rekordów w kampanii (uwzględniając filtry).

URL

https://api.thulium.pl/api/crm_outbounds/:id/records

Parametry

id

wymagany

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

opcjonalny

Liczba rekordów, które mają być zwrócone. Domyślnie: 100. Maksymalna wartość: 100. Przykładowa wartość: 100
offset

opcjonalny

Od którego rekordu należy zwrócić rezultat (używane, gdy rekordów jest więcej, niż limit). Domyślna wartość: 0. Przykładowa wartość: 10
order

opcjonalny

Lista pól, po których będą posortowane rezultaty. Prefiks '-' oznacza sortowanie malejące, brak prefiksu rosnące. Możliwe jest sortowanie po polach: next_call_date. Przykładowa wartość: -next_call_date
status_id[]

opcjonalny

Identyfikator statusu z kampanii (jeden lub wiele). Przykładowa wartość: [10, 15]
system_status[]

opcjonalny

Identyfikator statusu systemowego (jeden lub wiele). Przykładowa wartość: [TO_CALL, CALL]
create_date_from

opcjonalny

Minimalna data utworzenia rekordu. Format YYYY-MM-DD. Przykładowa wartość: 2016-10-18
create_date_to

opcjonalny

Maksymalna data utworzenia rekordu. Format YYYY-MM-DD. Przykładowa wartość: 2016-10-20
call_date_from

opcjonalny

Minimalna data ostatniej rozmowy. Format YYYY-MM-DD. Przykładowa wartość: 2016-10-18
call_date_to

opcjonalny

Maksymalna data ostatniej rozmowy. Format YYYY-MM-DD. Przykładowa wartość: 2016-10-20
include_customer

opcjonalny

Czy dołączyć dane klienta do zwracanych rekordów. Przykładowa wartość: true
include_custom_fields

opcjonalny

Czy zwracać pola specjalne klienta. Przykładowa wartość: true
include_address

opcjonalny

Czy zwracać adres klienta. Przykładowa wartość: true

Uwagi

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://api.thulium.pl/api/crm_outbounds/00001/records?limit=5&offset=0&order=-next_call_date&status_id[]=10&status_id[]=15

Przykładowy response

{
        "count": 1,
        "result": [
            {
                "record_id": 228,
                "phone_number": "5555",
                "system_status": "NO_CALL",
                "status": "Nie dzwonić",
                "status_id": 5,
                "call_date": "2016-10-19 14:02",
                "create_date": "2016-10-18 12:02",
                "next_call_date": "",
                "agent_name": "",
                "agent_login": "",
                "customer_id": 311,
                "last_note": "Ostatnia notatka dla rekordu",
                "order":""
            }
        ]
}

Przykładowe wywołanie


PHP

<?php
$request 
curl_init('https://api.thulium.pl/api/crm_outbounds/00001/records?limit=5&offset=0&order=-next_call_date&status_id[]=10&status_id[]=15');
curl_setopt($requestCURLOPT_HTTPHEADER, array('Content-Type: application/json; charset=utf-8'));
curl_setopt($requestCURLOPT_USERPWD"api_user:api_pass");
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);

$response curl_exec($request);
if (
$response) {
    
$httpCode curl_getinfo($requestCURLINFO_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://api.thulium.pl/api/crm_outbounds/00001/records?limit=5&offset=0&order=-next_call_date&status_id[]=10&status_id[]=15");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X GET -H "Accept: application/json" "https://api.thulium.pl/api/crm_outbounds/00001/records?limit=5&offset=0&order=-next_call_date&status_id[]=10&status_id[]=15"