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
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
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
Authorization
string
Access token : Bearer 'token'
Request Body
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
Authorization
string
Access token Bearer 'token'
Query Parameters
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
Authorization
string
Access token Bearer 'token'
Request body
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ờiLấy thông tin nhân viên qua Email
POST [URL]/api/v2/agent/get-by-email
Headers
Authorization
String
Access token : Bearer 'token'
Request Body
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
Authorization
String
Access token : Bearer 'token'
Request Params
page
Integer
Số thứ tự trang
size
Integer
Số lượng data lấy về trong 1 trang. Từ 1 - 50
Request Body (optional)
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
}Last updated
Was this helpful?