POST /api/v2/agentstatus

// NOTE: Make sure to replace the "{api_token}" below with your API token!

  curl \
  -H "Content-Type: application/json" \
  -H "Authorization: {api_token}" \
  -X POST \
  -d '{"agent_id":"{user_email}", "status":"pause", "sub_status":"Gone to lunch"}' \
  https://www.snapengage.com/api/v2/agentstatus

package com.snapengage.samples.agentstatus;

import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Response;

public class Example {

  private static final String apiKey = "{api_token}";

  public static void main(String[] args) {
    WebTarget webTarget = ClientBuilder.newBuilder().build()
        .target("https://www.snapengage.com/api/v2/agentstatus");

    SnapEngageAgentStatus snapEngageAgentStatus =
        new SnapEngageAgentStatus("{user_email}", "online", "Totally ready to chat");

    Response response = webTarget.request().header(HttpHeaders.AUTHORIZATION, apiKey)
        .post(Entity.json(snapEngageAgentStatus));

    System.out.println("Response: " + response.getStatus());
  }
}

// Note: This object is used in all of the Java code samples for the Agent Status API
package com.snapengage.samples.agentstatus;

public class SnapEngageAgentStatus {

  private String agent_id;
  private String status;
  private String sub_status;
  private Long org;
  private Long timestamp;

  private SnapEngageAgentStatus() {
    // no-args constructor required for json serialization/de-serialization
  }

  public SnapEngageAgentStatus(String agent_id, String status, String sub_status) {
    this.agent_id = agent_id;
    this.status = status;
    this.sub_status = sub_status;
  }

  public SnapEngageAgentStatus(String agent_id, String status, String sub_status, Long org, Long timestamp) {
    this(agent_id, status, sub_status);
    this.org = org;
    this.timestamp = timestamp;
  }

  public String getAgent_id() {
    return agent_id;
  }

  public void setAgent_id(String agent_id) {
    this.agent_id = agent_id;
  }

  public String getStatus() {
    return status;
  }

  public void setStatus(String status) {
    this.status = status;
  }

  public String getSub_status() {
    return sub_status;
  }

  public void setSub_status(String sub_status) {
    this.sub_status = sub_status;
  }

  public Long getOrg() {
    return org;
  }

  public void setOrg(Long org) {
    this.org = org;
  }

  public Long getTimestamp() {
    return timestamp;
  }

  public void setTimestamp(Long timestamp) {
    this.timestamp = timestamp;
  }
}

{
    "org": 5406213,
    "agent_id": "wc:[email protected]",
    "status": "pause",
    "sub_status": "Gone to lunch",
    "timestamp": 1551461879355
}

package com.snapengage.samples.agentstatus;

import static com.snapengage.samples.agentstatus.AgentStatusResource.RESOURCE_URL;

import java.util.logging.Logger;

import javax.inject.Singleton;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import com.google.common.base.Strings;

@Singleton
@Path(RESOURCE_URL)
public class AgentStatusResource {

  public static final String RESOURCE_URL = "/snapengage/agentstatus";

  static final String apiToken = "{api_token}";

  @POST
  @Produces(MediaType.APPLICATION_JSON)
  public static Response receiveAgentStatus(SnapEngageAgentStatus snapengageAgentStatus,
      @Context HttpServletRequest request) {

    // Optional check of incoming API token
    String headerApiToken = request.getHeader(HttpHeaders.AUTHORIZATION);
    if (Strings.isNullOrEmpty(headerApiToken) || !headerApiToken.equals(apiToken)) {
      log.severe("Incoming API token is empty or does not match our API token.");
      return Response.status(Response.Status.UNAUTHORIZED).build();
    }

    System.out.println("agentId: " + snapengageAgentStatus.getAgent_id());
    System.out.println("status: " + snapengageAgentStatus.getStatus());
    System.out.println("sub_status: " + snapengageAgentStatus.getSub_status());
    System.out.println("org: " + snapengageAgentStatus.getOrg());
    System.out.println("timestamp: " + snapengageAgentStatus.getTimestamp());

    return Response.ok().build();
  }
}

