NAV Navbar
curl

Check widget availability

Overview

Check if chat is currently online for this widget. Please see the cURL tab to the right for an example.

GET /api/v1/chat/{widgetId}

Request Parameters

Data Type Description
widgetId String Unique identifier of chat widget

Sample Request

Please see the cURL tab to the right for an example.

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

Response Parameters

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

Success Response 200 OK

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