管理用戶帳戶

本文件將講解以下內容：

• 建立用戶帳戶
• 更改用戶密碼
• 擷取用戶帳戶
• 刪除用戶帳戶

您僅可使用 admin 帳戶來管理帳戶，即執行建立或移除用戶等動作。如果您忘記了密碼，請聯絡直接支援團隊，以協助您重新設定密碼。

建立用戶帳戶

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?"
  }]
}

一些可能出現的錯誤：

如果回應中有其他錯誤，請參閱以下來源，以了解詳情：

• 錯誤代碼
• HTTP 狀態代碼

更改用戶密碼

如果用戶帳戶擁有 ROLE_ADMIN 或 ROLE_USER 角色，則擁有 ROLE_ADMIN 角色的用戶可更新與之相關的密碼。個別用戶也可更新自己帳戶的密碼。更新用戶帳戶密碼不會令任何與該用戶相關的存取憑證無效。目前，只有 admin 用戶擁有 ROLE_ADMIN 角色；其他用戶的角色均為 ROLE_USER。

要求

如要更新帳戶密碼，請提供 Bearer 憑證，以及用戶名稱和新密碼。

PUT /v1/users/username
Authorization: Bearer your-auth-token
   
{
  "password": "new-password"
}

回應

如果要求成功，該用戶名稱的密碼便會隨之更新。系統會傳回 200 OK HTTP 狀態代碼，以及與以下範例類似的承載：

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

如果要求失敗，回應或會包含下列其中一個錯誤代碼：

擷取用戶帳戶

您可以獲取資訊，以判斷是否已為特定用戶名稱建立用戶帳戶，並找出分配給該用戶帳戶的角色。

要求

如要擷取用戶帳戶，請 users 端點中使用 GET 要求：

GET /v1/users/username
Authorization: Bearer your-auth-token

回應

如果要求成功，回應會是 200 OK HTTP 狀態代碼和如下所示的承載：

{
   "users": [{
     "ROLES": "ROLE_ADMIN | ROLE_USER",
     "username": "username"
   }]
}

如果要求失敗，回應或會包含下列其中一個錯誤代碼：

刪除用戶帳戶

如果帳戶遭盜用，或因任何其他原因需要刪除帳戶，則 admin 必須刪除此帳戶。成功刪除帳戶後，系統將會移除與該帳戶相關的所有憑證。

要求

使用以下的 API 調用來刪除用戶帳戶，其中 username 是您想刪除的用戶帳戶的名稱。Bearer 憑證是屬於 admin 帳戶的憑證。

DELETE /v1/users/username
Authorization: Bearer your-auth-token

回應

如果要求成功，則系統會刪除用戶帳戶。回應會包括 HTTP 狀態代碼 200 OK 和下列承載：

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

如果要求失敗，回應或會包含下列其中一個錯誤代碼：