Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST voicebots/:name/calls/:call_id/transcript

Ostatnia modyfikacja 2024-11-20 13:20:36
Dodaje transkrypcję połączenia z voicebotem.

URL

https://your-system-name.thulium.com/api/voicebots/:name/calls/:call_id/transcript

Parametry

name

wymagany

Nazwa voicebota Przykładowa wartość: VendorName
call_id

wymagany

Identyfikator rozmowy z nagłówka SIP "X-Thulium-Id" Przykładowa wartość: 1234567.89
duration

opcjonalny

Czas trwania rozmowy w formacie HH:MM:SS Przykładowa wartość: 02:05:12
language

opcjonalny

Język rozmowy (np. pl, en, de) Przykładowa wartość: pl
note

opcjonalny

Notatka Przykładowa wartość: Opis konwersacji
status

wymagany

Status zakończenia połączenia z voicebotem. Dopuszczalne wartości: TRANSFERRED (przełączono rozmowę do kolejki), ABANDONED (klient się rozłączył). Przykładowa wartość: TRANSSFERRED|ABANDONED
body

wymagany

Transkrypcja Przykładowa wartość: [{"party":"bot","message":"Hej, w czym moge pomoc","timestamp":"2022-05-01T15:10:00.000Z"},{"party":"caller","message":"Przelacz mnie do kolejki","timestamp":"2022-05-01T15:10:05.000Z"}]
party

wymagany

Strona połączenia. Dopuszczalne wartości: voicebot, caller Przykładowa wartość: bot|caller
message

wymagany

Treść wypowiedzi Przykładowa wartość: Dzień dobry, chciałem porozmawiać o produkcie x
timestamp

wymagany

Znacznik czasu rozpoczęcia wypowiedzi w formacie YYYY-MM-DDThh:mm:ss.sssZ Przykładowa wartość: 2022-05-01T15:10:05.000Z

Przykładowy request

POST https://your-system-name.thulium.com/api/voicebots/some-voicebot-name/calls/1234567.89/transcript
Dane {"duration":"00:02:51","language":"pl","status":"TRANSFERRED","note":"Opis konwersacji","body":[{"party":"voicebot","message":"Hej, w czym moge pomoc","timestamp":"2022-05-01T15:10:00.000Z"},{"party":"caller","message":"Przelacz mnie do kolejki","timestamp":"2022-05-01T15:10:05.000Z"}]}

Przykładowy response

<!-- pusty -->

Przykładowe wywołanie


PHP 

<?php
$data = '{"duration":"00:02:51","language":"pl","status":"TRANSFERRED","note":"Opis konwersacji","body":[{"party":"voicebot","message":"Hej, w czym moge pomoc","timestamp":"2022-05-01T15:10:00.000Z"},{"party":"caller","message":"Przelacz mnie do kolejki","timestamp":"2022-05-01T15:10:05.000Z"}]}';

$request = curl_init('https://your-system-name.thulium.com/api/voicebots/some-voicebot-name/calls/1234567.89/transcript');
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://your-system-name.thulium.com/api/voicebots/some-voicebot-name/calls/1234567.89/transcript", "{\"duration\":\"00:02:51\",\"language\":\"pl\",\"status\":\"TRANSFERRED\",\"note\":\"Opis konwersacji\",\"body\":[{\"party\":\"voicebot\",\"message\":\"Hej, w czym moge pomoc\",\"timestamp\":\"2022-05-01T15:10:00.000Z\"},{\"party\":\"caller\",\"message\":\"Przelacz mnie do kolejki\",\"timestamp\":\"2022-05-01T15:10:05.000Z\"}]}");
        System.out.println(response);
    }
}

CURL 

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{"duration":"00:02:51","language":"pl","status":"TRANSFERRED","note":"Opis konwersacji","body":[{"party":"voicebot","message":"Hej, w czym moge pomoc","timestamp":"2022-05-01T15:10:00.000Z"},{"party":"caller","message":"Przelacz mnie do kolejki","timestamp":"2022-05-01T15:10:05.000Z"}]}' "https://your-system-name.thulium.com/api/voicebots/some-voicebot-name/calls/1234567.89/transcript"

HTTPie 

echo '{"duration":"00:02:51","language":"pl","status":"TRANSFERRED","note":"Opis konwersacji","body":[{"party":"voicebot","message":"Hej, w czym moge pomoc","timestamp":"2022-05-01T15:10:00.000Z"},{"party":"caller","message":"Przelacz mnie do kolejki","timestamp":"2022-05-01T15:10:05.000Z"}]}' | http -a api_user:api_pass POST https://your-system-name.thulium.com/api/voicebots/some-voicebot-name/calls/1234567.89/transcript