Create and manage support tickets.

List Tickets

GET /support/tickets

Get list of your support tickets.

Query Parameters

ParameterTypeDescription
pagenumberPage number
pageSizenumberItems per page (max 100)
statusstringFilter: open, in_progress, closed

Example

curl -G "https://www.HomaCRM.com/api/v1/external/support/tickets" \
  -H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Accept: application/json" \
  --data-urlencode "page=1" \
  --data-urlencode "pageSize=15" \
  --data-urlencode "status=open"

Create Ticket

POST /support/tickets

Create a new support ticket.

Request Body

FieldTypeRequiredDescription
titlestringYesTicket title (max 200)
descriptionstringYesDetailed description
prioritynumberNoInteger 1–4 only (1=normal, 2=important, 3=urgent, 4=critical); other values are rejected

Example

curl -X POST "https://www.HomaCRM.com/api/v1/external/support/tickets" \
  -H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "خطا در وب‌هوک ارسال پیامک",
    "description": "هر شب ساعت ۲۳:۱۰ درخواست POST به آدرس https://api.customer.example/hooks/sms با کد ۵۲۴ برمی‌گردد. شناسه درخواست نمونه: req_7f3a9c. لطفاً لاگ سمت سرور را بررسی کنید.",
    "priority": 3
  }'

Get Ticket

GET /support/tickets/{id}

Get ticket details including comments.

Example

curl -X GET "https://www.HomaCRM.com/api/v1/external/support/tickets/12840" \
  -H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Accept: application/json"

Reply to Ticket

POST /support/tickets/{id}/reply

Add a reply to an existing ticket.

Request Body

FieldTypeRequiredDescription
contentstringYesReply content (max 5000)

Example

curl -X POST "https://www.HomaCRM.com/api/v1/external/support/tickets/12840/reply" \
  -H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "با سلام، فایروال سرور ما فقط IP های 185.143.x.x را مجاز کرده بود؛ رنج جدید شما را اضافه کردیم. لطفاً دوباره تست کنید و در صورت تکرار خطا، زمان دقیق (با timezone) را ارسال کنید."
  }'

Ticket Actions (Follow-up / Request a Call)

POST /support/tickets/{id}/actions

Record an action on a ticket: request a follow-up (optionally urgent — raises the ticket priority) or request a phone callback. Closed tickets do not accept actions.

Request Body — followup

FieldTypeRequiredDescription
actionstringYes"followup"
notestringNoOptional note (max 2000)
urgentbooleanNoWhen true, the ticket priority is raised

Request Body — request_call

FieldTypeRequiredDescription
actionstringYes"request_call"
phonestringYesIranian mobile in 09xxxxxxxxx format
preferredTimestringNoPreferred time window (free text)
notestringNoOptional note (max 2000)

Example

curl -X POST "https://www.HomaCRM.com/api/v1/external/support/tickets/12840/actions" \
  -H "Authorization: a1B2c3D4e5F6g7H8-i9J0k1L2m3N4o5P6-q7R8s9T0u1V2w3X4" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "followup",
    "note": "این مشکل جلوی راه‌اندازی ما را گرفته، لطفاً در اولویت بررسی شود.",
    "urgent": true
  }'

HomaCRM External API

For support, create a ticket via /support/tickets endpoint.