Локальный API платформы WhatsApp Business

Мы прекращаем поддержку локального API. Подробные сведения и информацию о том, как перейти на облачный API нового поколения, см. в документе Упразднение локального API.

Пользователи

/v1/users

Узел users используется для управления аутентификацией и для доступа к клиенту локального API WhatsApp Business.

Прежде чем начать

В клиенте локального API WhatsApp Business имеется используемый по умолчанию аккаунт с именем пользователя admin и паролем secret. Его нельзя удалить. Из соображений безопасности необходимо сразу же сменить пароль администратора.

Если вы забыли пароль, отправьте запрос на его сброс через прямую поддержку.

Ограничения

  • Только аккаунт admin может создавать или удалять пользователей.

Рекомендации

  • Аккаунт admin следует использовать только для создания или удаления пользователей.
  • Создавайте аккаунты пользователей для управления своими клиентами локального WhatsApp Business API.

Создание

Чтобы создать для пользователя компании аккаунт с доступом к API WhatsApp Business, отправьте имя пользователя и пароль для доступа к клиенту локального API WhatsApp Business на конечную точку /users. Если имя пользователя и пароль пройдут проверку и такого имени пользователя ещё нет, аккаунт будет создан. Пароль шифруется с использованием одностороннего хэширования и сохраняется на томе данных. Параметры username и password обязательны.

Пример

Чтобы создать пользователя, отправьте следующий запрос:

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

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

В случае выполнения запроса и создания аккаунта вы получите ответ с кодом статуса HTTP 201 Created и следующими полезными данными:

{
  "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

Обязательный параметр.

Маркер аутентификации администратора, который выполняет запрос. Дополнительную информацию см. в разделе Маркеры статьи "Вход и аутентификация".

Границы контекста

С этим узлом связаны следующие границы контекста:

Граница контекстаОписание

/users/login

Используйте эту границу контекста, чтобы подключиться к клиенту локального WhatsApp Business API.

/users/logout

Используйте эту границу контекста, чтобы отключиться от клиента локального WhatsApp Business API.

/users/{username}

Используйте эту границу контекста, чтобы получить, обновить или удалить аккаунт пользователя.

Распространенные ошибки

Код статуса HTTPПричина

400

  • Слишком короткий (меньше 8 символов) или слишком длинный (больше 64 символов) пароль.
  • Слишком короткое (меньше 4 символов) или слишком длинное (больше 32 символов) имя пользователя.

Отправьте запрос ещё раз, указав имя пользователя или пароль нужной длины.

403

Для создания пользователя используется аккаунт, отличный от admin.

500

Не удается создать аккаунт. Возможно, он уже существует.

Если в ответе имеются другие ошибки, за дополнительной информацией обратитесь к следующим разделам: Коды ошибок и Коды статусов HTTP.