Kiểm tra trạng thái dự án chuyển mạng giữ số

Quyền truy cập tài khoản và dự án

Sử dụng tài khoản API đã được kích hoạt qua HTTPS từ địa chỉ IP được phép. Dự án phải thuộc tài khoản đó và chưa bị xóa. Sử dụng mã định danh duy nhất của dự án từ quy trình đặt lệnh chuyển mạng giữ số, không dùng mã định danh dạng số trong cơ sở dữ liệu hay số điện thoại. Mã hóa mã định danh dự án theo định dạng URL khi tạo yêu cầu.

Yêu cầu

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/lnp/project/$PROJECT_ID/status"

Điểm cuối này không đọc nội dung yêu cầu, thông tin phân trang hay bộ lọc ngày.

Phản hồi

Ví dụ phản hồi giả định.

{
  "status": {
    "code": 200,
    "msg": "Project Status"
  },
  "response": {
    "uniqueid": "PROJECT_EXAMPLE",
    "status": 2,
    "status_str": "Completed",
    "counts": {
      "total": 2,
      "pending": 0,
      "in_progress": 0,
      "completed": 1,
      "rejected": 1
    }
  }
}

Trường ở cấp ngoài status.code cho biết kết quả của API. Trường riêng biệt response.status là trạng thái chuyển mạng giữ số tổng hợp được suy ra cho dự án. Đừng nhầm lẫn hai trường này.

Trạng thái tổng hợp không phải là kết quả cho tất cả các số

Trạng thái tổng hợp chọn In Progress nếu có bất kỳ số nào mang trạng thái đó; nếu không thì lần lượt xét Pending, rồi Completed, rồi Rejected theo cùng cách. Nếu không khớp với trạng thái đã biết nào, trạng thái mặc định là Pending. Do đó, một dự án có cả số đã hoàn tất và số bị từ chối sẽ báo Completed dù vẫn còn số bị từ chối.

Luôn kiểm tra số lượng và danh sách từng số trước khi kết luận rằng toàn bộ dự án đã hoàn tất. counts.total bao gồm mọi dòng dữ liệu số điện thoại của dự án; các bộ đếm khác chỉ bao quát bốn giá trị trạng thái đã biết nên tổng của chúng có thể không bằng tổng số khi tồn tại các giá trị khác. Dự án không có số nào sẽ báo các bộ đếm bằng không và trạng thái tổng hợp là Pending.

Diễn giải trạng thái chuyển mạng giữ số

Giữ nguyên trạng thái dạng số và xử lý được cả các giá trị chưa biết. Với nhãn chưa biết, hệ thống dùng giá trị đã lưu làm giá trị dự phòng chứ không bảo đảm có nhãn mới. Bản thân trạng thái hoàn tất hoặc ngày dự kiến đã lưu không kiểm tra việc định tuyến cuộc gọi đến hay mọi dịch vụ trên số điện thoại đó.

Lỗi và giới hạn

Kiểm tra cả phản hồi HTTP và status.code/status.msg. Dự án không tồn tại, đã bị xóa hoặc không thuộc tài khoản sẽ trả về mã API 404 kèm thông báo không tìm thấy dự án. Các yêu cầu xác thực và hạn chế về địa chỉ IP nguồn cũng được áp dụng. Các ví dụ không thực hiện yêu cầu thực tế, và phản hồi thành công không chứng minh rằng nhà mạng đã chấp nhận hoặc hoàn tất việc chuyển mạng giữ số.

Tác động

Điểm cuối này đọc các số đếm đã lưu của dự án. Trong trình xử lý đã được rà soát, nó không gửi yêu cầu chuyển mạng giữ số, thay đổi trạng thái, khởi tạo cuộc gọi hay trừ tiền trong tài khoản. Nó không cung cấp chức năng truy vấn nhà mạng định kỳ theo thời gian thực hay đăng ký nhận thông báo qua webhook.