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

Query Parameters

Name

Type

Description

page

number

Page (mặc định là 1)

size

number

Size (kích thước trang) : mặc định là 50

keyword

string

Từ khóa tìm kiếm - Họ và tên - Email - SĐT

Headers

Name

Type

Description

Authorization

string

Access token, Bearer 'token'

{
    "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": "[email protected]",
                "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": "[email protected]",
                                "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": "[email protected]",
                "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": "[email protected]",
                                "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": "[email protected]",
                "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": "[email protected]",
                                "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
}

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

{
    "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": "[email protected]"
        },
        "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": "[email protected]",
            "last_updated_date": 1597798326714,
            "created_date": 1597798326714
        }
    },
    "key_enabled": false
}

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

Ít nhất 8 ký tự
Ký tự in hoa, in thường
Số và ký tự đặc biệt

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

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)

{
    "owner_email": "",
    "password": "13579Abc@",
    "identify_info": "[email protected]",
    "full_name": "Nhân viên 1",
    "service_package_id": "664175f5dgda95e5cbce704e9",
    "role_name": "Giám đốc"
}

Response

// Thông tin nhân viên đã mời

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

{
    "id": "673422b9e9caa0299d7e9799",
    "role_id": "6732dc3d827b8d5c308bcc7c"
}

Response

{
    "instance_id": "stg",
    "payload": {
        "id": "673422b9e9caa0299d7e9799",
        "tenant_id": "62d8b0d1a89196134b65409b",
        "contact_id": "673422b9e9caa0299d7e9798",
        "email": "[email protected]",
        "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
}

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

{
    "id": "673422b9e9caa0299d7e9799",
    "service_package_id": "67a4789e19a6ca32cbc4ca08"
}

Response

{
    "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
}

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

String

Email 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" : "[email protected]", //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
}

Danh sách nhân viên

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

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

}

{
    "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" : "[email protected]", //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
}

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

Name

Type

Description

sourceEmail*

String

Email liên kết với tài khoản gốc

targetEmail*

String

Email liên kết mới (phải chưa tồn tại trên hệ thống)

targetInfo

Object

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"
}

callbackResultConfig

Object

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"
    }
}

{
    "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
}

{
  "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": "[email protected]"
  }
}

PreviousDoanh nghiệp NextKhách hàng

Last updated 4 days ago

hashtagDanh sách nhân viên

hashtagQuery Parameters

hashtagHeaders

hashtagMời nhân viên

hashtagHeaders

hashtagRequest Body

hashtagXóa nhân viên

hashtagPath Parameters

hashtagQuery Parameters

hashtagMời nhân viên kèm theo gói dịch vụ

hashtagPath Parameters

hashtagRequest body

hashtagResponse

hashtagCập nhật phân quyền nhân viên

hashtagPath Parameters

hashtagRequest body

hashtagResponse

hashtagCập nhật gói dịch vụ nhân viên

hashtagPath Parameters

hashtagRequest body

hashtagResponse

hashtagLấy thông tin nhân viên qua Email

hashtagHeaders

hashtagRequest Body

hashtagDanh sách nhân viên

hashtagHeaders

hashtagRequest Params

hashtagRequest Body (optional)

hashtagChuyển chủ sở hữu tài khoản nhân viên

hashtagHeaders

hashtagRequest Body

Danh sách nhân viên

Query Parameters

Headers

Mời nhân viên

Headers

Request Body

Xóa nhân viên

Path Parameters

Query Parameters

Mời nhân viên kèm theo gói dịch vụ

Path Parameters

Request body

Response

Cập nhật phân quyền nhân viên

Path Parameters

Request body

Response

Cập nhật gói dịch vụ nhân viên

Path Parameters

Request body

Response

Lấy thông tin nhân viên qua Email

Headers

Request Body

Danh sách nhân viên

Headers

Request Params

Request Body (optional)

Chuyển chủ sở hữu tài khoản nhân viên

Headers

Request Body