Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.


Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

Transfer

This operation is part of the Chat API section of the Web Services API.

Overview

This transfers a chat to another agent or to a queue.

Request URL /api/v2/me/chats/{id}
HTTP Method POST
Required Features api-multimedia

Parameters

Parameter Value
operationName Transfer
targetUri or queueName user or queue to transfer to
text (Optional) The text to send to the customer.
messageType (Optional) Defines the message type. The default value is Text. Note that this parameter must be provided together with the text parameter.
treatAs (Optional) Specifies how the message should be treated: Normal or System. The default value is Normal. Note that this parameter must be provided together with the text parameter.

Sample

Request

Transfer to Agent

POST api/v2/me/chats/0071023821aec011
{
  "operationName": "Transfer",
  "targetUri": "http://localhost:8080/api/v2/users/e62d21e405a04274bd6bbcaf78bd8c38"
}

Transfer to Queue

POST api/v2/me/chats/0071023821aec011
{
  "operationName": "Transfer",
  "queueName": "test-queue"
}

Response

{
  "statusCode": 0
}

Notifications


This page was last edited on May 19, 2017, at 17:15.

Feedback

Comment on this article:

blog comments powered by Disqus