Skip to content

Получение бизнес-имени пользователя ​

GET

/v1/apps/{appId}/wa/username

Данный эндпоинт API предназначен для получения уникального бизнес-имени (username) приложения WhatsApp Business. Бизнес-имя позволяет пользователям находить ваш бизнес в WhatsApp по короткому имени.

Авторизация ​

Для доступа к методу необходим токен системного пользователя. Передайте его в заголовке HTTP-запроса.

Authorization: Bearer <ACCESS_TOKEN>

Параметры ​

ПараметрРасположениеТипОбязательныйОписание
appIdPathstringДаУникальный идентификатор приложения.

Пример запроса ​

bash
curl -X GET \
  "https://space.getloo.ru/api/v1/apps/{appId}/wa/username" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Пример ответа ​

Успешный ответ ​

json
{
  "username": "mybusiness",
  "status": "APPROVED"
}

Если имя не установлено ​

json
{
  "error": "Username not found",
  "message": "Business username has not been set for this application"
}

Параметры ответа ​

ПараметрТипОписание
usernamestringУникальное бизнес-имя приложения. Используется для поиска бизнеса в WhatsApp.
statusstringСтатус бизнес-имени. Возможные значения:
  • SUCCESS — успешно установлено
  • APPROVED — одобрено
  • RESERVED — зарезервировано
  • NOT_REQUESTED — еще не установлено

Коды состояния ​

Код состоянияОписание
200Запрос успешно выполнен
401Неавторизованный запрос
403Доступ запрещён
404Не найдено