API ReferenceAPI tổng đàiDanh bạ
Thêm và cập nhật danh bạ
Thêm mới hoặc cập nhật liên hệ trong danh bạ tổng đài AI Contact Center.
POST
https://api.ods.vn/api/CloudFone/AddPhoneBookThêm mới liên hệ vào danh bạ tổng đài hoặc cập nhật thông tin người liên hệ hiện có theo mã idPhoneBook. Danh bạ này được đồng bộ trực tiếp với màn hình quản lý danh bạ trên hệ thống CSKH.
Tham số request
| Tham số | Kiểu dữ liệu | Bắt buộc | Mô tả chi tiết |
|---|---|---|---|
ServiceName | string | Có | Mã dịch vụ tổng đài khi mua tại ODS (ví dụ: CF-PBXXXXXX). |
AuthUser | string | Có | Mã tài khoản khách hàng (ví dụ: ODSXXXXX). |
AuthKey | string | Có | Khóa bí mật API do ODS cấp. |
Name | string | Có | Tên hiển thị của liên hệ (ví dụ: Nguyen Van A). |
PhoneNumbers | string | Có | Số điện thoại cần lưu vào danh bạ (ví dụ: 0900000000). |
id | number | Không | ID danh bạ (idPhoneBook) cần cập nhật. Bỏ qua trường này nếu muốn thêm mới. |
Cấu trúc phản hồi
| Trường | Kiểu dữ liệu | Mô tả |
|---|---|---|
result | string | Trạng thái xử lý (success hoặc failed). |
message | string | Thông báo kết quả từ hệ thống. |
idPhoneBook | number | Mã định danh của liên hệ vừa được tạo hoặc cập nhật trong danh bạ. |
Lưu ý quan trọng
- Khi cập nhật thông tin (đổi tên hoặc số điện thoại), bắt buộc phải truyền đúng trường
idmang giá trịidPhoneBookđã nhận được lúc tạo. - Tên khách hàng trong danh bạ sẽ được ưu tiên hiển thị trên màn hình Softphone/IP Phone khi có cuộc gọi vào.
Lỗi thường gặp
Giá trị id truyền vào không tồn tại trong danh bạ của gói dịch vụ.
Kiểm tra xem số điện thoại đã được đăng ký trước đó dưới một liên hệ khác hay chưa.