v2

Danh sách

POST[URL]/api/v2/callTransaction/search

Lấy danh sách lịch sửa cuộc gọi

Path Parameters

Name	Type	Description
page	integer	Thứ tự phân trang, bắt đầu bằng 1
size	int	Giới hạn số lượng phân tử của danh sách trả về, max = 50

Request Body

Name	Type	Description
fromDate	long	Thời gian bắt đầu
toDate	long	Thời gian kết thúc
directions	array	Hướng cuộc gọi gồm: outbound, inbound, local
tagIds	array	Danh sách ID của tag cần lọc
sipNumbers	array	Danh sách đầu số
sipUsers	array	Danh sách số nội bộ của nhân viên
phoneNumbers	array	Danh sách số điện thoại khách hàng
transactionIds	array	Danh sách call UUID của cuộc gọi
agentEmails	array	Danh sách email của nhân viên thực hiện cuộc gọi
agentUuids	array	Danh sách UUID nhân viên, không kết hợp lọc cùng agentEmails
isAutoCall	Boolean	Lọc cuộc gọi tự động
isCallBot	Boolean	Lọc cuộc gọi voiceBot
autoCallIds	array	Danh sách ID phiên gọi tự động thường hoặc voiceBot
isAnswer	Boolean	Lọc cuộc gọi có trả lời
queueDestinations	array	Danh sách nhóm nội bộ
outerGroups	array	Danh sách nhóm ngoài
keyInteractiveScripts	array	Danh sách số nội bộ của kịch bản tương tác phím
keyword	String	Từ khóa tìm kiếm lớn hơn 3 ký tự
sortField	String	Field cần sort
sortAsc	Boolean	Thứ tự sort

Headers

Name	Type	Description
Content-type	string	application/json
Authorization	string	Access Token: Bearer 'token'

200 Danh sách cuộc gọi

{
    "instance_id": "stg",
    "payload": {
        "items": [
            {
                "transaction_id": "", //Call UUID cuộc gọi
                "tenant_id": "", //ID của DN
                "direction": "outbound", //Hướng gọi
                "source_number": "xxx", //Số nguồn
                "destination_number": "xxx", //Số đích
                "bill_sec": 5, //Thời lượng cuộc gọi
                "record_seconds": 3, //Thời lượng file ghi âm
                "time_start_to_answer": 1729870387, //Thời gian bắt đầu trả lời
                "recording_file": "",
                "recording_file_url": "", //Link file ghi âm
                "recording_data": null,
                "sip_user": "999", //Số nội bộ nhân viên thực hiện
                "created_date": 1729870397069, //Ngày tạo
                "last_updated_date": 1730788680689, //Ngày cập nhật
                "is_auto_call": false, //Cờ đánh dấu cuộc gọi tự động
                "ivr": "none",
                "provider": "viettel", //Nhà mạng số điện thoại KH
                "duration": 10, //Tổng thời gian
                "user": [ //Thông tin nhân viên liên quan đến cuộc gọi
                    {
                        "full_name": "DEV ZONE",
                        "full_name_unsigned": "DEV ZONE",
                        "note": null,
                        "tag": null
                    },
                    {
                        "full_name": "DEV ZONE",
                        "full_name_unsigned": "dev zone",
                        "note": "OMIDEV",
                        "tag": [
                            {
                                "name": "ATC_01"
                            }
                        ]
                    }
                ],
                "customer": {//Thông tin khách hàng
                    "full_name": "Trần Đình Tâm",
                    "full_name_unsigned": "tran dinh tam"
                },
                "state": null,
                "call_uuid": null,
                "from_number": null,
                "to_number": null,
                "hotline": null,
                "is_have_forward_out": false,
                "bill_sec_forward_out": 0,
                "call_out_price": 66.000, //Cước gọi
                "note": null, //Thông tin ghi chú cuộc gọi
                "tag": [ //Danh sách ID tag cuộc gọi
                    "63c0bb010748c865ba321c53"
                ],
                "invite_failure_status": null,
                "answer_sec": 3, //Thời gian trả lời
                "autocall_uuid": null, //Mã UUID mapping thông tin chi tiết cuộc gọi auto call
                "autocall_id": null, //ID phiên gọi auto call
                "sip_number": "842499950291", //Đầu số
                "phone_number": "0983223566", //Số điện thoại khách hàng
                "create_by": { //Nhân viên thực hiện cuộc gọi
                    "id": "60e79bd864b64271a923affe",
                    "name": "DEV ZONE",
                    "contact_id": "60e79beb1b20043c4e7a68af",
                    "avatar": null,
                    "gender": null,
                    "uuid": null,
                    "type": "agent"
                },
                "transfer_histories": [], //Danh sách luồng cuộc gọi
                "user_data_str": null,
                "user_ref_code": null,
                "endby_name": "end_call_by_customer", //Nguyên nhân tắt máy
                "hangup_cause": "NORMAL_CLEARING",
                "sip_hangup_disposition": "send_bye",
                "hangup_cause_q850": 16,
                "is_voicemail": false, //Cờ đánh dấu cuộc gọi vào hộp thư thoại
                "recording_file_voicemail": null,
                "domain_fusion": "omicalltest1",
                "send_num_retry": 0,
                "time_start_call": 1729870387, //Thời gian thực hiện cuộc gọi
                "time_end_call": 1729870396, //Thời gian kết thúc cuộc gọi
                "out_of_working_time": true,
                "sip_number_tags": [],
                "evaluations": null,
                "total_evaluate": null,
                "internal_destination": null,
                "classifies": null,
                "collect_info_variables": null //Danh sách kết quả thu thập cuộc gọi voice bot
            }
        ],
        "page_number": 1,
        "page_size": 50,
        "total_items": 1,
        "total_pages": 1,
        "has_next": false,
        "next_page": 1,
        "has_previous": false,
        "previous_page": 1,
        "extension": null
    },
    "instance_version": "1.2.164",
    "key_enabled": false,
    "status_code": 9999
}

