Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Send response to question (api=send)

Scroll Prev Top Next More

Purpose

 

The send API is used to display mailbox lists in the Forward Action menu.

 

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

 

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

 

 

 

Request

 

 

Request Parameters

Name

Type

Description

interactionIDs

Array

This parameter represents the Id of interaction.

answer

Object

Object with all the response mail details.

answer[].inResponseToID

String

This response is going to be sent on this Interaction id.

answer[].subject

String

This parameter has the subject of response.

answer[].segmentID

String

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

answer[].topicID

String

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

answer[].addSubjectRefNum

Boolean

Represent that add reference number in subject or not.

answer[].forwardSegmentID

String

This represents the segment ID to which this interaction was forwarded.

answer[].contactID

String

This is the ID of the customer.

answer[].isMassUpdate

Boolean

This represents whether this interaction can be used for mass update or not.

answer[].caseProperties

Number

This parameter has all case properties and their values if case property values are set in interaction.

answer[].interactionProperties

Number

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

answer[].responseProperties

Number

This parameter has all properties and their values if property value is set in response.

answer[].leaveOpen

Number

This represents whether to leave open the interaction or remove from the list after success.

answer[].expectReply

Number

Expecting reply on this mail or not

answer[].supressSubjectRef

Number

This represents whether to suppress the reference number from subject or not.

answer[].notificationID

Number

This is the notification or auto response ID associated with the interaction.

answer[].bodyHtml

String

Body contents of response with html format.

answer[].removedInlineAttachments

Array

This represents removed inline attachments of the interaction.

answer[].mailboxID

String

This represents  mailbox ID of the interaction.

answer[].note

String

This represents private comments the of the interaction.

answer[].attachments

Array

This represents attachments attached with the interaction.

answer[].destEmail

String

Email address of destination.

answer[].finalHtml

Number

This represents final HTML body of the interaction.

answer[].finalPlain

Number

This represents  final plain body of the interaction.

answer[].defaultMailboxID

String

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

answer[].isPublic

Boolean

This describes if the answer to an interaction is public or not.

answer[].threadProperties

Array

This parameter has all thread properties and their values if thread property values are set in interaction.

answer[].threadProperties[].propertyID

String

This parameter has all property id if property value is set in interaction.

answer[].threadProperties[].propertyName

String

This parameter has all property names if property value is set in interaction.

answer[].threadProperties[].propertyName[].values

Array

This parameter has all property values if property value is set in interaction.

answer[].threadProperties[].propertyName[].value

String

This describes the value of a given property set in an interaction.

interactionID

String

This parameter represents interaction id.

public

Boolean


_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

