# Nhân viên ## Danh sách nhân viên `GET` `[URL]/api/agent/list` Danh sách nhân viên của doanh nghiệp \* Tạm dừng cập nhật từ ngày 01/04/2026, vui lòng sử dụng [API v3](https://api.omicall.com/omicall-api/nhan-vien#danh-sach-nhan-vien-v3) #### Query Parameters
NameTypeDescription
pagenumberPage (mặc định là 1)
sizenumberSize (kích thước trang) : mặc định là 50
keywordstringTừ khóa tìm kiếm
- Họ và tên
- Email
- SĐT
#### Headers | Name | Type | Description | | ------------- | ------ | ---------------------------- | | Authorization | string | Access token, Bearer 'token' | {% tabs %} {% tab title="200 Danh sách nhân viên" %} ``` { "status_code": 9999, "instance_id": "stg", "instance_version": "1.1.951", "payload": { "next_page": 2, "page_number": 1, "has_previous": false, "has_next": true, "total_pages": 3, "previous_page": 1, "items": [ { "create_by": { "name": "Omi Team" }, "last_update_by": { "name": "Omi Team" }, "created_date": 1611889185166, "last_updated_date": 1611889185446, "public_id": null, "contact_type": "agent", "tags_view": [], "is_deleted": false, "tags": [], "is_active": true, "identify_info": "vietnam1@gmail.com", "attribute_structure": [ { "identify": null, "field_code": "full_name", "field_type": "single_text", "value": [ { "display_value": "Tran Van Tien", "data_type": "single_text", "value_type": null } ] }, { "identify": null, "field_code": "mail", "field_type": "email", "value": [ { "display_value": "vietnam1@gmail.com", "data_type": "personal", "value_type": "Cá nhân" } ] }, { "identify": null, "field_code": "gender", "field_type": "radio", "value": [ { "display_value": "male", "data_type": "male", "value_type": "Nam" } ] }, { "identify": null, "field_code": "phone_number", "field_type": "phone", "value": [ { "display_value": null, "data_type": "personal", "value_type": "Cá nhân" } ] } ] }, { "create_by": { "name": "Omi Team" }, "last_update_by": { "name": "Omi Team" }, "created_date": 1608024393791, "last_updated_date": 1608024393791, "public_id": null, "contact_type": "agent", "tags_view": [], "is_deleted": false, "tags": [], "is_active": false, "identify_info": "hanhttm@vihat.vn", "attribute_structure": [ { "identify": null, "field_code": "full_name", "field_type": "single_text", "value": [ { "display_value": "hanhttm", "data_type": "single_text", "value_type": null } ] }, { "identify": null, "field_code": "mail", "field_type": "email", "value": [ { "display_value": "hanhttm@vihat.vn", "data_type": "personal", "value_type": "Cá nhân" } ] }, { "identify": null, "field_code": "gender", "field_type": "radio", "value": [ { "display_value": "male", "data_type": "male", "value_type": "Nam" } ] }, { "identify": null, "field_code": "phone_number", "field_type": "phone", "value": [ { "display_value": null, "data_type": "personal", "value_type": "Cá nhân" } ] } ] }, { "create_by": { "name": "Omi Team" }, "last_update_by": { "name": "Omi Team" }, "created_date": 1607393421623, "last_updated_date": 1607393452508, "public_id": null, "contact_type": "agent", "tags_view": [], "is_deleted": false, "tags": [], "is_active": true, "identify_info": "minhnh@vihatgroup.com", "attribute_structure": [ { "identify": null, "field_code": "full_name", "field_type": "single_text", "value": [ { "display_value": "minhnh", "data_type": "single_text", "value_type": null } ] }, { "identify": null, "field_code": "mail", "field_type": "email", "value": [ { "display_value": "minhnh@vihatgroup.com", "data_type": "personal", "value_type": "Cá nhân" } ] }, { "identify": null, "field_code": "gender", "field_type": "radio", "value": [ { "display_value": "male", "data_type": "male", "value_type": "Nam" } ] }, { "identify": null, "field_code": "phone_number", "field_type": "phone", "value": [ { "display_value": null, "data_type": "personal", "value_type": "Cá nhân" } ] } ] } ], "total_items": 9, "page_size": 3 }, "key_enabled": false } ``` {% endtab %} {% endtabs %} ## Danh sách nhân viên (v3) `POST` `[URL]/api/v3/agent/search?page=1&size=50` Lấy danh sách nhân viên #### Headers | Name | Type | Description | | ------------------------------------------- | ------ | ----------- | | x-api-key\* | String | API Key | #### Request Params | Name | Type | Description | | ---- | ------- | -------------------------------------------------------- | | page | Integer | Thứ tự phân trang, bắt đầu bằng 1 | | size | Integer | Giới hạn số lượng phân tử của danh sách trả về, max = 50 | #### Request Body (optional) | Name | Type | Description | | ----------------- | ------- | ------------------------------------- | | filter.emails | Array | Danh sách email nhân viên | | filter.phones | Array | Danh sách số điện thoại của nhân viên | | filter.extensions | Array | Danh sách số nội bộ | | sort.field | String | Field cần sort | | sort.isAsc | Boolean | Thứ tự sort | {% tabs %} {% tab title="200 OK" %} ```json { "instance_id": "stg", "payload": { "items": [ { "_id": "6487dbeb1a309849f72056ad", // id nhân viên "create_by": {"name": "nhanvien1"}, "last_update_by": {"name": "Admin"}, "created_date": 1686625259248, "last_updated_date": 1773278136166, "public_id": null, "contact_type": "agent", "tags_view": [], "is_deleted": false, "tags": [], "is_active": true, "identify_info": "abc@gmail.com", "user_owner_email": null, "attribute_structure": [ { "identify": null, "field_code": "full_name", "field_type": "single_text", "value": [ { "display_value": "nhanvien1", // tên nhân viên "data_type" : null, "value_type" : null } ] }, { "identify": null, "field_code": "mail", "field_type": "email", "value": [ { "display_value": "abc@gmail.com", // email nhân viên "data_type" : "personal", "value_type" : null } ] }, { "identify": null, "field_code": "gender", "field_type": "radio", "value": [ {"display_value": "male", "data_type": null, "value_type": null} // giới tính ] }, { "identify": null, "field_code": "phone_number", "field_type": "phone", "value": [ { "display_value": "0123456789", // số điện thoại nhân viên "data_type" : "personal", "value_type" : null } ] }, { "identify": null, "field_code": "avatar", "field_type": "image", "value": [ { "display_value": "image.jpg", // avatar "data_type": null, "value_type": null } ] }, { "identify": null, "field_code": "job_title", "field_type": "single_text", "value": [ {"display_value": "", "data_type": null, "value_type": null} ] }, { "identify": null, "field_code": "passport", "field_type": "single_text", "value": [ {"display_value": "", "data_type": null, "value_type": null} ] }, { "identify": null, "field_code": "address", "field_type": "single_text", "value": [ {"display_value": "", "data_type": null, "value_type": null} ] }, { "identify": null, "field_code": "more_infomation", "field_type": "customize", "value": [] }, { "identify": null, "field_code": "note", "field_type": "multi_text", "value": [ { "display_value": "hvhvjbi", "data_type" : null, "value_type" : null } ] }, { "identify": null, "field_code": "birthday", "field_type": "date", "value": [ {"display_value": "", "data_type": null, "value_type": null} ] } ] } ], "page_number": 1, "page_size": 50, "total_items": 46, "total_pages": 1, "has_next": false, "next_page": 1, "has_previous": false, "previous_page": 1, "extension": null, "max_size": null }, "instance_version": "1.2.164", "key_enabled": false, "status_code": 9999 } ``` {% endtab %} {% tab title="Sample request body" %} ```json { "filter": { "emails": ["abc@gmail.com"] }, "sort": { "field": "created_date", "isAsc": false } } ``` {% endtab %} {% endtabs %} ## Mời nhân viên `POST` `[URL]/api/agent/invite` Mời nhân viên sử dụng tổng đài #### Headers | Name | Type | Description | | ------------- | ------ | ----------------------------- | | Authorization | string | Access token : Bearer 'token' | #### Request Body | Name | Type | Description | | --------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | owner\_email | string | Email nhân viên phụ trách | | role\_name | string |

