Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Qa reject by managers (api=qareject)

Scroll Prev Top Next More

Purpose

 

The qareject API is used to rejecting the answers by managers..

 

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

 

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

 

 

 

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 represents the ID of the notification or auto response.

answer[].bodyHtml

String

Body contents of response with html format.

answer[].removedInlineAttachments

Array

This represents the removed inline attachments.

answer[].mailboxID

String

This is the mailbox ID of the interaction answer.

answer[].note

String

This is the private comment of the interaction.

answer[].attachments

Array

This represents attachments attached to the interaction.

answer[].destEmail

String

Email address of destination.

answer[].finalHtml

Number

This represents final html body of the answer.

answer[].finalPlain

Number

This represents final plain body of the answer.

answer[].defaultMailboxID

String

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

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

String

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

answer[].answerProperties

Array

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

answer[].answerProperties[].propertyID

String

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

answer[].answerProperties[].propertyName

String

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

answer[].answerProperties[].values

Array

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

_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":[
      "35445"
   ],
   "answer":{
      "inResponseToID":"35445",
      "subject":"test attachment 123",
      "segmentID":"3",
      "topicID":"4",
      "addSubjectRefNum":true,
      "forwardSegmentID":"",
      "contactID":"25098",
      "isMassUpdate":false,
      "caseProperties":null,
      "interactionProperties":null,
      "responseProperties":null,
      "leaveOpen":null,
      "expectReply":null,
      "supressSubjectRef":null,
      "notificationID":null,
      "bodyHtml":"Please update your response<br />\n<br />\nPlease approve my response<br />\n&nbsp;\n<div>On 1/6/2022 3:23:33 AM, test@123.com &lt;test@123.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">test attachment 123</blockquote>\n</div>\n",
      "removedInlineAttachments":[
        
      ],
      "mailboxID":"16",
      "note":"",
      "attachments":[
        
      ],
      "destEmail":"test@123.com",
      "finalHtml":null,
      "finalPlain":null,
      "defaultMailboxID":"16",
      "messageProperties":[
         {
            "propertyID":"6",
            "propertyName":"QuestionProperty",
            "values":[
               {
                  "value":"test attachment 123"
               }
            ]
         }
      ],
      "answerProperties":[
         {
            "propertyID":"2",
            "propertyName":"Billable",
            "values":[
               
            ]
         }
      ]
   },
   "_pageAction":"QAReject",
   "_pageName":"messagequeue#/my-messages-to-approve"
}

 

 

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

Number

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

numCanApprove

Number

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

These values are explained in Properties that may be edited chapter.

thread[].details

Object

This object represents details of the interaction.

thread[].details[].id

String

This is the ID of the interaction.

thread[].details[].interactionProperties

Array

This represents the interaction properties of the interaction.

thread[].details[].interactionProperties[].name

String

This represents the name of the segment of the properties.

thread[].details[].interactionProperties[].properties

Array

These values are expalined in properties that may be edited chapter.

thread[].details[].interactionProperties[].logins

Number

These are the customer logins.

thread[].details[].interactionProperties[].canmodifylogins

Boolean

This represents whether user can modify their logins or not.

thread[].details[].caseProperties

Array

This represents 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

These values are explained in Properties that may be edited chapter.

question[].details

Object

This object returns details of the question.

question[].details[].id

String

This represents ID 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[].interactionProperties[].name

String

This represents name of the segment of the properties.

question[].details[].interactionProperties[].properties

Array

These values are explained in Properties that may be edited chapter.

question[].details[].interactionProperties[].logins

Number

This represents the logins of the customer.

question[].details[].interactionProperties[].canModifyLogins

Boolean

This represents whether customer can modify their logins or not.

question[].details[].caseProperties

String

This is the status question.

question[].details[].statusAudit

Array

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

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

Number

This is the user ID to whom interaction was assigned.

question[].details[].statusAudit[].assignedName

String

This is the user name to whom interaction was assigned.

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

