xaxumessageAPI
Методы API

Группы

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

Создать группу

POST/v1/accounts/:id/groups
API-ключ клиентаУспех: 201
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера

Тело запроса

namestring 1…100обязательно
название
participantsstring[]обязательно
адреса участников (chatId)

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X POST "https://msg.xaxu.am/v1/accounts/{id}/groups" \
  -H "Authorization: Bearer $XM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Гости 12–14 октября",
    "participants": [
      "79991234567@c.us",
      "79181234567@c.us"
    ]
  }'
Ответ 201
{
  "created": true,
  "chatId": "120363025746123456@g.us",
  "groupInviteLink": "https://chat.whatsapp.com/…"
}

Сведения о группе

GET/v1/accounts/:id/groups/:groupId
API-ключ клиентаУспех: 200

Ответ провайдера как есть: название, владелец, участники, ссылка-приглашение.

WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}" \
  -H "Authorization: Bearer $XM_API_KEY"
Ответ 200
{
  "groupId": "120363025746123456@g.us",
  "subject": "Гости 12–14 октября",
  "owner": "79991234567@c.us",
  "participants": [
    {
      "id": "79181234567@c.us",
      "isAdmin": false
    }
  ]
}

Переименовать группу

PATCH/v1/accounts/:id/groups/:groupId
API-ключ клиентаУспех: 200
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)

Тело запроса

namestring 1…100обязательно
новое название

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X PATCH "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}" \
  -H "Authorization: Bearer $XM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Гости 12–15 октября"}'
Ответ 200
{
  "updateGroupName": true
}

Добавить участника

POST/v1/accounts/:id/groups/:groupId/participants
API-ключ клиентаУспех: 200
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)

Тело запроса

chatIdstringобязательно
адрес участника

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X POST "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}/participants" \
  -H "Authorization: Bearer $XM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"chatId":"79181234567@c.us"}'
Ответ 200
{
  "addParticipant": true
}

Удалить участника

DELETE/v1/accounts/:id/groups/:groupId/participants/:participant
API-ключ клиентаУспех: 200
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)
participantstringобязательно
адрес участника: 79991234567@c.us

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X DELETE "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}/participants/{participant}" \
  -H "Authorization: Bearer $XM_API_KEY"
Ответ 200
{
  "removeParticipant": true
}

Назначить администратора

POST/v1/accounts/:id/groups/:groupId/admins
API-ключ клиентаУспех: 200
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)

Тело запроса

chatIdstringобязательно
адрес участника

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X POST "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}/admins" \
  -H "Authorization: Bearer $XM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"chatId":"79181234567@c.us"}'
Ответ 200
{
  "setGroupAdmin": true
}

Снять администратора

DELETE/v1/accounts/:id/groups/:groupId/admins/:participant
API-ключ клиентаУспех: 200
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)
participantstringобязательно
адрес участника: 79991234567@c.us

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X DELETE "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}/admins/{participant}" \
  -H "Authorization: Bearer $XM_API_KEY"
Ответ 200
{
  "removeAdmin": true
}

Выйти из группы

POST/v1/accounts/:id/groups/:groupId/leave
API-ключ клиентаУспех: 200
WhatsAppдаTelegramдаMAXда

Параметры пути

iduuidобязательно
id номера
groupIdstringобязательно
адрес группы в мессенджере, например 120363025746…@g.us (кодируйте в URL)

Ошибки

422unsupportedмессенджер номера не умеет эту операцию
404not_foundномера нет или он принадлежит другому клиенту
502upstream_errorпровайдер мессенджера не ответил или ответил ошибкой — повторите позже
Запрос
curl -X POST "https://msg.xaxu.am/v1/accounts/{id}/groups/{groupId}/leave" \
  -H "Authorization: Bearer $XM_API_KEY"
Ответ 200
{
  "leaveGroup": true
}