{"id":7598,"date":"2018-10-31T12:54:25","date_gmt":"2018-10-31T12:54:25","guid":{"rendered":"https:\/\/www.gosquared.com\/blog\/?p=7598"},"modified":"2019-11-28T10:57:14","modified_gmt":"2019-11-28T10:57:14","slug":"live-chat-api","status":"publish","type":"post","link":"https:\/\/www.gosquared.com\/blog\/live-chat-api","title":{"rendered":"Introducing the Live Chat API (beta)"},"content":{"rendered":"<p><img decoding=\"async\" src=\"https:\/\/static.gosquared.com\/images\/liquidicity\/18_10_31_livechatapi\/livechatapi_01@2x.jpg\" alt=\"GoSquared Live Chat API Docs icon\"\/><\/p>\n<p>We&#8217;re really excited to announce the <a href=\"https:\/\/www.gosquared.com\/docs\/api\/chat\" rel=\"noopener noreferrer\" target=\"_blank\">GoSquared Live Chat API<\/a> is now available.<\/p>\n<p><a href=\"https:\/\/www.gosquared.com\/live-chat\/\" rel=\"noopener noreferrer\" target=\"_blank\">GoSquared Live Chat<\/a> is used by hundreds of businesses to connect with their website visitors, leads, and customers every day.<\/p>\n<p>The Live Chat API gives you the ability to use the power of GoSquared Live Chat for a huge range of needs beyond the scope of what we could ever build.<\/p>\n<ul>\n<li>Automatically send messages\u00a0\u2013 automate messages from your team to your visitors and customers.<\/li>\n<li>Improve your workflows \u2013 automatically leave notes and archive conversations.<\/li>\n<li>Strengthen security and compliance \u2013 export and store customer communications at scale.<\/li>\n<\/ul>\n<p>With the new API, you can now automatically send messages from your team, leave notes on conversations in Inbox, and archive conversations \u2013 all in code.<\/p>\n<p><a href=\"https:\/\/www.gosquared.com\/docs\/api\/chat\/\" rel=\"noopener noreferrer\" target=\"_blank\"><strong>View the Live Chat API (beta) docs<\/strong><\/a><\/p>\n<h2>Why we&#8217;re excited about the Live Chat API<\/h2>\n<p><a href=\"https:\/\/www.gosquared.com\/docs\/api\/chat\/\" rel=\"noopener noreferrer\" target=\"_blank\"><img decoding=\"async\" src=\"https:\/\/static.gosquared.com\/images\/liquidicity\/18_10_31_livechatapi\/livechatapi_02@2x.jpg\" alt=\"GoSquared Live Chat API Docs screenshot\"\/><\/a><\/p>\n<p>GoSquared Live Chat, combined with Assistant on our customers&#8217; websites, has become an integral part of the marketing and sales process for hundreds of businesses. We want to give our customers even more flexibility to embed personal messaging in their existing workflows.<\/p>\n<p>For example, the Live Chat API now allows businesses to trigger personal messages instantly based on server-side events, such when customers make a purchase, upgrade their plan, or change a setting. This means you can reach out automatically with a personalised message at the perfect moment, giving you the highest chance of engagement.<\/p>\n<p>As ever more business-to-customer communication is moving online to messaging tools like <a href=\"https:\/\/www.gosquared.com\/assistant\/\" rel=\"noopener noreferrer\" target=\"_blank\">GoSquared Assistant<\/a>, we&#8217;re fully committed to making it easy for our customers to retrieve those conversations and connected information for reporting purposes.<\/p>\n<h2>Programatically engage with GoSquared Live Chat<\/h2>\n<h3>Send an agent message<\/h3>\n<p>You may want to create your own automated messages from a team member if a certain event occurs that would benefit from a real-time message while a visitor is actively on your site, like a failed payment for example.<\/p>\n<p>Example request:<\/p>\n<pre class=\"language-shell\">\r\n<code>\r\ncurl -X POST -H \"Content-Type: application\/json\" \\                                     \"https:\/\/api.gosquared.com\/chat\/v1\/chats\/chatID\/messages?api_key=API_KEY&site_token=YOUR_PROJECT_TOKEN\" \\\r\n-d '{\r\n      \"content\": \"Hello, were you having problems with your payment!\",\r\n      \"from\": \"client\"\r\n    }'\r\n<\/code>\r\n<\/pre>\n<h3>Leave a note on a conversation in Inbox<\/h3>\n<p>You may want to simply leave a note on an account for one of your team to be aware of the next time the client starts a conversation.<\/p>\n<p>Example request:<\/p>\n<pre class=\"language-shell\">\r\n<code>\r\ncurl -X POST -H \"Content-Type: application\/json\" \\\r\n\"https:\/\/api.gosquared.com\/chat\/v1\/chats\/chatID\/notes?api_key=API_KEY&site_token=YOUR_PROJECT_TOKEN\" \\\r\n-d '{\r\n      \"content\": \"Client has just opened a support ticket\"\r\n    }'\r\n<\/code>\r\n<\/pre>\n<h3>Archive a conversation<\/h3>\n<p>You may not necessarily want to keep specific conversations open in Inbox if they don&#8217;t need addressing right away, so you can now archive conversations via the Live Chat API.<\/p>\n<p>Example request:<\/p>\n<pre class=\"language-shell\">\r\n<code>\r\ncurl -X POST -H \"Content-Type: application\/json\" \\\r\n\"https:\/\/api.gosquared.com\/chat\/v1\/chats\/chatID\/archive?api_key=API_KEY&site_token=YOUR_PROJECT_TOKEN\"\r\n<\/code>\r\n<\/pre>\n<h2>Retrieve conversations and message history<\/h2>\n<h3>Retrieve chat conversations for a project<\/h3>\n<p>We believe a continuous history of communication between a client and team member offers the best experience for both parties. These are what we refer to as \u201cconversations\u201d and you can now retrieve information about all your conversations for a project through our chat API.<\/p>\n<p>Example request:<\/p>\n<pre class=\"language-shell\">\r\n<code>\r\ncurl \"https:\/\/api.gosquared.com\/chat\/v1\/chats?api_key=IH75SD7KK2AGGGSN&site_token=YOUR_PROJECT_TOKEN\"\r\n<\/code>\r\n<\/pre>\n<h3>Get a feed of messages and events from a conversation<\/h3>\n<p>Conversations consist of a feed of messages and events (from both the agent and client).  You can now also retrieve the history of a specific conversation.<\/p>\n<p>Example request:<\/p>\n<pre class=\"language-shell\">\r\n<code>\r\ncurl \"https:\/\/api.gosquared.com\/chat\/v1\/chats\/chatID\/feed?api_key=API_KEY&site_token=YOUR_PROJECT_TOKEN\"\r\n<\/code>\r\n<\/pre>\n<h2>Get started today<\/h2>\n<p>Our aim is to give businesses the ability to make Live Chat, with GoSquared Assistant, a seamless part of their sales and marketing workflow.<\/p>\n<p>We&#8217;re really excited to get more of the GoSquared platform in your ends to build on top of, and we welcome any feedback and requests around additional functionality.<\/p>\n<p>Reach out to us via <a href=\"https:\/\/www.gosquared.com\/assistant\/\" rel=\"noopener noreferrer\" target=\"_blank\">GoSquared Assistant<\/a>, hit us up <a href=\"https:\/\/twitter.com\/GoSquared\" rel=\"noopener noreferrer\" target=\"_blank\">on Twitter<\/a>, or feel free to reach out via <a href=\"https:\/\/www.gosquared.com\/contact\/\" rel=\"noopener noreferrer\" target=\"_blank\">our contact form<\/a>!<\/p>\n<p><a href=\"https:\/\/www.gosquared.com\/docs\/api\/chat\/\" rel=\"noopener noreferrer\" target=\"_blank\"><strong>View the Live Chat API (beta) docs<\/strong><\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>We&#8217;re really excited to announce the GoSquared Live Chat API is now available. GoSquared Live Chat is used by hundreds&#8230;<\/p>\n","protected":false},"author":25,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1586],"tags":[101,187,271,563,750],"class_list":["post-7598","post","type-post","status-publish","format-standard","hentry","category-gosquared-updates","tag-api","tag-chat","tag-developer","tag-live-chat","tag-real-time"],"yoast_head":"<!-- This site is optimized with the Yoast SEO Premium plugin v18.6 (Yoast SEO v19.0) - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Introducing the Live Chat API (beta) - GoSquared Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.gosquared.com\/blog\/live-chat-api\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Introducing the Live Chat API (beta)\" \/>\n<meta property=\"og:description\" content=\"We&#8217;re really excited to announce the GoSquared Live Chat API is now available. GoSquared Live Chat is used by hundreds...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.gosquared.com\/blog\/live-chat-api\" \/>\n<meta property=\"og:site_name\" content=\"GoSquared Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/GoSquared\" \/>\n<meta property=\"article:published_time\" content=\"2018-10-31T12:54:25+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2019-11-28T10:57:14+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:image\" content=\"https:\/\/static.gosquared.com\/images\/liquidicity\/18_10_31_livechatapi\/og_01@2x.jpg\" \/>\n<meta name=\"twitter:creator\" content=\"@Russellvaughan\" \/>\n<meta name=\"twitter:site\" content=\"@GoSquared\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Russell Vaughan\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/#organization\",\"name\":\"GoSquared\",\"url\":\"https:\/\/www.gosquared.com\/blog\/\",\"sameAs\":[\"https:\/\/instagram.com\/gosquaredteam\",\"https:\/\/www.linkedin.com\/company\/go-squared-ltd.\",\"https:\/\/www.facebook.com\/GoSquared\",\"https:\/\/twitter.com\/GoSquared\"],\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.gosquared.com\/blog\/wp-content\/uploads\/2015\/07\/gosquared.png\",\"contentUrl\":\"https:\/\/www.gosquared.com\/blog\/wp-content\/uploads\/2015\/07\/gosquared.png\",\"width\":1270,\"height\":250,\"caption\":\"GoSquared\"},\"image\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/#\/schema\/logo\/image\/\"}},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/#website\",\"url\":\"https:\/\/www.gosquared.com\/blog\/\",\"name\":\"GoSquared Blog\",\"description\":\"Turn visitors into customers.\",\"publisher\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.gosquared.com\/blog\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#primaryimage\",\"url\":\"\",\"contentUrl\":\"\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#webpage\",\"url\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api\",\"name\":\"Introducing the Live Chat API (beta) - GoSquared Blog\",\"isPartOf\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#primaryimage\"},\"datePublished\":\"2018-10-31T12:54:25+00:00\",\"dateModified\":\"2019-11-28T10:57:14+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.gosquared.com\/blog\/live-chat-api\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.gosquared.com\/blog\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introducing the Live Chat API (beta)\"}]},{\"@type\":\"Article\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#webpage\"},\"author\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/#\/schema\/person\/c5fbe35e2c32f13a6e05136b474f43b4\"},\"headline\":\"Introducing the Live Chat API (beta)\",\"datePublished\":\"2018-10-31T12:54:25+00:00\",\"dateModified\":\"2019-11-28T10:57:14+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#webpage\"},\"wordCount\":576,\"publisher\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.gosquared.com\/blog\/live-chat-api#primaryimage\"},\"thumbnailUrl\":\"\",\"keywords\":[\"API\",\"Chat\",\"Developer\",\"Live Chat\",\"Real-Time\"],\"articleSection\":[\"GoSquared Updates\"],\"inLanguage\":\"en-US\"},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/#\/schema\/person\/c5fbe35e2c32f13a6e05136b474f43b4\",\"name\":\"Russell Vaughan\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.gosquared.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/822f03d63c83bea45c7827659fab4514c085e2647cc4d6145ead087e3cec4a56?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/822f03d63c83bea45c7827659fab4514c085e2647cc4d6145ead087e3cec4a56?s=96&d=mm&r=g\",\"caption\":\"Russell Vaughan\"},\"description\":\"Russell is a sales engineer at GoSquared, focused on helping new customers get up and running with the GoSquared platform.\",\"sameAs\":[\"https:\/\/gosquared.com\",\"https:\/\/twitter.com\/Russellvaughan\"],\"url\":\"https:\/\/www.gosquared.com\/blog\/author\/russell\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"Introducing the Live Chat API (beta) - GoSquared Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.gosquared.com\/blog\/live-chat-api","og_locale":"en_US","og_type":"article","og_title":"Introducing the Live Chat API (beta)","og_description":"We&#8217;re really excited to announce the GoSquared Live Chat API is now available. GoSquared Live Chat is used by hundreds...","og_url":"https:\/\/www.gosquared.com\/blog\/live-chat-api","og_site_name":"GoSquared Blog","article_publisher":"https:\/\/www.facebook.com\/GoSquared","article_published_time":"2018-10-31T12:54:25+00:00","article_modified_time":"2019-11-28T10:57:14+00:00","twitter_card":"summary_large_image","twitter_image":"https:\/\/static.gosquared.com\/images\/liquidicity\/18_10_31_livechatapi\/og_01@2x.jpg","twitter_creator":"@Russellvaughan","twitter_site":"@GoSquared","twitter_misc":{"Written by":"Russell Vaughan","Est. reading time":"4 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Organization","@id":"https:\/\/www.gosquared.com\/blog\/#organization","name":"GoSquared","url":"https:\/\/www.gosquared.com\/blog\/","sameAs":["https:\/\/instagram.com\/gosquaredteam","https:\/\/www.linkedin.com\/company\/go-squared-ltd.","https:\/\/www.facebook.com\/GoSquared","https:\/\/twitter.com\/GoSquared"],"logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.gosquared.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.gosquared.com\/blog\/wp-content\/uploads\/2015\/07\/gosquared.png","contentUrl":"https:\/\/www.gosquared.com\/blog\/wp-content\/uploads\/2015\/07\/gosquared.png","width":1270,"height":250,"caption":"GoSquared"},"image":{"@id":"https:\/\/www.gosquared.com\/blog\/#\/schema\/logo\/image\/"}},{"@type":"WebSite","@id":"https:\/\/www.gosquared.com\/blog\/#website","url":"https:\/\/www.gosquared.com\/blog\/","name":"GoSquared Blog","description":"Turn visitors into customers.","publisher":{"@id":"https:\/\/www.gosquared.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.gosquared.com\/blog\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#primaryimage","url":"","contentUrl":""},{"@type":"WebPage","@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#webpage","url":"https:\/\/www.gosquared.com\/blog\/live-chat-api","name":"Introducing the Live Chat API (beta) - GoSquared Blog","isPartOf":{"@id":"https:\/\/www.gosquared.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#primaryimage"},"datePublished":"2018-10-31T12:54:25+00:00","dateModified":"2019-11-28T10:57:14+00:00","breadcrumb":{"@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.gosquared.com\/blog\/live-chat-api"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.gosquared.com\/blog"},{"@type":"ListItem","position":2,"name":"Introducing the Live Chat API (beta)"}]},{"@type":"Article","@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#article","isPartOf":{"@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#webpage"},"author":{"@id":"https:\/\/www.gosquared.com\/blog\/#\/schema\/person\/c5fbe35e2c32f13a6e05136b474f43b4"},"headline":"Introducing the Live Chat API (beta)","datePublished":"2018-10-31T12:54:25+00:00","dateModified":"2019-11-28T10:57:14+00:00","mainEntityOfPage":{"@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#webpage"},"wordCount":576,"publisher":{"@id":"https:\/\/www.gosquared.com\/blog\/#organization"},"image":{"@id":"https:\/\/www.gosquared.com\/blog\/live-chat-api#primaryimage"},"thumbnailUrl":"","keywords":["API","Chat","Developer","Live Chat","Real-Time"],"articleSection":["GoSquared Updates"],"inLanguage":"en-US"},{"@type":"Person","@id":"https:\/\/www.gosquared.com\/blog\/#\/schema\/person\/c5fbe35e2c32f13a6e05136b474f43b4","name":"Russell Vaughan","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.gosquared.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/822f03d63c83bea45c7827659fab4514c085e2647cc4d6145ead087e3cec4a56?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/822f03d63c83bea45c7827659fab4514c085e2647cc4d6145ead087e3cec4a56?s=96&d=mm&r=g","caption":"Russell Vaughan"},"description":"Russell is a sales engineer at GoSquared, focused on helping new customers get up and running with the GoSquared platform.","sameAs":["https:\/\/gosquared.com","https:\/\/twitter.com\/Russellvaughan"],"url":"https:\/\/www.gosquared.com\/blog\/author\/russell"}]}},"wps_subtitle":"The power of GoSquared Live Chat is now in your hands","_links":{"self":[{"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/posts\/7598","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/users\/25"}],"replies":[{"embeddable":true,"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/comments?post=7598"}],"version-history":[{"count":0,"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/posts\/7598\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/media?parent=7598"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/categories?post=7598"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.gosquared.com\/blog\/wp-json\/wp\/v2\/tags?post=7598"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}