alawadi.cloudمستندات
مرجع الـ API

واجهة الدعم

افتح تذاكر الدعم واقرأها وردّ عليها وأغلقها وأعد فتحها.

تذاكر الدعم محصورة بحسابك. تُرجِع القائمة التذاكر التي فتحتها أنت فقط، ولا يمكنك قراءة تذكرة أو التصرّف بها إلا إذا كانت تخصّك. هذه العمليات مُولَّدة من مواصفة OpenAPI المنسَّقة.

عند فتح تذكرة تُحدِّد موضوعاً ورسالةً أولى، ويمكنك وسمها بفئة (billing أو technical أو account أو abuse أو general أو feature request) وبأولوية (low أو normal أو high أو urgent). يردّ فريقنا ضمن المحادثة نفسها، ويمكنك إغلاق التذكرة أو إعادة فتحها في أي وقت.

تحديثات الدعم تظهر داخل التطبيق فقط. تظهر الردود وتغيّرات الحالة في البوابة ضمن محادثة التذكرة، فتابِع نشاطها هناك. لا نرسل لك بريداً إلكترونياً عن تحديثات التذاكر. (إشعارات البريد مخصّصة لسياسات التنبيه فقط، وإلى عنوان مُؤكَّد حصراً.)

GET
/v1/support/tickets

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer JWT obtained after Google sign-in in the portal.

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/support/tickets"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "subject": "string",
    "status": "open",
    "created_at": "2019-08-24T14:15:22Z",
    "messages": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "author": "customer",
        "body": "string",
        "created_at": "2019-08-24T14:15:22Z"
      }
    ]
  }
]
POST
/v1/support/tickets

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer JWT obtained after Google sign-in in the portal.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/support/tickets" \  -H "Content-Type: application/json" \  -d '{    "subject": "string",    "body": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subject": "string",
  "status": "open",
  "created_at": "2019-08-24T14:15:22Z",
  "messages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "author": "customer",
      "body": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
GET
/v1/support/tickets/{ticketId}

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer JWT obtained after Google sign-in in the portal.

In: header

Path Parameters

ticketId*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subject": "string",
  "status": "open",
  "created_at": "2019-08-24T14:15:22Z",
  "messages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "author": "customer",
      "body": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "error": "validation failed",
  "request_id": "01J9Z3K8QWERTYUIOP"
}
POST
/v1/support/tickets/{ticketId}/messages

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer JWT obtained after Google sign-in in the portal.

In: header

Path Parameters

ticketId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages" \  -H "Content-Type: application/json" \  -d '{    "body": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "author": "customer",
  "body": "string",
  "created_at": "2019-08-24T14:15:22Z"
}
POST
/v1/support/tickets/{ticketId}/close

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer JWT obtained after Google sign-in in the portal.

In: header

Path Parameters

ticketId*string

Response Body

application/json

curl -X POST "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08/close"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subject": "string",
  "status": "open",
  "created_at": "2019-08-24T14:15:22Z",
  "messages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "author": "customer",
      "body": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}
POST
/v1/support/tickets/{ticketId}/reopen

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer JWT obtained after Google sign-in in the portal.

In: header

Path Parameters

ticketId*string

Response Body

application/json

curl -X POST "https://example.com/v1/support/tickets/497f6eca-6276-4993-bfeb-53cbbbba6f08/reopen"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subject": "string",
  "status": "open",
  "created_at": "2019-08-24T14:15:22Z",
  "messages": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "author": "customer",
      "body": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}