Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Send reply to question and leave open (api=sendleaveopen)

Scroll Prev Top Next More

Purpose

 

The sendleaveopen API is used to send a reply to an interaction but do not close.

 

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

 

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

 

 

 

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

Boolean

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

String

This is the notification ID of the customer.

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 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 default mailbox ID of the segment associated with the interaction.

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

Array

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

interactionID

String

This has an interaction id value.

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": [
    "45553"
  ],
  "answer": {
    "inResponseToID": "45553",
    "subject": "Do you accept payment on delivery?",
    "segmentID": "2",
    "topicID": "39",
    "addSubjectRefNum": true,
    "forwardSegmentID": "",
    "contactID": "155",
    "isMassUpdate": false,
    "caseProperties": null,
    "interactionProperties": null,
    "responseProperties": null,
    "leaveOpen": true,
    "expectReply": null,
    "supressSubjectRef": null,
    "notificationID": "",
    "bodyHtml": "&nbsp;\n<div>On 10/28/2021 3:31:22 PM, Larissa Ostapenko &lt;customer9@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">I want to buy a HP laptop charger but I prefer paying after the item is delivered to me. Do you accept payment on delivery?</blockquote>\n</div>\n",
    "removedInlineAttachments": [],
    "mailboxID": "1",
    "note": "",
    "attachments": [],
    "destEmail": "customer9@1to1service.com",
    "finalHtml": null,
    "finalPlain": null,
    "defaultMailboxID": "1",
    "threadProperties": [
      {
        "propertyID": "11",
        "propertyName": "Account Number",
        "values": [
          {
            "value": "Platinum"
          }
        ]
      }
    ]
  },
  "interactionID": "45553",
  "_pageAction": "SendLeaveOpen",
  "_pageName": "messagequeue#/my-message-inbox"
}

 

 

 

Response

 

 

Response Parameters

Name

Type

Description

errors

Array

This parameter represents the lists of the 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.

row

Object

Object with row and their details.

row[].id

String

This is Interaction id.

row[].date

String

This returns the date of interaction.

row[].subject

String

This returns the subject of interaction.

row[].type

String

This returns the type of interaction.

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.

row[].assignedToID

String

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

row[].status

String

This is the status of interaction.

row[].topicID

String

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

row[].topicName

String

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

row[].segmentID

String

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

row[].properties

Array

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

details

Object

This object represents details of the interaction.

details[].id

String

This is Interaction id.

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 is the ID of the root case thread interaction.

details[].threadType

String

This is the type of the root case thread interaction.

details[].caseProperties

Array

This represents a list of case properties.

details[].caseProperties[].name

String

Property name.

details[].caseProperties[].properties

Array

Property details. see property values.

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 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 status change log of the interaction.

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

Number

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 user login.

details[].customerLogins[].type

String

This is the type of the user login.

details[].fromAddress

String

Email address who has initiated the interaction.

details[].composerAddress

String

This is the email address who is sending the reply.

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


details[].subjectRef

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 response HTML of the interaction.

details[].note

String

This is the private comment of the interaction.

details[].responseProperties

Array

This represents the interaction properties of the interaction.

details[].responseAttachments

Array

This represents the attachments attached to the 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 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 represents the default mailbox ID of the segment associated with the interaction.

details[].responseFinalHtml

String

This is the final HTML body of the response.

details[].responseFinalPlain

String

This is the final plain body of the response.

response

Object

This returns a question's row and details data.

response[].row

Object

This has all details of the row.

response[].row[].id

String

This is Interaction id.

response[].row[].date

String

This returns the date of interaction.

response[].row[].subject

String

This returns the subject of interaction.

response[].row[].type

String

This returns the type of interaction.

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

response[].row[].assignedToID

String

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

response[].row[].status

String

This is the status of interaction.

response[].row[].topicID

String

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

response[].row[].topicName

String

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

response[].row[].segmentID

String

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

response[].row[].properties

Array

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

response[].details

Object

This describes details of any response in an interaction.

response[].details[].date

String

This returns the date of interaction.

response[].details[].type

String

This returns the type of interaction.

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

response[].details[].subject

String

This returns the subject of interaction.

response[].details[].subjectBare

String

This represents the subject of the interaction without reference number.

response[].details[].status

String

This is the status question.

response[].details[].bodyPlain

String

This represents the plain body of the response.

response[].details[].bodyHtml

String

This has body contents of interaction with html format.

response[].details[].note

String

This represents private comment of the interaction.

response[].details[].interactionProperties

Array

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

response[].details[].caseProperties

Array

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

response[].details[].attachments

Array

This represents the attachments attached to the interaction.

response[].details[].statusAudit

Array

List of status changes log.

response[].details[].segmentID

String

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

response[].details[].segmentName

String

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

response[].details[].topicID

String

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

response[].details[].topicName

String

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

response[].details[].assignedToID

String

This is the user ID to whom interaction was assigned.

response[].details[].operatorName

String

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

 

 

 

Response example

