interactionID

String

This parameter represents the id of interaction.

customerID

String

This parameter represents the id of the customer.

segmentID

String

This parameter represents the id of the segment.

_pageAction

String

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

{
  "interactionID": "45529",
  "customerID": "4",
  "segmentID": "2",
  "_pageAction": "ShowDetails"
}

errors

Array

This will return error information if any otherwise return blank array.

errorDetails

Array

This will explain the reason behind the error returned if any, otherwise return blank array.

details

Object

This return object with all the mail and interaction details.

details[].id

String

This returns the id of interaction.

details[].type

String

This is a 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 value of interaction according to interaction type.

details[].threadID

String

This represents the root case ID.

details[].threadType

String

This represents the root case Interaction type.

details[].caseProperties

Array

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

details[].subject

String

This returns the subject of interaction.

details[].subjectBare

String

This returns the subject 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 contains the status history of an interaction.

details[].statusAudit[].timeStamp

String

Represents Time stamp of status when modified or changed.

details[].statusAudit[].date

String

Represents Date of status when modified or changed.

details[].statusAudit[].action

String

Represents the action when status modified or changed.

details[].statusAudit[].modifierID

String

Represents the user ID who modify or changed the status.

details[].statusAudit[].modifeirName

String

Represents the user name who modify or changed the status.

details[].statusAudit[].topicID

String

Represents the topic ID when status id modified or changed.

details[].statusAudit[].topicName

String

Represents the topic name.

details[].statusAudit[].assignedToID

Number

It represents the ID of user to which assigned.

details[].statusAudit[].assignedToName

Number

It represents the name of user to which assigned.

details[].statusAudit[].statusID

String

It represents the status ID of interaction.

details[].statusAudit[].statusName

String

It represents the status name.

details[].customerAddresses

Array

This returns all the email addresses of the customer.

details[].customerLogins

Array

This returns all the logins of the customer.

details[].fromAddress

String

Email address who has initiated the interaction.

details[].composerAddress

String

It represents the User email address.

details[].reCC

String

It represents the response CC address.

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

It represents the response ID.

details[].subjectRef

String

This is the subject reference value with interaction id.

details[].responseSubject

String

It represents the response subject.

details[].responseHtml

String

It represents the response body.

details[].note

String

It represents the private comment of response

details[].responseProperties

Array

It represents the interaction properties of response.

details[].responseAttachments

Array

It represents the attachments of response.

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 represents the to customer email address to which response sent.

details[].headerFrom

String

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

details[].headerTo

String

This is the email address of customer to whom this message sent.

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 represents the default mailbox ID of segment.

children

Array

This returns a list of all interactions that reference this interaction as the parent.

children[].id

String

This returns the id of a child interaction.

children[].subject

String

This is a subject of child message.

children[].type

String

This is a type of child message.

children[].tags

Array

These are tags associated with child interactions.

children[].properties

Array

This returns all properties and their values if any property values are set in the child interactions.

children[].date

String

Date of the child interaction.

history

Array

Details about the interaction assigned that are typically shown in history. These values area the same as details[ ].

history[].id

String

This returns the id of the interaction.

history[].subject

String

This is the subject of the interaction.

history[].type

String

This is a type of message.

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

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

history[].date

String

Date of the interaction.

history[].children

Array

This returns a list of all child interaction IDs.

question

Object

Object with question details which are assigned to the agent.

question[].row

Object

Object of row with details.

question[].row[].id

String

Id of question message.

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

Agent name who was assigned to the message.

question[].row[].assignedToID

String

Agent id who was assigned to the message.

question[].row[].status

String

Status of Question message.

question[].details

Object

All details about the question.

question[].details[].status

String

Status of Question message.

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 returns all properties and their values if any property value set in interaction.

question[].details[].caseProperties

Array

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

question[].details[].bodyHtml

String

This is the body content of the message with html format.

question[].details[].statusAudit

Array

This all audit details of status changes.

question[].details[].segmentID

String

This has the value of the segment id in which the question belongs to.

question[].details[].segmentName

String

This has the value of the segment name in which the question belongs to.

question[].details[].topicID

String

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

question[].details[].topicName

String

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

question[].details[].assignedToID

String

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

question[].details[].operatorName

String

This represents the agent name.

question[].details[].date

String

The date of question sent.

question[].details[].customerID

String

This returns the id of the customer who sent this question.

question[].details[].customerName

String

This returns the name of the customer who sent this question.

mailboxes

Array

An array of strings that define the mailbox that will be used in the response.

mailboxes[].id

String

This is the ID of the mailbox that will be used to provide a response.

mailboxes[].name

String

This represents the name of the mailbox.

mailboxes[].replyTo

String

Email address of mailbox used for response.

addresses

Array

An array of strings that lists the email addresses associated with the contact that submitted the question.

responseSegment

Array

Returns the segment list associated with response.

responseSegment[].id

String

This is an id of the segment.

