Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST agents/:login/call

Ostatnia modyfikacja 2022-11-03 14:45:19

Zestawia połączenie dla agenta na podany numer. Połączenie będzie raportowane w ramach wskazanej kampanii (aby raportowanie było poprawne kampania musi być kampanią uproszczoną).

Aby wykonywać połączenia należy stworzyć kampanię i przypisać do niej agenta.

Domyślnie kampania jest wybierana automatycznie na podstawie przypisania agenta do kampanii.

URL

https://api.thulium.com/api/agents/:login/call

Parametry

login

wymagany

Login agenta. Przykładowa wartość: jkowalski
phone_number

wymagany

Numer telefonu, na który zostanie zestawione połączenie. Opcjonalny jeśli podano customer_id. Przykładowa wartość: 111222333
outbound_id

opcjonalny

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

opcjonalny

Identyfikator klienta zapisanego w CRM. Przykładowa wartość: 321
caller_id

opcjonalny

Numer prezentacji (domyślnie brany jest z routingu połączeń lub parametrów kampanii). Przykładowa wartość: 321
custom_data

opcjonalny

Dodatkowe dane które zostaną przesyłane w webhookach. Przykładowa wartość: {"example":"json"} / some-id-123

Uwagi

Jeśli podany zostanie identyfikator klienta customer_id, pole numeru telefonu phone_number nie jest wymagane. W przypadku podania tylko identyfikatora klienta system zestawi połączenie na główny numer telefonu klienta.
Jeśli zostanie podany identyfikator klienta customer_id i numer telefonu phone_number system sprawdzi czy podany numer telefonu jest przypisany do klienta, jeśli zostanie odnaleziony zestawi połączenie dla podanego klienta na żądany numer.

Przykładowy request

POST https://api.thulium.com/api/agents/jkowalski/call
Dane {"phone_number":"111222333"}

Przykładowy response

<!-- pusty -->

Przykładowe wywołanie


PHP 

<?php
$data = '{"phone_number":"111222333"}';

$request = curl_init('https://api.thulium.com/api/agents/jkowalski/call');
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://api.thulium.com/api/agents/jkowalski/call", "{\"phone_number\":\"111222333\"}");
        System.out.println(response);
    }
}

CURL 

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{"phone_number":"111222333"}' "https://api.thulium.com/api/agents/jkowalski/call"

HTTPie 

echo '{"phone_number":"111222333"}' | http -a api_user:api_pass POST https://api.thulium.com/api/agents/jkowalski/call