Tài liệu REST API
REST API tra cứu định tuyến LRN
Tra cứu số định tuyến và thông tin nhà mạng hiện có cho một số điện thoại Bắc Mỹ với mức giá cố định.
Chọn API và thông tin xác thực cùng nhau
Các tài khoản Nhà phát triển & Tự động hóa, Doanh nghiệp và Nhà cung cấp truyền thông đã được phê duyệt có thể tích hợp các dịch vụ đã được bật. Một nhà phát triển cá nhân không cần phải giả danh là công ty. SMS/MMS ứng dụng yêu cầu phê duyệt gửi tin và đăng ký phù hợp. Dịch vụ Cá nhân & Gia đình không có API khởi tạo tin nhắn nào mà khách hàng có thể truy cập.
| Nhóm API | URL cơ sở | Xác thực và kết quả |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Thông tin xác thực Basic đã được phê duyệt; chỉ dùng token được cấp phát đủ điều kiện cho những thao tác có hỗ trợ. JSON status và response. |
| Đăng ký dịch vụ gọi khẩn cấp | https://api.multi.tel/emergency | Thông tin xác thực Basic đã được phê duyệt hoặc quyền truy cập bearer được cấp phát riêng. JSON code, message và data. |
| Tích hợp REST của cổng thông tin | Máy chủ và thao tác được hiển thị trong tài liệu tham chiếu dành cho nhà phát triển của tài khoản bạn | Hãy dùng thông tin xác thực, phạm vi quyền (scope) và lược đồ đã được ghi trong tài liệu của thao tác đó. Các yêu cầu từ phiên trình duyệt thuộc một giao diện riêng biệt. |
Hãy đặt MULTITEL_API_USERNAME và MULTITEL_API_PASSWORD thông qua cấu hình bí mật của máy chủ bạn trước khi dùng các ví dụ. Tuyệt đối không nhúng chúng vào JavaScript công khai trên trình duyệt, URL hoặc kho quản lý mã nguồn. Thông tin xác thực chuyên dụng được quản lý tại cài đặt tích hợp API.
Tra cứu một số
GET /v3/lrn/{number} nhận số đích trong đường dẫn. Có thể cung cấp thêm số của bên gọi dưới dạng /v3/lrn/{number}/{ani} để lấy thông tin phụ thuộc vào số gọi đi. Hãy nhập số điện thoại Bắc Mỹ chỉ bằng chữ số, kèm mã quốc gia khi áp dụng; các ví dụ sử dụng số hư cấu được dành riêng.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123"curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/lrn/12025550123/12025550124"Thực hiện tra cứu với thông tin xác thực hợp lệ sẽ bị tính phí. Mức giá là 0,00025 US$ cho mỗi lần tra cứu: 0,25 US$ cho mỗi 1.000 hoặc 250 US$ cho mỗi triệu. Không có chiết khấu theo khối lượng. Đây là tra cứu thông tin định tuyến; nó không thực hiện cuộc gọi điện thoại.
Đọc kết quả
{
"status": {
"code": 200,
"msg": "Success"
},
"response": {
"lrn": "12025550123",
"ported": 0,
"ocn": "",
"lata": "",
"rc": "",
"cost": "$0.00025"
}
}Ví dụ tự tạo này chỉ minh họa cấu trúc phản hồi; đây không phải kết quả định tuyến đo được. Hãy kiểm tra status.code trước khi dùng response. Trường cost là một chuỗi có tiền tố tiền tệ, không phải số JSON.
| Trường | Ý nghĩa |
|---|---|
lrn | Location Routing Number dùng để xác định đích định tuyến. |
ported | Chỉ báo chuyển mạng giữ số do lần tra cứu này cung cấp: thường là 0 hoặc 1. Không dùng nó làm bằng chứng về quyền sở hữu hay tính đủ điều kiện sử dụng dịch vụ. |
ocn | Operating Company Number, khi được cung cấp. |
lata | Khu vực truy cập và truyền tải nội hạt (Local Access and Transport Area), khi được cung cấp. |
rc | Rate center, khi được cung cấp. |
city, state, lec, lectype, jurisdiction, local | Các chi tiết bổ sung về vị trí, nhà mạng hoặc số gốc khi có. Chúng có thể vắng mặt hoặc để trống. |
Đừng yêu cầu mọi trường định tuyến đều phải có mặt. Đặc biệt, kết quả của số miễn cước cho người gọi (toll-free) có thể không có chi tiết về trung tâm tính cước nội hạt và mã nhà mạng. Một LRN được trả về không phải là bảo đảm theo thời gian thực về khả năng liên lạc được hay là một bài kiểm tra chất lượng cuộc gọi.
Sử dụng tra cứu trong quy trình định tuyến của bạn
- Hãy xác thực và chuẩn hóa số được yêu cầu trước khi gửi.
- Hãy kiểm tra trạng thái HTTP và trạng thái ứng dụng. Giữ một bản ghi đã ẩn thông tin nhạy cảm về số, thời điểm và kết quả để khắc phục sự cố.
- Chỉ dùng những trường liên quan đến quy tắc định tuyến của bạn và xử lý các giá trị vắng mặt một cách tường minh.
- Hãy giới hạn số lần thử lại sau một phản hồi không chắc chắn. Lặp lại một lần tra cứu có thể phát sinh thêm một khoản phí; điểm cuối này không có khóa idempotency được ghi trong tài liệu.
Xem sản phẩm LRN và mức giá cố định. Đường dẫn OpenAPI công khai có một phân đoạn ANI; triển khai LRN đang chạy cũng chấp nhận yêu cầu ngắn hơn không có ANI. lrninfo là một thao tác riêng biệt và không nên thay thế cho điểm cuối này.
Xử lý lỗi và thử lại
- Lỗi xác thực hoặc quyền truy cập
- Hãy kiểm tra trạng thái bật của thông tin xác thực API, dịch vụ được phép và giới hạn IP nguồn. Cookie phiên cổng thông tin không phải là thông tin xác thực tích hợp.
- Không đủ tín dụng hoặc chưa đáp ứng điều kiện phê duyệt
- Hãy giải quyết vấn đề số dư tài khoản, phê duyệt gửi tin hoặc yêu cầu về tài liệu trước khi lặp lại thao tác.
- Không có kết quả
- Hãy xử lý kho số trống hoặc không có tên người gọi như một kết quả bình thường. Đừng cho rằng một số hợp lệ về mặt cú pháp thì có đầy đủ mọi dịch vụ.
- Hết thời gian chờ mạng hoặc lỗi dịch vụ
- Với các thao tác đọc, hãy thử lại có giới hạn kèm backoff. Với thao tác mua, gửi hoặc đăng ký, hãy kiểm tra trạng thái thao tác trước; thử lại một yêu cầu đã được chấp nhận có thể tạo ra thao tác bị tính phí trùng lặp.
Khả năng hỗ trợ idempotency tùy thuộc vào từng nhóm API. Emergency API hỗ trợ khóa thử lại; điều đó không làm cho các yêu cầu v3 tùy ý trở nên idempotent. Hãy lưu lại dấu thời gian, ID được trả về và các phản hồi đã ẩn thông tin nhạy cảm để phục vụ hỗ trợ.
Tiếp tục với tài liệu tham chiếu dành cho tài khoản của bạn
Tài liệu tham chiếu sau khi đăng nhập lọc các thao tác theo quyền và các dịch vụ đã bật của bạn. Hãy dùng đúng máy chủ, loại thông tin xác thực, trường yêu cầu và lược đồ phản hồi được nêu trong đó. Các bảng điều khiển có thể thực thi thao tác thực, bao gồm mua hàng và gửi tin nhắn.