Quyền . Mặt định là Sale
- Sale
- Trưởng nhóm sale
- Trưởng phòng Kinh Doanh
- Kế toán
- Giám đốc

| | password | string | Mật khẩu đăng nhập, khởi tạo ban đầu | | identify\_info | string | Email định danh | | full\_name | string | Họ và tên nhân viên | | uuid | String | Mã user định danh từ bên thứ 3 | | call\_timeout | String | Thời gian chờ của nhân viên khi cuộc gọi chuyển tiếp tới | | target\_forward | Object |

Kịch bản khi nhân viên không nghe máy hoặc không trực tuyến

{

"target\_value":"",

"target\_type":""

}

target\_value : ID của thành phần

target\_type : Một trong các Type sau :

greeting : Lời chào báo bận

| | group\_name | String | Tên nhóm nhân viên | {% tabs %} {% tab title="200 Thông tin nhân viên " %} ``` { "status_code": 9999, "instance_id": "stg", "instance_name": "DESKTOP-1OB3SFM", "payload": { "agent": { // Thông tin nhân viên "full_name": "Tran Van Tien", "email": "vietnam12@gmail.com" }, "pbx_account": { // Thông tin tổng đài "sip_user": "", "password": "", "domain": null, "outbound_proxy": null, "public_number": null, "full_name": "Tran Van Tien", "email": "vietnam12@gmail.com", "last_updated_date": 1597798326714, "created_date": 1597798326714 } }, "key_enabled": false } ``` {% endtab %} {% endtabs %} | Mã lỗi | Mô tả | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | | full\_name\_is\_required | Họ và tên là bắt buộc | | identify\_info\_invalid | Email không hợp lệ | | password\_invalid |

