xaxumessageAPI
Методы API

Профиль и цены

Проверка ключа, лимиты самообслуживания и стоимость номеров.

Мой профиль и лимиты

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

Кто вы для шлюза, куда уходят события и сколько номеров ещё можно заказать. Удобно для проверки ключа.

Поле limitsЧто значит
maxAccountsсколько номеров можно иметь одновременно; 0 — самообслуживание выключено
accountsUsed, pendingOrders, remainingсколько номеров уже есть, сколько заказов в работе и сколько ещё можно заказать
canProvisionдля каких мессенджеров заказ номера доступен прямо сейчас
trialDaysсколько дней работает новый номер без оплаты
billingModeplatform — оплату номеров ведёт платформа (счета /v1/payments); tenant — вы сами ставите срок оплаты своих номеров
ordersPerHourсколько номеров можно заказать за час
Запрос
curl "https://msg.xaxu.am/v1/me" \
  -H "Authorization: Bearer $XM_API_KEY"
Ответ 200
{
  "id": "c3d4e5f6-1a2b-4c3d-8e9f-0a1b2c3d4e5f",
  "name": "XAXU",
  "webhookUrl": "https://example.ru/api/xaxumessage/events",
  "hasWebhookSecret": true,
  "limits": {
    "maxAccounts": 20,
    "accountsUsed": 4,
    "pendingOrders": 0,
    "remaining": 16,
    "canProvision": {
      "whatsapp": true,
      "telegram": true,
      "max": true
    },
    "trialDays": 3,
    "billingMode": "platform",
    "ordersPerHour": 10
  }
}

Цены на номера

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

Ваш прайс-лист: цена одного периода для каждого мессенджера, в копейках.

Запрос
curl "https://msg.xaxu.am/v1/pricing" \
  -H "Authorization: Bearer $XM_API_KEY"
Ответ 200
{
  "billingMode": "platform",
  "priceList": {
    "code": "standard",
    "name": "Стандартный",
    "currency": "RUB",
    "periodDays": 30,
    "prices": {
      "whatsapp": 299000,
      "telegram": 299000,
      "max": 299000
    }
  }
}