The unqueue API is used to unqueue the message from a user’s own list.
UI Reference: The API is called when the ''unqueue'' button is clicked on the forward button on any interaction page.
URI: webapp-api-mq-myqueue?api=unqueue
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 ID of segment to whom this answer forward. |
answer[].contactID |
String |
This represents the ID of customer. |
answer[].isMassUpdate |
Boolean |
Represents the case properties of the interaction. |
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 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 refrence number from subject. |
answer[].notificationID |
Number |
This represents the notification ID. |
answer[].bodyHtml |
String |
Body contents of response with html format. |
answer[].removedInlineAttachments |
String |
This represents the inline attachments. |
answer[].mailboxID |
String |
This represents the mailbox ID |
answer[].note |
String |
This represents the private comments. |
answer[].attachments |
String |
This represents the attachments attached to answer. |
answer[].destEmail |
String |
Email address of destination. |
answer[].finalHtml |
Number |
This represents the final html body of the answer. |
answer[].finalPlain |
Number |
This represents the final plain body of the answer. |
answer[].defaultMailboxID |
String |
This represents the default mailbox ID of segment associated with the answer/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. |
_pageAction |
String |
This parameter represents the action name which is performed from the page. |
_pageName |
String |
This parameter represents the page name. |
{ |
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 |
Obect |
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 returns all details of thread root. |
thread[].details[].interactionProperties |
String |
This returns the interaction properties of thread interaction. |
thread[].details[].caseProperties |
String |
This returns the case properties of 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[].name |
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[].questionstatus |
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 returns 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 status modified. |
question[].details[].timeStamp[].date |
String |
This represents the date of the status modified. |
question[].details[].statusAudit[].action |
String |
This represents the action name of the status modified. |
question[].details[].modifierID |
String |
This represents the user ID who modify the status. |
question[].details[].statusAudit[].modifierName |
String |
This represents the user name who modify the status. |
question[].details[].statusAudit[].topicID |
String |
This represents the topic ID. |
question[].details[].statusAudit[].topicName |
String |
This represents the topic name. |
question[].details[].statusAudit[].assignedToID |
Number |
This represents the agent ID to whom interaction was assigned. |
question[].details[].statusAudit[].assignedToName |
Number |
This represents the agent name to whom interaction was assigned.. |
question[].details[].statusAudit[].statusID |
String |
This represents the status ID. |
question[].details[].statusAudit[].statusName |
String |
This represents 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 is agent ID to whom interaction was assigned. |
question[].details[].assignedToName |
String |
This is agent name to whom interaction was assigned. |
question[].details[].modifiedByName |
String |
This is the modifier name by whom interaction was modified. |
question[].details[].approvedByName |
String |
This is the agent 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 customer address. |
question[].details[].cc |
String |
This is the CC email address. |
question[].details[].bcc |
String |
This is BCC email address. |
response |
Object |
This is the answer 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 |
{ |