Контакты и обслуживание

Контакты номера, проверка телефона, очередь провайдера и догрузка пропущенного.

Контакты номера

GET/v1/accounts/:id/contacts

API-ключ клиентаУспех: 200

Список контактов аккаунта у провайдера, как он его отдаёт.

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

iduuidобязательно

id номера

Ошибки

404	`not_found`	номера нет или он принадлежит другому клиенту
502	`upstream_error`	провайдер мессенджера не ответил или ответил ошибкой — повторите позже

Запрос

curl "https://msg.xaxu.am/v1/accounts/{id}/contacts" \
  -H "Authorization: Bearer $XM_API_KEY"

Ответ 200

{
  "contacts": [
    {
      "id": "79181234567@c.us",
      "name": "Анна",
      "type": "user"
    }
  ]
}

Есть ли у телефона аккаунт

POST/v1/accounts/:id/check

API-ключ клиентаУспех: 200

Проверяет, зарегистрирован ли телефон в мессенджере номера. Для Telegram и MAX ответ содержит chatId, по которому можно писать первым.

WhatsAppдаTelegramдаMAXда

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

iduuidобязательно

id номера

Тело запроса

phonestringобязательно

телефон в международном формате

Ошибки

422	`unsupported`	мессенджер номера не умеет эту операцию
404	`not_found`	номера нет или он принадлежит другому клиенту
502	`upstream_error`	провайдер мессенджера не ответил или ответил ошибкой — повторите позже

Запрос

curl -X POST "https://msg.xaxu.am/v1/accounts/{id}/check" \
  -H "Authorization: Bearer $XM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+7 918 123-45-67"}'

Ответ 200

{
  "existsWhatsapp": true
}

Очередь у провайдера

GET/v1/accounts/:id/provider-queue

API-ключ клиентаУспех: 200

Сообщения, которые уже переданы провайдеру, но ещё не ушли в мессенджер (например, пока телефон без сети).

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

iduuidобязательно

id номера

Ошибки

404	`not_found`	номера нет или он принадлежит другому клиенту
502	`upstream_error`	провайдер мессенджера не ответил или ответил ошибкой — повторите позже

Запрос

curl "https://msg.xaxu.am/v1/accounts/{id}/provider-queue" \
  -H "Authorization: Bearer $XM_API_KEY"

Ответ 200

{
  "queue": []
}

Догрузить пропущенные сообщения

POST/v1/accounts/:id/backfill

API-ключ клиентаУспех: 200

Забирает из журналов провайдера сообщения за последние N минут — после простоя. Повторять безопасно: уже принятые сообщения не дублируются.

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

iduuidобязательно

id номера

Тело запроса

minutesint 1…1440

глубина, минут (по умолчанию 60)

Ошибки

404	`not_found`	номера нет или он принадлежит другому клиенту
502	`upstream_error`	провайдер мессенджера не ответил или ответил ошибкой — повторите позже

Запрос

curl -X POST "https://msg.xaxu.am/v1/accounts/{id}/backfill" \
  -H "Authorization: Bearer $XM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"minutes":120}'

Ответ 200

{
  "fetched": 37,
  "created": 2
}