_pageAction

String

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

{
  "_pageAction": "LoadInbox"
}

inbox

Array

This returns a list of objects with all message details.

inbox[].id

String

This returns the id of interaction.

inbox[].threadID

String

The id of the case that the interaction is in. If its the same as id, then its the root interaction.

inbox[].customerID

String

This returns the id of the customer.

inbox[].customerName

String

This returns the name of the customer.

inbox[].fromAddress

String

Email address who has initiated the interaction.

inbox[].date

String

This returns the date of interaction.

inbox[].subject

String

This returns the subject of interaction.

inbox[].subjectBare

String

The subject without the reference number prepended.

inbox[].type

String

This is a type of interaction like Agent Email or Note or Ticket.

inbox[].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.

inbox[].status

String

This is the status value of interaction according to interaction type.

inbox[].topicID

String

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

inbox[].topicName

String

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

inbox[].agentName

String

This has an email address who has initiated the interaction.

inbox[].assignedToID

String

it represents the ID of user to which assigned.

inbox[].segmentID

String

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

inbox[].segmentName

String

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

inbox[].properties

String

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

inbox[].properties[].propertyID

String

This returns all property id if property value set in interaction.

inbox[].properties[].values

Array

This returns all property values if property value set in interaction.

numCanGet

Integer

It returns the total count/number of get next button.

numCanApprove

Integer

It returns the total count/number of get next QA button.

{
  "inbox": [
    {
      "id": "45529",
      "threadID": "45529",
      "customerID": "4",
      "customerName": "John Doe",
      "fromAddress": "customer1@1to1service.com",
      "date": "2021-10-28T20:31:18.4130000Z",
      "subject": "[ref#: 45529-45529] Can I track my package?",
      "subjectBare": "Can I track my package?",
      "type": "Ask A Question",
      "tags": [],
      "status": "Queued",
      "topicID": "6",
      "topicName": "Shipping",
      "agentName": "Niraj Raba",
      "assignedToID": "510",
      "segmentID": "2",
      "segmentName": "e-shop",
      "properties": [
        {
          "propertyID": "11",
          "values": [
            {
              "description": null,
              "value": "Platinum",
              "valueDate": null,
              "valueDatetime": null,
              "valueInt": null,
              "valueNumber": null
            }
          ]
        }
      ]
    }
  ],
  "numCanGet": 1,
  "numCanApprove": 0
}