Calls: transfer

Transfers an on-going chat from the currently connected operator to another available operator or queue.

Authentication

LibraryH3lp supports cookie-based authentication. To learn more, you can read the details on authentication.

HTTP and HTTPS

Requests are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

URI

/2011-12-03/queues/{QueueName}/calls/{GuestJid}/{ConversationId}/transfer

HTTP GET

Retrieve a list of users and queues able to accept a transfer.

Response

Returns a JSON response containing a list of queue JIDs (Jabber IDs) and a list of user JIDs.

Example

GET /2011-12-03/queues/example-queue/calls/5189487901334778072897@libraryh3lp.com/1790260/transfer
Note: GET is URL decoded above for clarity.

{
  "queues":
    [
      "test-queue1@chat.libraryh3lp.com",
      "test-queue2@chat.libraryh3lp.com",
    ],
  "users":
    [
      "another-operator@libraryh3lp.com"
    ]
}

HTTP POST

Transfers the chat from the current operator to the specified operator or queue.

Required Parameters

You must POST using the following parameter:

Parameter	Description
target	String which is the JID (Jabber ID) of the operator or queue to which the chat should be transferred.

Response

Returns a JSON response with the following properties:

Property	Description
success	Boolean indicating if the request was successful.
message	Optional. If success is null, message is a string describing the reason for the failed request.

Example - transfer to a queue

POST /2011-12-03/queues/example-queue/calls/5189487901334778072897@libraryh3lp.com/1790260/transfer
target=example-queue@chat.libraryh3lp.com Note: POST is URL decoded above for clarity.

{
  "success": true
}

Example - transfer to an operator

POST /2011-12-03/queues/example-queue/calls/5189487901334778072897@libraryh3lp.com/1790260/transfer
target=example-operator@libraryh3lp.com Note: POST is URL decoded above for clarity.

{
  "success": true
}

HTTP PUT

Not supported.

HTTP DELETE

Not supported.