Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Get all details of a interaction

Scroll Prev Top Next More

Purpose

 

The details API is used to get all details of a interaction.

 

UI Reference: The API is called when the ''details'' button is clicked on the my message inbox/manage messages page.

 

URI: webapp-api-mq-myqueue?api=details

 

 

 

Request

 

 

Request Parameters

Name

Type

Description

interactionID

String

This contains multiple interaction ID when mass update performed.

customerID

String

This is the ID of the customer.

segmentID

String

This is the ID of the segment.

_pageAction

String

This parameter represents the action name which is performed from the page.

_pageName

String

This parameter represents the page name.

 

 

Request Payload Example

{
  "interactionID": "45547",
  "customerID": "109",
  "segmentID": "2",
  "_pageAction": "ShowDetails",
  "_pageName": "messagequeue#/my-message-inbox"
}

 

 

 

Response

 

 

Response Parameters

Name

Type

Description

errors

Array

This parameter represents the list of errors.

errorDetails

Array

This parameter represents the list of error details.

details

Object

This object return details of the interaction.

details[].id

String

This is the ID of the interaction.

details[].type

String

This returns the type of interaction.

details[].tags

Array

Tags are used to label interactions for special display. For example, open quote tickets contain a tag to mark for display in the open Quotes pages.

details[].status

String

This is the status of interaction.

details[].threadID

String

This represents the ID of the case root thread interaction.

details[].threadTypes

String

This represent the type of the thread interaction.

details[].caseProperties

Array

This represents a list of case properties.

details[].caseProperties[].name

String

This represents the name of the segment of the properties.

details[].caseProperties[].properties

Array

Property details.

details[].caseProperties[].logins

Number

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

details[].caseProperties[].canModifyLogins

Boolean

This property represents rights of modification in logins.

details[].subject

String

This represents the subject of the email.

details[].subjectBare

String

This represents the subject of the interaction without reference number.

details[].date

String

This returns the date of interaction.

details[].dateResolved

String

This returns the resolve date of interaction.

details[].questionHtml

String

This returns a question which has been mentioned in mail.

details[].attachments

Array

This has all the attachments which are added in interaction.

details[].interactionProperties

Array

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

details[].customerID

String

This returns the id of the customer.

details[].customerName

String

This returns the name of the customer.

details[].statusAudit

Array

This represents the status change log details.

details[].statusAudit[].timeStamp

String

This represents the time stamp of the status modified.

details[].statusAudit[].date

String

This represents the date of the status modified.

details[].statusAudit[].action

String

This is the action name when status modified.

details[].statusAudit[].modifierID

String

This is the user ID by whom interaction modified.

details[].statusAudit[].modifierName

String

This is the user name by whom interaction modified.

details[].statusAudit[].topicID

String

This is the topic ID of the interaction.

details[].statusAudit[].topicName

String

This is the topic name of the interaction.

details[].statusAudit[].assignedToID

Number

This is the user ID to whom interaction was assigned.

details[].statusAudit[].assignedToName

String

This is the user name to whom interaction was assigned.

details[].statusAudit[].statusID

String

This is the ID of the status.

details[].statusAudit[].statusName

String

This is the name of the status.

details[].customerAddresses

Array

This returns all the email addresses of the customer.

details[].customerLogins

Array

This returns all the logins of the customer.

details[].customerLogins[].name

String

This is the name of the login.

details[].customerLogins[].type

String

This is the type of the login.

details[].fromAddress

String

Email address who has initiated the interaction.

details[].composerAddress

String

This is the email address of the agent sending the E-mail.

details[].recc

String


details[].topicID

String

This has the value of topic id in which interaction belongs to.

details[].topicName

String

This has the value of the topic name in which interaction belongs to.

details[].segmentID

String

This has the value of the segment id in which interaction belongs to

details[].segmentName

String

This has the value of the segment name in which interaction belongs to

details[].responseID

String

