Xóa máy nhánh (DeleteExtension)

API thu hồi và xóa tài khoản máy nhánh (extension) trên tổng đài PBX ODS khi nhân sự nghỉ việc hoặc thay đổi cơ cấu.

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

API DeleteExtension cho phép hệ thống HRM hoặc CRM tự động thu hồi và xóa số máy nhánh (extension) trên tổng đài PBX ODS khi nhân viên nghỉ việc hoặc doanh nghiệp tái cấu trúc phòng ban.

Ứng dụng thực tế

Tự động hóa Offboarding: Tự động vô hiệu hóa và xóa tài khoản thoại ngay khi hoàn tất quy trình bàn giao nghỉ việc trên HRM.
Giải phóng tài nguyên máy nhánh: Thu hồi số nội bộ để sẵn sàng cấp phát lại cho nhân sự mới, tối ưu số lượng extension trên gói cước.
Bảo mật kênh thoại doanh nghiệp: Ngăn chặn việc nhân sự đã nghỉ việc tiếp tục sử dụng tài khoản SIP cũ để gọi ra ngoài hoặc gọi nội bộ.

Tham số request

Tham số	Kiểu dữ liệu	Bắt buộc	Mô tả chi tiết
`ServiceCode`	string	Có	Mã dịch vụ tổng đài khi đăng ký tại ODS (ví dụ: `CF-BSXXXX`). Lưu ý: Endpoint này sử dụng `ServiceCode`, không dùng `ServiceName`.
`AuthUser`	string	Có	Mã tài khoản khách hàng do ODS cấp (ví dụ: `ODSXXXX`).
`AuthKey`	string	Có	Khóa bí mật API do ODS cấp để xác thực quyền quản trị.
`Ext`	string	Có	Số máy nhánh cần xóa trên tổng đài (ví dụ: `1001`, `1997`).

Ví dụ request

curl -X POST "https://api.ods.vn/api/CloudFone/DeleteExtension" \
  -H "Content-Type: application/json" \
  -d '{
    "ServiceCode": "CF-BSXXXX",
    "AuthUser": "YOUR_AUTH_USER",
    "AuthKey": "YOUR_AUTH_KEY",
    "Ext": "1001"
  }'

Response mẫu

{
  "result": "success",
  "message": "Thành công!"
}

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ý yêu cầu (`"success"` hoặc `"failed"`).
`message`	string	Thông báo kết quả chi tiết từ hệ thống tổng đài (ví dụ: `"Thành công!"`).

Lưu ý quan trọng

Ngắt kết nối thiết bị SIP: Toàn bộ thiết bị phần cứng (IP Phone) hoặc ứng dụng phần mềm (Softphone, WebRTC) đang đăng ký SIP bằng tài khoản này sẽ lập tức mất kết nối và không thể gửi/nhận cuộc gọi.
Bảo toàn lịch sử cuộc gọi: Việc xóa máy nhánh không làm mất dữ liệu các cuộc gọi đã phát sinh trước đó. Doanh nghiệp vẫn có thể tra cứu toàn bộ nhật ký cuộc gọi của số máy nhánh này thông qua API GetCallLogs.
Rà soát nhóm đổ chuông (Routing): Trước khi xóa, quản trị viên nên kiểm tra và gỡ số máy nhánh khỏi các nhóm trực cuộc gọi (Ring Group) hoặc hàng đợi (Queue) trên Portal để tránh cuộc gọi bị định tuyến vào số nội bộ không còn hoạt động.
Thao tác không thể hoàn tác: Xóa máy nhánh sẽ xóa vĩnh viễn cấu hình tài khoản của số đó. Nếu muốn kích hoạt lại số này trong tương lai, cần gọi lại API Tạo máy nhánh (AddExtension).

Xóa máy nhánh (DeleteExtension)

Ứng dụng thực tế

Tham số request

Cấu trúc phản hồi

Lưu ý quan trọng

Lỗi thường gặp và cách xử lý

Bài viết liên quan

Tạo máy nhánh (AddExtension)

Tra cứu lịch sử cuộc gọi (GetCallLogs)

Xóa máy nhánh (DeleteExtension)

Số máy nhánh không tồn tại trên hệ thống

Sai thông tin xác thực hoặc sai ServiceCode

Tạo máy nhánh (AddExtension)

Tra cứu lịch sử cuộc gọi (GetCallLogs)