Managing Support Tickets

Overview

The Ticket APIs enable you to create deferred support requests (tickets) for handling non-urgent support needs. This API allows you to integrate Take Control's ticketing capabilities into your existing support workflows and applications.

API Methods

Create Ticket

Creates a new deferred support request when immediate support isn't required.

Key Parameters

  • ids: Numeric identifier for the ticket (Required)
  • customer_name: Name of the customer submitting the ticket (Required)
  • customer_email: Email address of the customer (Required)
  • problem_description: Details of the issue to be addressed (Required, max 4000 characters)

Example Request

POST /rest/ticket
Content-Type: application/json
INTEGRATION-KEY: <YOUR_PUBLIC_KEY>

{
  "ids": 12345,
  "customer_name": "John Doe",
  "customer_email": "[email protected]",
  "problem_description": "Request for software installation"
}

This request creates a new ticket for handling at a later time. It's ideal for non-urgent support requests where immediate technician intervention isn't required. The customer will be notified about the ticket creation and can track its status.

Response

{
  "result": "SUCCESS",
  "details": {
    "ticket_number": 12345
  },
  "errorDetails": {
    "errorCode": null,
    "errorMsg": null
  }
}

Error Handling

Common response codes:

  • 200: Successful operation
  • 400: Invalid request - Missing required fields or invalid format
  • 403: Invalid key
  • 429: Too many requests

Example error response:

{
  "result": "ERROR",
  "details": null,
  "errorDetails": {
    "errorCode": 400,
    "errorMsg": "Missing required field: customer_email"
  }
}

Request Validation

Before submitting a ticket request, ensure:

  • All required fields (ids, customer_name, customer_email, problem_description) are included
  • Problem description doesn't exceed 4000 characters
  • Customer email is in a valid format
  • Customer name doesn't exceed 100 characters