This is the ID of the response.

details[].subRef

String

This is the subject reference value with interaction id.

details[].responseSubject

String

This is the subject of the response.

details[].responseHtml

String

This is the html body of the response.

details[].note

String

This is the private comment of the response.

details[].responseProperties

Array

This represents properties of the interaction.

details[].responseAttachments

Array

This represents attachments attached to the interaction.

details[].assignedToID

String

This is the id of the agent if the message is assigned to any agent.

details[].assignedToName

String

This is the full name of the agent if the message is assigned to any agent.

details[].resolvedByName

String

This is the name of the agent if the message is resolved by any agent.

details[].toAddress

String

This is the customer email address.

details[].headerFrom

String

This is the email address of the customer who sent this message.

details[].headerTo

String

This is the email address of the person to whom the E-mail is being sent to.

details[].cc

String

This is the email address of cc if added in the message.

details[].bcc

String

This is the email address of bcc if added in the message.

details[].bodyPlain

String

This is body content of message without html format

details[].defaultMailBoxID

String

This is the default mailbox ID of the segment associated with the interaction.

children

Array

This array represents the children interaction of the thread.

children[].id

String

This is the ID of the interaction.

children[].subject

String

This is the subject of the interaction.

children[].type

String

This is the type of the interaction.

children[].tags

Array

Tags are used to label interactions for special display. For example, open quote tickets contain a tag to mark for display in the open Quotes pages.

children[].properties

Array

These values are explained in Properties that may be edited chapter.

children[].date

String

This is the date of the interaction when created.

history

Array

This represents history of the interaction.

history[].id

String

This is the ID of the interaction.

history[].subject

String

This is the subject of the interaction.

history[].type

String

This is the type of the interaction

history[].tags

Array

Tags are used to label interactions for special display. For example, open quote tickets contain a tag to mark for display in the open Quotes pages.

history[].properties

Array

These values are explained in Properties that may be edited chapter.

history[].date

String

This is the date if the interaction when created.

history[].children

Array


question

Object

This returns a question's row and details data.

question[].row

Object

This has all details of the row.

question[].row[].id

String

This is Interaction id.

question[].row[].topicID

String

This has the value of topic id in which interaction belongs to.

question[].row[].topicName

String

This has the value of the topic name in which interaction belongs to.

question[].row[].agentName

String

This is the agent name by whom this question was created.

question[].row[].assignedToID

String

This has an id of an agent who has been assigned to this interaction.

question[].row[].status

String

This is the status of interaction.

question[].details

Object

This shows the details related to a question.

question[].details[].id

String

This is the ID of the interaction.

question[].details[].status

String

This is the status of the interaction.

question[].details[].tags

Array

Tags are used to label interactions for special display. For example, open quote tickets contain a tag to mark for display in the open Quotes pages.

question[].details[].interactionProperties

Array

This represents interaction properties of the interaction.

question[].details[].caseProperties

Array

This represents case properties of the interaction.

question[].details[].caseProperties[].name

String

This represents name of the segment of the properties.

question[].details[].caseProperties[].properties

Array

These values are explained in Properties that may be edited chapter.

question[].details[].caseProperties[].logins

Number

This represents customer logins.

question[].details[].caseProperties[].canModifyLogins

Boolean

This represents whether user can modify their logins or not.

question[].details[].bodyHtml

String

This represents HTML body of the interaction.

question[].details[].statusAudit

Array

This is the status change log of the interaction.

question[].details[].segmentID

String

This is the segment ID of the interaction.

question[].details[].segmentName

String

This is the segment name of the interaction.

question[].details[].topicID

String

This represents topic ID of the interaction.

question[].details[].topicName

String

This represents topic name of the interaction.

question[].details[].assignedToID

String

This is the user ID to whom interaction was assigned.

question[].details[].operatorName

String

This is the user name to whom interaction was assigned.

question[].details[].date

String

