رفتن به محتوا
cloudhostمستندات
مرجع API

پشتیبانی

درخواست از تیم پشتیبانی و پیگیری پاسخ‌ها.

توضیح هر مسیر به انگلیسی است، همان متنی که مرجع از کد ساخته می‌شود. مسیرها، نام فیلدها و کدها همان‌اند که در درخواست می‌نویسید.
GET/v1/support/cases

The cases you may see#

Owners and admins: every case of the team; other roles and API keys: the cases they opened (others answer 404).

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

پارامترها

  • statusstringکوئری

    open, pending, closed, or active (not closed)

    one of open, pending, closed, active

  • severitystringکوئری

    one of low, normal, high, urgent

  • categorystringکوئری

    one of billing, account, function, app, database, cache, storage, other

  • qstringکوئری

    subject or number

  • sortstringکوئری

    one of updated_at, created_at, number, severity

  • dirstringکوئری

    one of asc, desc

  • fromstring (date)کوئری

    created on or after

  • tostring (date)کوئری

    created on or before

  • limitintegerکوئری

    1-200, default 25

  • offsetintegerکوئری

پاسخ

200object

  • itemsSupportCase[]الزامی
  • totalintegerالزامی
  • limitinteger
  • offsetinteger
  • sortstring
  • dirstring
  • sees_allboolean

    owners and admins

خطاها

وضعیتتوضیح
401unauthorized: missing, invalid, expired or revoked credential
500internal: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/support/cases" \
  -H "Authorization: Bearer $KEY"
POST/v1/support/cases

Open a case#

Any member or API key. Urgent needs Pro. At most 20 cases a day per team. Body up to 10 MiB.

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

بدنهٔ درخواستapplication/json

  • subjectstringالزامی

    3–200 characters

  • categorystringالزامی

    one of billing, account, function, app, database, cache, storage, other

  • severitystring

    one of low, normal, high, urgent · default "normal"

  • bodystringالزامی

    1–20000 characters

  • resourceobject
  • attachmentsSupportUpload[]

    up to 3

پاسخ

201SupportCase

  • idstring (uuid)الزامی
  • numberintegerالزامی
  • subjectstringالزامی
  • categorystringالزامی

    one of billing, account, function, app, database, cache, storage, other

  • severitystringالزامی

    one of low, normal, high, urgent

  • statusstringالزامی

    open: waiting on support; pending: waiting on you

    one of open, pending, closed

  • resourceobject | null
  • opened_bystring

    the opener's email

  • waiting_onstring | null

    one of support, you

  • messagesinteger

    messages you can see

  • created_atstring (date-time)
  • updated_atstring (date-time)
  • closed_atstring (date-time) | null

خطاها

وضعیتتوضیح
400Bad request: bad_request, bad_json
401unauthorized: missing, invalid, expired or revoked credential
403Not allowed: plan_required
404Not found: not_found
413Body too large: too_large
429Too many requests: rate_limited
500internal: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/support/cases" \
  -H "Authorization: Bearer $KEY" \
  -d '{"subject":"…","category":"billing","body":"…"}'
GET/v1/support/cases/{id}

A case and its messages#

Owners and admins: every case of the team; other roles and API keys: the cases they opened (others answer 404).

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

پارامترها

  • idstring (uuid)مسیرالزامی

    case id

پاسخ

200object

  • caseSupportCaseالزامی
    • idstring (uuid)الزامی
    • numberintegerالزامی
    • subjectstringالزامی
    • categorystringالزامی

      one of billing, account, function, app, database, cache, storage, other

    • severitystringالزامی

      one of low, normal, high, urgent

    • statusstringالزامی

      open: waiting on support; pending: waiting on you

      one of open, pending, closed

    • resourceobject | null
    • opened_bystring

      the opener's email

    • waiting_onstring | null

      one of support, you

    • messagesinteger

      messages you can see

    • created_atstring (date-time)
    • updated_atstring (date-time)
    • closed_atstring (date-time) | null
  • messagesSupportMessage[]الزامی
    • idintegerالزامی
    • fromstringالزامی

      one of customer, staff

    • authorstring | null

      the customer's email; null for support

    • bodystringالزامی
    • attachmentsSupportAttachment[]
    • created_atstring (date-time)الزامی

