Nhà phát triển

POST/v3/directory/{number}

Gửi thông tin đăng danh bạ cho số điện thoại

Gửi thông tin danh bạ đã được cho phép đến nhà mạng, hiểu khoản phí đang áp dụng và đối soát kết quả chưa rõ trước khi thử lại.

Trên trang này
  1. Gửi thông tin đăng danh bạ đến nhà mạng
  2. Yêu cầu về tài khoản và số điện thoại
  3. Yêu cầu POST dạng biểu mẫu
  4. Cách thu phí và xử lý khi thử lại
  5. Phản hồi
  6. Các lỗi của hệ thống cũ
  7. Xác minh trước khi thử lại

Gửi thông tin đăng danh bạ đến nhà mạng

Gửi tên và địa chỉ dùng để đăng danh bạ cho một số điện thoại đủ điều kiện mà bạn sở hữu trong MultiTEL. Đây là thao tác cập nhật có tính phí tại nhà mạng, không phải tra cứu tên người gọi, thêm mục vào sổ địa chỉ riêng tư hay cập nhật chung trường LIDB trong kho số của cổng thông tin.

Chỉ gửi những thông tin mà khách hàng đã cho phép đăng danh bạ. Xác nhận nhà mạng hỗ trợ số đó trước khi dùng tuyến xử lý cũ này. Trình xử lý đã được rà soát không kiểm tra điều kiện hỗ trợ của nhà cung cấp hay định dạng số quốc tế; yêu cầu gửi đến nhà mạng mặc định coi đó là số Bắc Mỹ và loại bỏ chữ số đầu tiên được lưu.

Yêu cầu về tài khoản và số điện thoại

Dùng tài khoản API đang được kích hoạt qua HTTPS từ địa chỉ IP nguồn được cho phép. Số chính xác đó phải nằm trong một bản ghi số đã mua chưa bị hủy, thuộc tài khoản này. Dùng đầy đủ các chữ số theo định dạng quốc tế trong kho số của bạn, chẳng hạn định dạng có mã quốc gia 1 cho số Bắc Mỹ được hỗ trợ. Không dùng mã định danh gói giá, UUID của số hay số thuộc tài khoản khác.

Yêu cầu POST dạng biểu mẫu

Đặt NUMBER thành số điện thoại bạn sở hữu. Thay dữ liệu ví dụ hư cấu bằng thông tin danh bạ đã được cho phép. Tuyến này đọc các trường biểu mẫu từ POST; nó không phân tích phần thân application/json.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode "lastname=EXAMPLE" \
  --data-urlencode "firstname=EXAMPLE" \
  --data-urlencode "streetnum=1" \
  --data-urlencode "streetname=Example" \
  --data-urlencode "streetpredir=N" \
  --data-urlencode "streetpostdir=W" \
  --data-urlencode "city=Example City" \
  --data-urlencode "state=NY" \
  --data-urlencode "postalcode=10001" \
  "https://api.multitel.net/v3/directory/$NUMBER"
Các trường biểu mẫu đăng danh bạ
TrườngBắt buộc với API nàyÝ nghĩa
lastnameCóHọ dùng để đăng danh bạ hoặc trường tên đăng danh bạ phù hợp.
cityCóThành phố dùng để đăng danh bạ.
postalcodeCóMã bưu chính dùng để đăng danh bạ.
stateCóBang hoặc vùng dùng để đăng danh bạ mà nhà mạng được hỗ trợ chấp nhận.
streetnameCóTên đường.
streetnumCóSố nhà trên đường.
firstnameKhôngThành phần tên riêng bổ sung.
streetpredir, streetpostdirKhôngCác thành phần chỉ hướng đứng trước và sau tên đường, nếu có.
streettype, locationKhôngNội dung chỉ loại đường hoặc vị trí bổ sung, nếu có.

Các hướng và địa chỉ trong ví dụ chỉ là dữ liệu giữ chỗ, không phải địa chỉ bưu chính được khuyến nghị. Không thêm hướng hư cấu vào dữ liệu thực của khách hàng. Việc kiểm tra trường bắt buộc của API chỉ ở mức sơ bộ: không xác nhận địa chỉ hợp lệ hay được nhà mạng chấp nhận, và trang web cũ áp dụng các yêu cầu biểu mẫu khác.

