1
API nhập dữ liệu khách hàng theo chiến dịch:
- Nhập dữ liệu khách hàng vào hệ thống theo chiến dịch đã được tạo trước.
- Thực hiện cuộc gọi sau khi dữ liệu được tạo thành công nếu trạng thái chiến dịch là đang chạy.
Link Api:
Body:
access_token
string
Bắt buộc
- Lấy ở giao diện hồ sơ trên website.
contacts
array
Bắt buộc
-
Mảng chứa danh sách khách hàng.
otp_code
string
Bắt buộc
VD:
[
{
phone_number: ‘090xxxxxx’,
otp_code: ‘123456’
danh_xung: ‘anh’,
ho_ten: ‘Nguyễn Văn A’
},...
] - Giới hạn từ ‘000001’ đến ‘999999’
- Chú ý: Nếu phần tử nào trong mảng không đạt đủ điều kiện sẽ bị bỏ qua.
Params :
campaign_id
string
Bắt buộc
- id của chiến dịch.
Dữ liệu trả về :
Thất bại
- Mã 401.
-
access_token không đúng
VD: {
“status”: 0,
“code”: ‘401’,
“message”: “access token không chính xác. bạn không có quyền truy cập”
}
-
access_token không đúng
- Mã 400.
-
Trường contacts không đúng định dạng
VD: {
“status”: 0,
“code”: ‘400’,
“message”: “contacts không đúng định dạng”
}
-
Trường contacts không đúng định dạng
- Mã 01.
-
campaign_id không tồn tại hoặc không có quyền truy cập campaign_id này
VD: {
“status”: 0,
“code”: ‘01’,
“message”: “campaign_id không hợp lệ”
}
-
campaign_id không tồn tại hoặc không có quyền truy cập campaign_id này
Thành công
-
VD: {
“status”: 1,
“message”: Ghi thành công X trên Y bản ghi’
“results”:[{
“phone_number”: “090xxxxxx”,
“call_id”: 1234
}, … ]
} - Những phần tử trong mảng nếu trùng số điện thoại sẽ bị xóa khỏi danh sách ‘contacts’
- Tham số results ở kết quả trả về danh sách số điện thoại được thêm thành công và call_id tương ứng.
Ví dụ:
{{selectTransfer}}
2
API xuất dữ liệu cuộc gọi theo chiến dịch
- Xuất danh sách cuộc gọi theo chiến dịch
Link Api:
Query:
access_token
string
Bắt buộc
- Lấy ở giao diện hồ sơ trên website.
start_time
Long
Không bắt buộc
- Timestamp
- VD: 1580981004000
- Mặc định: Thời điểm khởi tạo chiến dịch
end_time
Long
Không bắt buộc
- Timestamp
- VD: 1580981004000
- Mặc định: Thời điểm hiện tại
limit
Không bắt buộc
- Giới hạn số bản ghi trong query
- Mặc định 10
offset
Number
Không bắt buộc
- Vị trí muốn query.
- Mặc định: 0
Params :
campaign_id
string
Bắt buộc
- id của chiến dịch.
Dữ liệu trả về :
Thất bại
- Mã 401.
- access_token không đúng
VD: {
“status”: 0,
“code”: ‘401’,
“message”: “access token không chính xác. bạn không có quyền truy cập”
}
- access_token không đúng
- Mã 01.
-
campaign_id không tồn tại hoặc không có quyền truy cập campaign_id này
VD: {
“status”: 0,
“code”: ‘01’,
“message”: “campaign_id không hợp lệ”
}
-
campaign_id không tồn tại hoặc không có quyền truy cập campaign_id này
Thành công
-
caller_id
Số gọi đi
-
callee_id
Số gọi đến
-
called_at
Thời điểm gọi
-
duration
Thời gian nghe máy (tính theo giây)
-
key_press
Lịch sử bấm phím
-
note
Mã tổng đài trả về
-
state
40 - Đã nghe, 50 - Lỗi
VD: {
“status”: 1,
“results”: {
limit:10
total: 1000,
calls: [
{
caller_id: “090xxxx”,
callee_id: “090xxxx”,
start_call_at: “2020-01-31 10:16:44”,
duration: 8,
key_press: “1 (29)”,
note: “NORMAL CLEARING”,
state: 40,
...
}
]
}
Ví dụ:
{{selectTransfer1}}
3
API Tạo mới access_token
- Tạo mới access_token của người dùng
Link Api:
Query:
secret_key
string
Bắt buộc
- Lấy ở giao diện hồ sơ trên website.
Dữ liệu trả về :
Thất bại
- Mã 401.
- secret_key không chính xác
VD: {
“status”: 0,
“code”: ‘401’,
“message”: “secret_key không chính xác”
}
- secret_key không chính xác
Thành công
VD: {
“status”: 1,
“results”: {
“access_token”: “eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoyNzYsInNpZ24iOiJhOTcxZjAxYmVjYjY5MDQ4YWYyMTg1ZjM4Y2E1M2MxOCIsImlhdCI6MTU4NDAwNjQ5NywiZXhwIjoxNTg5MTkwNDk3fQ.ualZcDZdPcmbqChDWbzfILi5GUf-tKrqitPmmwBgSaU”,
}
}
Ví dụ:
{{selectTransfer2}}
4
API xuất dữ liệu cuộc gọi theo user
- Xuất danh sách cuộc gọi theo người dùng
Link Api:
Query:
access_token
string
Bắt buộc
- Lấy ở giao diện hồ sơ trên website.
start_time
Long
Không bắt buộc
- Timestamp theo milliseconds
- VD: 1580981004000
- Mặc định: Thời điểm khởi tạo chiến dịch
end_time
Long
Không bắt buộc
- Timestamp theo milliseconds
- VD: 1580981004000
- Mặc định: Thời điểm hiện tại
limit
Không bắt buộc
- Giới hạn số bản ghi trong query
- Mặc định 10
offset
Number
Không bắt buộc
- Vị trí muốn query
- Mặc định: 0
Dữ liệu trả về :
Thất bại
- Mã 401.
- access_token không đúng
VD: {
“status”: 0,
“code”: ‘401’,
“message”: “access token không chính xác. bạn không có quyền truy cập”
}
- access_token không đúng
Thành công
-
call_id
ID cuộc gọi
-
caller_id
Số gọi đi
-
callee_id
Số gọi đến
-
called_at
Thời điểm gọi
-
duration
Thời gian nghe máy (tính theo giây)
-
key_press
Lịch sử bấm phím
-
note
Mã tổng đài trả về
-
state
40 - Đã nghe, 50 - Lỗi
VD: {
“status”: 1,
“results”: {
limit:10
total: 1000,
calls: [
{
call_id: ‘’,
caller_id: “090xxxx”,
callee_id: “090xxxx”,
start_call_at: “2020-01-31 10:16:44”,
duration: 8,
key_press: “1 (29)”,
note: “NORMAL CLEARING”,
state: 40,
...
}
]
}
Ví dụ:
{{selectTransfer3}}
phone_number
string
Bắt buộc