{
    "code": 400,
    "message": "Detailed message"
}

{
  "widget_id":"ff7b3314-24de-4a4c-b48b-1cf38d19acf0",
  "case_id":"ab992c69-7de8-46cc-9aaa-329d336bc182",
  "timestamp":1554321077338,
  "event":"chatStarted",
  "text":"Greetings!",
  "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36",
  "entry_url":"https://example.com/",
  "page_url":"https://example.com/contact",
  "ip_address":"71.56.219.144",
  "geo":{
    "city":"Boulder",
    "region":"CO",
    "country_code":"US"
  }, 
  "hmacVerificationResult":{
    "verificationProperty":{
      "property":"CaseEmail"
    },
    "content":"[email protected]",
    "status":"VERIFIED"
  }
}

{
  "widget_id":"ff7b3314-24de-4a4c-b48b-1cf38d19acf0",
  "case_id":"ab992c69-7de8-46cc-9aaa-329d336bc182",
  "timestamp":1554321077338,
  "event":"chatStarted",
  "text":"Greetings!",
  "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.86 Safari/537.36",
  "entry_url":"https://example.com/",
  "page_url":"https://example.com/contact",
  "ip_address":"71.56.219.144",
  "geo":{
    "city":"Boulder",
    "region":"CO",
    "country_code":"US"
  }
}

{
  "widget_id":"ff7b3314-24de-4a4c-b48b-1cf38d19acf0",
  "case_id":"ab992c69-7de8-46cc-9aaa-329d336bc182",
  "timestamp":1554321266626,
  "event":"chatClosed"
}

{
  "widget_id":"ff7b3314-24de-4a4c-b48b-1cf38d19acf0",
  "case_id":"ab992c69-7de8-46cc-9aaa-329d336bc182",
  "timestamp":1554321848997,
  "event":"message",
  "from":"visitor",
  "text":"What is your most flexible plan?"
}

{
  "widget_id":"XXX-XXX-XXX-XXX",
  "case_id":"XXX-XXX-XXX-XXX",
  "content":[
    {
      "type":"message",
      "text":"I need to ask you a few questions..."
    },
    {
      "type":"message",
      "text":"Are you willing to travel during the week?",
      "display_responses":[
        {
          "text":"Yes",
          "id": "btn-123"
        },
        {
          "text":"No"
        }
      ]
    }
  ]
}

{
  "widget_id":"XXX-XXX-XXX-XXX",
  "case_id":"XXX-XXX-XXX-XXX",
  "content":[
    {
      "type":"message",
      "text":"Let me show you our pricing page..."
    },
    {
      "type":"command",
      "operation":"GOTO",
      "parameters":"https://example.com/pricing"
    }
  ]
}

{
  "widget_id":"XXX-XXX-XXX-XXX",
  "case_id":"XXX-XXX-XXX-XXX",
  "content":[
    {
      "type":"command",
      "operation":"BYE"
    }
  ]
}

{
  "widget_id":"XXX-XXX-XXX-XXX",
  "case_id":"XXX-XXX-XXX-XXX",
  "content":[
    {
      "text":"Which is better?",
      "type":"message"
    },
    {
      "operation":"CARDS",
      "parameters":{
        "type":"cards",
        "layout":"VERTICAL",
        "cards":[
          {
            "title":"5 Reasons Life Is Better For Cat People",
            "excerpt":"But science tells us there are some unique benefits that come with cats.",
            "link":"https://www.businessinsider.com/why-cats-are-better-than-dogs-2015-1"
          },
          {
            "title":"11 Scientific Reasons Dogs Are Better Than Cats",
            "excerpt":"I can recognize the vast benefits of owning a dog over a litter-trained furball",
            "link":"https://www.businessinsider.com/11-reasons-dogs-are-better-than-cats-2014-4"
          }
        ]
      },
      "type":"command"
    }
  ]
}

