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ừ mộ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 lấy từ quy trình đặt yêu cầu chuyển mạng giữ số, không dùng mã định danh dạng số trong cơ sở dữ liệu hoặc số điện thoại. Mã hóa mã định danh dự án theo quy tắc 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"Xử lý phản hồi này như thông tin mật
Phản hồi đầy đủ bao gồm thông tin thanh toán tại nhà mạng chuyển đi, trong đó có giá trị đã lưu của billing_pin, tài khoản thanh toán, số điện thoại, địa chỉ, công ty và thông tin người liên hệ được ủy quyền. API không che các trường này. Chỉ yêu cầu trạng thái hoặc danh sách số điện thoại nếu quy trình của bạn chỉ cần những dữ liệu đó. Không đưa phản hồi chi tiết đầy đủ vào bộ nhớ trình duyệt, hệ thống phân tích, nhật ký công khai hoặc ảnh chụp màn hình hỗ trợ; chỉ hiển thị những trường mà khách hàng có quyền truy cập cần dùng.
Cấu trúc phản hồi
Ví dụ giả định chỉ trình bày một số trường được chọn; phản hồi có thể trả về thêm các trường khác.
{
"status": {
"code": 200,
"msg": "Project Detail"
},
"response": {
"project": {
"id": 11,
"uniqueid": "PROJECT_EXAMPLE",
"project_name": "Example transfer",
"location": "US",
"status": 0,
"status_str": "Pending"
},
"counts": {
"total": 0,
"pending": 0,
"in_progress": 0,
"completed": 0,
"rejected": 0
},
"numbers": [],
"events": [],
"uploads": []
}
}Ví dụ này cố ý chỉ trình bày một phần và bỏ qua toàn bộ thông tin xác thực thanh toán cùng các giá trị thông tin liên hệ cá nhân. Việc không đưa chúng vào ví dụ không có nghĩa là phản hồi thực tế sẽ che những dữ liệu đó.
| Phần | Nội dung |
|---|---|
| project | Mã định danh dạng số của hàng dữ liệu, mã định danh duy nhất của dự án, tên dự án, vị trí, dữ liệu thanh toán/liên hệ/địa chỉ đã lưu, thời điểm tạo và trạng thái được suy ra. Trường cũ dành cho nhà mạng chuyển đi được viết là loosing_carrier. |
| counts | Tổng số hàng dữ liệu số điện thoại và các bộ đếm Pending, In Progress, Completed và Rejected. |
| numbers | Các trường dữ liệu số điện thoại được lựa chọn và biểu diễn giống như ở điểm cuối lấy danh sách số điện thoại của dự án, bao gồm bình luận của khách hàng và các giá trị lịch thực hiện đã lưu. |
| events | Các hàng sự kiện đã lưu và các trường dữ liệu tải ở dạng thô/đã phân tích, tuân theo các giới hạn về khả năng hiển thị và định dạng của điểm cuối sự kiện. |
| uploads | Siêu dữ liệu tài liệu: mã định danh dạng số, upload_type, file_name, file_extension, date_created và download_url dạng tương đối. URL này vẫn yêu cầu xác thực tài khoản. |
Diễn giải thông tin tổng hợp và siêu dữ liệu
Trạng thái được suy ra ưu tiên In Progress, tiếp đến là Pending, rồi Completed, rồi Rejected, với Pending là giá trị dự phòng. Trạng thái tổng hợp Completed vẫn có thể đi kèm các số điện thoại bị từ chối. Hãy kiểm tra các bộ đếm và trạng thái của từng số điện thoại thay vì cho rằng tất cả các số đều đã hoàn tất chuyển mạng.
Phản hồi chứa siêu dữ liệu tài liệu, không chứa các byte của tệp. Phản hồi không có phân trang hoặc con trỏ để lấy dữ liệu tăng dần. Truy vấn chi tiết và truy vấn danh sách là các lần đọc riêng biệt, không phải một ảnh chụp dữ liệu duy nhất được bảo đảm nhất quán về giao dịch. Các giá trị ngày tháng được giữ nguyên như đã lưu, không có cơ chế chuyển đổi múi giờ được nêu trong tài liệu. Sử dụng uniqueid cho các tuyến dự án; không thể dùng mã định danh dự án dạng số để thay thế.
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.
Tác động và quy trình làm việc
Đây là tuyến chi tiết chuẩn được màn hình yêu cầu chuyển mạng giữ số của cổng thông tin hiện tại sử dụng. Cổng thông tin ánh xạ các trường cho giao diện người dùng và áp dụng cách lựa chọn, biểu diễn dữ liệu riêng cho khách hàng; không nên cho rằng phản hồi API thô giống hệt JSON hoặc cách trình bày của cổng thông tin. Bộ xử lý chi tiết đã được rà soát không sửa đổi dự án, cũng không trực tiếp khởi tạo yêu cầu tới nhà mạng hoặc phát sinh khoản phí.