Tài liệu REST API
Gửi yêu cầu API MultiTEL đầu tiên của bạn
Bắt đầu với một yêu cầu chỉ đọc, tìm hiểu phản hồi, sau đó chọn tài liệu tham chiếu cho dịch vụ bạn muốn xây dựng.
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.
Yêu cầu đầu tiên: đọc số dư của bạn
Thao tác đọc này không mua dịch vụ và không khởi tạo cuộc gọi hay tin nhắn.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getbalance"API communications v3 trả về kết quả ứng dụng bên trong nội dung JSON. Hãy kiểm tra trạng thái HTTP và status.code trước khi đọc response; một yêu cầu bị từ chối có thể không có đối tượng phản hồi. Giá trị mã có thể là chuỗi hoặc số.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"balance": "25.0000",
"currency": "USD",
"terms": "Prepaid"
}
}Đây là ví dụ hư cấu, không phải số dư tài khoản. Hãy xử lý các giá trị tiền tệ dưới dạng số thập phân. Khi chẩn đoán một yêu cầu bị từ chối, hãy giữ lại thông báo phản hồi của máy chủ, sau khi đã loại bỏ thông tin xác thực.
Sử dụng dữ liệu thanh toán đúng cách
Phản hồi số dư chứa số dư hiện tại, đơn vị tiền tệ và điều khoản thanh toán. Nó không cho biết chi phí của một cuộc gọi trong tương lai hay một hóa đơn đầy đủ. Hãy dùng các thao tác về giá cước và mức sử dụng tương ứng cho những câu hỏi đó. Các số hiện có có thể có gói khác với danh mục hiện nay.
Chọn tích hợp tiếp theo của bạn
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.
Đọc hướng dẫn tích hợp →REST API số điện thoại
Tìm các quốc gia và số khả dụng, xem toàn bộ nội dung gói dịch vụ, và quản lý các số bạn sở hữu.
Đọc hướng dẫn tích hợp →REST API SMS & MMS
Gửi các tin nhắn ứng dụng đã được phê duyệt và xử lý việc tiếp nhận, sự kiện chuyển phát, phân đoạn và cước phí.
Đọc hướng dẫn tích hợp →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.
Đọc hướng dẫn tích hợp →REST API tài khoản & thanh toán
Đọc số dư và thông tin thanh toán có sẵn cho tích hợp đã được phê duyệt của bạn.
Đọc hướng dẫn tích hợp →Tra cứu CNAM và định tuyến
Đọc tên người gọi, tìm hiểu các cấp tra cứu và sử dụng thông tin định tuyến số.
Tài liệu tham chiếu CNAM REST →Hosted PBX
Bắt đầu với các gói dịch vụ hiện có và tenant mà bạn dự định cấu hình.
API gói dịch vụ Hosted PBX →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.