Please enable JavaScript to view this site.

iService API Documentation

Navigation: iService API Forms > My Work Queue

Assign message on Get Next (api=getnext)

Scroll Prev Top Next More

Purpose

 

The getnext API is used to get the next message in My Message Inbox Menu.

 

UI Reference: The API is called when the get next button is clicked on any page.

 

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

 

 

 

Request

 

 

Request Parameters

Name

Type

Description

__TZO__

String

Not used

_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

{
  "__TZO__": "+05:30",
  "_pageAction": "MyQueueGetNext",
  "_pageName": "default"
}

 

 

 

Response

 

 

Response Parameters

Name

Type

Description

id 

String

The id of interaction.

details

Object

This returns all details of the object of interaction.

details[].id

String

This returns the id of interaction.

details[].threadID

String

The id of the case that the interaction is in. If its the same as id, then its the root interaction.

details[].customerID

String

This returns the id of the customer.

details[].customerName

String

This returns the name of the customer.

details[].fromAddress

String

Email address who has initiated the interaction.

details[].date

String

This returns the date of interaction.

details[].subject

String

This returns the subject of interaction.

details[].subjectBare

String

The subject without the reference number prepended.

details[].type

String

This is a type of interaction like Agent Email or Note or Ticket.

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.

details[].status

String

This is the status value of interaction according to interaction type.

details[].topicID

String

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

details[].topicName

String

This has the value of the topic name in which interaction belongs to.

details[].agentName

String

This has an email address who has initiated the interaction.

details[].assignedToID

String

This has an id of an agent who has been assigned to this interaction.

details[].segmentID

String

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

details[].segmentName

String

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

details[].properties

Array

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

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.

 

 

 

Response Example

{
  "id": "45538",
  "details": {
    "id": "45538",
    "threadID": "45538",
    "customerID": "92",
    "customerName": "John Bastion",
    "fromAddress": "customer4@1to1service.com",
    "date": "2021-10-28T20:31:20.2330000Z",
    "subject": "[ref#: 45538-45538] Will I have to pay customs duties and taxes?",
    "subjectBare": "Will I have to pay customs duties and taxes?",
    "type": "Ask A Question",
    "tags": [],
    "status": "Queued",
    "topicID": "6",
    "topicName": "Shipping",
    "agentName": "Niraj Raba",
    "assignedToID": "510",
    "segmentID": "2",
    "segmentName": "e-shop",
    "properties": []
  },
  "numCanGet": 0,
  "numCanApprove": 0
}

 

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