Mật khẩu không hợp lệ , Mật khẩu bao gồm

| | role\_is\_required | Quyền là bắt buộc | | agent\_exists | Nhân viên đã tồn tại | | limit\_agent | Vượt quá giới hạn gói dịch vu | | invite\_error | Có lỗi xảy ra khi invite | | agent\_uuid\_exists | Nhân viên có mã uuid đã tồn tại trước đó | ## Xóa nhân viên `DELETE` `[URL]/api/agent/delete?identify_info=` #### Path Parameters | Name | Type | Description | | ------------- | ------ | --------------------------- | | Authorization | string | Access token Bearer 'token' | #### Query Parameters | Name | Type | Description | | -------------- | ------ | --------------- | | identify\_info | string | Email nhân viên | {% tabs %} {% tab title="200 Xóa nhân viên thành công" %} ``` ``` {% endtab %} {% endtabs %} ## Mời nhân viên kèm theo gói dịch vụ `POST` `[URL]/api/agent/invite_with_package_v2` Mời nhân viên sử dụng tổng đài có liên kết gói v2 #### Path Parameters | Name | Type | Description | | ------------- | ------ | --------------------------- | | Authorization | string | Access token Bearer 'token' | #### Request body | Name | Type | Description | | -------------------- | ------ | --------------------------------------------------------------------------------------- | | owner\_email | string |

Email nhân viên phụ trách

(nếu bỏ trống sẽ gán mặc định chủ doanh nghiệp)

