The changesegment API is used to change segment of an interaction.
UI Reference: The API is called when the ''Forward to Segment'' button is clicked on the manage messages or my message inbox page.
URI: webapp-api-mq-myqueue?api=changesegment
Name |
Type |
Description |
---|---|---|
interactionIDs |
Array |
Represents the multiple interaction IDs used for mass update action. |
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 is the segment ID to which interaction is forward. |
answer[].contactID |
String |
This is the ID of the customer/conatct. |
answer[].isMassUpdate |
Boolean |
This represents whether the 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. |
asnwer[].leaveOpen |
Number |
This represents whether to leave open or remove from list after success. |
answer[].expectReply |
Number |
Expecting reply on this mail or not |
asnwer[].supressSubjectRef |
Number |
This represents whether to suppress the reference number from subject or not. |
answer[].notificationID |
Number |
This is the notification ID. |
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 answer. |
answer[].note |
String |
This is the private or public note of the answer. |
answer[].attachments |
Array |
This represents the attachments attached to the 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. |
answer[].forwardMailboxID |
String |
This is the mailbox ID to which interaction forward. |
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 |
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. |
thread[].details |
Object |
This object represents the details of root case. |
thread[].details[].interactionProperties |
Array |
This represents the interaction properties of the interaction. |
thread[].details[].caseProperties |
Array |
This represents the case properties of the interaction. |
thread[].details[].caseProperties[].name |
String |
This is the name of the property. |
thread[].details[].caseProperties[].properties |
Array |
|
thread[].details[].caseProperties[].logins |
Number |
These are the user logins. |
thread[].details[].caseProperties[].canModifyLogins |
Boolean |
This represents whether user can modify their logins or not. |
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 |
This returns all properties and their values if property value set in interaction. see Property value. |
question[].details |
Object |
This describes the status and other properties like interaction id/type, segment/topic, resolved/approved by and assigned to. |
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 is the time stamp of the status change log. |
question[].details[].statusAudit[].date |
String |
This is the date of the status change log. |
question[].details[].statusAudit[].action |
String |
This is the action name. |
question[].details[].statusAudit[].modifierID |
String |
This is the user ID by whom status was modified. |
question[].details[].statusAudit[].modifierName |
String |
This is the user name by whom status was modified. |
question[].details[].statusAudit[].topicID |
String |
This is the topic ID of the interaction. |
question[].details[].statusAudit[].topicName |
String |
This represents the topic name of the interaction. |
question[].details[].statusAudit[].assignedToID |
Number |
This represents the user ID to whom interaction was assigned. |
question[].details[].statusAudit[].assignedToName |
Number |
This represents the user name to whom interaction was assigned. |
question[].details[].statusAudit[].statusID |
String |
This is the status ID. |
question[].details[].statusAudit[].statusName |
String |
This is 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 the user ID to whom question was assigned. |
question[].details[].assignedToName |
String |
This is the user display name to whom question was assigned. |
question[].details[].modifiedByName |
String |
This is the user name by whom question was modified. |
question[].details[].approvedByName |
String |
This is the user name by whom question 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 email to which the E-mail is being sent. |
question[].details[].cc |
String |
This is the CC email address. |
question[].details[].bcc |
String |
This is the BCC email address. |
response |
Object |
This is the question 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 |
{ |