Tích hợp CNAM

Tài liệu tham chiếu CNAM REST API

Yêu cầu tên người gọi qua HTTPS và xử lý kết quả, khoản phí và các lỗi.

Chọn cách thức tra cứu

CấpGiá công khai mỗi truy vấnChức năng
Starter0,0026 US$Sử dụng thông tin tên người gọi độc quyền và được lưu trong bộ nhớ đệm.
Standard0,0037 US$Thực hiện tra cứu mạng theo thời gian thực cho mỗi truy vấn.
Mixed0,004 US$Thử tra cứu theo thời gian thực trước, sau đó chuyển sang dữ liệu Starter khi không tìm thấy tên.

Dịch vụ được chọn quyết định cách thức tra cứu; Mixed không phải là tra cứu ưu tiên bộ nhớ đệm. Hãy xem lại mức giá được áp dụng cho tài khoản của bạn trước khi dùng trong môi trường vận hành thực tế. Tên người gọi không phải là bằng chứng về danh tính hay quyền sở hữu.

Gửi một yêu cầu tra cứu có xác thực

Điểm cuối: GET https://api.multitel.net/v3/cnam/NUMBER. Dùng số điện thoại ở định dạng quốc tế, chỉ gồm chữ số và có mã quốc gia, không có dấu câu hay dấu cộng ở đầu. Hãy thực thi từ máy chủ ứng dụng của bạn bằng thông tin xác thực API đã được phê duyệt.

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multitel.net/v3/cnam/12025550123"

Cung cấp hai biến môi trường thông qua cấu hình bí mật phía máy chủ. Thông tin xác thực bearer được cấp riêng chỉ là một lựa chọn thay thế khi quyền truy cập đó được bật và các hạn chế IP nguồn của nó được đáp ứng. Tuyệt đối không đưa API secret vào gói mã trình duyệt công khai.

Hướng dẫn xác thực API và yêu cầu đầu tiên

Đọc phản hồi JSON

Phản hồi này chỉ mang tính minh họa. Tên được trả về và khoản phí phụ thuộc vào lần tra cứu và dịch vụ được chọn.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550123",
    "name": "EXAMPLE CALLER",
    "cost": "0.004",
    "balance": "24.9960"
  }
}
status.code
Mã kết quả ứng dụng; hãy chuẩn hóa các giá trị chuỗi/số trước khi so sánh với 200.
status.msg
Thông báo kết quả hoặc lý do từ chối đi kèm.
response.number
Số đã được truy vấn.
response.name
Tên người gọi hiện có.
response.cost
Khoản phí được báo cáo cho truy vấn này; hãy xử lý như một số thập phân.
response.balance
Số dư tài khoản được báo cáo, khi có.

Kết quả không có tên và các lỗi

Một yêu cầu thành công không đảm bảo có tên người gọi hữu ích. Hãy xử lý các trường hợp tên trống, số được trả về thay cho tên và lần tra cứu bị từ chối. Mã ứng dụng 403 có thể mô tả tình trạng không đủ số dư, một giao dịch mua bị cấm hoặc một số không có kết quả; hãy xem kỹ thông báo.

Hãy kiểm tra cả trạng thái HTTP và status trong JSON trước khi truy cập response.name. Đối tượng phản hồi có thể không có khi xảy ra lỗi. Việc thiếu tên không nên ngăn cuộc gọi thông thường được định tuyến.

Thanh toán, thử lại và điểm khác biệt so với việc cập nhật caller ID

Một lần tra cứu mới có thể phát sinh phí truy vấn. Các giao diện tra cứu này không có tài liệu về khóa idempotency, nên một lần thử lại mới có thể là một truy vấn tính phí thứ hai. Hãy dùng cơ chế backoff có giới hạn cho các lỗi truyền tải/dịch vụ, xử lý các lỗi tài khoản trước, và đối chiếu các khoản phí truy vấn đã báo cáo. Chỉ lưu bộ nhớ đệm trong khoảng thời gian phù hợp với ứng dụng của bạn; dữ liệu tên người gọi có thể thay đổi.

Tra cứu CNAM chỉ đọc một tên. Nó không thay đổi tên hiển thị trên các cuộc gọi đi của bạn. Cập nhật tên người gọi LIDB là một thao tác riêng, với các trường, việc ủy quyền, giá và quy trình xử lý riêng.