Mã triển khai có thể phát cảnh báo thiếu khóa mảng khi một thành phần chỉ hướng không bắt buộc bị thiếu hoặc để trống. Nếu phản hồi sai định dạng hoặc nhà mạng từ chối địa chỉ, hãy giữ thông tin tham chiếu yêu cầu và nhờ bộ phận hỗ trợ xác nhận thông tin danh bạ, thay vì liên tục đoán, sửa địa chỉ rồi gửi lại.

Cách thu phí và xử lý khi thử lại

Trình xử lý đã được rà soát kiểm tra số dư tối thiểu là 10.00 đơn vị số dư trước khi liên hệ nhà mạng. Sau khi nhà mạng báo thành công và việc cập nhật số trong hệ thống nội bộ cũng báo thành công, hệ thống trừ 10.00 khỏi số dư tài khoản và ghi một giao dịch thiết lập danh bạ. Đây là các mức tiền đang được triển khai, không phải đề xuất giá mới; hãy đối chiếu điều khoản tài khoản để xác nhận loại tiền thanh toán áp dụng và dịch vụ được hỗ trợ trước khi gửi.

Thao tác này không có khóa bảo đảm gửi lặp vẫn cho cùng kết quả, cơ chế ngăn đơn trùng hay giao dịch bao trùm việc gửi đến nhà mạng, cập nhật nội bộ và thu phí. Một yêu cầu gửi lặp thành công có thể dẫn đến một lần gửi nữa đến nhà mạng và một lần thu phí nữa. Hết thời gian chờ hoặc lỗi API không chứng minh nhà mạng đã từ chối yêu cầu trước đó: nhà cung cấp có thể đã chấp nhận yêu cầu trước khi cập nhật nội bộ thất bại.

Phản hồi

{
  "status": {
    "code": 200,
    "msg": "Success"
  },
  "response": ""
}

Phản hồi thành công thông thường có giá trị chuỗi rỗng ở trường response và không trả về mã định danh mục danh bạ hay chi tiết hoàn tất. Điều đó có nghĩa các luồng xử lý của nhà mạng và cập nhật nội bộ đã báo thành công; không chứng minh thông tin đã được công bố trong mọi danh bạ bên ngoài, đã lan truyền ngay lập tức hay sẽ hiển thị trong thông tin nhận dạng người gọi sau này.

Các lỗi của hệ thống cũ

Mã kết quả API đăng danh bạ
Mã APIÝ nghĩa
404Không tìm thấy số trong tài khoản hoặc một trong các trường biểu mẫu bắt buộc bị để trống.
400Số dư tài khoản thấp hơn khoản phí đang áp dụng trong mã triển khai.
500Yêu cầu gửi đến nhà mạng thất bại, hoặc cập nhật nội bộ thất bại sau khi nhà mạng có thể đã chấp nhận yêu cầu.
200Báo thành công; phản hồi không chứa xác nhận công bố.

Đọc cả trạng thái HTTP và các trường trong JSON status.code/status.msg. Các hạn chế về xác thực và IP nguồn cũng có thể khiến bạn không nhận được phản hồi có thể sử dụng. Không dùng GET hay tham số truy vấn để yêu cầu cập nhật chỉ vì trình xử lý cũ không có cơ chế kiểm soát phương thức HTTP một cách tường minh.

Xác minh trước khi thử lại

  1. Xác nhận số thuộc sở hữu của bạn, điều kiện hỗ trợ của nhà mạng, dữ liệu danh bạ đã được cho phép và khoản phí trước khi gửi yêu cầu.
  2. Gửi một lần và lưu kết quả phía tài khoản, không để lộ địa chỉ khách hàng trong nhật ký công khai hay dữ liệu phân tích.
  3. Kiểm tra thông tin danh bạ đã lưu và lịch sử giao dịch qua quy trình tài khoản được hỗ trợ hoặc qua bộ phận hỗ trợ. Chờ đủ thời gian xử lý mà nhà mạng xác nhận; API này không quy định thời hạn bảo đảm việc lan truyền thông tin.
  4. Khi kết quả chưa rõ, hãy nhờ bộ phận hỗ trợ đối soát đơn gửi đến nhà mạng và việc thu phí nội bộ trước khi thử lại. Gửi lặp yêu cầu không phải là thao tác kiểm tra trạng thái có thể lặp lại mà không gây thêm tác động.