ODS
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.

POSThttps://api.ods.vn/api/CloudFone/AddPhoneBook

Thê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ệuBắt buộcMô tả chi tiết
ServiceNamestringCóMã dịch vụ tổng đài khi mua tại ODS (ví dụ: CF-PBXXXXXX).
AuthUserstringCóMã tài khoản khách hàng (ví dụ: ODSXXXXX).
AuthKeystringCóKhóa bí mật API do ODS cấp.
NamestringCóTên hiển thị của liên hệ (ví dụ: Nguyen Van A).
PhoneNumbersstringCóSố điện thoại cần lưu vào danh bạ (ví dụ: 0900000000).
idnumberKhôngID 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ườngKiểu dữ liệuMô tả
resultstringTrạng thái xử lý (success hoặc failed).
messagestringThông báo kết quả từ hệ thống.
idPhoneBooknumberMã đị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 id mang 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

Bài viết liên quan