{
  "interactionIDs": [
    "45529"
  ],
  "answer": {
    "inResponseToID": "45529",
    "subject": "Can I track my package?",
    "segmentID": "2",
    "topicID": "6",
    "addSubjectRefNum": true,
    "forwardSegmentID": "",
    "contactID": "4",
    "isMassUpdate": false,
    "caseProperties": null,
    "interactionProperties": null,
    "responseProperties": null,
    "leaveOpen": null,
    "expectReply": true,
    "supressSubjectRef": null,
    "notificationID": "",
    "bodyHtml": "<br />\nTesting reply<br />\n&nbsp;\n<div>On 10/28/2021 3:31:18 PM, John Doe &lt;customer1@1to1service.com&gt; wrote:\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>\n</div>\n",
    "removedInlineAttachments": [],
    "mailboxID": "1",
    "note": "",
    "attachments": [],
    "destEmail": "customer1@1to1service.com",
    "finalHtml": null,
    "finalPlain": null,
    "defaultMailboxID": "1",
    "threadProperties": [
      {
        "propertyID": "11",
        "propertyName": "Account Number",
        "values": [
          {
            "value": "Platinum"
          }
        ]
      },
      {
        "propertyID": "35",
        "propertyName": "Item #",
        "values": [
          {
            "value": "123"
          }
        ]
      },
      {
        "propertyID": "121",
        "propertyName": "Shipping Method",
        "values": []
      }
    ]
  },
  "_pageAction": "Send",
  "_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.

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.

thread

Object

Object with row and their details.

thread[].row

Object

Object with all the details of the row selected.

thread[].row[].id

String

This is Interaction id.

thread[].row[].date

String

This returns the date of interaction.

thread[].row[].subject

String

This returns the subject of interaction.

thread[].row[].type

String

This returns the type of interaction.

thread[].row[].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.

thread[].row[].assignedToID

String

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

thread[].row[].status

String

This is the status of interaction.

thread[].row[].topicID

String

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

thread[].row[].topicName

String

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

thread[].row[].segmentID

String

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

thread[].row[].properties

Array

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

thread[].details

Object

This describes the properties related to an interaction.

thread[].details[].interactionProperties

Array

This represents the interaction properties of the interaction.

thread[].details[].caseProperties

Array

This represents the case properties of the interaction.

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

String

This returns the date of interaction.

question[].row[].subject

String

This returns the subject of interaction.

question[].row[].type

String

This returns the type of interaction.

question[].row[].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[].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[].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[].segmentID

String

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

question[].row[].properties

Array

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

question[].details

Object

This object represents the details of the question.

question[].details[].status

string

This is the status question.

question[].details[].interactionProperties

Array

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

question[].details[].caseProperties

Array

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

question[].details[].statusAudit

Array

List of status changes log.

question[].details[].statusAudit[].timeStamp

String

This represents the time stamp of the status modified.

question[].details[].statusAudit[].date

String

This represents the date of the status modified.

question[].details[].statusAudit[].action

String

This is the action name when status modified.

question[].details[].statusAudit[].modifierID

String

This is the user ID by whom interaction modified.

question[].details[].statusAudit[].modifierName

String

This is the user name by whom interaction modified.

question[].details[].statusAudit[].topicID

String

This is the topic ID of the interaction.

question[].details[].statusAudit[].topicName

String

This is the topic name of the interaction.

question[].details[].statusAudit[].assignedToID

String

This is the user ID to whom interaction was assigned.

question[].details[].statusAudit[].assignedToName

String

This is the user name to whom interaction was assigned.

question[].details[].statusAudit[].statusID

String

This is the ID of the status.

question[].details[].statusAudit[].statusName

String

This is the name of the status.

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 the question belongs to.

question[].details[].topicName

String

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

question[].details[].operatorName

String

This has an agent name who has been assigned for the question.

question[].details[].assignedToID

Number

This is the user ID to whom interaction was assigned.

question[].details[].assignedToName

Number

This is the user name to whom interaction was assigned.

question[].details[].modifiedByName

String

This is the user name by whom interaction was modified.

question[].details[].approvedByName

String

This is the user name by whom interaction was approved.

question[].details[].resolvedByName

String

This has an agent name who has resolved this question.

question[].details[].toAddress

String

This is the customer email address.

question[].details[].headerFrom

String

This is a customer email who has sent this question.

question[].details[].headerTo

String

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

question[].details[].cc

String

This is the CC email address.

question[].details[].bcc

String

This is the BCC email address.

response

Object


response[].row

Object

This returns all same property as question object with response row data

response[].details

Object

This returns all same property as question object with response details data

 

 

Response Example

{
  "errors": [],
  "errorDetails": [],
  "numCanGet": 1,
  "numCanApprove": 0,
  "thread": {
    "row": {
      "id": "45529",
      "date": "2021-10-28T20:31:18.4130000Z",
      "subject": "[ref#: 45529-45529] Can I track my package?",
      "type": "Ask A Question",
      "tags": [],
      "assignedToID": "",
      "status": "Resolved",
      "topicID": "6",
      "topicName": "Shipping",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "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",
                  "valueDate": null,
                  "valueDatetime": null,
                  "valueInt": null,
                  "valueNumber": null
                }
              ],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ]
    }
  },
  "question": {
    "row": {
      "id": "45529",
      "date": "2021-10-28T20:31:18.4130000Z",
      "subject": "[ref#: 45529-45529] Can I track my package?",
      "type": "Ask A Question",
      "tags": [],
      "assignedToID": "",
      "status": "Resolved",
      "topicID": "6",
      "topicName": "Shipping",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "status": "Resolved",
      "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",
                  "valueDate": null,
                  "valueDatetime": null,
                  "valueInt": null,
                  "valueNumber": null
                }
              ],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "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"
        }
      ],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "6",
      "topicName": "Shipping",
      "operatorName": "Niraj Raba",
      "assignedToID": "",
      "assignedToName": "",
      "modifiedByName": "",
      "approvedByName": "",
      "resolvedByName": "Niraj Raba",
      "toAddress": "",
      "headerFrom": "customer1@1to1service.com",
      "headerTo": "",
      "cc": "",
      "bcc": ""
    }
  },
  "response": {
    "row": {
      "id": "45586",
      "date": "2021-11-11T17:03:06.2130000Z",
      "subject": "Re: [ref#: 45529-45586] Can I track my package?",
      "type": "Agent Response",
      "tags": [],
      "assignedToID": "510",
      "status": "SentWaitingReply",
      "topicID": "6",
      "topicName": "Shipping",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "date": "2021-11-11T17:03:06.2130000Z",
      "type": "Agent Response",
      "tags": [],
      "subject": "Re: [ref#: 45529-45586] Can I track my package?",
      "status": "SentWaitingReply",
      "bodyPlain": "\r\nTesting reply\r\n \r\nOn 10/28/2021 3:31:18 PM, John Doe <customer1@1to1service.com> wrote:\r\n> 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\r\n",
      "bodyHtml": "<br>\nTesting reply<br>\n&nbsp;\n<div>On 10/28/2021 3:31:18 PM, John Doe &lt;customer1@1to1service.com&gt; wrote:\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>\n</div>\n",
      "note": "",
      "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",
                  "valueDate": null,
                  "valueDatetime": null,
                  "valueInt": null,
                  "valueNumber": null
                }
              ],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "attachments": [],
      "statusAudit": [
        {
          "timeStamp": "/Date(1636650186213)/",
          "date": "2021-11-11T17:03:06.2130000Z",
          "action": "Contact 510 -> [ messagequeue#/mymessageinbox : AutoSave ] Form Submit (webapp-api-mq-myqueue) -> Save Draft -> Question 45529 -> Update Response -> Create -> Create Composition",
          "modifierID": "510",
          "modifierName": "Niraj Raba",
          "topicID": "6",
          "topicName": "e-shop -- All Topics -- Shipping",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "6",
          "statusName": "Unsent"
        }
      ],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "6",
      "topicName": "Shipping",
      "assignedToID": "510",
      "operatorName": "Niraj Raba"
    }
  }
}

 

 

 

 

 

 

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