CINXE.COM

Platform Overview | Text Platform Docs & API Reference

<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Platform Overview | Text Platform Docs &amp; API Reference</title><link rel="canonical" href="https://platform.text.com/docs/getting-started"/><link rel="preconnect" href="https://LATDYRDX9J-dsn.algolia.net" crossorigin="true"/><meta name="description" content="Many possibilities, not just a messaging tool, offered by the Platform help you grow a business, bringing customer satisfaction."/><meta property="og:title" content="Platform Overview"/><meta property="og:description" content="Many possibilities, not just a messaging tool, offered by the Platform help you grow a business, bringing customer satisfaction."/><meta property="og:type" content="website"/><meta property="og:image" content="https://platform.text.com/docs/images/text-docs-og.png"/><link rel="icon" href="/docs/images/favicon.ico"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@textplatform"/><meta name="twitter:title" content="Platform Overview"/><meta name="twitter:description" content="Many possibilities, not just a messaging tool, offered by the Platform help you grow a business, bringing customer satisfaction."/><meta name="twitter:image" content="https://platform.text.com/docs/images/livechat-docs-og.png"/><script type="text/javascript"> window.__lc = window.__lc || {}; window.__lc.license = 1520; ;(function(n,t,c){function i(n){return e._h?e._h.apply(null,n):e._q.push(n)}var e={_q:[],_h:null,_v:"2.0",on:function(){i(["on",c.call(arguments)])},once:function(){i(["once",c.call(arguments)])},off:function(){i(["off",c.call(arguments)])},get:function(){if(!e._h)throw new Error("[LiveChatWidget] You can't use getters before load.");return i(["get",c.call(arguments)])},call:function(){i(["call",c.call(arguments)])},init:function(){var n=t.createElement("script");n.async=!0,n.type="text/javascript",n.src="https://cdn.livechatinc.com/staging/tracking.js",t.head.appendChild(n)}};!n.__lc.asyncInit&&e.init(),n.LiveChatWidget=n.LiveChatWidget||e}(window,document,[].slice)) </script><meta name="next-head-count" content="17"/><link rel="preload" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/getting-started-5cdf0fb376cce0ea048b.js" as="script"/> <script>!function(e){var n="https://s.go-mpulse.net/boomerang/";if("False"=="True")e.BOOMR_config=e.BOOMR_config||{},e.BOOMR_config.PageParams=e.BOOMR_config.PageParams||{},e.BOOMR_config.PageParams.pci=!0,n="https://s2.go-mpulse.net/boomerang/";if(window.BOOMR_API_key="SWHJY-Y2PHV-NVPM2-PDH42-VMPQS",function(){function e(){if(!o){var e=document.createElement("script");e.id="boomr-scr-as",e.src=window.BOOMR.url,e.async=!0,i.parentNode.appendChild(e),o=!0}}function t(e){o=!0;var n,t,a,r,d=document,O=window;if(window.BOOMR.snippetMethod=e?"if":"i",t=function(e,n){var t=d.createElement("script");t.id=n||"boomr-if-as",t.src=window.BOOMR.url,BOOMR_lstart=(new Date).getTime(),e=e||d.body,e.appendChild(t)},!window.addEventListener&&window.attachEvent&&navigator.userAgent.match(/MSIE [67]\./))return window.BOOMR.snippetMethod="s",void t(i.parentNode,"boomr-async");a=document.createElement("IFRAME"),a.src="about:blank",a.title="",a.role="presentation",a.loading="eager",r=(a.frameElement||a).style,r.width=0,r.height=0,r.border=0,r.display="none",i.parentNode.appendChild(a);try{O=a.contentWindow,d=O.document.open()}catch(_){n=document.domain,a.src="javascript:var d=document.open();d.domain='"+n+"';void(0);",O=a.contentWindow,d=O.document.open()}if(n)d._boomrl=function(){this.domain=n,t()},d.write("<bo"+"dy onload='document._boomrl();'>");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"SWHJY-Y2PHV-NVPM2-PDH42-VMPQS";var i=document.currentScript||document.getElementsByTagName("script")[0],o=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!o)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),i.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="bdpnbet4tppjwz2b5obq-f-70a784404-clientnsv4-s.akamaihd.net",i="false"=="true"?2:1,o={"ak.v":"39","ak.cp":"1461330","ak.ai":parseInt("908031",10),"ak.ol":"0","ak.cr":1,"ak.ipv":4,"ak.proto":"http/1.1","ak.rid":"e1c5fd6","ak.r":6099,"ak.a2":n,"ak.m":"b","ak.n":"essl","ak.bpcip":"8.222.208.0","ak.cport":33270,"ak.gh":"124.155.222.130","ak.quicv":"","ak.tlsv":"tls1.2","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"reno","ak.t":"1732373379","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==be9YuzJB0hiApCQ7jZa493mAa6jdCxu2WOK+KyjNg5js/kqlRgtrUsAKOgcklce92/G1Ke3100Vf09GPVBB1TF+Oz3ucOrRr54/4LlIrVy9/EbMuxLxSMyQ1cZj4t/e9OeIqpeUUk9IrWDT7Hk1mGsvTUAdHpN/osouSNvY92D9z+fi6OHoJYdz2YPnkDg4trvV/ZyTJtPj4CnF3gTinS2wNvwtl/FyoyuterrZ4qCaBGK+irpKlZ/TIGYNdEBKZD5vpppyLaexEfiuBM+P2z/NV75YSws7h50ZipCbWb8Ce8cNRFkNharHi2HyWnHabACdVmunBtOnmGm/WmKKSiBr8UFXZE5c92uC1ho9HhpTprXrsRSN0XlFr6lrvDOkbuVZ8g+SlFlb95Y2kBsZPrFyT+9FaTl6bZjx3sCLh5eE=","ak.pv":"55","ak.dpoabenc":"","ak.tf":i};if(""!==t)o["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))o["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(o)},rv:function(){var e=["ak.bpcip","ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:o,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window);</script></head><body><div id="__next"><style data-emotion-css="cvn8wj">.css-cvn8wj{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;background-color:#4a4a55;height:60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;position:fixed;top:0;width:100%;z-index:99;}@media (min-width:768px){.css-cvn8wj{height:60px;}}</style><div class="css-cvn8wj"><style data-emotion-css="y9662z">.css-y9662z{background:#4a4a55;width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;}</style><div class="css-y9662z"><style data-emotion-css="qqcdow">.css-qqcdow{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;font-size:15px;margin:0 20px;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:60px;}.css-qqcdow > a > svg{margin:0;display:block;height:24px;}</style><nav class="css-qqcdow"><style data-emotion-css="c2yzgf">.css-c2yzgf{color:white;-webkit-text-decoration:none;text-decoration:none;font-weight:500;white-space:nowrap;margin-left:8px;}.css-c2yzgf:hover{-webkit-text-decoration:none;text-decoration:none;color:white;}</style><a href="https://text.com/" class="css-c2yzgf"><style data-emotion-css="ofqsza">.css-ofqsza{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;justify-items:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:0.8em;height:40px;}.css-ofqsza .logo{margin:0;font-size:2em;font-weight:500;-webkit-letter-spacing:-0.01em;-moz-letter-spacing:-0.01em;-ms-letter-spacing:-0.01em;letter-spacing:-0.01em;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-ofqsza .adjacent{margin:0;font-size:1.8em;font-weight:500;line-height:34px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-letter-spacing:-0.5px;-moz-letter-spacing:-0.5px;-ms-letter-spacing:-0.5px;letter-spacing:-0.5px;}.css-ofqsza .carrier{font-weight:500;-webkit-animation-name:blink;animation-name:blink;-webkit-animation-duration:0.9s;animation-duration:0.9s;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;}</style><header class="css-ofqsza"><span class="logo">text<span class="carrier">|</span></span></header></a><a href="/docs" class="css-c2yzgf">Platform Docs</a></nav><style data-emotion-css="16b59id">.css-16b59id{margin:0;padding:0;max-width:calc(100% - 60px);width:calc(100% - 60px);overflow-x:auto;overflow-y:hidden;display:none;margin-right:10px;margin-left:40px;}@media (min-width:1024px){.css-16b59id{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;gap:32px;}}</style><div class="css-16b59id"><style data-emotion-css="11hjr56">.css-11hjr56{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;position:relative;display:inline-block;height:100%;color:#ffffff;font-weight:400;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-11hjr56:hover{cursor:default;}</style><div class="css-11hjr56">Platform<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">APIs &amp; SDKs<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">Resources<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div><style data-emotion-css="1hppjzv">.css-1hppjzv{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1hppjzv"><style data-emotion-css="7wgbw1">.css-7wgbw1{display:none;}@media (min-width:1024px){.css-7wgbw1{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;width:192px;margin-right:16px;}}</style><div class="DocSearch-Button-Desktop css-7wgbw1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><style data-emotion-css="1i8rrts">.css-1i8rrts{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:100%;}@media (min-width:1024px){.css-1i8rrts{display:none;}}</style><div class="DocSearch-Button-Mobile css-1i8rrts"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><p>...</p><style data-emotion-css="pskeb7">@media (min-width:1024px){.css-pskeb7{display:none;}}</style><style data-emotion-css="19rp0xe">.css-19rp0xe{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin-right:16px;cursor:pointer;}@media (min-width:1024px){.css-19rp0xe{display:none;}}@media (min-width:1024px){.css-19rp0xe{display:none;}}</style><svg width="32px" height="28px" fill="#ffffff" class="rmi rmi-menu css-19rp0xe" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg></div></div></div><style data-emotion-css="ov1ktg">.css-ov1ktg{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}</style><div class="css-ov1ktg"><style data-emotion-css="hpx2k5">.css-hpx2k5{border-right:1px solid #e2e2e4;height:50px;position:fixed;-webkit-transition:height 300ms;transition:height 300ms;display:block;bottom:0%;width:100%;opacity:1;z-index:10;box-shadow:0px 0px 8px rgba(0,0,0,0.25);background-color:white;}@media (min-width:768px){.css-hpx2k5{box-shadow:none;height:100vh;max-height:100vh;position:-webkit-sticky;position:sticky;top:60px;-webkit-transition:all 0s;transition:all 0s;width:260px;}}</style><aside class="css-hpx2k5"><style data-emotion-css="y8dejn">.css-y8dejn{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;background-color:white;padding:10px 14px;cursor:pointer;}@media (min-width:768px){.css-y8dejn{display:none;}}</style><div class="css-y8dejn"><svg style="transform:rotate(270deg);transition:transform 300ms" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z" fill="currentColor"></path><path d="M0 0h24v24H0z" fill="none"></path></svg>Platform Overview</div><style data-emotion-css="v8mm6">.css-v8mm6{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}@media (min-width:768px){.css-v8mm6{display:none;}}</style><div class="css-v8mm6"><style data-emotion-css="1pjh3pd">.css-1pjh3pd{width:100%;color:#62626D;}.css-1pjh3pd:hover{cursor:pointer;-webkit-text-decoration:none;text-decoration:none;background-color:#f6f6f7;}</style><a class="css-1pjh3pd"><style data-emotion-css="1yw2pv4">.css-1yw2pv4{padding:4px 14px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;font-size:16px;}</style><div class="css-1yw2pv4"><style data-emotion-css="5c7uuc">.css-5c7uuc{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:start;-ms-flex-pack:start;justify-content:start;}</style><div class="css-5c7uuc"><svg width="24" height="20px" fill="#62626D" class="rmi rmi-home undefined" viewBox="0 0 24 24"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8h5z"></path></svg></div>Home</div></a></div><style data-emotion-css="1ln71vl">.css-1ln71vl{overflow:scroll;height:calc(100% - 90px);}@media (min-width:768px){.css-1ln71vl{height:calc(100% - 60px);position:fixed;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;height:100%;max-height:100vh;position:-webkit-sticky;position:-webkit-sticky;position:sticky;top:0;margin-top:8px;}}</style><div class="css-1ln71vl"><style data-emotion-css="1gg9bms">.css-1gg9bms{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:600;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1gg9bms:hover{background-color:#f6f6f7;}</style><div class="css-1gg9bms"><style data-emotion-css="17iyluq">.css-17iyluq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#4284F5;width:100%;}.css-17iyluq:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-17iyluq"><style data-emotion-css="2hhlpj">.css-2hhlpj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 20px;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-2hhlpj:hover{background-color:#f6f6f7;}</style><div class="css-2hhlpj"><style data-emotion-css="oe3dsw">.css-oe3dsw{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;margin-right:8px;}</style><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Platform Overview</div></a></div><style data-emotion-css="1psvkz3">.css-1psvkz3{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1psvkz3:hover{background-color:#f6f6f7;}</style><div class="css-1psvkz3"><style data-emotion-css="19nl305">.css-19nl305{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#62626D;width:100%;}.css-19nl305:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Installing LiveChat</div></a><style data-emotion-css="155ms1k">.css-155ms1k{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;padding-right:5px;-webkit-transform:rotate(0deg);-ms-transform:rotate(0deg);transform:rotate(0deg);-webkit-transition:-webkit-transform 300ms;-webkit-transition:transform 300ms;transition:transform 300ms;cursor:pointer;}</style><div class="css-155ms1k"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>LiveChat Apps</div></a><div class="css-155ms1k"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>HelpDesk Apps</div></a><div class="css-155ms1k"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>App Guides</div></a><div class="css-155ms1k"><svg width="24" height="24px" fill="#62626D" weight="24px" class="rmi rmi-chevron-right undefined" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6-1.41-1.42z"></path></svg></div></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>API Pricing</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Developer SDK</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#ABABB1" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Developer CLI</div></a></div></div></aside><style data-emotion-css="1g06r20">.css-1g06r20{padding-bottom:30vh;position:relative;width:100%;}@media (min-width:768px){.css-1g06r20{width:calc(100% - 258px);max-width:900px;}}</style><div class="css-1g06r20"><style data-emotion-css="c8i9h7">.css-c8i9h7{margin-top:120px;padding:0px 30px;}@media (min-width:768px){.css-c8i9h7{padding:0px 60px;}}.css-c8i9h7.redoc{margin-top:60px;display:block;}</style><article class=" css-c8i9h7"><style data-emotion-css="1lyzzun">.css-1lyzzun{margin:3em 0 1em;padding:2em 0 1em;}</style><div class="css-1lyzzun"><style data-emotion-css="12qxxrf">.css-12qxxrf{margin:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;font-weight:500;text-rendering:optimizeLegibility;font-size:2.25rem;line-height:1.1;-webkit-letter-spacing:-0.02em;-moz-letter-spacing:-0.02em;-ms-letter-spacing:-0.02em;letter-spacing:-0.02em;}@media (min-width:768px){.css-12qxxrf{-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}}</style><h2 id="platform-overview" class="css-12qxxrf"><span>Platform Overview</span><style data-emotion-css="1g0dr3m">.css-1g0dr3m{margin-top:8px;}.css-1g0dr3m > label{margin:0 0 5px 0;}.css-1g0dr3m label + div{-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;}</style></h2></div><style data-emotion-css="1679d3t">.css-1679d3t{border-bottom:1px solid #e0e4e9;padding-bottom:0.5em;}</style><h2 class="heading css-1679d3t"><style data-emotion-css="180507a">.css-180507a{color:inherit;-webkit-text-decoration:none;text-decoration:none;position:relative;}.css-180507a:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}.css-180507a:hover:before{content:"#";position:absolute;font-weight:300;left:-1em;top:1px;opacity:0.3;}.css-180507a:focus-visible{outline-width:0px;}</style><a id="welcome-to-the-platform" href="#welcome-to-the-platform" class="reference css-180507a"><a href="/docs/getting-started#welcome-to-the-platform"><span class="icon icon-link"></span></a>Welcome to the Platform</a></h2><p>If you&#x27;re wondering whether the Platform suits your business, this is where you can get started. We&#x27;d like to tell you about our products, their main functionalities, and their high potential for customization. Let&#x27;s take you on a small tour!</p><h2 class="heading css-1679d3t"><a id="what-text-is-about" href="#what-text-is-about" class="reference css-180507a"><a href="/docs/getting-started#what-text-is-about"><span class="icon icon-link"></span></a>What Text is about</a></h2><a target="_blank" href="https://text.com/">Text</a> enables entrepreneurs to build technology that provides better customer service apps and helps them reach new audiences. Text products are used by more than <span>37,000</span> companies in over 150 countries.<p>The Text Platform is an ecosystem for developers that grew mainly from two Text products, <a target="_blank" href="https://www.livechat.com/">LiveChat</a> and <a target="_blank" href="https://www.helpdesk.com/">HelpDesk</a>. From a more tech perspective, the Platform provides:</p><ul><li>open messaging protocol with real-time and web APIs</li><li>rich messaging tools and chatbots</li><li>reporting and data extraction APIs</li><li>management and configuration APIs</li><li>monetization tools and <a href="https://platform.text.com/console/" target="_blank" rel="noopener noreferrer">Developer Console</a></li><li>authorization tools</li><li>the <a href="https://www.livechat.com/marketplace/" target="_blank" rel="noopener noreferrer">LiveChat Marketplace</a> and <a target="_blank" href="https://www.helpdesk.com/marketplace/">HelpDesk Marketplace</a> of apps and services</li></ul><h2 class="heading css-1679d3t"><a id="meet-livechat" href="#meet-livechat" class="reference css-180507a"><a href="/docs/getting-started#meet-livechat"><span class="icon icon-link"></span></a>Meet LiveChat</a></h2><p><strong>LiveChat</strong> helps you handle conversations with customers visiting your websites. Customers can start chats with your agents, but it can also be the other way around. Your agents can initiate chats, making your visitors feel welcome and valued. If you&#x27;re up to some automation, you can engage them in a conversation with <a target="_blank" href="https://www.livechat.com/help/targeted-messages/">targeted messages</a>. Also, delegating some work to <a target="_blank" href="https://www.livechat.com/help/chatbots-explained/">bots</a> is an option when running a business on a bigger scale.</p><p>Your customers can start multiple conversations with agents and continue existing ones - it&#x27;s up to them. Keeping track of chat history is easy, as agents can scroll up to get a preview of all the exchanged messages in a conversation.</p><p>All of these functionalities are guaranteed <em>out of the box</em>, but this is just a tiny bit of what LiveChat offers. If you&#x27;re interested in other default features, see the <a target="_blank" href="https://www.livechat.com/features/">full list of LiveChat features</a>.</p><h3 class="heading"><a id="what-livechat-can-be" href="#what-livechat-can-be" class="reference css-180507a"><a href="/docs/getting-started#what-livechat-can-be"><span class="icon icon-link"></span></a>What LiveChat can be</a></h3><p>We&#x27;re constantly trying to put forward new ways customers could integrate with LiveChat. Certain business needs call for specific customization, whether it&#x27;s creating an app or just tweaking the look &amp; feel.</p><h4 class="heading"><a id="extending-livechat" href="#extending-livechat" class="reference css-180507a"><a href="/docs/getting-started#extending-livechat"><span class="icon icon-link"></span></a>Extending LiveChat</a></h4><p>LiveChat can extend its interface by building apps to add new panels, widgets, and UI elements. Developers can choose from various options when integrating with the LiveChat Agent App. All options were designed to extend different app locations, making it very flexible. Our Platform offers, for example, apps in the Details section (widgets), fullscreen apps displayed in the main menu, or apps in the Customer Details section (Customer Details widgets). <a target="_blank" href="https://platform.text.com/docs/extending-agent-app">Learn more...</a> The <a target="_blank" href="https://platform.text.com/docs/extending-agent-app/products-sdk/agent-app-sdk">Agent App SDK</a> is currently the primary way to develop your own widgets.</p><p>Just as there are ways to build upon an app, there are also ways to extend the <a href="/docs/getting-started#chat-widget">Chat Widget</a> using <a target="_blank" href="https://platform.text.com/docs/extending-chat-widget/javascript-api/">Chat Widget JavaScript API</a> or <a target="_blank" href="https://platform.text.com/docs/extending-chat-widget/customer-sdk/">Chat Widget Customer SDK</a>.</p><p>Besides extending LiveChat UI, you can also develop LiveChat using our <a href="/docs/getting-started#messaging">Messaging</a> and <a href="/docs/getting-started#management">Management</a> APIs or by <a href="/docs/getting-started#interacting-with-data">interacting with data</a>.</p><h4 class="heading"><a id="monetizing-your-livechat-app" href="#monetizing-your-livechat-app" class="reference css-180507a"><a href="/docs/getting-started#monetizing-your-livechat-app"><span class="icon icon-link"></span></a>Monetizing your LiveChat app</a></h4><p>After building your LiveChat app, personalizing it, and fitting it to your customers&#x27; needs, you can <a href="/docs/getting-started#monetization">monetize</a> it and place it on our <a href="https://www.livechat.com/marketplace/" target="_blank" rel="noopener noreferrer">LiveChat Marketplace</a> to reach many potential customers and gain some profit.</p><p>馃挕 If you want to read about building LiveChat apps, go to our <a target="_blank" href="https://platform.text.com/docs/getting-started/livechat-apps">tutorial</a>.</p><h2 class="heading css-1679d3t"><a id="meet-helpdesk" href="#meet-helpdesk" class="reference css-180507a"><a href="/docs/getting-started#meet-helpdesk"><span class="icon icon-link"></span></a>Meet HelpDesk</a></h2><a target="_blank" href="https://www.helpdesk.com/">HelpDesk</a> is a ticketing system that helps you manage your asynchronous communication with customers. You can imagine it as a mailbox with many features that make communication much more manageable:<ul><li><a target="_blank" href="https://www.helpdesk.com/help/what-are-canned-responses/">Canned responses</a></li><li><a target="_blank" href="https://www.helpdesk.com/help/what-are-statuses/">Statuses</a></li><li><a target="_blank" href="https://www.helpdesk.com/help/how-to-use-private-notes/">Private notes</a></li><li><a target="_blank" href="https://www.helpdesk.com/help/how-to-use-filters/">Filters</a> and <a target="_blank" href="https://www.helpdesk.com/help/what-are-tags-and-how-to-use-them/">tags</a></li><li><a target="_blank" href="https://www.helpdesk.com/help/what-are-teams/">Teams</a></li></ul><a target="_blank" href="https://www.helpdesk.com/help/what-is-helpdesk/">Learn more</a> about HelpDesk, and start your experience with it by checking out the <a target="_blank" href="https://www.helpdesk.com/help/starting-with-helpdesk/">3 simple steps on how to begin</a>.<h3 class="heading"><a id="what-helpdesk-can-be" href="#what-helpdesk-can-be" class="reference css-180507a"><a href="/docs/getting-started#what-helpdesk-can-be"><span class="icon icon-link"></span></a>What HelpDesk can be</a></h3><p>As the Platform tries to follow the needs of our developers so they can build a wide range of integrations that perfectly fit their customers, you can extend HelpDesk in many different areas.</p><h4 class="heading"><a id="extending-helpdesk" href="#extending-helpdesk" class="reference css-180507a"><a href="/docs/getting-started#extending-helpdesk"><span class="icon icon-link"></span></a>Extending HelpDesk</a></h4><p>The first and definitely most fun way to extend HelpDesk is by playing with its interface. It can be done by adding widgets and placing them in many different locations of your app. You can choose one of the following placements: the Details section, Fullscreen apps, or Settings (<a target="_blank" href="https://platform.text.com/docs/extending-agent-app">Learn more...</a>). The <a target="_blank" href="https://platform.text.com/docs/extending-agent-app/products-sdk/helpdesk-sdk">HelpDesk SDK</a> is currently the primary way to develop your own widgets.</p><p>You can also let users sign in to your service via <a target="_blank" href="https://platform.text.com/docs/authorization/sign-in-with-livechat#accounts-sdk">Accounts SDK</a> or automate various tasks using <a href="/docs/getting-started#helpdesk-api">HelpDesk APIs</a>.</p><h4 class="heading"><a id="helpdesk-api" href="#helpdesk-api" class="reference css-180507a"><a href="/docs/getting-started#helpdesk-api"><span class="icon icon-link"></span></a>HelpDesk API</a></h4><p>When you build HelpDesk applications with our Platform, they may need to use our <a target="_blank" href="https://api.helpdesk.com/docs">HelpDesk API</a>. It&#x27;s fully available to experiment with and discover its potential, which is developed in many useful areas:</p><ul><li><a target="_blank" href="https://api.helpdesk.com/docs#tag/Agents">Account and users</a></li><li><a target="_blank" href="https://api.helpdesk.com/docs#tag/Tickets">Tickets</a></li><li><a target="_blank" href="https://api.helpdesk.com/docs#tag/Email-domains">Managing your emails</a></li><li><a target="_blank" href="https://api.helpdesk.com/docs#tag/Canned-responses">Automating your work</a></li><li><a target="_blank" href="https://api.helpdesk.com/docs#tag/Reports">Analyzing your reports</a></li></ul><h4 class="heading"><a id="monetize-helpdesk-apps" href="#monetize-helpdesk-apps" class="reference css-180507a"><a href="/docs/getting-started#monetize-helpdesk-apps"><span class="icon icon-link"></span></a>Monetize HelpDesk apps</a></h4><p>Our Platform also provides you with <a href="/docs/getting-started#monetization">monetization tools</a> that can help you gain profit for the created integrations after publishing them on the <a target="_blank" href="https://www.helpdesk.com/marketplace/">HelpDesk Marketplace</a>.</p><p>馃挕 If you want to read about building HelpDesk apps, go to our <a target="_blank" href="https://platform.text.com/docs/getting-started/helpdesk-apps">tutorial</a>.</p><h2 class="heading css-1679d3t"><a id="authorization" href="#authorization" class="reference css-180507a"><a href="/docs/getting-started#authorization"><span class="icon icon-link"></span></a>Authorization</a></h2><p>LiveChat and HelpDesk use the OAuth 2.1 protocol to <a target="_blank" href="https://platform.text.com/docs/authorization">authenticate and authorize</a> their services. </p><a target="_blank" href="https://platform.text.com/docs/authorization/authorizing-api-calls">API authorization flows</a> are divided into the <a target="_blank" href="https://platform.text.com/docs/authorization/agent-authorization">agent</a> and <a target="_blank" href="https://platform.text.com/docs/authorization/customer-authorization">customer</a> authorization flows. Each app functionality requires different <a target="_blank" href="https://platform.text.com/docs/authorization/scopes">scopes</a> to be configured in the <a href="https://platform.text.com/console/" target="_blank" rel="noopener noreferrer">Developer Console</a>.<p>To access basic information in LiveChat and HelpDesk accounts, you will use <a target="_blank" href="https://platform.text.com/docs/authorization/sign-in-with-livechat">Accounts SDK (Sign in with LiveChat)</a>, which is the simplest way to do that.</p><p>The Platform also provides you with a <a target="_blank" href="https://platform.text.com/docs/authorization/global-accounts">Global Accounts service</a> which is very useful for customers who use <a target="_blank" href="https://www.chatbot.com/">ChatBot</a>, <a target="_blank" href="https://www.helpdesk.com/">HelpDesk</a>, or <a target="_blank" href="https://www.knowledgebase.com/">KnowledgeBase</a>. It allows customers to configure standard options and resources across all products.</p><h2 class="heading css-1679d3t"><a id="developer-console-tools" href="#developer-console-tools" class="reference css-180507a"><a href="/docs/getting-started#developer-console-tools"><span class="icon icon-link"></span></a>Developer Console tools</a></h2><p>If you want to save time while building your app and don&#x27;t want to play with APIs, the <a href="https://platform.text.com/console/" target="_blank" rel="noopener noreferrer">Developer Console</a> comes with a helping hand to provide easy access to all tools and resources for developers who want to build their apps. It is a place where you can configure your application, set up its most crucial functions, create all the necessary extensions, and display your app on the Marketplace.</p><h2 class="heading css-1679d3t"><a id="api-usage" href="#api-usage" class="reference css-180507a"><a href="/docs/getting-started#api-usage"><span class="icon icon-link"></span></a>API Usage</a></h2><p>If you鈥檙e looking for precise details about your API calls and requests, refer to the API Usage reports.</p><p>API Usage is a tool for reporting and managing various development-related activities in your organization. The interface combines all the information about your requests usage, the API you called, and the app that sent the request. It includes a visual representation of your API use and aggregated and raw data reports for your API calls.</p><h2 class="heading css-1679d3t"><a id="text-api" href="#text-api" class="reference css-180507a"><a href="/docs/getting-started#text-api"><span class="icon icon-link"></span></a>Text API</a></h2><p>We want to provide you with a technology that allows you to build applications that meet all the customers&#x27; current needs and follow all the trends set by the world. Text API is open to the public and enables the building of powerful products using various text operations. <a href="/docs/text">Learn</a> what the Text Universe can already give you, and <a target="_blank" href="https://text.com/universe">take a look</a> at what we&#x27;re about to offer soon.</p><h2 class="heading css-1679d3t"><a id="messaging" href="#messaging" class="reference css-180507a"><a href="/docs/getting-started#messaging"><span class="icon icon-link"></span></a>Messaging</a></h2><p>Many LiveChat applications built upon the Platform need to use our API. For that reason, we make it accessible and let developers experiment with it. You can choose between:</p><ul><li><a target="_blank" href="https://platform.text.com/docs/messaging/agent-chat-api">Agent Chat API</a></li><li><a target="_blank" href="https://platform.text.com/docs/messaging/customer-chat-api">Customer Chat API</a></li></ul><p>Together, the <a target="_blank" href="https://platform.text.com/docs/messaging/agent-chat-api">Agent Chat API</a> and the <a target="_blank" href="https://platform.text.com/docs/messaging/customer-chat-api">Customer Chat API</a> create the <a target="_blank" href="https://platform.text.com/docs/messaging">Messaging APIs</a>. It is a full set of methods to use either as an agent or as a customer. We divide it, though, to make it more use-case-specific. The distinction is intuitive; when you want to join a chat as an agent, use the Agent Chat API. To interact as a customer, use the Customer Chat API.</p><p>These two sets of APIs are very versatile. The Agent Chat API lets you build your custom Agent App, as well as browser chat archives, or ban customers. With the use of the Customer Chat API, you can build a custom chat widget. Both APIs allow for interactions, such as joining a chat, posting messages, etc.</p><p>If Messaging APIs seem overwhelming, or you don&#x27;t have time to play with them, <a target="_blank" href="https://platform.text.com/docs/messaging/chat-sdk">Chat SDK</a> comes to the rescue. It was designed to allow developers to build apps quickly. It comes with a method template for sending plain text messages. Based on that method, you can easily build new methods.</p><p>The Platform also provides two Software Development Kits, <a target="_blank" href="https://platform.text.com/docs/messaging/go-sdk">LiveChat Go SDK</a>, written in Go, and <a target="_blank" href="https://platform.text.com/docs/messaging/js-sdk">LiveChat JS SDK</a>, written in Typescript. They are tools for developers to build external backend apps which extend LiveChat features. The SDKs make it easy to use the <a target="_blank" href="https://platform.text.com/docs/messaging/agent-chat-api">Agent Chat API</a>, the <a target="_blank" href="https://platform.text.com/docs/messaging/customer-chat-api">Customer Chat API</a>, and the <a href="/docs/getting-started#management">Configuration API</a>.</p><h2 class="heading css-1679d3t"><a id="management" href="#management" class="reference css-180507a"><a href="/docs/getting-started#management"><span class="icon icon-link"></span></a>Management</a></h2><p>The <a target="_blank" href="https://platform.text.com/docs/management">Configuration API</a> is a service for storing license configurations. It can be used to build complex integrations or to configure resources directly via the API.</p><p>The Configuration API allows for:</p><ul><li>Properties setup to store information about chats or events.</li><li>Webhook management to connect LiveChat with different services and react immediately to the things happening in the chat.</li><li>Bot agent configuration to connect LiveChat with AI solutions.</li></ul><h2 class="heading css-1679d3t"><a id="interacting-with-data" href="#interacting-with-data" class="reference css-180507a"><a href="/docs/getting-started#interacting-with-data"><span class="icon icon-link"></span></a>Interacting with data</a></h2><p>One of the most extensively used sections in the Agent App is <a target="_blank" href="https://www.livechat.com/help/reporting-options-available-in-livechat/">Reports</a>. We provide several types of reports which help managers with the analysis. You can measure chat satisfaction and duration, keep track of agents&#x27; activity, or compare time periods to observe trends.</p><p>Again, this is just a tiny bit of what&#x27;s available in terms of reporting. Yet, we&#x27;re aware that what we offer does not cover every single business case. This is where <a target="_blank" href="https://platform.text.com/docs/data-reporting">Reports API</a> comes into play. It serves as a set of tools to create apps that interact on the server side. With this API, it&#x27;s possible to design exactly what you need.</p><h2 class="heading css-1679d3t"><a id="chat-widget-solutions" href="#chat-widget-solutions" class="reference css-180507a"><a href="/docs/getting-started#chat-widget-solutions"><span class="icon icon-link"></span></a>Chat Widget solutions</a></h2><p>Suppose you want to integrate your website or application with the Platform, monitor and interact with your users, or build advanced custom solutions. In that case, you can do all of this with the help of multiple <a target="_blank" href="https://platform.text.com/docs/extending-chat-widget">Chat Widget</a> solutions:</p><ul><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#mobile-chat-widgets">Mobile Chat Widgets</a> for Android or iOS.</li><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#javascript-api">JavaScript API</a> for changing the look and behavior of the Chat Widget.</li><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#moments">Moments</a> allow customers to perform specific actions.</li><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#rich-messages">Rich messages</a> make your messages more stylish and interactive.</li><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#customer-sdk">Customer SDK</a> allows you to build a chat widget from scratch.</li><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#custom-identity-provider">Custom Identity Provider</a> gives you the possibility of creating cross-platform communication.</li><li><a target="_blank" href="https://platform.text.com/docs/extending-chat-widget#chat-widget-adapters">Chat Widget Adapters</a> allow you to use the Chat Widget with popular frontend frameworks.</li></ul><h2 class="heading css-1679d3t"><a id="monetization" href="#monetization" class="reference css-180507a"><a href="/docs/getting-started#monetization"><span class="icon icon-link"></span></a>Monetization</a></h2><p>The Platform provides you with <a target="_blank" href="https://platform.text.com/docs/monetization">monetization tools</a> allowing you to start getting a profit from the apps you have created. All the payments are processed within the Text ecosystem. Thanks to this solution, you have more precise control over monetizing features of your app.</p><p>We want you to deliver well-designed and efficient apps for users. We put apps through the <a target="_blank" href="https://platform.text.com/docs/monetization/app-review-process">app review process</a> before they are published on the marketplace and provide developers with some guidelines that help improve apps and make them more attractive to customers.</p><p>The <a target="_blank" href="https://platform.text.com/docs/monetization/partner-program-api">Partner Program API</a> offered by Text allows you to build tools to help you use your data better and develop your business. Play with the API and decide what you want to create.</p><h2 class="heading css-1679d3t"><a id="contact-us" href="#contact-us" class="reference css-180507a"><a href="/docs/getting-started#contact-us"><span class="icon icon-link"></span></a>Contact us</a></h2><p>If you feel that our Platform is the platform you&#x27;d like to build upon, don&#x27;t hesitate to contact us at <a href="mailto:developers@text.com">developers@text.com</a> and <a href="https://discord.com/invite/NcfJu3a9kM">join our Discord</a> to learn, get inspired, and meet other developers.</p><p>Got any questions or feedback? We&#x27;ll be happy to hear from you!</p><style data-emotion-css="1fsewzh">.css-1fsewzh{margin-top:50px;}.css-1fsewzh > label{margin:0 0 5px 0;}.css-1fsewzh label + div{-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}</style></article></div><p>...</p></div><style data-emotion-css="1mpu5jj">.css-1mpu5jj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:space-evenly;-webkit-justify-content:space-evenly;-ms-flex-pack:space-evenly;justify-content:space-evenly;-webkit-align-items:start;-webkit-box-align:start;-ms-flex-align:start;align-items:start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;background-color:#f6f6f7;color:#424d57;min-height:248px;margin-bottom:45px;}@media (min-width:768px){.css-1mpu5jj{margin-bottom:0px;}}</style><div class="css-1mpu5jj"><style data-emotion-css="dtzkur">.css-dtzkur{width:100%;padding:20px;}@media (min-width:768px){.css-dtzkur{margin-top:75px;padding:0;width:160px;}}</style><div class="css-dtzkur"><style data-emotion-css="r8rj3w">.css-r8rj3w{font-weight:600;font-size:16px;line-height:24px;color:#424d57;}</style><div class="css-r8rj3w">Join the community</div><style data-emotion-css="1ws0nkq">.css-1ws0nkq{font-weight:400;font-size:12px;line-height:20px;color:#424d57;}</style><div class="css-1ws0nkq">Get in direct contact with us through Discord.</div><style data-emotion-css="652pjx">.css-652pjx:hover{-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://discord.gg/MGFyhbdFxt" target="_blank" rel="noopener noreferrer" class="css-652pjx"><style data-emotion-css="y77wuh">.css-y77wuh{margin-top:5px;}</style><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="20" height="16" viewBox="0 0 20 16" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_613_10386)"><path d="M16.9308 1.63294C15.6561 1.04804 14.2892 0.617109 12.8599 0.370298C12.8339 0.365535 12.8079 0.377439 12.7945 0.401247C12.6187 0.713926 12.4239 1.12184 12.2876 1.44246C10.7503 1.21232 9.22099 1.21232 7.71527 1.44246C7.57887 1.11471 7.37707 0.713926 7.20048 0.401247C7.18707 0.378233 7.16107 0.366329 7.13504 0.370298C5.70659 0.616321 4.33963 1.04725 3.06411 1.63294C3.05307 1.6377 3.04361 1.64564 3.03732 1.65595C0.444493 5.52959 -0.265792 9.30801 0.0826501 13.0396C0.0842267 13.0578 0.0944749 13.0753 0.108665 13.0864C1.81934 14.3427 3.47642 15.1054 5.10273 15.6109C5.12876 15.6188 5.15634 15.6093 5.1729 15.5879C5.55761 15.0625 5.90054 14.5086 6.19456 13.926C6.21192 13.8919 6.19535 13.8514 6.15989 13.838C5.61594 13.6316 5.098 13.38 4.59977 13.0943C4.56037 13.0713 4.55721 13.015 4.59347 12.988C4.69831 12.9094 4.80318 12.8277 4.9033 12.7451C4.92141 12.7301 4.94665 12.7269 4.96794 12.7364C8.24107 14.2308 11.7846 14.2308 15.0191 12.7364C15.0404 12.7261 15.0657 12.7293 15.0846 12.7443C15.1847 12.8269 15.2895 12.9094 15.3952 12.988C15.4314 13.015 15.4291 13.0713 15.3897 13.0943C14.8914 13.3856 14.3735 13.6316 13.8288 13.8372C13.7933 13.8507 13.7775 13.8919 13.7949 13.926C14.0952 14.5078 14.4381 15.0617 14.8157 15.5871C14.8315 15.6093 14.8599 15.6188 14.8859 15.6109C16.5201 15.1054 18.1772 14.3427 19.8879 13.0864C19.9028 13.0753 19.9123 13.0586 19.9139 13.0404C20.3309 8.72626 19.2154 4.97883 16.9568 1.65674C16.9513 1.64564 16.9419 1.6377 16.9308 1.63294ZM6.68335 10.7674C5.69792 10.7674 4.88594 9.86274 4.88594 8.75167C4.88594 7.6406 5.68217 6.7359 6.68335 6.7359C7.69239 6.7359 8.49651 7.64855 8.48073 8.75167C8.48073 9.86274 7.68451 10.7674 6.68335 10.7674ZM13.329 10.7674C12.3435 10.7674 11.5316 9.86274 11.5316 8.75167C11.5316 7.6406 12.3278 6.7359 13.329 6.7359C14.338 6.7359 15.1421 7.64855 15.1264 8.75167C15.1264 9.86274 14.338 10.7674 13.329 10.7674Z" fill="#424D57"></path></g><defs><clipPath id="clip0_613_10386"><rect width="20" height="15.493" fill="white" transform="translate(0 0.25354)"></rect></clipPath></defs></svg></i><div>Discord</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Follow us</div><div class="css-1ws0nkq">Follow our insightful tweets and interact with our content.</div><a href="https://twitter.com/TextPlatform" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-twitter undefined" viewBox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23z"></path></svg></i><div>Twitter</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contribute</div><div class="css-1ws0nkq">See something that&#x27;s wrong or unclear? Submit a pull request.</div><a href="https://github.com/livechat/livechat-public-docs" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-github undefined" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2z"></path></svg></i><div>GitHub</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contact us</div><div class="css-1ws0nkq">Want to share feedback? Reach us at:<!-- --> <a href="mailto:developers@text.com">developers@text.com</a></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/getting-started","query":{},"buildId":"mT926s0W5VyhfFaApGsyO","assetPrefix":"/docs","runtimeConfig":{},"nextExport":true,"autoExport":true,"isFallback":false}</script><script nomodule="" src="/docs/_next/static/chunks/polyfills-c2dc1d9251306528e50c.js"></script><script src="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" async=""></script><script src="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" async=""></script><script src="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" async=""></script><script src="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" async=""></script><script src="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" async=""></script><script src="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" async=""></script><script src="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" async=""></script><script src="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" async=""></script><script src="/docs/_next/static/chunks/pages/getting-started-5cdf0fb376cce0ea048b.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_buildManifest.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_ssgManifest.js" async=""></script></body></html>

Pages: 1 2 3 4 5 6 7 8 9 10