Revision as of 19:45, April 14, 2014 by Clondon (talk | contribs)
Jump to: navigation, search

Accept

This operation can be performed after a new chat notification arrives.

Accepting allows the agent to start working on a chat.

After successfully executing this operation, a CometD notification will arrive with complete chat history.

Overview

This request accepts an incoming chat.

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

Parameters

Parameter Value
operationName Accept
nickname agent nickname as will be seen by customer

Sample

HTTP Request

POST on /me/chats/{id}

{
  "operationName":"Accept",
  "nickname":agent-nickname-to-be-displayed-in-chat
}

HTTP Response

Success

{
  "statusCode": 0
}

Failure

{
  "statusCode": an integer value above 0,
  "statusMessage":details
}

For details on the statusCode value, please refer to the All Methods sub-section of the Return Values section.

Comments or questions about this documentation? Contact us for support!