Check Widget Availability
(Last Updated On: June 25, 2013)
Overview

Check if chat is currently online for this widget.

GET /api/v1/chat/{widgetId}

Request Parameters
widgetId Unique identifier of chat widget

Sample Request
curl -i -H 'X-Api-Key:4a9fecdd4c344f279a59d9446157636e' 'https://www.snapengage.com/api/v1/chat/204557b4-f777-46be-b31b-e660d721364d'

Response Parameters
emailRequired An email address is required when starting a new chat.
messageRequired The initial message is required when starting a new chat.
online This chat widget is available to start a chat.
screenshotRequired This chat widget requires a screenshot.
widgetId Widget UUID from request.

Success Response

200 OK

{
   "emailRequired":"true",
   "messageRequired":"true",
   "online":"false",
   "screenshotRequired":"false",
   "widgetId":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Error Responses

Please see the Error Responses document.