String

This represents ID of the status.

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

String

This represents 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

String

This is the user ID to whom interaction was assigned.

question[].details[].assignedToName

String

This is the user name to whom interaction was assigned.

question[].details[].modifiedByName

String

This is the user name by whom interaction modified.

question[].details[].approvedByName

String

This is the user name by whom interaction approved.

question[].details[].resolvedByName

String

This has an agent name who has resolved this question.

question[].details[].toAddress

String

This represents customer email address.

question[].details[].headerFrom

String

This is a customer email who has sent this question.

question[].details[].headerTo

String

This shows the email address of the person who is about to receive the E-mail.

question[].details[].cc

String

This is the CC email address.

question[].details[].bcc

String

This is the BCC email address.

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

These values are explained in Properties that may be edited chapter.

response[].details

Object

This object represents the details of the response interaction.

response[].details[].id

String

This is the ID of the 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[].status

String

This is the status question.

response[].details[].bodyPlain

String

This represents plain body of the interaction.

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[].interactionProperties[].name

String

This represents name of the segment of the properties.

response[].details[].interactionProperties[].properties

Array

These values are explained in Properties that may be edited chapter.

response[].details[].interactionProperties[].logins

Number

This represents customer logins.

response[].details[].interactionProperties[].canModifyLogins

Boolean

This represents whether user can modify their logins or not.

response[].details[].caseProperties

Array

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

response[].details[].attachments

Array

This represents attachments attached with the interaction.

response[].details[].statusAudit

Array

List of status changes log.

response[].details[].statusAudit[].timeStamp

String

This represents the time stamp of the status modified.

response[].details[].statusAudit[].date

String

This represents the date of the status modified.

response[].details[].statusAudit[].action

String

This is the action name when status modified.

response[].details[].statusAudit[].modifierID

String

This is the user ID by whom interaction modified.

response[].details[].statusAudit[].modifierName

String

This is the user name by whom interaction modified.

response[].details[].statusAudit[].topicID

String

This is the topic ID of the interaction.

response[].details[].statusAudit[].topicName

String

This is the topic name of the interaction.

response[].details[].statusAudit[].assignedToID

Number

This is the user ID to whom interaction was assigned.

response[].details[].statusAudit[].assignedToName

Number

This is the user name to whom interaction was assigned.

response[].details[].statusAudit[].statusID

String

This is the ID of the status.

response[].details[].statusAudit[].statusName

String

