Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Resolve a question without a response (api=saveresolve)

Scroll Prev Top Next More

Purpose

 

The saveresolve API is used to resolve an interaction

 

UI Reference: The API is called when the resolve button is clicked on any interaction page.

 

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

 

 

 

Request

 

 

Request Parameters

Name

Type

Description

interactionID 

Array

This is the interaction IDs array.

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

Sttring

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 is the segmentID of the interaction that was forward to that segment.

answer[].contactID

String

Represents the ID of the customer.

answer[].isMassUpdate

Boolean

Represents that 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 answer or remove from list after success.

answer[].expectReply

Number

Expecting reply on this mail or not.

answer[].supressSubjectRef

Number

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

answer[].notificationID

Number

This is the notification ID or auto response ID.

answer[].bodyHtml

Number

Body contents of response with html format.

answer[].removedInlineAttachments

Array

Returns the inline attachments.

answer[].mailboxID

string

Represents the mailbox ID of answer.

answer[].note

string

Represents the private comments.

answer[].attachments

Array

Represents the attachments attached with answer.

answer[].destEmail

String

Email address of destination.

answer[].finalHtml

Number

Represents the final html body of answer

answer[].finalPlain

Number

Represents the final plain body of answer.

answer[].defaultMailboxID

String

Represents the default mailbox of segment associated with the answer.

answer[].messageProperties

Array

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

answer[].messageProperties[].propertyID

String

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

answer[].messageProperties[].propertyName

String

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

answer[].messageProperties[].values

Array

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

answer[].answerProperties

Array

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

answer[].answerProperties[].propertyID

String

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

answer[].answerProperties[].propertyName

String

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

answer[].answerProperties[].values

Array

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

_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": [
    "45556"
  ],
  "answer": {
    "inResponseToID": "45556",
    "subject": "Do you offer discounts on new arrivals?",
    "segmentID": "2",
    "topicID": "4",
    "addSubjectRefNum": true,
    "forwardSegmentID": "",
    "contactID": "50",
    "isMassUpdate": false,
    "caseProperties": null,
    "interactionProperties": null,
    "responseProperties": null,
    "leaveOpen": null,
    "expectReply": null,
    "supressSubjectRef": null,
    "notificationID": null,
    "bodyHtml": "&nbsp;\n<div>On 10/28/2021 3:31:23 PM, Julie Margonia &lt;customer10@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">I&rsquo;m eyeing your promo season in December. Do you also offer discounts on new arrivals?</blockquote>\n</div>\n",
    "removedInlineAttachments": [],
    "mailboxID": "1",
    "note": "",
    "attachments": [],
    "destEmail": "customer10@1to1service.com",
    "finalHtml": null,
    "finalPlain": null,
    "defaultMailboxID": "1",
    "messageProperties": [
      {
        "propertyID": "4",
        "propertyName": "Product Type",
        "values": []
      }
    ],
    "answerProperties": [
      {
        "propertyID": "5",
        "propertyName": "Type of Inquiry",
        "values": []
      }
    ]
  },
  "_pageAction": "SaveResolve",
  "_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.

details

Details

This returns the  details of answer/interaction.

details[].interactionProperties

Array

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

details[].interactionProperties[].name

String

Name of interaction property

qurdetails[].interactionProperties[].properties

Array

List of property object with name, id, type and value

 

details[].interactionProperties[].logins

Number

List of logins

details[].interactionProperties[].canModifyLogins

Boolean

This has a value that shows logins are editable or not.

details[].interactionProperties[].caseProperties

Array

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

question

Object

This returns a question's row and details data.

question[].row

string

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 represents the details of question.

question[].details[].status

Object

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

Returns the time stamp of status update.

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

String

Returns the date of status update.

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

String

Return the action performed when status changed or update.

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

String

Returns the agent id who modify the interaction status.

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

String

Returns the agent name who modify the interaction.

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

String

Returns the topic ID of status after update.

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

String

Returns the topic name.

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

Number

Returns the agent ID to whom assigned.

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

Number

Returns the agent name.

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

String

Returns the status ID.

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

String

Returns the status name.

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

String

This returns the agent ID to whom this question was assigned.

question[].details[].assignedToName

String

This returns the agent name to whom this question was assigned

question[].details[].modifiedByName

String

This returns the agent ID by whom this question was modified.

question[].details[].approvedByName

String

This returns the agent ID by whom this question was approved.

question[].details[].resolvedByName

String

This has an agent name who has resolved this question.

question[].details[].toAddress

String

This represents the customer address.

question[].details[].headerFrom

String

This is a customer email who has sent this question.

question[].details[].headerTo

String


question[].details[].cc

String

This represents the CC email address.

question[].details[].bcc

String

This represents the BCC email address.

response

Object

