The forwardexternal API is used to forward/assign an interaction to an anonymous/external agent/user.
UI Reference: The API is called when the ''Forward to External Agent'' button is clicked on the manage messages/my message inbox page.
URI: webapp-api-mw-myqueue?api=forwardexternal
Name |
Type |
Description |
---|---|---|
interactionIDs |
Array |
This represents the multiple interaction IDs used when mass update 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. |
answetr[].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 represents 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 |
String |
This represents 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[].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 represents the default mailbox ID of the segment associated with the interaction. |
answer[].forwardExternalAddress |
Array |
Email address of external agent to whom to send this message. |
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 |
String |
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. |
{ |
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. |
row |
Object |
Object with all the details of the row selected. |
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. |
details |
Object |
This shows all the details related to an interaction. |
details[].interactionProperties |
Array |
This returns all interaction properties and their values if property value set in interaction. |
details[].name |
String |
Name of interaction property |
details[].properties |
Array |
List of property object with name, id, type and value
|
details[].logins |
Number |
List of logins |
details[].canModifyLogins |
Boolean |
This has a value that shows logins are editable or not. |
details[].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 |
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. |
question[].details |
Object |
This object represents 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 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[].assignedToID |
String |
This is the user ID to whom interaction was assigned. |
question[].details[].statusAudit[].assignedToName |
String |
This is the user name to whom interaction was assigned. |
question[].details[].statusAudit[].statusID |
String |
This is the ID of the status. |
question[].details[].statusAudit[].statusName |
String |
This is the 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 |
Number |
This is the user ID to whom interaction was assigned. |
question[].details[].assignedToName |
Number |
This is the user name to whom interaction was assigned. |
question[].details[].modifiedByName |
String |
This is the user name by whom interaction was modified. |
question[].details[].approvedByName |
String |
This is the user 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 email address of the person to whom 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 describes all details related to a response sent. |
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 |
{ |