{
  "widget_id":"XXX-XXX-XXX-XXX",
  "case_id":"XXX-XXX-XXX-XXX",
  "content":[
    {
      "type":"command",
      "operation":"TAG_TRANSFER",
      "parameters":"ZZZZ-ZZZZ-ZZZZ-ZZZZ [\"TAG1\", \"TAG2\"]"
    }
  ]
}

{
  "widget_id":"XXX-XXX-XXX-XXX",
  "case_id":"XXX-XXX-XXX-XXX",
  "content":[
    {
      "type":"command",
      "operation":"LABEL",
      "parameters":"[{\"labelName1\": [\"labelValue1\"]},{\"labelName2\": [\"labelValue1\",\"labelValue2\"]}]"
    }
  ]
}

{
  "widget_id": "XXX-XXX-XXX-XXX",
  "case_id": "XXX-XXX-XXX-XXX",
  "timestamp": 1573467739035,
  "event": "commandResult",
  "failedCommands": [
    {
      "operation": "WIDGET_TRANSFER",
      "params": "XXX-XXX-XXX-XXX",
      "error": "NO_AGENTS_AVAILABLE"
    }
  ]
}

{
    "widget_id": "beaa0150-5a54-4a58-96e1-cc7971239d75",
    "widget_name": "Paddy's Irish Pub",
    "case_id": "2e3362fc-b537-4a16-bd0b-4b5d4108c53d",
    "agent_id": "wc:[email protected]",
    "agent_email": "[email protected]",
    "agent_alias": "Charlie Boy",
    "event": "caseLabeled",
    "timestamp": 1551461879355,
    "label": {
        "value": "new chat",
        "name": "chatType"
    },
    "survey_score": 75,
    "survey_comment": "really helpful"
}

window.addEventListener(
    "message",
    (event) => {
        if (event.origin !== "https://www.snapengage.com") return;
        console.log(event.data);
        // ...
        // Events are present inside event.data
        // You can use data inside event.data by assigning a variable
        // e.g.: let eventPayload = event.data
    },
    false
);

{
    origin:"https://snapengage.com",
    isTrusted: true,
    ....
    data: {
        "type": <conversation_event_type>
        "conversationId": <string>
        ....
    },
};

{
  "type": conversation_started,
  "conversationId": string,
  "agentEmail": string,
  "data": {
     "type": "Text",
     "text": data.message,
     },
}

{
  "type": name_captured,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "name": visitor_name
   }
}

{
  "type": agent_message_received,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      message¹
   }
}

{
  "type":  visitor_message_received,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      message¹
   }
}

{
  "type":  visitor_typing,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      message¹
   }
}

{
  "type":  visitor_page_update,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "page": new URL
   }
}

{
  "type": conversation_closed_by_visitor,
  "conversationId": string,
}

{
  "type": phone_captured,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "phone": visitor_phone
   }
}

{
  "type": email_captured,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "phone": visitor_email
   }
}

{
  "type": reclaim_transfer_request,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": request_file,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": request_secure_data,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "secure_data_type": SSN|Credit Card|Secure Note
   }
}

{
  "type": ban_user,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": call_me,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": visitor_transcript_request,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": widget_changed,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "changed_widget": widget_name
   }
}

{
  "type": ignore,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": record,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": auto_translate_enabled,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": auto_translate_disabled,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": auto_translate_language_changed,
  "conversationId": string,
  "agentEmail": string,
}

{
  "type": weather_info_captured,
  "conversationId": string,
  "agentEmail": string,
   "data": {
      "temperature_celsius":  °C,
      "temperature_fahrenheit":  °F,
      "description": weather description
   }
}

"message": {
    "type": "text",
    "text": "some text",
}

"message": {
    "type": "File",
    "mimeType": "depending upon the configured type",
    "fileName": "file name",
    "url": "file uploaded URL",
    "mimeTypeUrl": "mimeType specification",
}

{
  let message =  {
  type: "agent_message_received",
  conversationId: "bce21499-50e4-4728-b5f8-6ed57e490bf2&d",
  agent: <email address of the signed in agent into the Hub>,
  data: {
      "message": "message from agent",
},
   },

  // after having the message structure, finally you can make a call to send
  // the data to Hub

  window.parent.postMessage(message, "*");
}

