Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Save a draft for an answer (api=savedraft)

Scroll Prev Top Next More

Purpose

 

The savedraft API is used to save interaction as draft.

 

UI Reference: The API is called when the  button is clicked on the ___ page.

 

URIwebapp-api-mq-myqueue?api=savedraft

 

 

 

Request

 

 

Request Parameters

Name

Type

Description

interactionIDs

String

This contains multiple interaction IDs when mass update action is performed.

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 of the interaction to which 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

nswer[].supressSubjectRef

Number

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

answer[].notificationID

Number

This is the notification or auto response ID.

answer[].bodyHtml

String

Body contents of response with html format.

answer[].removedInlineAttachments

Array

This represents the removed inline attachments.

answer[].mailboxID

String

This represents the mailbox ID of the interaction.

answer[].note

String

This represents the private comments of the interaction.

answer[].attachments

Array

This represents the attachments attached to the interaction answer.

answer[].destEmail

String

Email address of destination.

answer[].finalHtml

Number

This represents the final HTML body of the interaction.

answer[].finalPlain

Number

This represents the final plain body of the interaction.

answer[].defaultMailboxID

String

This is the 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 parameter represents interaction id.

_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": [
    "45538"
  ],
  "answer": {
    "inResponseToID": "45538",
    "subject": "Will I have to pay customs duties and taxes?",
    "segmentID": "2",
    "topicID": "6",
    "addSubjectRefNum": true,
    "forwardSegmentID": "",
    "contactID": "92",
    "isMassUpdate": false,
    "caseProperties": null,
    "interactionProperties": null,
    "responseProperties": null,
    "leaveOpen": null,
    "expectReply": null,
    "supressSubjectRef": null,
    "notificationID": null,
    "bodyHtml": "<br />\n<br />\n&nbsp;\n<div>On 10/28/2021 3:31:20 PM, John Bastion &lt;customer4@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">I&rsquo;m about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I&rsquo;m not sure whether the cost includes customs duties and taxes. Kindly help.</blockquote>\n</div>\n",
    "removedInlineAttachments": [],
    "mailboxID": "1",
    "note": "",
    "attachments": [],
    "destEmail": "customer4@1to1service.com",
    "finalHtml": null,
    "finalPlain": null,
    "defaultMailboxID": "1",
    "threadProperties": [
      {
        "propertyID": "35",
        "propertyName": "Item #",
        "values": []
      },
      {
        "propertyID": "121",
        "propertyName": "Shipping Method",
        "values": []
      }
    ]
  },
  "interactionID": "45538",
  "_pageAction": "SaveDraft",
  "_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 describes the properties related to an 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 represents the ID of the interaction.

details[].threadType

String

This represents the type of the 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 the subject of the interaction with 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 gives the full status audit of an 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 parameter represents the name of the login.

details[].customerLogins[].type

String

This represents the type of the login.

details[].fromAddress

String

Email address who has initiated the interaction.

details[].composerAddress

String

This is the composer email address.

details[].reCC

String

This is the replying CC email 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

This is the ID of the response.

details[].subjectRef

String

This is the subject reference value with interaction id.

details[].responseSubject

String

This represents the subject of the response.

details[].responseHtml

String

This represents the HTML body of the response.

details[].note

String

This represents the private comment of the response interaction.

details[].responseProperties

Array

This represents the properties of the response.

details[].responseAttachments

Array

This represents the attachments attached with 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 recipient that is about to receive the E-mail.

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.

details[].responseFinalHtml

String

This represents the final HTML body  of the interaction

details[].responseFinalPlain

String

This represents 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 object represents the details of the response.

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 with reference number.

response[].details[].status

String

This is the status question.

response[].details[].bodyPlain

String

This represents the plain body of the interaction.

response[].details[].bodyHtml

String

This has body contents of interaction with html format.

response[].details[].note

String

