Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > History

Create a ticket (api=startticket)

Scroll Prev Top Next More

Purpose

 

The startticket API is used to get detail for Ticket form fields.

 

UI Reference: The API is called when the ticket form is loaded.

 

URI: webapp-api-History?api=startticket

 

Access Rights Required:  All agents

 

 

Request

 

 

Request Parameters

Name

Type

Description

interactionID

String

This parameter represents the id of interaction.

topicID

String

This parameter represents the id of the topic.

segmentID

String

This parameter represents the id of the segment.

customerID

String

This parameter represents the id of the customer.

pageAction

String

This parameter represents the action name which was performed.

pageName

String

This parameter represents the page name.

 

 

 

Request Payload Example

{
  "interactionID":"45606",
  "topicID":"1",
  "segmentID":"2",
  "customerID":"510",
  "_pageAction":"StartTicket",
  "_pageName":"default"
}

 

 

Response

 

 

Response Parameters

Name

Type

Description

errors

Array

An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error.

errorsDetails

Array

An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered.

quotedBody

String


interactionProperties

Array

This returns all properties and their values if property value set in interaction.

caseProperties

Array

This returns all case properties and their values if property value set in interaction.

caseProperties[].name

String

This represents the name of the property.

caseProperties[].properties

Array

Array of Property details.see property data structure.

caseProperties[].logins

Number

This property has a list of objects with login details including name and type of property value.

caseProperties[].canModifyLogins

Boolean

This property represents rights of modification in logins.

attachments

Array

This has all the attachments which are added in interaction.

addresses

Array

All email addresses of users.

 

Response Example

{
  "errors": [],
  "errorDetails": [],
  "quotedBody": "<div>On 11/19/2021 3:36:41 AM, &quot;Customer Service&quot; &lt;demo-cc@1to1service.com&gt; wrote:<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">Quick Agent Email</blockquote></div>",
  "interactionProperties": [],
  "caseProperties": [
    {
      "name": "e-shop",
      "properties": [
        {
          "propertyID": "129",
          "name": "Date and Time Field",
          "isDate": false,
          "isDatetime": true,
          "isInteger": false,
          "isNumber": false,
          "allowMultiple": false,
          "hasDescriptions": false,
          "isMultiLine": false,
          "isReadOnly": false,
          "isRequired": false,
          "values": [],
          "valueChoices": [],
          "descriptionChoices": []
        }
      ],
      "logins": null,
      "canModifyLogins": false
    }
  ],
  "attachments": [],
  "addresses": [
    "niraj@1to1service.com",
    "nirajraba212@gmail.com"
  ]
}

© 2008 - 2022 One-to-One Service.com, Inc. All rights reserved.