{
  "type": agent_message_received,
  "conversationId": string,
  "agent": "email address",
  "data": {
     "text": message_to_send
  }
}

{
  "type": conversation_closed_by_agent,
  "conversationId": string,
  "agent": "email address",
}

{
  "type": label_added,
  "conversationId": string,
  "agent": "email address",
  "data": {
    "labelName": string,
    "freeForm": boolean,
    "value": string,
    }
}

{
  "type": label_removed,
  "conversationId": string,
  "agent": "email address",
   "data": {
      "labelName": string,
      "freeForm": boolean,
      "value": string,
   }
}

{
  "type": transfer_request,
  "conversationId": string,
  "agent": "email address",
   "data": {
      "widgetId": widget public Id to which the conversation should be transfered
   }
}

{
  "type": reclaim_transfer_request,
  "conversationId": string,
  "agent": "email address",
}

{
  "type": request_file,
  "conversationId": string,
  "agent": "email address",
}

{
  "type": request_secure_data,
  "conversationId": string,
  "agent": "email address",
   "data": {
      "secure_data_type": SSN|Credit Card|Secure Note
   }
}

{
  "type": ban_user,
  "conversationId": string,
  "agent": "email address",
  "data": {
   "type": "cookie" or "IP",
 }
}

{
  "type": populate_text,
  "conversationId": string,
  "agent": "email address",
  "data": {
   "message": "text to send",
 }
}

$json = fopen("php://input","r");

{
    "id": "8b7c3b3b-f5d7-4e58-96d8",
    "widget_id": "e8175843-d381-4d7c-aa9f-0da1610ad1b",
    "url": "https://www.snapengage.com/viewcase?c=8b7c3b3b-f5d7-4e58-96d8",
    "type": "chat",
    "requested_by": "[email protected]",
    "requester_details":
      {
        "name": "Jim Tester",
        "emails": ["[email protected]"],
        "name_profile_link": "http://facebook.com/jimtester",
        "phones": ["555-555-1010"],
        "address": "111 2nd Ave.",
        "address_2": "",
        "city": "Boulder",
        "state": "CO",
        "zip": "80303",
        "country": "US",
        "company_name": "SnapEngage",
        "company_profile_link": "http://facebook.com/snapengage",
        "employees": "Abe,Betty,Charlie",
        "revenue": "100",
        "title": "CEO",
        "website": "www.snapengage.com",
        "social_profile_links": ["www.facebook.com/jimatsnapengage","www.twitter.com/jimtesteratsnap"],
        "gender": "Male",
        "age": 44,
        "influencer_score": "88.8",
        "notes": "This is just for testing",
        "industry": "Tech",
        "avatars": ["http://www.avatars.com/jimtester"],
        "other_data": []
      },
    "description": "Testing the Integration API...",
    "created_at_date": "Oct 3, 2014 2:14:31 PM",
    "created_at_seconds": 1412367271,
    "created_at_milliseconds": 268,
    "proactive_chat": false,
    "page_url": "http://www.snapengage.com/demo/integrationapi.html",
    "referrer_url": "http://www.comingfromurl.com",
    "entry_url": "http://www.yoursite.com",
    "ip_address": "67.174.108.196",
    "user_agent": "Mozilla/5.0 (Windows; U; Windows NT 6.0; en-US) AppleWebKit/532.0 (KHTML, like Gecko) Chrome/3.0.195.27 Safari/532.0,gzip(gfe)",
    "browser": "Chrome (3.0.195.27)",
    "os": "Microsoft Windows Vista",
    "country_code": "US",
    "country": "United States",
    "region": "16",
    "city": "Boulder",
    "latitude": 39.914700,
    "longitude": -105.080902,
    "source_id": 2,
    "chat_waittime": 2,
    "chat_duration": 15,
    "chat_ended_by": "agent",
    "language_code": "en-US,en;q=0.8",
    "transcripts": [
      {
        "id": "",
        "date": "Oct 3, 2014 2:14:31 PM",
        "date_seconds": 1412367271,
        "date_milliseconds": 154,
        "alias": "visitor",
        "message": "Hola, ",
        "translations": {
          "en": "Hello,"
        },
        "sender": "VISITOR"
      },
      {
        "id": "[email protected]",
        "date": "Oct 3, 2014 2:14:31 PM",
        "date_seconds": 1412367271,
        "date_milliseconds": 456,
        "alias": "test",
        "message": "Good day",
        "translations": {
          "es": "Buen día"
        },
        "sender": "AGENT"
      },
      {
        "id": "",
        "date": "Oct 3, 2014 2:14:31 PM",
        "date_seconds": 1412367271,
        "date_milliseconds": 835,
        "alias": "visitor",
        "message": "Esto es una prueba.",
         "translations": {
          "en": "This is a test."
        },
        "sender": "VISITOR"
      }
    ],
    "javascript_variables": [{
        "name": "variable1",
        "value": "v1_1234"
    }, {
        "name": "variable2",
        "value": "v2_123456789"
    }],
    "operator_variables": [{
        "name": "note",
        "value": "this is a note entered by the agent"
    }, {
        "name": "customerTemp",
        "value": "Very Happy"
    }],
    "labels": [{
        "name": "note",
        "value": "this is a note entered by the agent"
    }, {
        "name": "customerTemp",
        "value": "Very Happy"
    }]
}

