Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST batch/crm_outbounds/:id/records

Ostatnia modyfikacja 2024-11-20 13:20:36
Dodanie wielu rekordów do kampanii CRM.

W rezultacie zwracana jest lista klientów wraz z informacją o statusie oraz identyfikatorze dodanego rekordu. Zwracany status przyjmować może dwie wartości:
ADDED - klient został dodany do kampanii
ALREADY_EXISTS - klient już był dodany do kampanii,
FAILED - dodanie klienta do kampanii nie powiodło się.

URL

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

Parametry

id

wymagany

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

wymagany

Lista rekordów do dodania. Każdy rekord z parametrami:
          customer_id

          wymagany

Identyfikator klienta zapisanego w CRM. Przykładowa wartość: 441
          status_id

          opcjonalny

Identyfikator statusu rekordu w kampanii. Przykładowa wartość: 8
          dictionary_status_id

          opcjonalny

Identyfikator statusu słownikowego. Przykładowa wartość: 8
          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
          order

          opcjonalny

Kolejność rekordu Przykładowa wartość: 50

Przykładowy request

POST https://your-system-name.thulium.com/api/batch/crm_outbounds/00001/records
Dane { "records": [ { "customer_id": 441, "status_id": 3 }, { "customer_id": 445, "status_id": 1 }, { "customer_id": 448, "status_id": 1 } ] }

Przykładowy response

{
    "441": {
        "http_status": 201,
        "record_id": 111,
        "status": "ADDED"
    },
    "445": {
        "http_status": 400,
        "record_id": 100,
        "status": "ALREADY_EXISTS"
    },
    "448": {
        "http_status": 400,
        "status": "FAILED",
        "message": "Customer not found."
    }
}

Przykładowe wywołanie


PHP

<?php
$data 
'{
    "records": [
        {
            "customer_id": 441,
            "status_id": 3
        },
        {
            "customer_id": 445,
            "status_id": 1
        },
        {
            "customer_id": 448,
            "status_id": 1
        }
    ]
}'
;

$request curl_init('https://your-system-name.thulium.com/api/batch/crm_outbounds/00001/records');
curl_setopt($requestCURLOPT_HTTPHEADER, array(
    
'Content-Type: application/json; charset=utf-8',
    
'Content-Length: ' mb_strlen($data)
));
curl_setopt($requestCURLOPT_USERPWD'api_user:api_pass');
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);
curl_setopt($requestCURLOPT_CUSTOMREQUEST'POST');
curl_setopt($requestCURLOPT_POSTFIELDS$data);

$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.post("https://your-system-name.thulium.com/api/batch/crm_outbounds/00001/records", "{
    \"records\": [
        {
            \"customer_id\": 441,
            \"status_id\": 3
        },
        {
            \"customer_id\": 445,
            \"status_id\": 1
        },
        {
            \"customer_id\": 448,
            \"status_id\": 1
        }
    ]
}");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{
    "records": [
        {
            "customer_id": 441,
            "status_id": 3
        },
        {
            "customer_id": 445,
            "status_id": 1
        },
        {
            "customer_id": 448,
            "status_id": 1
        }
    ]
}' "https://your-system-name.thulium.com/api/batch/crm_outbounds/00001/records"

HTTPie

echo '{
    "records": [
        {
            "customer_id": 441,
            "status_id": 3
        },
        {
            "customer_id": 445,
            "status_id": 1
        },
        {
            "customer_id": 448,
            "status_id": 1
        }
    ]
}' | http -a api_user:api_pass POST https://your-system-name.thulium.com/api/batch/crm_outbounds/00001/records