This represents the private comments 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 represents 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": "45538",
    "date": "2021-10-28T20:31:20.2330000Z",
    "subject": "[ref#: 45538-45538] Will I have to pay customs duties and taxes?",
    "type": "Ask A Question",
    "tags": [],
    "assignedToID": "510",
    "status": "Queued",
    "topicID": "6",
    "topicName": "Shipping",
    "segmentID": "2",
    "properties": []
  },
  "details": {
    "id": "45538",
    "type": "Ask A Question",
    "tags": [],
    "status": "Queued",
    "threadID": "45538",
    "threadType": "Ask A Question",
    "caseProperties": [
      {
        "name": "e-shop",
        "properties": [
          {
            "propertyID": "35",
            "name": "Item #",
            "isDate": false,
            "isDatetime": false,
            "isInteger": false,
            "isNumber": false,
            "allowMultiple": false,
            "hasDescriptions": false,
            "isMultiLine": false,
            "isReadOnly": false,
            "isRequired": true,
            "values": [],
            "valueChoices": [],
            "descriptionChoices": []
          }
        ],
        "logins": null,
        "canModifyLogins": false
      }
    ],
    "subject": "Will I have to pay customs duties and taxes?",
    "subjectBare": "Will I have to pay customs duties and taxes?",
    "date": "2021-10-28T20:31:20.2330000Z",
    "dateResolved": "0001-01-01T06:00:00.0000000Z",
    "questionHtml": "I'm about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I'm not sure whether the cost includes customs duties and taxes. Kindly help.",
    "attachments": [],
    "interactionProperties": [],
    "customerID": "92",
    "customerName": "John Bastion",
    "statusAudit": [
      {
        "timeStamp": "/Date(1635453080233)/",
        "date": "2021-10-28T20:31:20.2330000Z",
        "action": "Anonymous -> Form Submit (118) -> Ticket/AAQ -> Ask A Question -> Create Composition",
        "modifierID": "92",
        "modifierName": "John Bastion",
        "topicID": "6",
        "topicName": "e-shop -- All Topics -- Shipping",
        "assignedToID": null,
        "assignedToName": null,
        "statusID": "1",
        "statusName": "Unassigned"
      }
    ],
    "customerAddresses": [
      "customer4@1to1service.com"
    ],
    "customerLogins": [
      {
        "name": "customer4@1to1service.com",
        "type": "Email"
      }
    ],
    "fromAddress": "customer4@1to1service.com",
    "composerAddress": "customer4@1to1service.com",
    "reCC": "",
    "topicID": "6",
    "topicName": "Shipping",
    "segmentID": "2",
    "segmentName": "e-shop",
    "responseID": "45588",
    "subjectRef": "Re: [ref#: 45538-45588]",
    "responseSubject": "Will I have to pay customs duties and taxes?",
    "responseHtml": "<br />\r\n<br />\r\n&nbsp;\r\n<div>On 10/28/2021 3:31:20 PM, John Bastion &lt;customer4@1to1service.com&gt; wrote:\r\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">I&rsquo;m about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I&rsquo;m not sure whether the cost includes customs duties and taxes. Kindly help.</blockquote>\r\n</div>\r\n",
    "note": "",
    "responseProperties": [],
    "responseAttachments": [],
    "assignedToID": "510",
    "assignedToName": "Niraj Raba",
    "resolvedByName": "",
    "toAddress": "",
    "headerFrom": "customer4@1to1service.com",
    "headerTo": "",
    "cc": "",
    "bcc": "",
    "bodyPlain": "I'm about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I'm not sure whether the cost includes customs duties and taxes. Kindly help.\r\n",
    "defaultMailboxID": "1",
    "responseFinalHtml": "<br>\n<br>\n&nbsp;\n<div>On 10/28/2021 3:31:20 PM, John Bastion &lt;customer4@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex\">I'm about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I'm not sure whether the cost includes customs duties and taxes. Kindly help.</blockquote>\n</div>\n",
    "responseFinalPlain": "\r\n\r\nOn 10/28/2021 3:31:20 PM, John Bastion <customer4@1to1service.com> wrote:\r\n> I'm about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I'm not sure whether the cost includes customs duties and taxes. Kindly help.\r\n\r\n"
  },
  "response": {
    "row": {
      "id": "45588",
      "date": "2021-11-15T09:20:15.7400000Z",
      "subject": "Will I have to pay customs duties and taxes?",
      "type": "Unsent Response",
      "tags": [],
      "assignedToID": "",
      "status": "Unsent",
      "topicID": "6",
      "topicName": "Shipping",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "date": "2021-11-15T09:20:15.7400000Z",
      "type": "Unsent Response",
      "tags": [],
      "subject": "Will I have to pay customs duties and taxes?",
      "subjectBare": "Will I have to pay customs duties and taxes?",
      "status": "Unsent",
      "bodyPlain": "\r\n\r\nOn 10/28/2021 3:31:20 PM, John Bastion <customer4@1to1service.com> wrote:\r\n> I'm about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I'm not sure whether the cost includes customs duties and taxes. Kindly help.\r\n\r\n",
      "bodyHtml": "<br>\n<br>\n&nbsp;\n<div>On 10/28/2021 3:31:20 PM, John Bastion &lt;customer4@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex\">I'm about to pay for my order and the total amount is $450 inclusive of shipping cost. However, I'm not sure whether the cost includes customs duties and taxes. Kindly help.</blockquote>\n</div>\n",
      "note": "",
      "interactionProperties": [],
      "caseProperties": [
        {
          "name": "e-shop",
          "properties": [
            {
              "propertyID": "35",
              "name": "Item #",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": true,
              "values": [],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "attachments": [],
      "statusAudit": [
        {
          "timeStamp": "/Date(1636968015740)/",
          "date": "2021-11-15T09:20:15.7400000Z",
          "action": "Contact 510 -> [ messagequeue#/mymessageinbox : AutoSave ] Form Submit (webapp-api-mq-myqueue) -> Save Draft -> Question 45538 -> 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": "",
      "operatorName": ""
    }
  }
}

 

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