خطاها

وضعیتتوضیح
401unauthorized: missing, invalid, expired or revoked credential
404Not found: not_found
500internal: an unexpected failure

نمونه

curl "https://api.ibel.ai/v1/support/cases/88e2fe1d-6d75-4de5-8c8f-27380ec66903" \
  -H "Authorization: Bearer $KEY"
POST/v1/support/cases/{id}/messages

Reply (a closed case opens again)#

Owners and admins: every case of the team; other roles and API keys: the cases they opened (others answer 404).

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

پارامترها

  • idstring (uuid)مسیرالزامی

    case id

بدنهٔ درخواستapplication/json

  • bodystringالزامی

    1–20000 characters

  • attachmentsSupportUpload[]

    up to 3

    • namestring

      up to 120 characters

    • typestringالزامی

      one of image/png, image/jpeg, image/gif, image/webp, application/pdf, text/plain, text/csv, application/json

    • datastringالزامی

      base64; 2 MiB at most decoded

پاسخ

201object

  • messageintegerالزامی
  • statusstringالزامی
  • attachmentsSupportAttachment[]

خطاها

وضعیتتوضیح
400Bad request: bad_request, bad_json
401unauthorized: missing, invalid, expired or revoked credential
404Not found: not_found
413Body too large: too_large
500internal: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/support/cases/88e2fe1d-6d75-4de5-8c8f-27380ec66903/messages" \
  -H "Authorization: Bearer $KEY" \
  -d '{"body":"…"}'
POST/v1/support/cases/{id}/close

Close a case#

Owners and admins: every case of the team; other roles and API keys: the cases they opened (others answer 404).

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

پارامترها

  • idstring (uuid)مسیرالزامی

    case id

پاسخ

200object

  • idstring (uuid)الزامی
  • numberintegerالزامی
  • statusstringالزامی

خطاها

وضعیتتوضیح
401unauthorized: missing, invalid, expired or revoked credential
404Not found: not_found
500internal: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/support/cases/88e2fe1d-6d75-4de5-8c8f-27380ec66903/close" \
  -H "Authorization: Bearer $KEY"
POST/v1/support/cases/{id}/reopen

Open a closed case again#

Owners and admins: every case of the team; other roles and API keys: the cases they opened (others answer 404).

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

پارامترها

  • idstring (uuid)مسیرالزامی

    case id

پاسخ

200object

  • idstring (uuid)الزامی
  • numberintegerالزامی
  • statusstringالزامی

خطاها

وضعیتتوضیح
401unauthorized: missing, invalid, expired or revoked credential
404Not found: not_found
500internal: an unexpected failure

نمونه

curl -X POST "https://api.ibel.ai/v1/support/cases/88e2fe1d-6d75-4de5-8c8f-27380ec66903/reopen" \
  -H "Authorization: Bearer $KEY"
GET/v1/support/cases/{id}/attachments/{file}

Download an attachment#

Owners and admins: every case of the team; other roles and API keys: the cases they opened (others answer 404).

دسترسی
کلید API یا نشست داشبورد
نقش‌ها
همهٔ نقش‌ها

پارامترها

  • idstring (uuid)مسیرالزامی

    case id

  • filestringمسیرالزامی

    attachment id

    pattern ^[0-9a-f]{24}$

پاسخ

200string (binary)application/octet-stream

خطاها

وضعیتتوضیح
401unauthorized: missing, invalid, expired or revoked credential
404Not found: not_found
500internal: an unexpected failure

نمونه

درخواست
curl "https://api.ibel.ai/v1/support/cases/88e2fe1d-6d75-4de5-8c8f-27380ec66903/attachments/file" \
  -H "Authorization: Bearer $KEY"