responseSegment[].name

String

This is the name of the segment.

responseSegment[].description

String

This is the description of the segment.

responseSegment[].bodyHtml

String

This is the body of the segment

responsesAgent

Array

This is the list of agents of response.

{
  "errors": [],
  "errorDetails": [],
  "details": {
    "id": "45529",
    "type": "Ask A Question",
    "tags": [],
    "status": "Queued",
    "threadID": "45529",
    "threadType": "Ask A Question",
    "caseProperties": [],
    "subject": "Can I track my package?",
    "subjectBare": "Can I track my package?",
    "date": "2021-10-28T20:31:18.4130000Z",
    "dateResolved": "0001-01-01T06:00:00.0000000Z",
    "questionHtml": "I just bought a camera and got an email notification that the order has been placed successfully. How do I track my package since the shipping duration is 2 weeks? ",
    "attachments": [],
    "interactionProperties": [],
    "customerID": "4",
    "customerName": "John Doe",
    "statusAudit": [
      {
        "timeStamp": "/Date(1635453078413)/",
        "date": "2021-10-28T20:31:18.4130000Z",
        "action": "Anonymous -> Form Submit (118) -> Ticket/AAQ -> Ask A Question -> Create Composition",
        "modifierID": "4",
        "modifierName": "John Doe",
        "topicID": "89",
        "topicName": "e-shop -- All Topics -- Account Questions -- Orders",
        "assignedToID": null,
        "assignedToName": null,
        "statusID": "1",
        "statusName": "Unassigned"
      }
    ],
    "customerAddresses": [
      "customer1@1to1service.com"
    ],
    "customerLogins": [
      {
        "name": "customer1@1to1service.com",
        "type": "Email"
      }
    ],
    "fromAddress": "customer1@1to1service.com",
    "composerAddress": "customer1@1to1service.com",
    "reCC": "",
    "topicID": "6",
    "topicName": "Shipping",
    "segmentID": "2",
    "segmentName": "e-shop",
    "responseID": "45586",
    "subjectRef": "Re: [ref#: 45529-45586]",
    "responseSubject": "Can I track my package?",
    "responseHtml": "<br />\r\n<br />\r\n&nbsp;\r\n<div>On 10/28/2021 3:31:18 PM, John Doe &lt;customer1@1to1service.com&gt; wrote:\r\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">I just bought a camera and got an email notification that the order has been placed successfully. How do I track my package since the shipping duration is 2 weeks?&nbsp;</blockquote>\r\n</div>\r\n",
    "note": "",
    "responseProperties": [],
    "responseAttachments": [],
    "assignedToID": "510",
    "assignedToName": "Niraj Raba",
    "resolvedByName": "",
    "toAddress": "",
    "headerFrom": "customer1@1to1service.com",
    "headerTo": "",
    "cc": "",
    "bcc": "",
    "bodyPlain": "I just bought a camera and got an email notification that the order has been placed successfully. How do I track my package since the shipping duration is 2 weeks? \r\n",
    "defaultMailboxID": "1"
  },
  "children": [
    {
      "id": "45530",
      "subject": "Shipping Acknowledgment:[ref#: 45529-45529] Can I track my package?",
      "type": "Auto Response",
      "tags": [],
      "properties": [],
      "date": "2021-10-28T20:31:18.5130000Z"
    }
  ],
  "history": [
    {
      "id": "45529",
      "subject": "[ref#: 45529-45529] Can I track my package?",
      "type": "Ask A Question",
      "tags": [],
      "properties": [],
      "date": "2021-10-28T20:31:18.4130000Z",
      "children": []
    }
  ],
  "question": {
    "row": {
      "id": "45529",
      "topicID": "6",
      "topicName": "Shipping",
      "agentName": "Niraj Raba",
      "assignedToID": "510",
      "status": "Queued"
    },
    "details": {
      "status": "Queued",
      "tags": [],
      "interactionProperties": [],
      "caseProperties": [],
      "bodyHtml": "I just bought a camera and got an email notification that the order has been placed successfully. How do I track my package since the shipping duration is 2 weeks?&nbsp;",
      "statusAudit": [],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "6",
      "topicName": "Shipping",
      "assignedToID": "510",
      "operatorName": "Niraj Raba",
      "date": "2021-10-28T20:31:18.4130000Z",
      "customerID": "4",
      "customerName": "John Doe"
    }
  },
  "mailboxes": [
    {
      "id": "1",
      "name": "Customer Service",
      "replyTo": "demo-cc@1to1service.com"
    }
  ],
  "addresses": [
    "customer1@1to1service.com"
  ],
  "responsesSegment": [
    {
      "id": "99",
      "name": "__Template",
      "description": "",
      "bodyHtml": "$stock -id'44'$ <br />\r\n<br />\r\n{enter your response here}<br />\r\n<br />\r\n$stock -id'17'$"
    }
  ],
  "responsesAgent": []
}