Перейти к содержимому
Справочник API
/
Облачные телефоны
/
/Account & Quotas

Account & Quotas

Запрос баланса кошелька и квот использования облачного телефона.

Operations

Получить баланс и доступные ресурсы Cloud Phone

Request

Возвращает баланс кошелька команды и доступные объёмы использования облачных телефонов.

  • Предварительные условия: вызывающему участнику нужно право на расходы. Кошелёк ищется по команде, поэтому эти цифры относятся ко всей команде, а не к отдельному участнику.
  • Эффект: отсутствует. Только чтение. Повтор безопасен при ограниченной выдержке.
  • Единицы: balance — баланс кошелька в центах, а не в денежных единицах. remainingDuration — остаток минут облачного телефона, remainingConcurrency — число слотов; оба ограничиваются нулём и не уходят в минус.
  • Содержимое: ровно эти три числа. Замороженные суммы кошелька, разделение израсходованных и выданных минут и даты истечения существуют выше по стеку, но здесь намеренно не публикуются.
  • Примечание: вызов падает целиком, если не удался запрос кошелька или запрос квот; частичные цифры он не возвращает.
curl -i -X GET \
  http://127.0.0.1:40000/api/balance

Responses

Request processed; inspect code for the business result

Bodyapplication/json
codeintegerrequired

Business result code; 0 indicates success

Example:0
msgstring or nullrequired

Error message; null when successful

Example:null
requestIdstringrequired

Request ID for troubleshooting

Example:"1d4f3ea968664593860b94b35d4ebf5e"
dataobjectrequired
Response
{
  "code": 0,
  "msg": null,
  "data": {
    "balance": 12500,
    "remainingDuration": "120",
    "remainingConcurrency": 3
  },
  "requestId": "1d4f3ea968664593860b94b35d4ebf5e"
}