{
  "errors": [],
  "errorDetails": [],
  "numCanGet": 0,
  "numCanApprove": 0,
  "row": {
    "id": "45553",
    "date": "2021-10-28T20:31:22.9200000Z",
    "subject": "[ref#: 45553-45553] Do you accept payment on delivery?",
    "type": "Ask A Question",
    "tags": [],
    "assignedToID": "510",
    "status": "Queued",
    "topicID": "39",
    "topicName": "Computers",
    "segmentID": "2",
    "properties": []
  },
  "details": {
    "id": "45553",
    "type": "Ask A Question",
    "tags": [],
    "status": "Queued",
    "threadID": "45553",
    "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",
                "valueDate": null,
                "valueDatetime": null,
                "valueInt": null,
                "valueNumber": null
              }
            ],
            "valueChoices": [],
            "descriptionChoices": []
          }
        ],
        "logins": null,
        "canModifyLogins": false
      }
    ],
    "subject": "Do you accept payment on delivery?",
    "subjectBare": "Do you accept payment on delivery?",
    "date": "2021-10-28T20:31:22.9200000Z",
    "dateResolved": "0001-01-01T06:00:00.0000000Z",
    "questionHtml": "I want to buy a HP laptop charger but I prefer paying after the item is delivered to me. Do you accept payment on delivery?",
    "attachments": [],
    "interactionProperties": [],
    "customerID": "155",
    "customerName": "Larissa Ostapenko",
    "statusAudit": [
      {
        "timeStamp": "/Date(1635453082920)/",
        "date": "2021-10-28T20:31:22.9200000Z",
        "action": "Anonymous -> Form Submit (118) -> Ticket/AAQ -> Ask A Question -> Create Composition",
        "modifierID": "155",
        "modifierName": "Larissa Ostapenko",
        "topicID": "7",
        "topicName": "e-shop -- All Topics -- Technical Support",
        "assignedToID": null,
        "assignedToName": null,
        "statusID": "1",
        "statusName": "Unassigned"
      }
    ],
    "customerAddresses": [
      "customer9@1to1service.com"
    ],
    "customerLogins": [
      {
        "name": "customer9@1to1service.com",
        "type": "Email"
      }
    ],
    "fromAddress": "customer9@1to1service.com",
    "composerAddress": "customer9@1to1service.com",
    "reCC": "",
    "topicID": "39",
    "topicName": "Computers",
    "segmentID": "2",
    "segmentName": "e-shop",
    "responseID": "",
    "subjectRef": "Re: [ref#: 45553-45553]",
    "responseSubject": "Do you accept payment on delivery?",
    "responseHtml": "<br/><br/><br/><div>On 10/28/2021 3:31:22 PM, Larissa Ostapenko &lt;customer9@1to1service.com&gt; wrote:<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">I want to buy a HP laptop charger but I prefer paying after the item is delivered to me. Do you accept payment on delivery?</blockquote></div>",
    "note": "",
    "responseProperties": [],
    "responseAttachments": [],
    "assignedToID": "510",
    "assignedToName": "Niraj Raba",
    "resolvedByName": "",
    "toAddress": "",
    "headerFrom": "customer9@1to1service.com",
    "headerTo": "",
    "cc": "",
    "bcc": "",
    "bodyPlain": "I want to buy a HP laptop charger but I prefer paying after the item is delivered to me. Do you accept payment on delivery?\r\n",
    "defaultMailboxID": "1",
    "responseFinalHtml": "",
    "responseFinalPlain": ""
  },
  "response": {
    "row": {
      "id": "45596",
      "date": "2021-11-17T11:07:25.0100000Z",
      "subject": "Re: [ref#: 45553-45596] Do you accept payment on delivery?",
      "type": "Agent Email",
      "tags": [],
      "assignedToID": "",
      "status": "Sent",
      "topicID": "39",
      "topicName": "Computers",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "date": "2021-11-17T11:07:25.0100000Z",
      "type": "Agent Email",
      "tags": [],
      "subject": "Re: [ref#: 45553-45596] Do you accept payment on delivery?",
      "subjectBare": "Do you accept payment on delivery?",
      "status": "Sent",
      "bodyPlain": "On 10/28/2021 3:31:22 PM, Larissa Ostapenko <customer9@1to1service.com> wrote:\r\n> I want to buy a HP laptop charger but I prefer paying after the item is delivered to me. Do you accept payment on delivery?\r\n\r\n",
      "bodyHtml": "&nbsp;\n<div>On 10/28/2021 3:31:22 PM, Larissa Ostapenko &lt;customer9@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex\">I want to buy a HP laptop charger but I prefer paying after the item is delivered to me. Do you accept payment on delivery?</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(1637147245010)/",
          "date": "2021-11-17T11:07:25.0100000Z",
          "action": "Contact 452 -> [ manage#/messagestree : ManageQueue_Messages_QuickAction/Assign ] Form Submit (webapp-api-mq-myqueue) -> Assign -> Question 45553 -> Update Response -> Create -> Create Composition",
          "modifierID": "452",
          "modifierName": "bhavin.patel@iservice.info",
          "topicID": "39",
          "topicName": "e-shop -- All Topics -- Products -- Computers",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "6",
          "statusName": "Unsent"
        }
      ],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "39",
      "topicName": "Computers",
      "assignedToID": "",
      "operatorName": "Niraj Raba"
    }
  }
}

 

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