This is the name of the status.

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

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": 7,
  "numCanApprove": 0,
  "thread": {
    "row": {
      "id": "35445",
      "date": "2022-01-06T09:23:33.8370000Z",
      "subject": "test attachment 123",
      "type": "Ask A Question",
      "tags": [],
      "assignedToID": "25054",
      "status": "Queued",
      "topicID": "4",
      "topicName": "All Topics",
      "segmentID": "3",
      "properties": []
    },
    "details": {
      "id": "35445",
      "interactionProperties": [
        {
          "name": "Segment1",
          "properties": [
            {
              "propertyID": "6",
              "name": "QuestionProperty",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [
                {
                  "description": null,
                  "value": "test attachment 123",
                  "valueDateUtc": null,
                  "valueDatetimeUtc": null,
                  "valueInt": null,
                  "valueNumber": null
                }
              ],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "caseProperties": []
    }
  },
  "question": {
    "row": {
      "id": "35445",
      "date": "2022-01-06T09:23:33.8370000Z",
      "subject": "test attachment 123",
      "type": "Ask A Question",
      "tags": [],
      "assignedToID": "25054",
      "status": "Queued",
      "topicID": "4",
      "topicName": "All Topics",
      "segmentID": "3",
      "properties": []
    },
    "details": {
      "id": "35445",
      "status": "Queued",
      "interactionProperties": [
        {
          "name": "Segment1",
          "properties": [
            {
              "propertyID": "6",
              "name": "QuestionProperty",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [
                {
                  "description": null,
                  "value": "test attachment 123",
                  "valueDateUtc": null,
                  "valueDatetimeUtc": null,
                  "valueInt": null,
                  "valueNumber": null
                }
              ],
              "valueChoices": [],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "caseProperties": [],
      "statusAudit": [
        {
          "timeStamp": "/Date(1641461013837)/",
          "date": "2022-01-06T09:23:33.8370000Z",
          "action": "Contact 1 -> Form Submit (32) -> Ticket/AAQ -> Ask A Question -> Create Composition",
          "modifierID": "25098",
          "modifierName": "test@123.com",
          "topicID": "4",
          "topicName": "Segment1 -- All Topics",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "1",
          "statusName": "Unassigned"
        }
      ],
      "segmentID": "3",
      "segmentName": "Segment1",
      "topicID": "4",
      "topicName": "All Topics",
      "operatorName": "s1topic123csrqa@qavmmail02",
      "assignedToID": "25054",
      "assignedToName": "s1topic123csrqa@qavmmail02",
      "modifiedByName": "",
      "approvedByName": "",
      "resolvedByName": "s1topic123csrqa@qavmmail02",
      "toAddress": "",
      "headerFrom": "test@123.com",
      "headerTo": "",
      "cc": "",
      "bcc": ""
    }
  },
  "response": {
    "row": {
      "id": "35728",
      "date": "2022-01-10T13:35:52.6500000Z",
      "subject": "test attachment 123",
      "type": "Unsent Response",
      "tags": [],
      "assignedToID": "",
      "status": "Unsent",
      "topicID": "4",
      "topicName": "All Topics",
      "segmentID": "3",
      "properties": []
    },
    "details": {
      "id": "35728",
      "date": "2022-01-10T13:35:52.6500000Z",
      "type": "Unsent Response",
      "tags": [],
      "subject": "test attachment 123",
      "status": "Unsent",
      "bodyPlain": "Please update your response\r\n\r\nPlease approve my response\r\n \r\nOn 1/6/2022 3:23:33 AM, test@123.com <test@123.com> wrote:\r\n> test attachment 123\r\n\r\n",
      "bodyHtml": "Please update your response<br>\n<br>\nPlease approve my response<br>\n&nbsp;\n<div>On 1/6/2022 3:23:33 AM, test@123.com &lt;test@123.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex\">test attachment 123</blockquote>\n</div>\n",
      "note": "",
      "interactionProperties": [
        {
          "name": "Segment1",
          "properties": [
            {
              "propertyID": "2",
              "name": "Billable",
              "isDate": false,
              "isDatetime": false,
              "isInteger": false,
              "isNumber": false,
              "allowMultiple": false,
              "hasDescriptions": false,
              "isMultiLine": false,
              "isReadOnly": false,
              "isRequired": false,
              "values": [],
              "valueChoices": [
                "False",
                "True"
              ],
              "descriptionChoices": []
            }
          ],
          "logins": null,
          "canModifyLogins": false
        }
      ],
      "caseProperties": [],
      "attachments": [],
      "statusAudit": [
        {
          "timeStamp": "/Date(1641821748200)/",
          "date": "2022-01-10T13:35:48.2000000Z",
          "action": "Contact 25054 -> [ messagequeue#/mymessageinbox : AutoSave ] Form Submit (webapp-api-mq-myqueue) -> Save Draft -> Question 35445 -> Update Response -> Create -> Create Composition",
          "modifierID": "25054",
          "modifierName": "s1topic123csrqa@qavmmail02",
          "topicID": "4",
          "topicName": "Segment1 -- All Topics",
          "assignedToID": null,
          "assignedToName": null,
          "statusID": "6",
          "statusName": "Unsent"
        }
      ],
      "segmentID": "3",
      "segmentName": "Segment1",
      "topicID": "4",
      "topicName": "All Topics",
      "assignedToID": "",
      "operatorName": "s1topic123csrqa@qavmmail02"
    }
  }
}

 

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