| Uwierzytelnianie | wymagane |
| Format odpowiedzi | json |
| Metoda HTTP | PUT |
Edytowanie wielu rekordów w kampanii.
Za pomocą API nie można edytować zduplikowanych numerów.
https://your-system-name.thulium.com/api/batch/outbounds/:id/records
|
id
wymagany |
Pięcioznakowy identyfikator kampanii.
Przykładowa wartość: 00001
|
|
records
wymagany |
Lista rekordów do edycji. Każdy rekord z parametrami: |
|
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
|
|
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"}
|
|
search_in_additional_numbers
opcjonalny |
Flaga odpowiedzialna za wyszukiwanie w numerach dodatkowych.
Przykładowa wartość: 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: batch/outbounds/00001/records?search_in_additional_numbers=true |
| PUT | https://your-system-name.thulium.com/api/batch/outbounds/00001/records |
| Dane | {
"records": [
{
"phone_number": "111222333",
"status_id": "3",
"record_fields": {
"pole1": "wartosc1",
"pole2": "wartosc2"
}
},
{
"phone_number": "555123321",
"agent_login": "user"
}
]
} |
{
"111222333": {
"http_status": 204
},
"555123321": {
"http_status": 400,
"message": "Agent not found."
}
}
<?php $data = '{ "records": [ { "phone_number": "111222333", "status_id": "3", "record_fields": { "pole1": "wartosc1", "pole2": "wartosc2" } }, { "phone_number": "555123321", "agent_login": "user" } ] }'; $request = curl_init('https://your-system-name.thulium.com/api/batch/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, 'PUT'); 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);
public class Example { public static void main(String[] args) throws Exception { ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true); ThuliumRestClient.ThuliumRestResponse response = restClient.put("https://your-system-name.thulium.com/api/batch/outbounds/00001/records", "{ \"records\": [ { \"phone_number\": \"111222333\", \"status_id\": \"3\", \"record_fields\": { \"pole1\": \"wartosc1\", \"pole2\": \"wartosc2\" } }, { \"phone_number\": \"555123321\", \"agent_login\": \"user\" } ] }"); System.out.println(response); } }
curl -u api_user:api_pass -k -X PUT -H "Content-type: application/json" -d '{ "records": [ { "phone_number": "111222333", "status_id": "3", "record_fields": { "pole1": "wartosc1", "pole2": "wartosc2" } }, { "phone_number": "555123321", "agent_login": "user" } ] }' "https://your-system-name.thulium.com/api/batch/outbounds/00001/records"
echo '{ "records": [ { "phone_number": "111222333", "status_id": "3", "record_fields": { "pole1": "wartosc1", "pole2": "wartosc2" } }, { "phone_number": "555123321", "agent_login": "user" } ] }' | http -a api_user:api_pass PUT https://your-system-name.thulium.com/api/batch/outbounds/00001/records