用户

/v1/users

使用 users 节点管理身份验证以及访问 WhatsApp Business On-Premises API 客户端。

准备工作

WhatsApp Business On-Premises API 客户端具有一个默认账户，账户的账号是 admin，密码是 secret。您无法从系统中移除或删除此账户。出于安全原因，您需要立即更改管理员密码。

如果您忘记密码，请联系站内支持，协助自己重置密码。

限制

只有 admin 账户可以创建或删除用户。

建议

只在创建或删除用户时使用 admin 账户
创建用户账户用于管理您的 WhatsApp Business On-Premises API 客户端

创建

如要为您公司内能够访问 WhatsApp Business API 的用户创建账户，请使用 /users 端点将账号和密码发送至 WhatsApp Business On-Premises API 客户端。系统会验证账号和密码，如果账号并不存在，则会创建一个新账户。我们会对密码进行单向散列处理，并将其存储在数据卷中。username 和 password 都是必要参数。

示例

要创建一个用户，请发送如下请求：

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

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

如果请求成功并已创建用户账户，您将会收到 201 Created HTTP 状态码和下列负载：

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

如果请求失败，您会收到一个 HTTP 状态码以及一个 WhatsApp 错误代码。如果您提交重复的账号，错误响应将如下所示：

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

参数

名称描述

名称	描述
`username`	必要。最少为 4 个字符，最多为 32 个字符。建立 `username` 模板（如首字母和姓氏），以避免为同一用户创建多个账户。
`password`	必要。长度必须在 8 至 64 个字符之间，而且必须包含大写字母、小写字母、数字以及特殊字符： !\/'"#$%&()*+-.,:;_<>=?@[]{}^`\|~
`Authorization`	必要。正在运行请求的管理员的身份验证口令。详情请参阅登录和身份验证 — 口令文档。

username

必要。

最少为 4 个字符，最多为 32 个字符。
建立 username 模板（如首字母和姓氏），以避免为同一用户创建多个账户。

password

必要。

长度必须在 8 至 64 个字符之间，而且必须包含大写字母、小写字母、数字以及特殊字符：


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

Authorization

必要。

正在运行请求的管理员的身份验证口令。详情请参阅登录和身份验证 — 口令文档。

连线

以下连线会连接至此节点：

连线	描述
`/users/login`	使用此连线登录 WhatsApp Business On-Premises API 客户端。
`/users/logout`	使用此连线退出 WhatsApp Business On-Premises API 客户端。
`/users/{username}`	使用此连线检索、更新或删除用户账户。

常见错误

HTTP 状态代码原因

HTTP 状态代码	原因
`400`	密码太短（不足 8 个字符）或太长（多于 64 个字符）。账号太短（不足 4 个字符）或太长（多于 32 个字符）请输入合适长度的账号/密码，再次提交请求。
`403`	您未使用 `admin` 账户创建用户账户。
`500`	无法创建账户，可能因为该账户已存在。

400

密码太短（不足 8 个字符）或太长（多于 64 个字符）。
账号太短（不足 4 个字符）或太长（多于 32 个字符）

请输入合适长度的账号/密码，再次提交请求。

403

您未使用 admin 账户创建用户账户。

500

无法创建账户，可能因为该账户已存在。

如果响应中存在其他错误，请参考以下源内容以获取更多信息：错误码和 HTTP 状态码。