<?xml version="1.0" encoding="UTF-8"?>
<case>

  <id><![CDATA[8b7c3b3b-f5d7-4e58-96d8]]></id>
  <url>http://www.snapengage.com/viewcase?c=8b7c3b3b-f5d7-4e58-96d8</url>
  <requested_by><![CDATA[[email protected]]]></requested_by>
  <description><![CDATA[Testing the Integration API...]]></description>
  <created_at type="datetime">2010-10-18T01:48:18.623Z</created_at>
  <page_url>http://www.snapengage.com/demo/integrationapi.html></page_url>
  <ip_address>67.174.108.196</ip_address>
  <browser>Chrome (6.0.472.63)</browser>
  <os>Microsoft Windows 7</os>
  <country_code>US</country_code>
  <country>United States</country>
  <region>CO</region>
  <city><![CDATA[Boulder]]></city>
  <latitude>39.914700</latitude>
  <longitude>-105.080902</longitude>
  <source_id type="integer">2</source_id>

  <languages type="array">
    <language>
      <name><![CDATA[English]]></name>
<![CDATA[en-US]]>
    </language>
    <language>
      <name><![CDATA[German]]></name>
<![CDATA[de-DE]]>
    </language>
  </languages>

  <plugins type="array">
    <plugin>
      <name>Flash</name>
      <value>10.0.45</value>
    </plugin>
    <plugin>
      <name>Java</name>
      <value>1.6</value>
    </plugin>
  </plugins>

  <javascript_variables type="array">
    <javascript_variable>
      <name><![CDATA[userid]]></name>
      <value><![CDATA[ab123456789]]></value>
    </javascript_variable>
  </javascript_variables>

  <operator_variables type="array">
   <operator_variable>
     <name><![CDATA[note]]></name>
     <value><![CDATA[this is a note entered by the agent]]></value>
    </operator_variable>
  </operator_variables>

  <labels type="array">
   <label>
     <name><![CDATA[note]]></name>
     <value><![CDATA[this is a note entered by the agent]]></value>
   </label>
 </labels>

  <transcripts type="array">
    <transcript>
      <id>[email protected]</id>
      <date type="datetime">Mon Oct 18 01:48:27 UTC 2010</date>
      <alias>test</alias>
      <message>Hello, </message>
    </transcript>
    <transcript>
      <id></id>
      <date type="datetime">Mon Oct 18 01:48:32 UTC 2010</date>
      <alias>visitor</alias>
      <message>Hi,</message>
    </transcript>
    <transcript>
      <id></id>
      <date type="datetime">Mon Oct 18 01:48:41 UTC 2010</date>
      <alias>visitor</alias>
      <message>This is a test.</message>
    </transcript>
    <transcript>
      <id>[email protected]</id>
      <date type="datetime">Mon Oct 18 01:48:49 UTC 2010</date>
      <alias>test</alias>
      <message>ok. thank's for testing. </message>
    </transcript>
  </transcripts>

  <chat_waittime type="integer">2</chat_waittime>
  <chat_duration type="integer">15</chat_duration>
  <referrer_url><![CDATA[http://refering.url/]]></referrer_url>
  <entry_url><![CDATA[http://entry.url/]]></entry_url>

 </case>

<!-- begin SnapEngage code -->
<script type="text/javascript">
  (function() {
    var se = document.createElement('script'); se.type = 'text/javascript'; se.async = true;
    se.src = '//storage.googleapis.com/code.snapengage.com/js/...';
    var done = false;
    se.onload = se.onreadystatechange = function() {
      if (!done&&(!this.readyState||this.readyState==='loaded'||this.readyState==='complete')) {
        done = true;
        /* Place your SnapEngage JS API code below */
        /* Example JS API: Enable sounds for Visitors. */
        var allow = true;
        SnapEngage.allowChatSound(allow);
      }
    };
    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(se, s);
  })();
</script>
<!-- end SnapEngage code -->

SnapEngage.setCallback('Close', function (type, status) {
    console.log('type: ' + type);
    console.log('status: ' + status);
});

SnapEngage.setCallback('Close', function (type, status) {
    console.log('A visitor just closed the ' + type + ' window.');
});

// The callback above returns this
// when the visitor closes a chat window
'A visitor just closed the chat window.'

SnapEngage.setCallback('Close', function (type, status) {
    console.log('A visitor closed a ' + type +
     ' and the widget is ' + status + '.');
})

// The callback above returns this
// when the visitor closes a form
'A visitor closed a form and the widget is offline.'

SnapEngage.setCallback('ChatMessageReceived', function (agent, msg) {
    console.log('agent: ' + agent);
    console.log('msg: ' + msg);
});

SnapEngage.setCallback('ChatMessageReceived', function (agent, msg) {
    console.log('A visitor received a chat message from ' + agent);
    console.log('And the msg was: ' + msg);
});

// The callback above returns this
// when the visitor receives a chat message
'A visitor received a chat message from Samantha';
'And the msg was: hello ';

SnapEngage.setCallback('ChatMessageSent', function (msg) {
    console.log('msg: ' + msg);
});

SnapEngage.setCallback('ChatMessageSent', function (msg) {
    console.log('A visitor sent this chat message: ' + msg);
});

// The callback above returns this
// when a visitor sends a chat message
'A visitor sent this chat message: What does SnapEngage integrate with?';

SnapEngage.setCallback('MessageSubmit', function (email, msg) {
    console.log('email: ' + email);
    console.log('msg: ' + msg);
});

SnapEngage.setCallback('MessageSubmit', function (email, msg) {
    console.log(email + ' just submitted an offline message.');
    console.log('The message was: ' + msg);
});

// The callback above returns this
// when an offline message is submitted
'[email protected] just submitted an offline message.'
'The message was: hello!';

SnapEngage.setCallback('Minimize', function(isMinimized, chatType, boxType) {
    // Handle results.
    console.log('Chatbox is' + (isMinimized ? '' : ' not') + ' minimized');
    console.log('Chat Type is: ' + chatType);
    console.log('Chat Box is: ' + boxType);
});

SnapEngage.setCallback('Minimize', function(isMinimized, chatType, boxType) {
    // Handle results.
    console.log('Chatbox is' + (isMinimized ? '' : ' not') + ' minimized');
    console.log('Chat Type is: ' + chatType);
    console.log('Chat Box is: ' + boxType);
});

// The callback above returns this
// when a visitor has minimized a manual live chat:
'Chatbox is minimized'
'Chat Type is manual'
'Chat Box is chatManual'

SnapEngage.setCallback('Open', function (status) {
    console.log('status: ' + status);
});

SnapEngage.setCallback('Open', function (status) {
    console.log('A form just opened and the widget status is: ' + status);
});

// The callback above returns this
// when a form is opened and the widget is offline
'A form just opened and the widget status is: offline'

SnapEngage.setCallback('OpenProactive', function (agent, msg) {
    console.log('agent: ' + agent);
    console.log('msg: ' + msg);
});

SnapEngage.setCallback('OpenProactive', function (agent, msg) {
    console.log('A proactive message just popped up. The agent shown is ' +
     agent + '.');
    console.log('The proactive message used is: ' + msg);
});

// The callback above returns this
// when a proactive prompt opens
'A proactive message just popped up. The agent shown is Samantha.';
'The proactive message used is: You know nothing, Jon Snow.';

SnapEngage.setCallback('StartChat', function (email, msg, type) {
    console.log('email: ' + email);
    console.log('msg: ' + msg);
    console.log('type: ' + type);
});

SnapEngage.setCallback('StartChat', function (email, msg, type) {
    console.log(email + ' just started a ' + type + ' chat.');
    console.log('The message was: ' + msg);

});

// The callback above returns this
// when the visitor starts a manual chat
'[email protected] just started a manual chat.';
'The message was: The King in the North!';

SnapEngage.setCallback('StartCallme', function (phone) {
    console.log('phone: ' + phone);
});

SnapEngage.setCallback('StartCallMe', function (phone) {
    console.log('A visitor just started a callme request.');
    console.log('Their phone number is ' + phone);
});

// The callback above returns this
// when the visitor starts a callme request
'A visitor just started a callme request.'
'Their phone number is 555-1234';

SnapEngage.setCallback('SwitchWidget', function(newWidgetId) {
    // Handle results.
    console.log('I just switched to widget ID: ' + newWidgetId);
});

SnapEngage.setCallback('SwitchWidget', function(newWidgetId) {
    // Handle results.
    console.log('I just switched to widget ID: ' + newWidgetId);
});

// The callback above returns this
// when a visitor has selected an option:
'I just switched to widget ID: 123-abc'

SnapEngage.setCallback('InlineButtonClicked', function(options) {
    console.log('A visitor clicked on a bot button sent from ' + options.botName);
    console.log('And the button label was: ' + options.buttonLabel);
    console.log('And the button value was: ' + options.buttonValue);
});

SnapEngage.setCallback(SnapEngage.callbacks.CHAT_ENDED, function(options) {
    console.log('Who has ended the chat?');
    console.log(options.endedByUser ? "Visitor" : "Agent or the System");
});

SnapEngage.setCallback('RatingPromptClicked', function (botAlias, scaleType, selectedOption) {
    console.log('botAlias: ' + botAlias);
    console.log('scaleType: ' + scaleType);
    console.log('selectedOption: ' + selectedOption);
});

var allow = true;
SnapEngage.allowChatSound(allow);

var allow = true;
SnapEngage.allowPageChangeNotification(allow);

var allow = true;
SnapEngage.allowProactiveChat(allow);

var allow = true;
SnapEngage.allowScreenshot(allow);

SnapEngage.clearAllCookies();

SnapEngage.disableLighbox();

SnapEngage.getAgentStatusAsync(function (online) {
    if (online) {
        console.log('chat is online/available');
    } else {
        console.log('chat is offline');
    }
});

SnapEngage.getAgentStatusAsync(function (online) {
    if (!online) {
        SnapEngage.hideButton();
    }
});

// Using Javascript
SnapEngage.getAgentStatusAsync(function (online) {
    if (!online) {
        document.getElementById('myInlineButtonId').style.display = 'none';
    }
});

// Using jQuery
SnapEngage.getAgentStatusAsync(function (online) {
    if (!online) {
        $('#myInlineButtonId').hide();
    }
});

var threeMinutes = 3 * 60 * 1000;
var tid = setTimeout(checkChatStatus, threeMinutes);

// Check the widget status every three minutes
function checkAgentStatus() {
    SnapEngage.getAgentStatusAsync(function(online) {
        if (online) {
            SnapEngage.showButton();
        } else {
            SnapEngage.hideButton();
        }
    });

    // Recursive call
    clearTimeout(tid);

    // Set another three minute time out
    tid = setTimeout(checkAgentStatus, threeMinutes);
}

SnapEngage.getWidgetId();

// An example widget ID is returned from the call above
'1z1z1z1z1-y2y2-x3x3-w4w4-v5v5v5v5v5v'

SnapEngage.setCallback('StartChat', function(email, msg, type) {
    var success = false;
    var tid;

    function sendWidgetName() {
        var currWidget = SnapEngage.getWidgetId();

        // For each different widget ID, send a message to the agent with that widget's name
        switch (currWidget) {
            case 'xxxxx-xxxx-xxxx-xxxx' :
                success = SnapEngage.sendTextToChat('A Widget\'s Name');
                break;
            case 'yyyyyy-yyyy-yyyy-yyyyy' :
                success = SnapEngage.sendTextToChat('Other Widget\'s Name');
                break;
            default :
                success = SnapEngage.sendTextToChat('Error fetching Widget Name');
                break;
        }
    }

    // Call the function above
    sendWidgetName();

    if (!success) {
        clearTimeout(tid);

        // Try again every two seconds until success.
        tid = setTimeout(sendWidgetName, 2000);
    }
});

SnapEngage.hideButton();

// Do not open proactive chat if the user has recently
// closed a proactive invite
var forced = false;

// Do not open the offline box if the widget is not online
var offlineFallback = false;

// Do not open the offline box if the widget is not online
var message = 'Hey there! How can I help you today?';

// Regular chat box
var minimizedView = false; 

// Call the API with the above parameters
SnapEngage.openProactiveChat(forced, offlineFallback, message, minimizedView);

// You MUST use sendTextToChat() inside the ChatMessageReceived callback
// which ensures that there is an active chat before the message is sent.
SnapEngage.setCallback('ChatMessageReceived', function (agent, msg) {

    // Send a message to the agent
    var text = 'Remember to mention the current promotion!';
    SnapEngage.sendTextToChat(text);

    // Now clear the ChatMessageReceived callback since you
    // just sent the message. (Otherwise, this callback will
    // send the message every time ChatMessageReceived fires)
    SnapEngage.setCallback('ChatMessageReceived', '');

});

// You MUST use sendTextToChat() inside the ChatMessageReceived callback
// which ensures that there is an active chat before the message is sent.
SnapEngage.setCallback('ChatMessageReceived', function (agent, msg) {

    // Send a message to the visitor
    var text = 'Thanks for chatting! Here is a 10% off coupon code: TENOFF';
    SnapEngage.sendTextToChat(text, 'visitor');

    // Now clear the ChatMessageReceived callback since you
    // just sent the message. (Otherwise, this callback will
    // send the message every time ChatMessageReceived fires)
    SnapEngage.setCallback('ChatMessageReceived', '');

});

// if the call above returns 'false', it means
// there is an active chat and the message was
// sent to the visitor.
false

var negativePixels = '-4px';
SnapEngage.setButtonEffect(negativePixels);

// Set the legacy chatbox to pop up in the 'tl' (top left)
// corner of the browser window
var position = 'tl';
SnapEngage.setChatFormPosition(position);

var fieldName = 'Company';
var fieldValue = 'Vandelay Industries';

SnapEngage.setCustomField(fieldName, fieldValue);

var description = 'Hello! I need help!';
SnapEngage.setDescription(description);

var languageCode = 'de';
SnapEngage.setLocale(languageCode);

// Delay the proactive invitation for 10 minutes
var delayInMinutes = 10;
SnapEngage.setNoProactiveChatDelay(delayInMinutes);

// Autoclose the proactive invitation after 5 minutes of inactivity
var minutes = 5;
SnapEngage.setProactiveAutocloseDelay(minutes);

var email = '[email protected]';

// Set the email field
SnapEngage.setUserEmail(email);

// Do the same as above AND make the email field read-only
// i.e. not editable for the visitor
SnapEngage.setUserEmail(email, true);

var name = 'Arya Stark';
SnapEngage.setUserName(name);