API Tại chỗ của Nền tảng WhatsApp Business

Chúng tôi sẽ ngừng cung cấp API Tại chỗ. Hãy tham khảo tài liệu về việc Ngừng cung cấp API Tại chỗ để biết chi tiết, đồng thời tìm hiểu cách chuyển sang API Đám mây thế hệ tiếp theo của chúng tôi.

Người dùng

/v1/users

Sử dụng nút users để quản lý hoạt động xác thực và truy cập vào Ứng dụng API WhatsApp Business Tại chỗ.

Trước khi bạn bắt đầu

Ứng dụng API WhatsApp Business Tại chỗ có một tài khoản mặc định với admin được đặt làm tên người dùng và mật khẩu là secret. Bạn không thể gỡ hay xóa tài khoản này khỏi hệ thống. Vì lý do bảo mật, bạn phải đổi mật khẩu quản trị viên ngay lập tức.

Nếu bạn quên mật khẩu, vui lòng liên hệ với bộ phận Hỗ trợ trực tiếp để được trợ giúp về việc đặt lại mật khẩu.

Các giới hạn

  • Chỉ tài khoản admin mới tạo hoặc xóa được người dùng.

Đề xuất

  • Chỉ sử dụng tài khoản admin để tạo hoặc xóa người dùng
  • Tạo tài khoản người dùng để quản lý Ứng dụng API WhatsApp Business Tại chỗ

Tạo

Để tạo tài khoản cho một người dùng trong doanh nghiệp bạn - người có thể truy cập vào API WhatsApp Business, hãy gửi tên người dùng và mật khẩu cho Ứng dụng API WhatsApp Business Tại chỗ bằng điểm cuối /users. Ứng dụng này sẽ xác thực tên người dùng và mật khẩu, đồng thời tạo tài khoản mới nếu chưa tồn tại tài khoản có tên người dùng đó. Mật khẩu được xử lý bằng cách mã hóa một chiều và lưu trữ trong ổ đĩa dữ liệu. Cả username và password đều là thông số bắt buộc.

Ví dụ

Để tạo người dùng, hãy gửi yêu cầu như sau:

POST /v1/users
Authorization: Bearer your-auth-token

{
  "username": "username",
  "password": "password"
}

Nếu yêu cầu thành công và tài khoản người dùng được tạo, bạn sẽ nhận được mã trạng thái HTTP là 201 Created và phần tải dữ liệu sau:

{
  "users": [{
     "username": "username"
  }]
}

Nếu yêu cầu không thành công, bạn sẽ nhận được mã trạng thái HTTP, cùng với mã lỗi WhatsApp. Nếu bạn gửi tên người dùng trùng lặp, phản hồi lỗi sẽ có dạng như sau:

{
  "errors": [{
    "code": 1014,
    "title": "Internal error",
    "details": "Unable to create user. Already exist?"
  }]
}

Thông số

TênMô tả

username

Bắt buộc.

Phải có tối thiểu 4 ký tự và tối đa 32 ký tự.
Hãy thiết lập một mẫu cho username - chẳng hạn như tên viết tắt và họ - để tránh tạo nhiều tài khoản cho cùng một người.

password

Bắt buộc.

Phải dài từ 8 đến 64 ký tự, đồng thời phải có ít nhất một ký tự viết hoa, một ký tự viết thường, một chữ số và một ký tự đặc biệt:


!\/'"#$%&()*+-.,:;_<>=?@[]{}^`|~

Authorization

Bắt buộc.

Mã xác thực cho quản trị viên đang chạy yêu cầu. Hãy xem tài liệu về Đăng nhập và xác thực - Mã để biết thêm thông tin.

Cạnh

Dưới đây là những cạnh được kết nối với nút này:

CạnhMô tả

/users/login

Sử dụng cạnh này để đăng nhập vào Ứng dụng API WhatsApp Business Tại chỗ.

/users/logout

Sử dụng cạnh này để đăng xuất khỏi Ứng dụng API WhatsApp Business Tại chỗ.

/users/{username}

Sử dụng cạnh này để truy xuất, cập nhật hoặc xóa tài khoản người dùng.

Lỗi thường gặp

Mã trạng thái HTTPLý do

400

  • Mật khẩu quá ngắn (ít hơn 8 ký tự) hoặc quá dài (nhiều hơn 64 ký tự).
  • Tên người dùng quá ngắn (ít hơn 4 ký tự) hoặc quá dài (nhiều hơn 32 ký tự)

Gửi lại yêu cầu với tên người dùng/mật khẩu có độ dài phù hợp.

403

Bạn hiện không sử dụng tài khoản admin để tạo tài khoản người dùng.

500

Không thể tạo tài khoản, có thể do tài khoản đó đã tồn tại.

Nếu phản hồi có lỗi khác, hãy tham khảo những nguồn sau để biết thêm thông tin: Mã lỗi và Mã trạng thái HTTP.