用戶

/v1/users

使用 users 節點來管理身分驗證及存取 WhatsApp Business 企業內部 API 用戶端。

準備工作

WhatsApp Business 企業內部 API 用戶端擁有一個預設帳戶，其用戶名稱設為 admin，密碼則為 secret。您無法將此帳戶從系統中移除或刪除。出於安全原因，您必須立即更改管理員密碼。

如果您忘記了密碼，請聯絡直接支援團隊，以協助您重新設定密碼。

限制

只有 admin 帳戶能夠建立或刪除用戶。

建議事項

只使用 admin 帳戶建立或刪除用戶
建立用戶帳戶來管理 WhatsApp Business 企業內部 API 用戶端

建立

如要為您企業內部能存取 WhatsApp Business API 的用戶建立帳戶，請使用 /users 端點將用戶名稱和密碼傳送至 WhatsApp Business 企業內部 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 企業內部 API 用戶端。
`/users/logout`	使用此關係連線以登出 WhatsApp Business 企業內部 API 用戶端。
`/users/{username}`	使用此關係連線以檢索、更新或刪除用戶帳戶。

常見錯誤

HTTP 狀態代碼原因

HTTP 狀態代碼	原因
`400`	密碼太短（少於 8 個字元）或太長（多於 64 個字元）。用戶名稱太短（少於 4 個字元）或太長（多於 32 個字元）請使用合適長度的用戶名稱/密碼，並再次提交要求。
`403`	您並非使用 `admin` 帳戶來建立用戶帳戶。
`500`	無法建立帳戶，原因可能是帳戶已存在。

400

密碼太短（少於 8 個字元）或太長（多於 64 個字元）。
用戶名稱太短（少於 4 個字元）或太長（多於 32 個字元）

請使用合適長度的用戶名稱/密碼，並再次提交要求。

403

您並非使用 admin 帳戶來建立用戶帳戶。

500

無法建立帳戶，原因可能是帳戶已存在。

如果回應中有其他錯誤，請參閱下列資源以了解詳情：錯誤代碼和 HTTP 狀態代碼。