Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Assign a question to an agent (api=assign)

Scroll Prev Top Next More

Purpose

 

The assign API is used to used to assign a specific interaction to another agent.

 

UI Reference: The API is called when the ''assign'' button is clicked on manage messages.

 

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

 

 

 

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 whom interaction was forward.

answer[].contactID

String

This represents the customer ID.

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

Boolean

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 after success or not.

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 notification ID

answer[].bodyHtml

String

Body contents of response with html format.

answer[].removedInLineAttachments

Array

This represents the inline attachments.

answer[].mailboxID

String

This represents the mailbox ID.

answer[].note

String

This represents the private comments.

answer[].attachments

Array

This represents the attachments attached to answer.

answer[].destEmail

String

Email address of destination.

answer[].finalHtml

Number

This represents the final 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[].reassignAgentID

String

This represents the agent ID to whom interaction assigned.

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":[

      "35341"

   ],

   "answer":{

      "inResponseToID":"35341",

      "subject":"[ref#: 45529-45529] Can I track my package?",

      "segmentID":"3",

      "topicID":"31",

      "addSubjectRefNum":true,

      "forwardSegmentID":"",

      "contactID":"25081",

      "isMassUpdate":false,

      "caseProperties":null,

      "interactionProperties":null,

      "responseProperties":null,

      "leaveOpen":null,

      "expectReply":null,

      "supressSubjectRef":null,

      "notificationID":null,

      "bodyHtml":"&nbsp;\n<div>On 11/13/2021 12:26:47 AM, kXeHkcontactemail@auto.com &lt;kXeHkcontactemail@auto.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;\">This is ask question body kXeHk</blockquote>\n</div>\n",

      "removedInlineAttachments":[

         

      ],

      "mailboxID":"16",

      "note":"",

      "attachments":[

         

      ],

      "destEmail":"kxehkcontactemail@auto.com",

      "finalHtml":null,

      "finalPlain":null,

      "defaultMailboxID":"16",

      "reassignAgentID":"25048",

      "answerProperties":[

         {

            "propertyID":"14",

            "propertyName":"AnswerProperty",

            "values":[

               

            ]

         }

      ]

   },

   "_pageAction":"Assign",

   "_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

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 the 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[].ssegmentID

String

This has the value of the segment id in which interaction belongs to.

thread[].row[].properties

Array

This represents the interaction properties array.

thread[].details

Object

This object represents the details of root interaction.

thread[].details[].id

String

This represents id of the interaction.

thread[].details[].interactionProperties

Array

This represents the interaction properties of the interaction.

thread[].row[].caseProperties

Array

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

String

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 represents the interaction properties of the interaction.

question[].details

Object

This represents the question details.

question[].details[].id

String

This represents the 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[].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 represents the action name performed when status modified.

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

String

This represents the user ID by whom interaction was modified.

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

String

This represents the user name by whom interaction was modified.

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 is 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 represents the user id to whom question was assigned.

question[].details[].assignedToName

String

This represents the user name to whom question was assigned.

question[].details[].modifiedByName

String

This represents the user name by whom interaction was modified.

question[].details[].approvedByName

String

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

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 response details.

response[].details[].id

String

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

String

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 the plain html body of the interaction.

response[].details[].bodyHtml

String

This has body contents of interaction with html format.

response[].details[].note

String

This represents the private comments 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 the name of the property.

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

Array

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

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

Number

This represents the user logins.

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

Boolean

This represents whether user can modify their logins.

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 returns the attachments of the interaction.

response[].details[].statusAudit

Array

List of status changes log.

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

String

This is the time stamp of status modified.

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

String

This is the date of the status when modified.

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

String

This is the action name.

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

String

This is the user ID by whom interaction was modified.

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

String

This is the user name by whom interaction was modified.

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

String

This is the topic ID.

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

String

This is the topic name.

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 status ID.

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

String