This is the date of the interaction when created.

question[].details[].customerID

String

This is the ID of the customer.

question[].details[].customerName

String

This is the name of the customer.

mailboxes

Array

This returns mailboxes list associated with the interaction.

mailboxes[].id

String

This is the ID of the mailbox.

mailboxes[].name

String

This is the name of the mailbox.

mailboxes[].replyTo

String

This is the email address of the mailbox.

addresses

Array

This describes the contact to whom the E-mail is being sent.

responsesSegment

Array

This describes the segment in which the response is being sent. i.e where the interaction belongs

responsesSegment[].id

String

This shows the id of the response in a segment.

responsesSegment[].name

String

This shows the name of the response in a segment.

responsesSegment[].description

String

This shows the description of the response in a segment.

responsesSegment[].bodyHtml

String

This shows the bodyhtml of the response in a segment.

responsesAgent

Array

This describes the agents that have responded to interactions.

 

 

Response Example

{
  "errors": [],
  "errorDetails": [],
  "details": {
    "id": "45547",
    "type": "Ask A Question",
    "tags": [],
    "status": "Queued",
    "threadID": "45547",
    "threadType": "Ask A Question",
    "caseProperties": [
      {
        "name": "e-shop",
        "properties": [
          {
            "propertyID": "11",
            "name": "Account Number",
            "isDate": false,
            "isDatetime": false,
            "isInteger": false,
            "isNumber": false,
            "allowMultiple": false,
            "hasDescriptions": false,
            "isMultiLine": false,
            "isReadOnly": false,
            "isRequired": false,
            "values": [
              {
                "description": null,
                "value": "Platinum",
                "valueDateUtc": null,
                "valueDatetimeUtc": null,
                "valueInt": null,
                "valueNumber": null
              }
            ],
            "valueChoices": [],
            "descriptionChoices": []
          }
        ],
        "logins": null,
        "canModifyLogins": false
      }
    ],
    "subject": "My package arrived damaged, what should I do?",
    "subjectBare": "My package arrived damaged, what should I do?",
    "date": "2021-10-28T20:31:21.8330000Z",
    "dateResolved": "0001-01-01T06:00:00.0000000Z",
    "questionHtml": "Two weeks ago I bought an iPhone 12 PRO  from your online store. However, upon receipt, I noticed the screen had a crack. Will I get a replacement or what happens?",
    "attachments": [],
    "interactionProperties": [],
    "customerID": "109",
    "customerName": "Ralph Fixers",
    "statusAudit": [
      {
        "timeStamp": "/Date(1635453081833)/",
        "date": "2021-10-28T20:31:21.8330000Z",
        "action": "Anonymous -> Form Submit (118) -> Ticket/AAQ -> Ask A Question -> Create Composition",
        "modifierID": "109",
        "modifierName": "Ralph Fixers",
        "topicID": "7",
        "topicName": "e-shop -- All Topics -- Technical Support",
        "assignedToID": null,
        "assignedToName": null,
        "statusID": "1",
        "statusName": "Unassigned"
      }
    ],
    "customerAddresses": [
      "customer7@1to1service.com"
    ],
    "customerLogins": [
      {
        "name": "customer7@1to1service.com",
        "type": "Email"
      }
    ],
    "fromAddress": "customer7@1to1service.com",
    "composerAddress": "customer7@1to1service.com",
    "reCC": "",
    "topicID": "38",
    "topicName": "Cell Phones",
    "segmentID": "2",
    "segmentName": "e-shop",
    "responseID": "45598",
    "subjectRef": "Re: [ref#: 45547-45598]",
    "responseSubject": "My package arrived damaged, what should I do?",
    "responseHtml": "$stock -id'44'$<br />\r\n<br />\r\n{enter your response here}<br />\r\n<br />\r\n$stock -id'17'$\r\n<div>On 10/28/2021 3:31:21 PM, Ralph Fixers &lt;customer7@1to1service.com&gt; wrote:\r\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">Two weeks ago I bought an iPhone 12 PRO&nbsp; from your online store. However, upon receipt, I noticed the screen had a crack. Will I get a replacement or what happens?</blockquote>\r\n</div>\r\n",
    "note": "",
    "responseProperties": [],
    "responseAttachments": [],
    "assignedToID": "452",
    "assignedToName": "bhavin.patel@iservice.info",
    "resolvedByName": "",
    "toAddress": "",
    "headerFrom": "customer7@1to1service.com",
    "headerTo": "",
    "cc": "",
    "bcc": "",
    "bodyPlain": "Two weeks ago I bought an iPhone 12 PRO  from your online store. However, upon receipt, I noticed the screen had a crack. Will I get a replacement or what happens?\r\n",
    "defaultMailboxID": "1"
  },
  "children": [
    {
      "id": "45548",
      "subject": "Transfer[ref#: 45547-45547] My package arrived damaged, what should I do?",
      "type": "Auto Response",
      "tags": [],
      "properties": [],
      "date": "2021-10-28T20:31:21.9030000Z"
    }
  ],
  "history": [
    {
      "id": "45547",
      "subject": "[ref#: 45547-45547] My package arrived damaged, what should I do?",
      "type": "Ask A Question",
      "tags": [],
      "properties": [],
      "date": "2021-10-28T20:31:21.8330000Z",
      "children": [
        {
          "id": "45548",
          "subject": "Transfer[ref#: 45547-45547] My package arrived damaged, what should I do?",
          "type": "Auto Response",
          "tags": [],
          "properties": [],
          "date": "2021-10-28T20:31:21.9030000Z"
        }
      ]
    }
  ],
  "question": {
    "row": {
      "id": "45547",
      "topicID": "38",
      "topicName": "Cell Phones",
      "agentName": "bhavin.patel@iservice.info",
      "assignedToID": "452",
      "status": "Queued"
    },
    "details": {
      "id": "45547",
      "status": "Queued",
      "tags": [],
      "interactionProperties": [],
      "caseProperties": [
        {
          "name": "e-shop",
          "properties": [
            {
              "propertyID": "11",
              "name": "Account Number",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [
                {
                  "description": null,
                  "value": "Platinum",
                  "valueDateUtc": null,
                  "valueDatetimeUtc": null,
                  "valueInt": null,
                  "valueNumber": null
                }
              ],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "bodyHtml": "Two weeks ago I bought an iPhone 12 PRO&nbsp; from your online store. However, upon receipt, I noticed the screen had a crack. Will I get a replacement or what happens?",
      "statusAudit": [
        {
          "timeStamp": "/Date(1635453081833)/",
          "date": "2021-10-28T20:31:21.8330000Z",
          "action": "Anonymous -> Form Submit (118) -> Ticket/AAQ -> Ask A Question -> Create Composition",
          "modifierID": "109",
          "modifierName": "Ralph Fixers",
          "topicID": "7",
          "topicName": "e-shop -- All Topics -- Technical Support",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "1",
          "statusName": "Unassigned"
        }
      ],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "38",
      "topicName": "Cell Phones",
      "assignedToID": "452",
      "operatorName": "bhavin.patel@iservice.info",
      "date": "2021-10-28T20:31:21.8330000Z",
      "customerID": "109",
      "customerName": "Ralph Fixers"
    }
  },
  "mailboxes": [
    {
      "id": "1",
      "name": "Customer Service",
      "replyTo": "demo-cc@1to1service.com"
    }
  ],
  "addresses": [
    "customer7@1to1service.com"
  ],
  "responsesSegment": [
    {
      "id": "123",
      "name": "xHello",
      "description": "Chat",
      "bodyHtml": "<span style=\"font-size: 13.3333px;\">Hello! Thanks for contacting eShop.</span>"
    }
  "responsesAgent": []

}

 

 

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