| | password | string | Mật khẩu tối thiểu 8 kí tự, ít nhất 1 ký tự IN HOA, ít nhất 1 chữ số \[0-9] | | identify\_info | string | Eemail nhân viên | | full\_name | string | Tên nhân viên | | service\_package\_id | string | Id gói nhân viên v2 | | role\_name | string | Phân quyền (nếu bỏ trống mặc định là quyền Sale mặc định) | {% tabs %} {% tab title="Body" %} 
{
    "owner_email": "",
    "password": "13579Abc@",
    "identify_info": "abc@gmail.com",
    "full_name": "Nhân viên 1",
    "service_package_id": "664175f5dgda95e5cbce704e9",
    "role_name": "Giám đốc"
}
{% endtab %} {% endtabs %} #### Response {% tabs %} {% tab title="200 Mời nhân viên thành công" %} ``` // Thông tin nhân viên đã mời ``` {% endtab %} {% endtabs %} ## Cập nhật phân quyền nhân viên `POST` `[URL]/api/agent/role/update` Cập nhật thông tin phân quyền của một nhân viên #### Path Parameters | Name | Type | Description | | ------------- | ------ | --------------------------- | | Authorization | string | Access token Bearer 'token' | #### Request body | Name | Type | Description | | ------------------------------------------ | ------ | ------------- | | id\* | string | Id nhân viên | | role\_id\* | string | Id phân quyền | {% tabs %} {% tab title="Body" %} ``` { "id": "673422b9e9caa0299d7e9799", "role_id": "6732dc3d827b8d5c308bcc7c" } ``` {% endtab %} {% endtabs %} #### Response {% tabs %} {% tab title="200 Cập nhật phân quyền thành công" %} ``` { "instance_id": "stg", "payload": { "id": "673422b9e9caa0299d7e9799", "tenant_id": "62d8b0d1a89196134b65409b", "contact_id": "673422b9e9caa0299d7e9798", "email": "test@gmail.com", "full_name": "test agent", "role_id": "6732dc3d827b8d5c308bcc7c", "type": "agent", "pbx_account": { "sip_user": "114", "sip_password": "3du1Qch6fm" } }, "instance_version": "1.2.164", "key_enabled": false, "status_code": 9999 } ``` {% endtab %} {% endtabs %} ## Cập nhật gói dịch vụ nhân viên `POST` `[URL]/api/agent/service_package/update` Cập nhật hoặc gỡ gói dịch vụ cho một nhân viên #### Path Parameters | Name | Type | Description | | ------------- | ------ | --------------------------- | | Authorization | string | Access token Bearer 'token' | #### Request body | Name | Type | Description | | ------------------------------------ | ------ | ---------------------------------------------------------------------------------------- | | id\* | string | Id nhân viên | | service\_package\_id | string | Id gói dịch vụ được gán. Nếu muốn gỡ gói dịch vụ của nhân viên, không truyền tham số này | {% tabs %} {% tab title="Body" %} ``` { "id": "673422b9e9caa0299d7e9799", "service_package_id": "67a4789e19a6ca32cbc4ca08" } ``` {% endtab %} {% endtabs %} #### Response {% tabs %} {% tab title="200 Cập nhật gói thành công" %} ``` { "instance_id": "stg", "payload": true, // true nếu cập nhật thành công "instance_version": "1.2.164", "key_enabled": false, "status_code": 9999 } ``` {% endtab %} {% endtabs %} ## Lấy thông tin nhân viên qua Email `POST` `[URL]/api/v2/agent/get-by-email` #### Headers | Name | Type | Description | | ------------- | ------ | ----------------------------- | | Authorization | String | Access token : Bearer 'token' | #### Request Body | Name | Type | Description | | ----- | ------ | --------------- | | email | String | Email nhân viên | {% tabs %} {% tab title="200 Thông tin nhân viên " %} ``` { "status_code": 9999, "instance_id": "stg", "instance_name": "DESKTOP-1OB3SFM", "payload": { "id": "60e79bd864b64271a923affe", //Id của nhân viên, "tenant_id" : "60e79bd864b64271a923affb", //Id của doanh nghiệp, "contact_id": "60e79beb1b20043c4e7a68af", //Id contact của nhân viên "email" : "omi@vihatgroup.com", //Email nhân viên "phone" : "098xxxxxx", //Số điện thoại của nhân viên "full_name": "DEV ZONE", //Tên nhân viên "pbx_account": { // Thông tin tổng đài "sip_user": "999", // Số nội bộ "sip_password": "xxx" //Mật khẩu } }, "key_enabled": false } ``` {% endtab %} {% endtabs %} ## Danh sách nhân viên `POST` `[URL]/api/v2/agent/search` \* Tạm dừng cập nhật từ ngày 01/04/2026, vui lòng sử dụng [API v3](https://api.omicall.com/omicall-api/nhan-vien#danh-sach-nhan-vien-v3) #### Headers | Name | Type | Description | | ------------- | ------ | ----------------------------- | | Authorization | String | Access token : Bearer 'token' | #### Request Params | Name | Type | Description | | ---- | ------- | --------------------------------------------- | | page | Integer | Số thứ tự trang | | size | Integer | Số lượng data lấy về trong 1 trang. Từ 1 - 50 | | | | | #### Request Body (optional) | Name | Type | Description | | ---------- | ------ | ------------------------------------------------------------------------------ | | emails | List | Danh sách email nhân viên | | phones | List | Danh sách số điện thoại của nhân viên | | extensions | List | Danh sách số nội bộ | | sort | Object |