This returns the 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": 0,
  "numCanApprove": 0,
  "thread": {
    "row": {
      "id": "45556",
      "date": "2021-10-28T20:31:23.6370000Z",
      "subject": "[ref#: 45556-45556] Do you offer discounts on new arrivals?",
      "type": "Ask A Question",
      "tags": [],
      "assignedToID": "",
      "status": "Resolved",
      "topicID": "4",
      "topicName": "Products",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "interactionProperties": [
        {
          "name": "e-shop",
          "properties": [
            {
              "propertyID": "4",
              "name": "Product Type",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [],
              "valueChoices": [
                "Audio-Video",
                "Cameras",
                "Cell Phones",
                "Computers",
                "Televisions"
              ],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "caseProperties": []
    }
  },
  "question": {
    "row": {
      "id": "45556",
      "date": "2021-10-28T20:31:23.6370000Z",
      "subject": "[ref#: 45556-45556] Do you offer discounts on new arrivals?",
      "type": "Ask A Question",
      "tags": [],
      "assignedToID": "",
      "status": "Resolved",
      "topicID": "4",
      "topicName": "Products",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "status": "Resolved",
      "interactionProperties": [
        {
          "name": "e-shop",
          "properties": [
            {
              "propertyID": "4",
              "name": "Product Type",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [],
              "valueChoices": [
                "Audio-Video",
                "Cameras",
                "Cell Phones",
                "Computers",
                "Televisions"
              ],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "caseProperties": [],
      "statusAudit": [
        {
          "timeStamp": "/Date(1635453083637)/",
          "date": "2021-10-28T20:31:23.6370000Z",
          "action": "Anonymous -> Form Submit (118) -> Ticket/AAQ -> Ask A Question -> Create Composition",
          "modifierID": "50",
          "modifierName": "Julie Margonia",
          "topicID": "4",
          "topicName": "e-shop -- All Topics -- Products",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "1",
          "statusName": "Unassigned"
        }
      ],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "4",
      "topicName": "Products",
      "operatorName": "Niraj Raba",
      "assignedToID": "",
      "assignedToName": "",
      "modifiedByName": "",
      "approvedByName": "",
      "resolvedByName": "Niraj Raba",
      "toAddress": "",
      "headerFrom": "customer10@1to1service.com",
      "headerTo": "",
      "cc": "",
      "bcc": ""
    }
  },
  "response": {
    "row": {
      "id": "45595",
      "date": "2021-11-17T11:07:24.9670000Z",
      "subject": "Re: [ref#: 45556-45595] Do you offer discounts on new arrivals?",
      "type": "Resolve Note",
      "tags": [],
      "assignedToID": "",
      "status": "PublicNote",
      "topicID": "4",
      "topicName": "Products",
      "segmentID": "2",
      "properties": []
    },
    "details": {
      "date": "2021-11-17T11:07:24.9670000Z",
      "type": "Resolve Note",
      "tags": [],
      "subject": "Re: [ref#: 45556-45595] Do you offer discounts on new arrivals?",
      "status": "PublicNote",
      "bodyPlain": "On 10/28/2021 3:31:23 PM, Julie Margonia <customer10@1to1service.com> wrote:\r\n> I’m eyeing your promo season in December. Do you also offer discounts on new arrivals?\r\n\r\n",
      "bodyHtml": "&nbsp;\n<div>On 10/28/2021 3:31:23 PM, Julie Margonia &lt;customer10@1to1service.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex\">I’m eyeing your promo season in December. Do you also offer discounts on new arrivals?</blockquote>\n</div>\n",
      "note": "",
      "interactionProperties": [
        {
          "name": "e-shop",
          "properties": [
            {
              "propertyID": "5",
              "name": "Type of Inquiry",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [],
              "valueChoices": [
                "Account Question",
                "Compliment",
                "Handled on phone",
                "Other",
                "Product Inquiry",
                "Product Issue",
                "Technical Support"
              ],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "caseProperties": [],
      "attachments": [],
      "statusAudit": [
        {
          "timeStamp": "/Date(1637147244967)/",
          "date": "2021-11-17T11:07:24.9670000Z",
          "action": "Contact 452 -> [ manage#/messagestree : ManageQueue_Messages_QuickAction/Assign ] Form Submit (webapp-api-mq-myqueue) -> Assign -> Question 45556 -> Update Response -> Create -> Create Composition",
          "modifierID": "452",
          "modifierName": "bhavin.patel@iservice.info",
          "topicID": "4",
          "topicName": "e-shop -- All Topics -- Products",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "6",
          "statusName": "Unsent"
        }
      ],
      "segmentID": "2",
      "segmentName": "e-shop",
      "topicID": "4",
      "topicName": "Products",
      "assignedToID": "",
      "operatorName": "Niraj Raba"
    }
  }
}

 

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