Tài liệu REST API
REST API gọi khẩn cấp
Đăng ký một số và địa chỉ dịch vụ, theo dõi trạng thái kích hoạt, và duy trì bản ghi khi vị trí thay đổi.
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.
Đọc phạm vi phủ sóng mà không cần đăng ký một số
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multi.tel/emergency/coverage?environment=production"https://api.multitel.net/emergency cũng được hỗ trợ. Cả hai URL cơ sở khẩn cấp đều không chứa /v3. Phạm vi phủ sóng liệt kê các quốc gia được dịch vụ quốc tế hỗ trợ, các loại số được hỗ trợ và giá; tính đủ điều kiện E911 của Bắc Mỹ được kiểm tra trong quá trình đăng ký.
{
"code": 200,
"message": "",
"environment": "production",
"requestId": "EXAMPLE_REQUEST_ID",
"data": {}
}Phần này chỉ minh họa phần vỏ bọc. Hãy đọc lược đồ data của từng thao tác trong hướng dẫn Emergency API đã được công bố.
Đăng ký, theo dõi trạng thái, rồi cấu hình cuộc gọi
- Đối với Hoa Kỳ/Canada và các khu vực E911 Bắc Mỹ được hỗ trợ khác, hãy cung cấp số, địa chỉ E911 và các xác nhận đồng ý bắt buộc. E911 Bắc Mỹ chỉ dùng cho môi trường production.
- Đối với một số quốc tế thuộc sở hữu của bạn và được hỗ trợ, hãy cung cấp một tham chiếu Document đã lưu hoặc danh tính và địa chỉ của người dùng cuối. Hãy xem trước các yêu cầu theo quốc gia và loại số.
- Gửi một yêu cầu
POST /registrations. MộtIdempotency-Keytùy chọn xác định một thay đổi logic; hãy giữ nguyên nó và đúng nội dung payload qua các lần thử lại. - Đọc
GET /registrations/:number. Kiểm tra vòng đời,pendingvàactionRequired; hãy xử lý các chỉnh sửa bắt buộc. Được chấp nhận hoặc đang chờ không có nghĩa là dịch vụ đã hoạt động. - Sau khi kích hoạt, hãy cấu hình đúng caller ID khẩn cấp và tuyến quay số theo từng quốc gia. Sử dụng quy trình xác minh không khẩn cấp của dịch vụ.
Các đăng ký sandbox quốc tế được cô lập và không kích hoạt cuộc gọi khẩn cấp thật. E911 Bắc Mỹ yêu cầu thông tin xác thực của tài khoản chính; hướng dẫn giải thích phần hỗ trợ tài khoản phụ quốc tế còn hạn chế.
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.