{

field: "created\_date",

isAsc: true

}

| | | | | {% tabs %} {% tab title="200 Thông tin nhân viên " %} ``` { "status_code": 9999, "instance_id": "stg", "instance_name": "DESKTOP-1OB3SFM", "payload": { "items": [ { "id": "60e79bd864b64271a923affe", //Id của nhân viên, "tenant_id" : "60e79bd864b64271a923affb", //Id của doanh nghiệp, "contact_id": "60e79beb1b20043c4e7a68af", //Id contact của nhân viên "email" : "omi@vihatgroup.com", //Email nhân viên "phone" : "098xxxxxx", //Số điện thoại của nhân viên "full_name": "DEV ZONE", //Tên nhân viên "pbx_account": { // Thông tin tổng đài "sip_user": "999", // Số nội bộ "sip_password": "xxx" //Mật khẩu }, { ... } ], "page_number" : 1, "page_size" : 50. "total_items" : 1000, "total_pages" : 20, "has_next" : true, "next_page: 2, "has_previous: false, "previous_page" : 1 }, "key_enabled": false } ``` {% endtab %} {% endtabs %} ## Chuyển chủ sở hữu tài khoản nhân viên `POST` `[URL]/api/v3/agent/transfer` #### Headers | Name | Type | Description | | --------- | ------ | ----------- | | x-api-key | String | API Key | #### Request Body
NameTypeDescription
sourceEmail*StringEmail liên kết với tài khoản gốc
targetEmail*StringEmail liên kết mới (phải chưa tồn tại trên hệ thống)
targetInfoObject

Thông tin nhân viên mới:

  • fullName: tên nhân viên
  • phoneNumber: số điện thoại nhân viên
{
    "fullName": "agent",
    "phoneNumber": "0123456789"
}
callbackResultConfigObject

Thông tin hook nhận kết quả sau khi hoàn tất tiến trình:

  • url: url nhận hook
  • headers (optional): danh sách headers muốn gửi kèm khi nhận hook
{
    "url": "https://...",
    "headers": {
        "key1": "value1"
    }
}
{% tabs %} {% tab title="202 Khởi tạo tiến trình thành công " %} ```json { "instance_id": "stg", "payload": { "requestId": "270ea881-a6e1-44fb-9400-a89eb4ceab4b" // unique request id, trả về kèm theo webhook nếu có khai báo "callbackResultConfig" }, "instance_version": "1.2.164", "key_enabled": false, "status_code": 9999 } ``` {% endtab %} {% tab title="Webhook" %} ```json { "requestId": "270ea881-a6e1-44fb-9400-a89eb4ceab4b", // unique request id "requestTimeMs": 1769163675593, // thời gian request "action": "AGENT_TRANSFER", // loại tiến trình "status": "SUCCESS", // trạng thái SUCCESS/ERROR "responseTimeMs": 1769163675890, // thời gian kết thúc "payload": { // Thông tin nhân viên mới "fullName": "agent", "phoneNumber": "0123456789", "email": "example@gmail.com" } } ``` {% endtab %} {% endtabs %}