Create Callback

/api/incidentissue/createcallback

The createcallback interface is intended to be used to generate an full incident issue linked to a subscriber ticket object. After creating the ticket a task is executed to add the callback to the asterisk scheduled callbacks queue.

Query Parameters (HTTP POST)

These params are required to create a callback

subscriber_id

issuetracker subscriber ID, obtained from the /api/subscriber/search interface

notes

callback notes, instructions for the tech

callback_number| 10 digit phone number: 8014316543

staff_id

id of user that will create the callback

queue

One of our available queues: broadband, mdu directv, lan, or spanish.

issue_id

Unique Issue ID, can be obtained from the /api/issue interface

api_key

Key (password) sent with every request to help identify the system sending the query. This is can be given to serverplus, or generated by serverplus. Combined with HTTPS and Access Control lists, a query page can be secured so unauthorized users cannot retrieve information.

Response JSON

Responses are JSON encoded and are an object with the following properties:

Element Name

Description

error_fields

If there was an error while creating the callback

data

data related to the created callback

status_message

status message

Success Response Object:

Element Name

|Description

incident_issue_id

ID of the newly created note, append N to the begging to search for the note in issuetracker

status

16 | this is an internal status it cannot be changed

company_id

company ID of subscriber

queue

the queue that was passed in the POST request

staff_id

staff ID that was passed in the POST request

subscriber_id

subscriber_id that was passed in the POST request

notes

notes that were passed in the POST request

subscriber_ticket_id

ID of the genererated T#### Ticket in issuetracker

callback_number

callback_number passed in the POST request

issue_id

issue_id passed in the POST request

ticket_subject

this will always be “API Created Callback”

incident_id

ID of the generated Incident

timezone

this will be auto obtained based on the api_key used

priority

this will always be 0, scheduled callbacks are always lowest priority

Example Response JSON

An example response for successful callback

https://tracker.serverplus.com/api/incidentissue/createcallback?subscriber_id=203320&notes=sometestnotes&callback_number=3458768988&staff_id=1&queue=lan&issue_id=4

JSON Response Body:

{
  "status": "ok",
  "data": {
      "status": 16,
      "queue": "lan",
      "staff_id": 1,
      "subscriber_id": 203320,
      "notes": "sometestnotes",
      "incident_issue_id": 8362475,
      "company_id": 3,
      "subscriber_ticket_id": 4265761,
      "callback_number": 3458768988,
      "issue_id": 4,
      "ticket_subject": "API Created Callback",
      "incident_id": 8334118,
      "timezone": "MDT",
      "priority": 0
  },
  "error_fields": {},
  "status_message": "success"
}