This is the status name.

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

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": 0,

  "numCanApprove": 0,

  "thread": {

    "row": {

      "id": "35341",

      "date": "2021-11-13T06:26:47.0500000Z",

      "subject": "[ref#: 35341-35341] AskQuestion from automation for save as public notekXeHk",

      "type": "Ask A Question",

      "tags": [],

      "assignedToID": "25048",

      "status": "Queued",

      "topicID": "31",

      "topicName": "s1TopicNoInteraction",

      "segmentID": "3",

      "properties": []

    },

    "details": {

      "id": "35341",

      "interactionProperties": [],

      "caseProperties": []

    }

  },

  "question": {

    "row": {

      "id": "35341",

      "date": "2021-11-13T06:26:47.0500000Z",

      "subject": "[ref#: 35341-35341] AskQuestion from automation for save as public notekXeHk",

      "type": "Ask A Question",

      "tags": [],

      "assignedToID": "25048",

      "status": "Queued",

      "topicID": "31",

      "topicName": "s1TopicNoInteraction",

      "segmentID": "3",

      "properties": []

    },

    "details": {

      "id": "35341",

      "status": "Queued",

      "interactionProperties": [],

      "caseProperties": [],

      "statusAudit": [

        {

          "timeStamp": "/Date(1636784807050)/",

          "date": "2021-11-13T06:26:47.0500000Z",

          "action": "Anonymous -> [ undefined : null ] Form Submit (webapp-api-findanswer) -> Ticket/AAQ -> Ask A Question -> Create Composition",

          "modifierID": "25081",

          "modifierName": "kXeHkcontactemail@auto.com",

          "topicID": "31",

          "topicName": "Segment1 -- All Topics -- s1TopicNoInteraction",

          "assignedToID": null,

          "assignedToName": null,

          "statusID": "1",

          "statusName": "Unassigned"

        }

      ],

      "segmentID": "3",

      "segmentName": "Segment1",

      "topicID": "31",

      "topicName": "s1TopicNoInteraction",

      "operatorName": "Round Robin1",

      "assignedToID": "25048",

      "assignedToName": "Round Robin1",

      "modifiedByName": "landlord@qavmmail02",

      "approvedByName": "",

      "resolvedByName": "",

      "toAddress": "",

      "headerFrom": "kXeHkcontactemail@auto.com",

      "headerTo": "",

      "cc": "",

      "bcc": ""

    }

  },

  "response": {

    "row": {

      "id": "35345",

      "date": "2021-11-13T06:27:42.5800000Z",

      "subject": "AskQuestion from automation for save as public notekXeHk",

      "type": "Unsent Response",

      "tags": [],

      "assignedToID": "",

      "status": "Unsent",

      "topicID": "31",

      "topicName": "s1TopicNoInteraction",

      "segmentID": "3",

      "properties": []

    },

    "details": {

      "id": "35345",

      "date": "2021-11-13T06:27:42.5800000Z",

      "type": "Unsent Response",

      "tags": [],

      "subject": "AskQuestion from automation for save as public notekXeHk",

      "status": "Unsent",

      "bodyPlain": "On 11/13/2021 12:26:47 AM, kXeHkcontactemail@auto.com <kXeHkcontactemail@auto.com> wrote:\r\n> This is ask question body kXeHk\r\n\r\n",

      "bodyHtml": "&nbsp;\n<div>On 11/13/2021 12:26:47 AM, kXeHkcontactemail@auto.com &lt;kXeHkcontactemail@auto.com&gt; wrote:\n<blockquote style=\"border-left: 1px solid #cccccc; margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex\">This is ask question body kXeHk</blockquote>\n</div>\n",

      "note": "",

      "interactionProperties": [

        {

          "name": "Segment1",

          "properties": [

            {

              "propertyID": "14",

              "name": "AnswerProperty",

              "isDate": false,

              "isDatetime": false,

              "isInteger": false,

              "isNumber": false,

              "allowMultiple": false,

              "hasDescriptions": false,

              "isMultiLine": false,

              "isReadOnly": false,

              "isRequired": false,

              "values": [],

              "valueChoices": [],

              "descriptionChoices": []

            }

          ],

          "logins": null,

          "canModifyLogins": false

        }

      ],

      "caseProperties": [],

      "attachments": [],

      "statusAudit": [

        {

          "timeStamp": "/Date(1636784862580)/",

          "date": "2021-11-13T06:27:42.5800000Z",

          "action": "Contact 2 -> [ messagequeue#/mymessageinbox : AutoSave ] Form Submit (webapp-api-mq-myqueue) -> Save Draft -> Question 35341 -> Update Response -> Create -> Create Composition",

          "modifierID": "2",

          "modifierName": "s1topic1csr@qavmmail02",

          "topicID": "31",

          "topicName": "Segment1 -- All Topics -- s1TopicNoInteraction",

          "assignedToID": null,

          "assignedToName": null,

          "statusID": "6",

          "statusName": "Unsent"

        }

      ],

      "segmentID": "3",

      "segmentName": "Segment1",

      "topicID": "31",

      "topicName": "s1TopicNoInteraction",

      "assignedToID": "",

      "operatorName": ""

    }

  }

}

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