# Voice Insights API

## Bước 1: Đăng ký webhook url để nhận kết quả ASR

<mark style="color:green;">`POST`</mark> [`https://public-v1-stg.omicrm.com/api/ai/register_webhook_ai`](https://public-v1-stg.omicrm.com/api/ai/register_webhook_ai)

#### Headers

| Name                                     | Type   | Description                    |
| ---------------------------------------- | ------ | ------------------------------ |
| apiKey<mark style="color:red;">\*</mark> | String | Token xác thực để truy cập API |

#### Request Body

| Name                                  | Type   | Description            |
| ------------------------------------- | ------ | ---------------------- |
| url<mark style="color:red;">\*</mark> | String | Đường dẫn nhận dữ liệu |

{% tabs %}
{% tab title="200: OK Thành công" %}

{% endtab %}
{% endtabs %}

Kết Quả Từ Hook

<div align="center"><figure><img src="https://3454047468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LukDt3aTxo8xMLonIwO%2Fuploads%2FYjACg4heHTmKvKnGjA0W%2Fimage.png?alt=media&#x26;token=0d144720-f43d-4512-8bcf-0a4cc20faf7c" alt=""><figcaption></figcaption></figure></div>

| Name                             | Type   | Description                                                                    |
| -------------------------------- | ------ | ------------------------------------------------------------------------------ |
| analyst\_results                 | Object | Tổng hợp các kết quả phân tích                                                 |
| criteria\_classification\_result | Object | Kết quả chấm điểm tự động theo bộ tiêu chí                                     |
| customer\_talk\_time             | Double | Thời gian nói của khách hàng                                                   |
| customer\_word\_alignments       | String | Kết quả chi tiết từng từ của khách hàng từ ASR                                 |
| keyword\_count                   | Object | Danh sách từ khóa tìm được và số lần xuất hiện                                 |
| nl\_analyze\_result              | Object | Kết quả trả về từ mô hình ngôn ngữ lớn (LLM) như GPT                           |
| quality\_evaluation\_result      | Object | Bảng điểm chất lượng tổng hợp cho STAFF và CUSTOMER                            |
| result\_nlp\_analytics           | Object | Kết quả chi tiết từng phân đoạn hội thoại. Tổng hợp thông tin theo một câu nói |
| staff\_talk\_time                | Double | Thời gian nói của nhân viên                                                    |
| staff\_word\_alignments          | Object | Kết quả chi tiết từng từ của nhân viên từ ASR                                  |
| tracking\_id                     | String | ID truyền vào lúc gửi request phân tích qua để Mapping kết quả với request     |

##

## Bước 2: Upload audio, kết quả ASR sẽ được trả về webhook url&#x20;

<mark style="color:green;">`POST`</mark> [`https://public-v1-stg.omicrm.com/api/ai/call_analyze`](https://public-v1-stg.omicrm.com/api/ai/register_webhook_ai)

#### Headers

| Name                                     | Type   | Description                    |
| ---------------------------------------- | ------ | ------------------------------ |
| apiKey<mark style="color:red;">\*</mark> | String | Token xác thực để truy cập API |
| Content-Type                             | String | multipart/form-data;           |

#### Request Body ( Form Data)

| Name                                           | Type   | Description                                                            |
| ---------------------------------------------- | ------ | ---------------------------------------------------------------------- |
| file<mark style="color:red;">\*</mark>         | String | audio file (định dạng hỗ trợ  .wav/ . mp3/.m4a ) muốn chuyển sang text |
| tracking\_id<mark style="color:red;">\*</mark> | String | String chứa ID để khi nhận Webhook client biết kết quả của request nào |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}