Mã Lỗi	Mô tả
missing_time_query	Thiếu bộ lọc thời gian
date_is_too_long	Khoảng cách thời gian quá lớn, giới hạn trong 3 tháng gần nhất
email_agent_not_found	Bộ lọc email nhân viên không đúng hoặc không có giữ liệu nhân viên
uuid_agent_not_found	Bộ lọc agentUuids không đúng hoặc không có giữ liệu nhân viên

Chi tiết cuộc gọi

POST[URL]/api/v2/callTransaction/getByTransactionId

Lấy thông tin chi tiết cuộc gọi

Request Body

Name	Type	Description
transactionId	String	Call UUID cuộc gọi

Headers

Name	Type	Description
Content-type	string	application/json
Authorization	string	Access token: Bearer 'token'

200 Yêu cầu thành công

{
    "instance_id": "stg",
    "payload": {
        "transaction_id": "", //Call UUID cuộc gọi
        "tenant_id": "", //ID của DN
        "direction": "outbound", //Hướng gọi
        "source_number": "xxx", //Số nguồn
        "destination_number": "xxx", //Số đích
        "bill_sec": 5, //Thời lượng cuộc gọi
        "record_seconds": 3, //Thời lượng file ghi âm
        "time_start_to_answer": 1729870387, //Thời gian bắt đầu trả lời
        "recording_file": "",
        "recording_file_url": "", //Link file ghi âm
        "recording_data": null,
        "sip_user": "999", //Số nội bộ nhân viên thực hiện
        "created_date": 1729870397069, //Ngày tạo
        "last_updated_date": 1730788680689, //Ngày cập nhật
        "is_auto_call": false, //Cờ đánh dấu cuộc gọi tự động
        "ivr": "none",
        "provider": "viettel", //Nhà mạng số điện thoại KH
        "duration": 10, //Tổng thời gian
        "user": [ //Thông tin nhân viên liên quan đến cuộc gọi
            {
                "full_name": "DEV ZONE",
                "full_name_unsigned": "DEV ZONE",
                "note": null,
                "tag": null
            },
            {
                "full_name": "DEV ZONE",
                "full_name_unsigned": "dev zone",
                "note": "OMIDEV",
                "tag": [
                    {
                        "name": "ATC_01"
                    }
                ]
            }
        ],
        "customer": {//Thông tin khách hàng
            "full_name": "Trần Đình Tâm",
            "full_name_unsigned": "tran dinh tam"
        },
        "state": null,
        "call_uuid": null,
        "from_number": null,
        "to_number": null,
        "hotline": null,
        "is_have_forward_out": false,
        "bill_sec_forward_out": 0,
        "call_out_price": 66.000, //Cước gọi
        "note": null, //Thông tin ghi chú cuộc gọi
        "tag": [ //Danh sách ID tag cuộc gọi
            "63c0bb010748c865ba321c53"
        ],
        "invite_failure_status": null,
        "answer_sec": 3, //Thời gian trả lời
        "autocall_uuid": null, //Mã UUID mapping thông tin chi tiết cuộc gọi auto call
        "autocall_id": null, //ID phiên gọi auto call
        "sip_number": "842499950291", //Đầu số
        "phone_number": "0983223566", //Số điện thoại khách hàng
        "create_by": { //Nhân viên thực hiện cuộc gọi
            "id": "60e79bd864b64271a923affe",
            "name": "DEV ZONE",
            "contact_id": "60e79beb1b20043c4e7a68af",
            "avatar": null,
            "gender": null,
            "uuid": null,
            "type": "agent"
        },
        "transfer_histories": [], //Danh sách luồng cuộc gọi
        "user_data_str": null,
        "user_ref_code": null,
        "endby_name": "end_call_by_customer", //Nguyên nhân tắt máy
        "hangup_cause": "NORMAL_CLEARING",
        "sip_hangup_disposition": "send_bye",
        "hangup_cause_q850": 16,
        "is_voicemail": false, //Cờ đánh dấu cuộc gọi vào hộp thư thoại
        "recording_file_voicemail": null,
        "domain_fusion": "omicalltest1",
        "send_num_retry": 0,
        "time_start_call": 1729870387, //Thời gian thực hiện cuộc gọi
        "time_end_call": 1729870396, //Thời gian kết thúc cuộc gọi
        "out_of_working_time": true,
        "sip_number_tags": [],
        "evaluations": null,
        "total_evaluate": null,
        "internal_destination": null,
        "classifies": null,
        "collect_info_variables": null //Danh sách kết quả thu thập cuộc gọi voice bot
            },
        "call_stacks": [
             {
                "from": "0909689867", // Vị trí khởi tạo của leg call (stack)
                "to": "70759-118", //Nhân viên thuộc nhóm nội bộ
                "phone_number": "0909689867", //Số điện thoại khách hàng
                "type": "criteria-script", //Tiêu chí
                "at": 1757408394, //Thời điểm cuộc gọi đi vào nhánh
                "ringing_at": 1757408394, //Thời điểm cuộc gọi bắt đầu ring đến user
                "answer_at": 1757408400, //Thời điểm user bắt máy
                "bye_at": 1757408408, //Thời điểm kết thúc nhánh (stack)
                "index": 1,
                "is_answer": true, //Trạng thái trả lời
                "is_online": true, //Trạng thái trực tuyến
                "is_busy": false, //Trạng thái bận (user đang trong cuộc gọi khác)
                "is_dnd": false, //Trạng thái không làm phiền
                "timeout": 30
            },
    "instance_version": "1.2.164",
    "key_enabled": false,
    "status_code": 9999
}

Cập nhật thông tin cuộc gọi

POST [URL]/api/call_transaction/change/:transaction_id

- Cập nhật các thông tin bổ sung cho lịch sử cuộc gọi

Path Parameters

Name	Type	Description
transaction_id	string	Id cuộc gọi

Headers

Name	Type	Description
Content-type	string	application/json
Authorization	string	Access token: Bearer 'token'

Request Body

Name	Type	Description
tag	array	Danh sách Tag được gán với lịch sử cuộc gọi Ví dụ : tag : ["hailong","goilaisau"]
note	string	Ghi chú cuộc gọi

200

{
    "status_code": 9999,
    "payload": {
        "transaction_id": "91d3e842-9da2-43ec-8bb1-979c17e817ad",
        "direction": "outbound",
        "source_number": "842727777787",
        "destination_number": "0979816773",
        "disposition": "answered",
        "bill_sec": 232,
        "record_seconds": 232,
        "time_start_to_answer": 1589015432,
        "recording_file": "https://drive.google.com/uc?id=1Jry_LGzQM....",
        "sip_user": "101",
        "created_date": 1589015675440,
        "last_updated_date": 1589015678726,
        "ivr": "none",
        "note": null,
        "provider": "viettel",
        "note": "Ghi chu cuoc goi",
        "tag":["hailong","dongy","vip"],
        "duration": 242,
        "user": [
            {
                "full_name": "TestBoss 123",
                "full_name_unsigned": "TestBoss 123",
                "note": "Ghi chu cuoc goi",
                "tag" :[ // Danh sách thẻ tag cuộc gọi
                    {"name": "hailong"},
                    {"name": "dongy"},
                    {"name": "vip"}
                ]
            }
        ],
        "customer": {
            "full_name": "Trần Văn Tiến 1",
            "full_name_unsigned": "Tran Van Tien 1"
        }
    }
}

Danh sách tiêu chí đánh giá cuộc gọi

GET [URL]/api/evaluation_criteria/call/list

Headers

Name	Type	Description
Authorization*	String	Access token: Bearer 'token'

Lấy danh sách chi tiết lịch sử cuộc gọi

POST https://public-v1-stg.omicall.com/api/call_transaction/search

Danh sách chi tiết lịch sử cuộc gọi, lấy chi tiết rút gọn

Dữ liệu Body truyền lên dưới định dạng JSON. Ví dụ:

{

"from_date" : 1693846799000,

"to_date" : 1696438799000,

"user_uuids" : ["0123456789"]

}

Path Parameters

Name	Type	Description
page	int	Page cần get (= 1)
size	int	Số phần tử trong trang (max 50 item)

Headers

Name	Type	Description
x-api-key*	String	API key
Content-Type*	String	application/json

Request Body

Name	Type	Description
from_date*	String	Thời gian bắt đầu lấy log (milisecond)
to_date*	String	Thời gian kết thúc lấy log (milisecond)
user_uuids*	List<String>	Danh sách user UUID
direction	List<String>	Hướng gọi ("inbound", "outbound", "local")
disposition	List<String>	Trạng thái trả lời/không trả lời ("answered", "cancelled")
tags	List<String>	Danh sách ID tags
numbers	List<String>	Danh sách đầu số

200: OK Dữ liệu trả về thành công (JSON format)

// sample data
{
  "instance_id": "stg",
  "payload": {
    "items": [
      {
        "_id": "123400000000000000000000",
        "created_date": 946659600000,
        "last_updated_date": 946659600000,
        "create_by": {
          "id": "123400000000000000000000",
          "name": "Lorem ipsum dolor sit amet.",
          "contact_id": "123400000000000000000000",
          "type": "agent",
          "extension": "0123456"
        },
        "tenant_id": "123400000000000000000000",
        "transaction_id": "7125081d-288a-4d35-8eb1-012345678912",
        "direction": "local",
        "source_number": "0123456",
        "destination_number": "0123456",
        "disposition": "cancelled",
        "duration": 28,
        "bill_sec": 0,
        "record_seconds": 0,
        "time_start_call": 9466596000,
        "time_end_call": 9466596000,
        "time_start_to_answer": 9466596000,
        "ms_time_start_to_answer": 946659600000,
        "time_start_media": 9466596000,
        "wait_sec": 0,
        "hold_call_sec": 0,
        "hangup_cause": "ORIGINATOR_CANCEL",
        "hangup_cause_q850": 16,
        "customer": {
          "_id": "649e981afd4c703b39692f5f",
          "full_name": "Lorem ipsum dolor sit amet.",
          "full_name_unsigned": "Lorem ipsum dolor sit amet.",
          "uuid": "0123456789",
          "type": "extension",
          "extension": "0123456"
        },
        "user": [
          {
            "_id": "123400000000000000000000",
            "full_name": "Lorem ipsum dolor sit amet.",
            "full_name_unsigned": "Lorem ipsum dolor sit amet.",
            "tags_view": [],
            "note_created_date": 1696421425598
          }
        ],
        "sip_user": "0123456",
        "is_stop_ivr": false,
        "ivr": "none",
        "is_have_forward_out": false,
        "is_auto_call": false,
        "is_deleted": false,
        "rtp_audio_in_mos": 4.5,
        "is_callbot": false,
        "dial_status": "CANCEL",
        "answer_sec": 0,
        "domain_fusion": "Lorem ipsum dolor sit amet.",
        "sip_from_user": "1000071",
        "nation": "vn",
        "is_ai": false,
        "domain": "Lorem ipsum dolor sit amet.",
        "playback_seconds": 0,
        "pbx_type": "",
        "is_trunk": false,
        "suspicious_checked": false,
        "is_missed_call": false,
        "is_analyzed": false,
        "internal_destination": {
          "id": "123400000000000000000000",
          "contact_id": "649e981afd4c703b39692f5f",
          "name": "Lorem ipsum dolor sit amet.",
          "uuid": "0123456789",
          "extension": "0123456",
          "type": "extension"
        }
      }
    ],
    "pageNumber": 1,
    "pageSize": 20,
    "totalItems": 1000,
    "totalPages": 100,
    "hasNext": true,
    "nextPage": 2,
    "hasPrevious": false,
    "previousPage": 1
  },
  "instance_version": "1.0.0",
  "key_enabled": false,
  "status_code": 9999
}

Đánh giá cuộc gọi theo tiêu chí

POST [URL]/api/call_transaction/add_evaluation/:transaction_id

Path Parameters

Name	Type	Description
transaction_id*	String	Transaction Id cuộc gọi

Request Body

Name	Type	Description
user_uuid*	String	Id của User bên thứ 3 hoặc Số máy lẻ trong hệ thống
evaluation*	Object	Đối tượng chưa thông tin đánh giá, json format như sau (Format như ảnh bên dưới )

200: OK Thông tin cuộc gọi + đánh giá

201

Mã Lỗi	Mô tả
missing_params	Request Body thiếu hoặc sai format