CINXE.COM
Complete API reference
<!DOCTYPE html> <html lang="en-US"> <head> <meta name="referrer" content="no-referrer"> <link href='//fonts.googleapis.com/css?family=Open+Sans:400,300,700&subset=latin,latin-ext' rel='stylesheet' type='text/css'> <link rel="preconnect" href="https://fonts.googleapis.com"> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <link href="https://fonts.googleapis.com/css2?family=Poppins:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;0,800;0,900;1,100;1,200;1,300;1,400;1,500;1,600;1,700;1,800;1,900&display=swap" rel="stylesheet"> <script src='https://code.jquery.com/jquery-3.6.0.min.js' type='text/javascript'></script> <script src='https://code.jquery.com/jquery-migrate-1.4.1.min.js' type='text/javascript'></script> <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery.colorbox/1.6.4/jquery.colorbox-min.js"></script> <script type="text/javascript"> jQuery(window).load(function() { // Auto-handle direct jpeg links jQuery('.ArticleContent a.FileImage').each(function() { jQuery(this).colorbox({photo:true,scalePhotos:true,maxWidth:'90%',maxHeight:'90%'}); }); jQuery(".ArticleContent img").each(function() { var pic_real_width; var image = new Image(); image.src = jQuery(this).attr("src"); pic_real_width = image.naturalWidth; if(pic_real_width>jQuery(this).width()) { jQuery(this).wrap("<a href=\"" + jQuery(this).attr('src') + "\"></a>"); jQuery(this).parent().colorbox({photo:true,scalePhotos:true,maxWidth:'90%',maxHeight:'90%'}); } }); }); </script> <meta name="norton-safeweb-site-verification" content="ot0i6xe4uoo1isth7zqv-pxuczevdfbs350l595s51qtc4ukdgr04qh4nwkjjuehjrfsgrz9o0vm6s3gqpcxbdprehhiy-n-agc97sfi587fj5uum4te0-4zzbbayw0g" /> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="canonical" href="//support.liveagent.com/840770-Complete-API-reference" /> <link href="/./themes/kb/montana/kb.css?v=5.51.5.26" rel="stylesheet" type="text/css"/> <link href="static/webpack/liveagent-common-bundle/bundle.e3f8621f3498fb9699e2.css" rel="stylesheet" type="text/css"/> <link rel="stylesheet" href="index.php?type=css&v=5.51.5.26&c=1732649701&kbid=eb4a77da" type="text/css"> <script src="static/webpack/liveagent-common-bundle/bundle-09c5bdd57d387328717c.esm.js" type="text/javascript" ></script> <script src="static/webpack/liveagent-common-bundle/stringutils-de61a176319e908e4d31.esm.js" type="text/javascript" ></script> <link rel="apple-touch-icon" href="/themes/kb/montana/img/apple-touch-icon.png" /> <link type="image/x-icon" href="//support.qualityunit.com/themes/kb/classic/img/favicon.ico" rel="shortcut icon" /> <link type="image/x-icon" href="//support.qualityunit.com/themes/kb/classic/img/favicon.ico" rel="icon" /> <link rel="mask-icon" href="/themes/kb/montana/img/kb-mask-icon.svg" color="#F6921E"> <script type="text/javascript"> (function(d, src, c) { var t=d.scripts[d.scripts.length - 1],s=d.createElement('script');s.id='la_x2s6df8d';s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, '//support.qualityunit.com/scripts/track.js', function(e){}); </script> <style> @import url('https://fonts.googleapis.com/css2?family=Poppins:wght@200;300;400;600;800&display=swap'); h2, h3, h4 { margin: 25px 0px 15px 0px; } h3 { font-size: 20px; } h4 { font-size: 16px; } img:not(.UserAvatar) { display: block; margin: 10px auto !important; } figure { margin: auto; } .inlineImg { display: inline-block; } .category-box-13233 { display: none; } #scroll-top { right: unset; left: 25px; } .addInfo { padding: 15px; background-color: #F44336; color: white; margin-bottom: 15px; border-radius: 7px; text-align: center; } .addInfo.green { background-color: #04AA6D; } .addInfo a { color: white; text-decoration: underline; } .addInfo.code { background-color: #FFF0B3; border: none; color: black; text-align: left; overflow: auto; white-space: pre; } .addInfo.code a { color: black; text-decoration: none; } .addInfo.code a:hover { color: black; text-decoration: underline; } .footer-container { display: none; } .footer-links { border: none; background: black; color: white; } .footer-links li { padding-left: unset; } .footer-links h5, .footer-links li a, footer a { color: white; text-decoration: none; } .product-links li a:hover, .popular-links li a:hover, footer a:hover { color: white; text-decoration: underline white; } .footer-links li:before, .footer-links .popular-links li:before { content: unset; } .product-desc.socials a:hover { text-decoration: none; } footer svg { fill: white; } .product-desc svg { margin: 0 0 0 5.5%; } #copyright { margin-top: 30px; } .floatRight { float: right; } @media (max-width: 768px) { .floatRight { float: unset; } } .scrolled .navbar { position: absolute; } div.Avatar { border-radius: 25px; width: 50px; } .navbar,.scrolled .navbar { background: white; } .nav>li>a:focus, .nav>li>a:hover, .nav-pills > li.active > a, .nav-pills > li.active > a:hover, .nav-pills > li.active > a:focus { background-color: unset; border-color: unset; color: #000; } .menu_overlay { position: absolute; bottom: 0; left: 0; right: 0; background-image: linear-gradient(to left, #FFBD39, #FA9531); width: 0; height: 10%; transition: .5s ease; } .nav>li>a:hover .menu_overlay { width: 100%; } .input-group .form-control:not(:first-child):not(:last-child), .input-group .form-control:first-child { border-radius: 25px 0 0 25px; padding-left: 25px; } .input-group .form-control:not(:first-child):not(:last-child)::placeholder { color: black; } .input-group .form-control:not(:first-child):not(:last-child):after { content: \1F50D; color: black; } .input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle), .input-group-btn:last-child>.btn { border: none; border-radius: 0 25px 25px 0; color: white; background-image: linear-gradient(to left, #FFBD39, #FA9531); border-image: linear-gradient(to left, #FFBD39, #FA9531); } .jumbotron { padding: 100px 0 10px 0; } .jumbotron p, .jumbotron .breadcrumbs a { color: black; } .jumbotron .inner-margin-top { padding-top: 0; } .panel.panel-default { border: none; box-shadow: none; } .panel.panel-default a, .panel.panel-default a:hover { color: black; } .panel-default>.panel-heading { background-image: linear-gradient(to left, #FFBD39, #FA9531); border-image: linear-gradient(to left, #FFBD39, #FA9531); border-radius: 7px 7px 0 0; color: white; } .panel>.list-group { border: 1px solid #ddd; border-radius: 0 0 7px 7px; } .panel .panel-footer { border: none; background: none; } .MoreLinkTitle { padding-left: 30px; } .item-A:before { content: "\00a0"; background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M217.32 228.08a6.69 6.69 0 01-6.7 6.72h-44.25l-102.18-.19a6.7 6.7 0 110-13.39l102.17.19h37.54L203.11 29 51.4 28.38l.11 29h103a6.7 6.7 0 110 13.39H51.56l.11 31 129.72 1.07a6.7 6.7 0 010 13.4h-.06l-129.61-1.09.07 17.75h47.55a6.7 6.7 0 110 13.39h-47.5l.07 19.78h126.34a6.7 6.7 0 010 13.39H52v15.76a6.69 6.69 0 01-6.67 6.72 6.69 6.69 0 01-6.7-6.67l-.2-54.43a6.39 6.39 0 01-.12-1.25 6.67 6.67 0 01.11-1.19L38 21.68v-.05-.33a1.83 1.83 0 010-.3v-.34a1.64 1.64 0 010-.32 3.38 3.38 0 01.2-.34c0-.1 0-.2.08-.31s.08-.21.12-.31a1.82 1.82 0 01.11-.3c0-.1.09-.2.14-.3a2.44 2.44 0 01.14-.28c.05-.1.11-.19.16-.28l.17-.28c.06-.08.13-.16.19-.25a2.56 2.56 0 01.2-.26c.06-.08.13-.15.19-.22l.24-.26.21-.19.26-.24.23-.17.29-.22.23-.14.32-.19c.08 0 .17-.08.25-.12a2.49 2.49 0 01.33-.16l.28-.1.34-.13.3-.08.34-.08.33-.06L44 15h.72l165.11.62a6.7 6.7 0 016.67 6.67z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; background-size: 50%; } .item-A:before { color: #ddd; } .category-list .item-A:before, .category-list .item-C:before { background-size: 100%; } .category-box-title:before, .item-C:before { content: "\00a0"; background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M216.31 83.68A6.7 6.7 0 00210.2 78c-28.6-2.21-47.58-1.7-65.94-1.21-10.84.29-21.11.56-32.63.22a78.54 78.54 0 00-7.52-4.8 56.35 56.35 0 01-7.6-5 17.6 17.6 0 00-4.41-2.88 17.69 17.69 0 00-6.74-1.19l-3-.07c-15-.39-25.9-.67-48.87 3.45A6.69 6.69 0 0028 72.4c-3 30.27-5.51 70.58 1.55 114a6.69 6.69 0 005.81 5.57 666.56 666.56 0 0080.15 4.56c28.57 0 59.62-1.52 94.75-4.54a6.69 6.69 0 006.08-5.86c4.86-39.75 4.84-68.46-.03-102.45zm-12.6 95.38c-64.45 5.31-114.78 5.36-161.68.15-5.5-37.62-3.72-72.82-1.16-100.41 18.23-3 27.57-2.75 41.16-2.4l3 .08a14.87 14.87 0 011.77.1 13.39 13.39 0 011.18.9 67 67 0 009.37 6.26 55.12 55.12 0 017.6 5 6.68 6.68 0 004 1.53c12.84.47 23.91.17 35.63-.14 16.84-.46 34.21-.92 59.17.78 3.84 29.24 3.82 54.14-.04 88.15z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; background-size: 80%; } .category-box-5174 .category-box-title:before { background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M236.49 96.72a8.94 8.94 0 00-7.28-6l-65.16-8.62-29.9-58.86a8.92 8.92 0 00-8-4.88h-.12a8.92 8.92 0 00-7.95 5.1L89.84 83.14 24.93 93.52a8.93 8.93 0 00-4.75 15.28l47.71 45.5-10.23 65.31a8.93 8.93 0 0013.1 9.22l57.74-31.53 58.57 29.95a8.92 8.92 0 0012.84-9.57l-12-65 46.46-46.78a8.94 8.94 0 002.12-9.18zM172 143.4a8.91 8.91 0 00-2.45 7.91l9.56 51.79-46.64-23.85a8.92 8.92 0 00-8.34.12l-46 25.1 8.15-52a8.93 8.93 0 00-2.66-7.84l-38.08-36.32L97.3 100a8.93 8.93 0 006.7-5l22.51-47.47 23.78 46.84a9 9 0 006.71 4.85l52 6.87z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; } .category-box-5178 .category-box-title:before { background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M108.88 79.67c-28.34 0-51.4 23.46-51.4 52.31s23.06 52.31 51.4 52.31 51.4-23.47 51.4-52.31-23.06-52.31-51.4-52.31zm0 91.22c-21 0-38-17.45-38-38.91s17-38.92 38-38.92 38 17.46 38 38.92-17.04 38.91-38 38.91zM234 72.14a1.13 1.13 0 01-.1-.13c-.1-.14-.19-.28-.3-.41a6.7 6.7 0 00-9.42-1l-22.65 18.25c-1.41-16.42-4.1-32-9.11-39-5.49-7.61-19.2-12.52-41.92-15-38.65-4.27-107.61-.3-123.69 14-3.23 2.86-7.28 9.14-9.87 32.45a462.83 462.83 0 00-2.19 51.61c.12 16.83 1.31 72.66 11.46 84.27 2.14 2.44 8.64 9.86 54 12.76 10 .64 20.51.95 31 .95a425.52 425.52 0 0044.65-2.15c28.18-3.09 34.54-8.19 37-12.76 4.68-8.56 7.49-28.78 8.93-50.25l4.76 3.57c4.76 3.57 8.88 6.65 15.25 11.86a5.84 5.84 0 00.87.6l.13.07a6.86 6.86 0 00.91.42h.16a6.15 6.15 0 001 .25h.16a6.77 6.77 0 001 .09H226.85l.46-.07.23-.05a4.6 4.6 0 00.5-.13l.17-.06a5.59 5.59 0 00.57-.22h.09c.21-.1.42-.21.62-.33l.16-.11c.14-.09.28-.18.41-.28l.21-.17.34-.29.19-.19.32-.34.1-.12.07-.09.22-.3.17-.25.18-.3.15-.27c0-.1.09-.2.14-.31s.09-.19.13-.29.07-.21.1-.31.07-.21.1-.31a3 3 0 00.08-.32c0-.11.05-.21.07-.32a3.11 3.11 0 000-.32v-.33-.31-.48c-1.18-29-2-66.37 2.47-98.63a6.67 6.67 0 00-1.1-4.95zm-52.88 137.33zm8.5-77.12c-.26 35.79-3.77 67.92-8.36 76.85-4.32 3.82-33 8.73-76.45 8.18-41.76-.52-65.21-5.65-68.51-9.09-3.07-3.83-7.79-30.33-8.16-75-.37-45.37 4.22-70.89 7.55-74.47 7.49-6.64 44.13-12.3 81-12.3A297.63 297.63 0 01149 48.14c26.51 2.93 31.75 8.48 32.53 9.56 4.14 5.68 8.41 31.47 8.09 74.65zm13 17c.21-5.81.33-11.53.37-16.93.05-6.89 0-17.06-.48-28a6.54 6.54 0 002.61-1.27l15-12.14c-2.09 23.53-2 48-1.34 70.69l-4.26-3.2c-3.42-2.6-7.03-5.31-11.88-9.12z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; } .category-box-5177 .category-box-title:before { background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M244.91 216.22a5.28 5.28 0 00-.19-.71c-7.95-27.72-16.16-55.36-24.84-82.85q-12-38-25.08-75.55-8.15-23.55-16.52-47a6.09 6.09 0 00-3.11-3.59 4.89 4.89 0 00-3.75-.3c-15.45 4.58-31.23 7.65-47 10.91a3.93 3.93 0 00-1 .2 4.85 4.85 0 00-1.61-.21c-16.11-.53-32.22.06-48.34.09a5.66 5.66 0 00-5.58 5.58q-.25 9.08-.45 18.15V28.36v-5.82A5.63 5.63 0 0061.88 17c-16.11-.53-32.22.06-48.33.09A5.65 5.65 0 008 22.63q-1.32 43.75-1.49 87.52c-.14 26.81-.06 53.62-.08 80.42q0 23.19-.19 46.39a5.65 5.65 0 005.58 5.58c13.52.41 27.07 1.13 40.59.59q5.28-.23 10.55-.69a6 6 0 004.17-1.93 4.91 4.91 0 00.67-.85 5.44 5.44 0 004.78 2.76c13.52.41 27.07 1.14 40.59.59q5.28-.22 10.55-.69a6 6 0 004.17-1.93 4.82 4.82 0 001.41-3.65q-.13-24.54-.4-49.07-.21-20.56-.52-41.11-.25-18.69-.51-37.38-.25-19-.38-38-.06-9.61-.09-19.23 8.07 28.31 16.59 56.47 12.16 40.13 25.39 79.92 7.47 22.47 15.29 44.82a6.55 6.55 0 002.11 2.95 5.07 5.07 0 004.75 1c16.89-3.48 33.56-7.49 49.45-14.25a5.38 5.38 0 00.89-.37l.41-.17a4.84 4.84 0 002.59-3.46 5.35 5.35 0 00.04-2.64zM25.55 231.81l-8.11-.26c.17-25.32.15-50.64.14-76 0-27.38.06-54.76.45-82.13q.31-22.65 1-45.28c12.44-.11 24.87-.42 37.31-.2v38.09q0 19.04.15 38.3.12 18.64.27 37.28l.24 40.7q.18 24 .32 47.89v1.48c-10.56.63-21.15.46-31.77.13zm60.76-.12l-8.12-.25c.16-25.29 0-50.58-.13-75.87-.16-27.33-.28-54.66 0-82q.24-22.62.86-45.24c12.44-.1 24.87-.42 37.31-.2q0 19 .07 38.06t.35 38.24q.22 18.6.5 37.2.28 20.3.53 40.59.27 23.93.42 47.86v1.47c-10.58.64-21.18.45-31.79.14zm139.78-15c-3.78 1.3-7.61 2.47-11.47 3.54-6.91 1.91-13.9 3.49-20.91 5q-13-37.35-25-75-12.93-40.44-24.71-81.17-6.13-21-12-42.12c12.55-2.57 25.1-5.15 37.45-8.56 8.93 25.17 17.76 50.38 26.22 75.72s16.49 50.67 24.19 76.18q6.6 21.91 12.91 43.92l-1 .42q-2.86 1.07-5.68 2.04zM155.61 62.25a5.59 5.59 0 01-6.86-3.9 5.67 5.67 0 01.56-4.3 6 6 0 013.34-2.57c4.7-1.58 9.48-2.91 14.22-4.4 3-.94 6 1.11 6.86 3.9a5.67 5.67 0 01-.56 4.3 5.88 5.88 0 01-3.33 2.56c-4.74 1.5-9.52 2.82-14.23 4.41zM162 83.54a5.59 5.59 0 01-4.3-.56 5.6 5.6 0 01-2-7.64 5.94 5.94 0 013.3-2.56c4.69-1.62 9.52-2.78 14.21-4.42a5.5 5.5 0 014.3.56 5.65 5.65 0 012.57 3.33 5.71 5.71 0 01-.57 4.3 5.94 5.94 0 01-3.33 2.57c-4.7 1.64-9.53 2.81-14.18 4.42zm-.44 17.55a5.72 5.72 0 01.56-4.3 5.79 5.79 0 013.34-2.56c4.7-1.37 9.46-2.46 14-4.3a5.42 5.42 0 014.3.57 5.65 5.65 0 012.57 3.33 5.72 5.72 0 01-.57 4.3 6.14 6.14 0 01-3.33 2.57c-4.56 1.83-9.31 2.92-14 4.29a5.68 5.68 0 01-6.92-3.9zm32 12.67a5.63 5.63 0 01-3.89 6.87c-5.83 1.39-11.61 2.86-17.29 4.8-3 1-6-1.16-6.87-3.9a5.72 5.72 0 01.57-4.3 5.92 5.92 0 013.33-2.56c5.68-1.94 11.46-3.41 17.29-4.81a5.7 5.7 0 016.81 3.9zM113.24 59.7a5.64 5.64 0 01-5.58 5.58c-5 0-10-.13-14.94 0a5.58 5.58 0 110-11.16c5-.11 10 0 14.94 0a5.68 5.68 0 015.58 5.58zm-.74 22.13a5.64 5.64 0 01-1.63 4 5.88 5.88 0 01-4 1.63c-5 .17-10-.15-14.93 0A5.58 5.58 0 0188 77.88a5.83 5.83 0 014-1.64c5-.14 10 .18 14.93 0a5.65 5.65 0 015.57 5.59zm-21.22 27.89a5.58 5.58 0 010-11.16c4.91.09 9.79.47 14.7.07a5.46 5.46 0 014 1.64 5.59 5.59 0 010 7.89 6 6 0 01-4 1.63c-4.91.4-9.79.02-14.7-.07zm20.83 15.6a5.62 5.62 0 01-5.59 5.58c-6-.4-12-.71-18-.55a5.66 5.66 0 01-5.52-5.58c-.14-3.07 2.66-5.5 5.58-5.58 6-.16 12 .15 18 .55a5.72 5.72 0 015.53 5.58zm-59.63-65.5a5.64 5.64 0 01-5.58 5.58c-5 0-9.95-.13-14.93 0a5.67 5.67 0 01-5.58-5.58c-.14-3.06 2.66-5.52 5.58-5.58 5-.11 10 0 14.93 0a5.67 5.67 0 015.58 5.58zM51.75 82a5.69 5.69 0 01-1.64 4 5.84 5.84 0 01-3.94 1.63c-5 .17-10-.15-14.94 0A5.57 5.57 0 0127.29 78a5.82 5.82 0 013.94-1.64c5-.14 10 .18 14.94 0 3.12-.1 5.45 2.64 5.58 5.64zm-21.23 27.84a5.69 5.69 0 01-5.58-5.58 5.63 5.63 0 015.58-5.58c4.92.09 9.8.46 14.71.07a5.49 5.49 0 013.94 1.63 5.58 5.58 0 010 7.9 6 6 0 01-3.94 1.63c-4.91.39-9.79.02-14.71-.07zm20.83 15.6a5.6 5.6 0 01-5.58 5.56c-6-.4-12-.71-18-.55a5.66 5.66 0 01-5.58-5.58c-.14-3.07 2.66-5.5 5.58-5.58 6-.16 12 .15 18 .55a5.72 5.72 0 015.58 5.6z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; } .category-box-12915 .category-box-title:before { background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M160.56 102c-9.67 9.3-22 20.61-32.83 30.6-8.37 7.69-15.59 14.33-20 18.53-1.67 1.61-3.39 3.1-5 4.54-2 1.71-3.86 3.34-5.55 5.06l-4.28 4.42c-4 4.11-7.41 7.67-11 10.71-16 13.7-24.8 22.05-36 32.62l-5.2 4.92a6.66 6.66 0 01-8.62.47 6.56 6.56 0 01-2.35-1.1 14.89 14.89 0 01-4.42-4.74c-.11-.17-.22-.36-.36-.57l-.15-.14a6.7 6.7 0 01.22-9.47c36.35-34.69 74-69.19 110.39-102.55L146.78 85c6.08-5.56 11-4.89 14-3.34a9.54 9.54 0 015.21 7.2c.79 5.14-2.44 10.29-5.43 13.14zm54.73 10.37a6.7 6.7 0 01-6.7 6.7h-6.93a6.62 6.62 0 01-4-1.34 6.72 6.72 0 01.64 2.84v8.8a6.7 6.7 0 11-13.4 0v-8.8a6.61 6.61 0 01.28-1.9 6.69 6.69 0 01-2.25.4H176a6.7 6.7 0 010-13.39h6.93a6.47 6.47 0 012.07.32 7.61 7.61 0 01-.11-1.18v-8.8a6.7 6.7 0 0113.4 0v8.8a6.49 6.49 0 01-.29 1.93 6.69 6.69 0 013.65-1.08h6.93a6.69 6.69 0 016.71 6.73zm-143.92-3a6.71 6.71 0 01.46-9.46l5.66-5.13.33-.27-.1-.11-3.66-4a6.69 6.69 0 019.91-9l3.67 4 .08.1 5.55-5a6.7 6.7 0 119 9.92l-5.63 5.11a6.29 6.29 0 01.9.82l3.67 4a6.7 6.7 0 11-9.92 9l-3.66-4a6.21 6.21 0 01-.76-1 3.5 3.5 0 01-.38.39l-5.66 5.13a6.69 6.69 0 01-9.46-.46zM134 55.64a6.69 6.69 0 009.46.46l3.08-2.79 2.12 2.33a6.69 6.69 0 109.91-9l-2.11-2.33 2.77-2.52a6.69 6.69 0 00-9-9.92l-2.78 2.52-1.57-1.73a6.69 6.69 0 10-9.92 9l1.57 1.74-3.08 2.79a6.69 6.69 0 00-.45 9.45zm33.59 87.77a6.69 6.69 0 00-9.46-.46l-2.78 2.51-1.57-1.73a6.7 6.7 0 10-9.92 9l1.57 1.73-3.08 2.8a6.69 6.69 0 009 9.92l3.09-2.8 2.11 2.33a6.7 6.7 0 009.93-9l-2.12-2.34 2.77-2.51a6.7 6.7 0 00.48-9.45z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; } .category-box-13003 .category-box-title:before { background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M231.27 159.91a4.46 4.46 0 01-2.87 5.62 43.82 43.82 0 00-26.48 24.59 4.44 4.44 0 01-3.83 2.74h-.29a4.47 4.47 0 01-3.87-2.24 39.37 39.37 0 00-9.28-10.9 4.46 4.46 0 115.6-6.94 46.67 46.67 0 017 6.93 52.72 52.72 0 0128.4-22.71 4.46 4.46 0 015.62 2.91zm14 29.82a48.86 48.86 0 01-25.55 26 36.26 36.26 0 01-14.23 3.12 26.41 26.41 0 01-10-1.89c-5.59-2.28-13.94-9.06-17.47-12.93-5.6-6.13-7.15-10.86-9.12-16.84-.28-.86-.58-1.76-.91-2.74a44.92 44.92 0 014-37.24 43.63 43.63 0 0131-20.57 6.7 6.7 0 011.48 0c.21 0 .43-.1.65-.13 16.52-2.37 34 9.07 40.74 26.64a50 50 0 01-.54 36.58zm-12-31.87c-3.9-10.23-14.83-19.81-26.32-18.15a6.31 6.31 0 01-1.5 0 5.1 5.1 0 01-.68.13 30.52 30.52 0 00-21.35 14.23 31.85 31.85 0 00-2.78 26c.34 1 .65 2 .95 2.85 1.8 5.48 2.63 8 6.3 12 2.68 2.94 9.54 8.3 12.63 9.56 5 2.05 10.86.17 13.89-1.13A35.39 35.39 0 00233 184.59a36.45 36.45 0 00.34-26.73zm-66.52 32.64a6.69 6.69 0 01-6.45 6.93c-18.27.67-33.88 1.09-49 1.09-18.29 0-35.85-.61-56.51-2.12-2.23-.16-9-.66-13.48-5.68-3.8-4.28-4.06-9.91-4.22-13.28l-.27-6a6.21 6.21 0 01-.61-1l-32.46-70C2.62 98 .26 92.9 2.29 87.62c1.94-5.05 6.61-7.17 9.12-8.31 46.06-20.9 92.92-41.73 139.27-61.93a6.68 6.68 0 018.54 2.91 336.53 336.53 0 0124.59 56.49h2.47c6.18.14 13.91.86 18.76 5.26 6.71 6.08 9.14 18 7.66 37.35a6.69 6.69 0 11-13.35-1c1.55-20.32-2.13-25.35-3.3-26.4-.42-.38-2.38-1.63-10.07-1.8L64.54 87.51c-5.19-.12-9.72-.05-12.56 2-4.64 3.32-4.91 11.81-4.57 19.67 1 22.45 2 45.21 3.06 67.66.06 1.28.2 4.27.86 5 .2.23 1.09 1 4.44 1.21 37.09 2.71 64.14 2.47 104 1a6.72 6.72 0 016.98 6.45zm2.82-114q-3.16-9.12-6.88-18C151.27 64.15 138.6 70 126 75.48zm-19.2-44.34c-31.91 13.93-64 28.16-96 42.48a56 56 0 0110.43-.48l27.47.61.5-.22c20.62-7.8 44.56-18.34 64.48-28.37-2.16-4.77-4.45-9.45-6.88-14.06zM15 92.51a17.49 17.49 0 00.92 2.28l5.76 12.42c1.86-.8 3.88-1.71 5.87-2.61 2.15-1 4.34-2 6.42-2.86.29-7.18 2-16 8.53-21.77q-12.83 5.76-25.56 11.54a16.73 16.73 0 00-1.94 1zm20.24 43.94q-.45-10.14-.9-20.23l-1.25.57c-1.93.88-3.89 1.76-5.77 2.58zm72.52-31.9c-.2 3.39-.07 6.85.06 10.51a116.2 116.2 0 010 11.82 6.69 6.69 0 01-6.2 6.28c-6.47.46-12.26.64-17.92.64-7 0-13.88-.28-21.64-.64a6.69 6.69 0 01-6.39-6.59c0-2.22-.13-4.42-.24-6.75a94.58 94.58 0 01.29-17.68 6.69 6.69 0 016.92-5.78c3.86.17 7.44.36 10.9.55a262.56 262.56 0 0027.2.55 6.69 6.69 0 017 7.09zm-13.19 15.61c0-1.5-.09-3-.15-4.6s-.11-3-.15-4.55c-7.53 0-14.33-.33-21.44-.72l-4.24-.23c0 3 .1 6 .25 9.13v.87c9.06.37 16.8.52 25.73.1zm94-4a6.7 6.7 0 000-13.39h-3.73c-11 0-19.73-.09-31.7.42a6.7 6.7 0 00.28 13.39h.3c11.64-.5 20.21-.46 31.06-.41zm-18 5.45c-10.49.55-16.33.48-30.44.32l-4.19-.05h-.08a6.7 6.7 0 00-.07 13.4h4.18c5.77.07 10.19.12 14.11.12 5.87 0 10.64-.12 17.19-.46a6.69 6.69 0 10-.7-13.37z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; } .category-box-5714 .category-box-title:before { background: url("data:image/svg+xml,%3C?xml version='1.0' encoding='UTF-8'?%3E %3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M127.38 51h-.75a6.83 6.83 0 00-2-.24 47.3 47.3 0 00-43.2 62.91c6.57 18.79 25.74 31.58 45.35 31.58a44.3 44.3 0 009.29-1c22.54-4.89 39.14-27.55 37-50.5S150.45 51.59 127.38 51zm5.86 80.21c-15.86 3.44-33.8-6.61-39.16-21.93a33.91 33.91 0 0131-45.1h.38a6.51 6.51 0 001.6.23c16.24.43 31.22 14.46 32.73 30.64s-10.68 32.7-26.55 36.14zm78.08-55.81c-3.61-3.53-7-6.86-8.47-10.51-1.39-3.5-1.42-8.15-1.45-13.07-.06-8.64-.14-19.39-9.39-25.57-5.58-3.73-12.1-3.85-17.35-3.95h-1.32c-14.34-.36-18.59-4.69-23.14-9.3-3.85-3.87-8.61-8.67-17.93-9.69-9-2.47-20.06 3.62-24.84 9.21-1.06 1.23-2 2.48-3 3.7-2.35 3-4.57 5.88-7.17 7.18-3.18 1.6-7.73 1.31-12.56 1-6.94-.44-14.81-.95-21.65 4-8.9 6.4-9.51 16.66-10 25.71-.34 5.66-.66 11-2.82 14.75-1.29 2.23-3.53 4.31-5.91 6.5-3.43 3.18-7.32 6.78-9.54 12-2.79 6.56-3.68 17.57 8 32.79l2.09 2.68c4.82 6.16 9.37 12 9.63 18.18a37.6 37.6 0 01-.4 5.73c-.58 4.84-1.29 10.88 1.88 16.51 5.59 9.93 16.49 9.75 25.23 9.6h3.34a2.81 2.81 0 000 .29c.32 19.81-.15 39.88-1.38 59.67a6.7 6.7 0 009 6.69l36.21-13.48c3.58 1.63 7.14 3.14 10.6 4.62a196.56 196.56 0 0120.57 9.68 6.67 6.67 0 003.3.87 6.68 6.68 0 006.68-6.26c1.36-20.62 1.73-39.66 1.19-61.31 7.27-.44 15.46-1 22.07-6.64 7.77-6.63 8.91-16.24 9.92-24.72.61-5.1 1.18-9.92 3-13.65 1.52-3.09 4.2-6 7-9.19 5.34-5.92 11.39-12.64 11.11-22.27S217.06 81 211.32 75.4zm-54.58 148.36c-4.21-2-8.41-3.77-12.53-5.53s-8.49-3.6-12.69-5.6a6.73 6.73 0 00-5.21-.22L97.07 223.3c.76-15.67 1-31.46.85-47.11a80 80 0 017.4 5.89c6.28 5.4 13.31 11.45 22.63 11.45a22 22 0 003.19-.24c7.85-1.13 13.2-6.27 17.92-10.79 2.82-2.7 5.48-5.25 8.3-6.63.37 16.81.19 32.13-.62 47.89zm46-113.39c-3.32 3.68-6.75 7.48-9.09 12.23-2.86 5.8-3.63 12.28-4.31 18-.82 6.91-1.53 12.89-5.31 16.11-3.29 2.81-8.47 3.12-14.47 3.48-5.68.34-12.11.73-18 3.57-4.76 2.3-8.52 5.9-11.83 9.07-3.74 3.59-7 6.69-10.57 7.21-4.57.67-8.78-2.62-15.17-8.12-5.13-4.42-11-9.42-18.32-11.38a43.37 43.37 0 00-11.2-1.17H80.9c-7.94.14-11.83-.1-13.34-2.77-1-1.84-.67-4.87-.25-8.38a49.21 49.21 0 00.48-7.88c-.44-10.5-6.83-18.66-12.46-25.85-.68-.87-1.35-1.72-2-2.58-4.27-5.57-8.83-13.45-6.3-19.38 1.1-2.57 3.52-4.81 6.32-7.41s6.1-5.64 8.4-9.62c3.75-6.49 4.2-14 4.6-20.67.47-8 1-13.13 4.49-15.62 2.94-2.12 7.59-1.82 13-1.47 6.09.39 13 .84 19.43-2.39 5.3-2.66 8.72-7 11.73-10.93.89-1.14 1.73-2.22 2.58-3.21 2.71-3.17 9.06-5.72 11.16-5a7 7 0 001.62.34c4.92.42 6.83 2.35 10.31 5.86C146 27.84 153.33 35.2 173 35.67h1.38c4 .08 7.85.15 10.16 1.7 3.19 2.13 3.38 6.91 3.43 14.53 0 5.66.09 12.08 2.41 17.91 2.5 6.3 7.31 11 11.55 15.15 4.5 4.39 8.38 8.19 8.5 12.47s-3.43 8.3-7.64 12.94z'%3E%3C/path%3E%3C/svg%3E") no-repeat center; } .category-box-14283 .category-box-title:before { background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' data-name='Layer 1' viewBox='0 0 250 250'%3E%3Cpath d='M114.11 111.41q3.26 23.61 7.07 47.14a5.59 5.59 0 003.89 3.9h.23a5 5 0 002.74 0 6.45 6.45 0 001.16-.51 4.56 4.56 0 002.74-3.39c3.88-25.42 8.2-50.87 10-76.56.23-3.21.65-6.51.1-9.71-.73-4.29-4.36-6.84-8.42-7.55a44.88 44.88 0 00-10.85-.66c-3.66.27-7.77.75-10.53 3.47a9.42 9.42 0 00-2.8 6.3 28.8 28.8 0 00.46 5.07q.63 5.18 1.29 10.34 1.39 11.09 2.92 22.16zm9.11-36.21a40.77 40.77 0 014.69 0c.7 0 1.42.08 2.11.19h.15l1 .17c0 .59 0 1.17-.08 1.75-.08 1.41-.16 2.82-.26 4.23-.4 5.85-.95 11.68-1.59 17.51q-.49 4.5-1.06 9c-.18 1.44-.36 2.87-.55 4.3-.09.68-.17 1.36-.27 2 .2-1.43 0 .1 0 .33-.07.45-.13.9-.19 1.36-.18 1.32-.38 2.64-.56 4-.18-1.25-.38-2.5-.55-3.75-.47-3.28-.93-6.55-1.37-9.83-.12-.82-.23-1.64-.34-2.46l-.13-1c0-.09-.08-.58-.12-.84v.36c-.22-1.64-.44-3.28-.65-4.92q-1.31-9.85-2.5-19.71c-.1-.79-.21-1.59-.29-2.39.14 0 .28-.07.42-.09.39-.08.45-.14.39-.17.59-.06 1.53-.02 1.75-.04zm.79 26.88zm3.61 70.15a4.33 4.33 0 00-.63 0 3.76 3.76 0 00-.58 0c-6.62.31-13.09 3.67-15.57 10.09-2.16 5.58.21 13 5.73 15.62 3.45 1.66 7.35 1.5 11.09 1.39s7.59-.15 11-1.67c6.28-2.79 7.72-11.24 4.22-16.71a19.18 19.18 0 00-15.26-8.72zm5.84 14.55c.07 0 .11.21.15.39-.11-.17-.2-.41-.15-.39zm-1.5-1.62l-.24-.2a.82.82 0 01.28.2zm-10.72 1a.37.37 0 000-.11l.13-.2zm0 1.41zm-.07-.86v.38a2 2 0 01-.06-.3.22.22 0 00.04-.07zm.81 1.48h-.06zm10.57-.26h.1zm.27-.06l-.74.06c-.73.06-1.47.11-2.2.15-2.55.14-5.09.13-7.64.07l-.41-.09.1.09-.13-.09.06.08a1.74 1.74 0 01.12.14 1.14 1.14 0 00-.11-.11s-.11-.05-.2-.16c0 .18-.07.16-.17-.09-.29-.11-.33-.21-.21-.2 0-.07 0-.1.08-.05l-.13-.14.18.15a1.31 1.31 0 01-.07-.19l-.1-.17.07.09c0-.06 0-.13-.08-.2s0-.34 0-.51v-.3l.09-.38.09-.27.15-.18a1.34 1.34 0 01.18-.24.79.79 0 00.15-.26 1 1 0 01-.07.18c.16-.15.31-.29.46-.45l.38-.25.69-.4.33-.16h.12c.31-.11.62-.21.93-.29l.64-.16.71-.11H128l.8.18c.34.08.67.2 1 .3l.48.23c.38.2.74.42 1.1.65l.16.09a17.11 17.11 0 011.49 1.46c.13.2.27.4.39.6l.19.35v.19-.05.06a.83.83 0 010 .13V187.69a.19.19 0 010-.08l-.27.07zm-10.24.36l-.27-.06c.13.02.25.04.25.07zm11-.25zm-.06.1a.73.73 0 00-.06.22zm0 0l.1-.07c-.04.1-.09.13-.11.05zm0-.24h.07v.05a.22.22 0 01-.06-.07zm-12-2.2c.08-.09.14-.18.2-.26l.08-.08c-.16.5-.38.56-.24.32zm.07 2.31l.18.14h-.06l.07.09-.22-.19a.12.12 0 010-.05h-.12v-.05a.65.65 0 01-.19-.15h.16a.23.23 0 01-.07-.07v.05c0-.08-.08-.15-.12-.24v-.08a3 3 0 01.28.44zm11.94-.27l.06-.2v.28h-.08v-.08a.64.64 0 01.06-.02zm113.57 5.84a4.24 4.24 0 00-.29-1.18 4.78 4.78 0 00-.59-1.37c-6.42-15.08-13.66-29.79-21.2-44.33-8.64-16.63-17.7-33-27-49.31q-12.93-22.57-26.59-44.75c-6.5-10.58-13.1-21.14-20.24-31.31a94.63 94.63 0 00-6.72-8.83 14.91 14.91 0 00-3.69-2.92A40.66 40.66 0 00122 4a32.72 32.72 0 00-9.08 1 5.28 5.28 0 00-.66.16 4.88 4.88 0 00-.64.23c-6.46 2.35-11.18 8.56-15.21 13.79a236 236 0 00-16.07 24.55c-5.94 10.1-11.54 20.41-17 30.78-5.27 10-10.41 20.07-15.53 30.16-3.86 7.6-7.67 15.24-11.7 22.77-.35.64-.69 1.29-1.05 1.93a289.23 289.23 0 00-16.76 28.89q-3.81 7.55-7.17 15.31A159.44 159.44 0 004.73 190c-3.17 10.34-3.79 22.73 2.8 32a24.14 24.14 0 0010.21 8.42 47.88 47.88 0 0012.49 3.34c10.51 1.44 21.09 1.09 31.67.91l24.18.18q22.23.15 44.46.23 23.81.08 47.61 0c11.21-.06 22.45-.06 33.65-.57a46.71 46.71 0 0014.57-2.65 38.48 38.48 0 0015.14-9.7 26.61 26.61 0 007.14-18.38 47.35 47.35 0 00-1.51-10.28zM105.81 25.07zM237 208.19c-.09.35-.33.82-.49 1.27.07-.08.11 0-.06.42a.8.8 0 00-.08.16V210.06c-.14.29-.29.59-.44.87-.27.5-.56 1-.86 1.45-.19.29-.39.56-.58.84a26.62 26.62 0 01-2.53 2.67c-.22.2-1.08.76-1.44 1.13.24-.21.6-.33.13 0l-.26.19c-.2.14-.39.29-.59.42a35.34 35.34 0 01-3.7 2.2q-.79.4-1.62.78l-.12.05h.12c-.23.07-.45.19-.68.27a39.83 39.83 0 01-4.13 1.35c-1.13.3-2.28.52-3.43.73s-2.15.19-3.22.24c-10.52.56-21.08.54-31.61.61-15.49.11-31 .1-46.48.06q-22.44-.06-44.89-.21l-26.83-.2H61.9c-8.73.15-17.49.48-26.2-.27-1-.09-2.06-.2-3.09-.32H32.32l-1.73-.28a47.31 47.31 0 01-5.65-1.33c-.76-.24-1.5-.51-2.25-.79l-.13-.06c-.43-.2-.86-.42-1.29-.64-.65-.36-1.29-.75-1.9-1.17h-.05c-.29-.26-.59-.51-.87-.79s-.73-.76-1.07-1.16c-.07-.07-.58-.82-.43-.57a20.82 20.82 0 01-1.74-3.13l-.1-.19c0-.07 0-.15-.1-.28-.2-.55-.39-1.11-.55-1.67a31.42 31.42 0 01-.77-3.46v-.11-.37c-.05-.52-.08-1-.1-1.57a32.07 32.07 0 01.09-3.67c0-.51.08-1 .15-1.51.05-.3.16-.91.2-1.11.25-1.36.56-2.71.92-4a79.64 79.64 0 012.56-7.69c.47-1.23 1-2.45 1.45-3.67.23-.57.46-1.14.7-1.71l.36-.86.08-.2.07-.17q3.11-7.23 6.57-14.31a289.2 289.2 0 0118-31.38 4.12 4.12 0 00.33-.62c3.67-6.73 7.09-13.59 10.56-20.41 5-9.78 9.93-19.56 15-29.28C76 74.31 81.55 64 87.38 53.82a294.87 294.87 0 0116.19-25.69c.61-.85 1.23-1.69 1.87-2.52a.35.35 0 010-.08l.08-.1 1-1.25a81.18 81.18 0 013.46-4 38.75 38.75 0 013.07-2.94c.23-.14.45-.35.65-.49a13.66 13.66 0 011.42-.85h.09c.67-.19 1.35-.36 2-.49l.83-.17h.16a35 35 0 014.58-.07l1 .08h.39a16.59 16.59 0 011.65.34 32.76 32.76 0 014.45 1.28l.79.29.39.15c.58.24.53.22-.16-.07.36-.09 1.6.75 1.9.9.9.46 1.75 1 2.62 1.48a27.51 27.51 0 012.23 2.58l.63.84c.55.74 1.09 1.49 1.63 2.24 6.82 9.52 13.06 19.47 19.25 29.41Q173 76.16 185.61 98.07c9.24 16 18.24 32.18 26.86 48.55 7.78 14.77 15.32 29.7 22 45l1 2.29.51 1.18c0 .06.06.13.09.21.43 1.71.84 3.42 1.13 5.16 0 .21.39 1.74.07.42a7.74 7.74 0 01.12 1.19 26.52 26.52 0 01.06 3.09c0 .32-.05.63-.06 1V206.57c-.15.51-.26 1.07-.39 1.62zm-.64 1.87a.9.9 0 01.15-.6 2 2 0 00-.14.58zm-6 7.09l.05-.06zm.09-.1zm-6.17 3.64c-.4.15-1.14.36 0 0zm6.08-3.54a.36.36 0 000 .09.41.41 0 01.02-.09z'/%3E%3C/svg%3E") no-repeat center; } #statusPageArticle:before { margin-top: 10px; background: url("data:image/svg+xml,%3Csvg fill='%23000000' height='40px' width='40px' id='Layer_1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' viewBox='0 0 512 512' xml:space='preserve'%3E%3Cg id='SVGRepo_bgCarrier' stroke-width='0'%3E%3C/g%3E%3Cg id='SVGRepo_tracerCarrier' stroke-linecap='round' stroke-linejoin='round'%3E%3C/g%3E%3Cg id='SVGRepo_iconCarrier'%3E%3Cg%3E%3Cg%3E%3Cpath d='M442.667,53.333h-86.293c-2.24-6.4-8.213-10.667-15.04-10.667h-16v-32C325.333,4.8,320.533,0,314.667,0H197.333 c-5.867,0-10.667,4.8-10.667,10.667v32h-16.853c-6.613,0-12.373,4.373-14.4,10.667h-86.08c-5.867,0-10.667,4.8-10.667,10.667 v437.333c0,5.867,4.8,10.667,10.667,10.667h373.333c5.867,0,10.667-4.8,10.667-10.667V64 C453.333,58.133,448.533,53.333,442.667,53.333z M208,21.333h96v21.333h-96V21.333z M176,64h10.667H336v42.667H176V64z M165.44,128h181.333c5.867,0,10.667-4.8,10.667-10.667h32v164.16h-0.107l-12.16-20.267c-2.027-3.413-5.653-5.333-9.6-5.12 c-3.84,0.107-7.36,2.453-9.173,5.867l-11.733,23.573l-22.4-44.907c-2.667-5.227-9.067-7.467-14.293-4.8 c-2.773,1.387-4.8,3.947-5.547,6.933l-21.76,86.613l-21.653-86.613c-1.173-4.693-5.44-8.107-10.347-8.107 s-9.173,3.413-10.347,8.107l-11.947,48.853l-20.587-91.307c-1.067-4.8-5.333-8.213-10.24-8.32s-9.28,3.2-10.453,8.107 l-23.147,92.48l-9.707-29.227c-1.813-5.547-7.893-8.64-13.44-6.72c-1.6,0.533-2.987,1.387-4.16,2.56l-13.867,13.76V117.333h32 C154.773,123.2,159.573,128,165.44,128z M389.227,322.773V448h-266.56V303.04l16.64-16.64l15.893,47.573 c1.813,5.547,7.893,8.64,13.44,6.72c3.413-1.173,6.08-3.947,6.933-7.573l21.12-84.48l20.693,91.84 c1.067,4.8,5.333,8.32,10.347,8.32c5.333,0.32,9.28-3.307,10.453-8.107l12.48-51.093l21.547,86.187 c1.387,5.76,7.253,9.173,12.907,7.787c3.84-0.96,6.827-3.947,7.787-7.787l24.96-100.053l19.093,38.187 c3.627,7.253,15.467,7.253,19.093,0l12.693-25.28L389.227,322.773z M432,490.667H80v-416h74.667V96H112 c-5.867,0-10.667,4.8-10.667,10.667v352c0,5.867,4.8,10.667,10.667,10.667h288c5.867,0,10.667-4.8,10.667-10.667v-352 C410.667,100.8,405.867,96,400,96h-42.667V74.667H432V490.667z'%3E%3C/path%3E%3C/g%3E%3C/g%3E%3C/g%3E%3C/svg%3E") no-repeat center; } #statusPageArticle { border-radius: 10px; } #statusPageArticle.status-okay { background-image: linear-gradient(to left, #35a945, #4BC65C); border-image: linear-gradient(to left, #35a945, #4BC65C); color: #FFF; } #statusPageArticle.status-degradation { background-image: linear-gradient(to left, #F6931E, #FA9531); border-image: linear-gradient(to left, #F6931E, #FA9531); color: #333; } #statusPageArticle.status-outage { background-image: linear-gradient(to left, #ea1b0d, #F44236); border-image: linear-gradient(to left, #ea1b0d, #F44236); color: #FFF; } #statusPageArticle.status-okay > .list-group-item-heading, #statusPageArticle.status-outage > .list-group-item-heading { color: #FFF; } #statusPageArticle.status-okay:before, #statusPageArticle.status-outage:before { filter: invert(1); } #statusPageArticle h3 { font-weight: bold; } .status-okay:hover { -webkit-box-shadow: 0 0 8px rgba(37,118,48,0.6); box-shadow: 0 0 15px rgba(37,118,48,0.6); z-index: 99; } .status-degradation:hover { -webkit-box-shadow: 0 0 8px rgba(207,106,0,0.6); box-shadow: 0 0 15px rgba(207,106,0,0.6); z-index: 99; } .status-outage:hover { -webkit-box-shadow: 0 0 8px rgba(163,18,9,0.6); box-shadow: 0 0 15px rgba(163,18,9,0.6); z-index: 99; } .category-box-5174 .category-box-title:before, .category-box-5178 .category-box-title:before, .category-box-5177 .category-box-title:before, .category-box-12915 .category-box-title:before, .category-box-13003 .category-box-title:before, .category-box-5714 .category-box-title:before, .category-box-14283 .category-box-title:before { background-size: 90%; width: 25px; height: 25px; } .category-box-title .category-link { margin-right: 5px; } /* Colorbox Core Style: The following CSS is consistent between example themes and should not be altered. */ #colorbox, #cboxOverlay, #cboxWrapper{position:absolute; top:0; left:0; z-index:9999; overflow:hidden; -webkit-transform: translate3d(0,0,0);} #cboxWrapper {max-width:none;} #cboxOverlay{position:fixed; width:100%; height:100%;} #cboxMiddleLeft, #cboxBottomLeft{clear:left;} #cboxContent{position:relative;} #cboxLoadedContent{overflow:auto; -webkit-overflow-scrolling: touch;} #cboxTitle{margin:0;} #cboxLoadingOverlay, #cboxLoadingGraphic{position:absolute; top:0; left:0; width:100%; height:100%;} #cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{cursor:pointer;} .cboxPhoto{float:left; margin:auto; border:0; display:block; max-width:none; -ms-interpolation-mode:bicubic;} .cboxIframe{width:100%; height:100%; display:block; border:0; padding:0; margin:0;} #colorbox, #cboxContent, #cboxLoadedContent{box-sizing:content-box; -moz-box-sizing:content-box; -webkit-box-sizing:content-box;} /* User Style: Change the following styles to modify the appearance of Colorbox. They are ordered & tabbed in a way that represents the nesting of the generated HTML. */ :root { --controlsIcon: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGIAAACCCAMAAACKP+2+AAAA0lBMVEX///8AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABmZmZOT1BKSkopKSkZGRoQEBAICAjv7+9aWlpra2uHiYt/gIF7e3t2d3hzc3Nub3Hq6uvq6+vm5udSUlLe3t9FRkdCQkI6OjotLS4hISG9vb3P0NIzMzPFxcbS09Str7GnqKmlpaaZmZmPkJKLi4vi4+SDg4TMzMzBw8Ta29y3ubvW1te0tbX39/f////g4eLY2drHyMqpq62Tk5Stra2goqShuidxAAAAD3RSTlMAESIzRFVmd4iZqrvM3e5GKvWZAAAFL0lEQVR4Xu3aV5eyOACA4dAHlYSOvfc6vc/Xdvf//6UNxiECo2AIZy923pu5cPQxEQKeCFRwOklWriDKqKbJsgROp4IqOJ+gnQWgAjKqAiSDjNRzQxCyBBkBZGT+Fx2HRwA/GoOYJQgGAnneSRWRrI4bCqOmi0haplBDIYGgmkEoRHA77TY26vf3HSLALEGFiBAYqWjxpLiBSPN2q+2Oms2eR4hKHJC0eBUMREQ6QzkmDGq0Hh8b/lfzpBgoHSFOpSc/DGK02yYW0oSOUH6CGmli0ul0um6CIAILgZQUMen1zG634aYIBbERRpKYNhp138GMlyQMRgJJccIzzZGPkNNoWISIDnYJsRJq4vxeWFjABob2iXSNYSToRIjoq+gKqhUnwNVXhMyVALUT08iREPQEAFXAiaDJlWNAFwFHgibJh+jr8yZo7ISz4EEsFqeJdW/Gg1ib8zQRLUGcCHP6JeFPTX4ENtKEb+EHGmsexNzEWX6S8O16SJizMJeV8Jw5rm6Gjfw44Vl1TGCj0et2uzNWYlbfZxLDowQRqMFOTEfUwHmUcO0RJbDBPopRyiCEa1mjmFGASBgOIVzbxgTBCbIuTlAjJNaYiBvshEUMikz2hD9LGgWIhGH5IUGMiC9KUAM39aODdm4f8UUIOzQiZEYPWmqQ5qzE2qYGESiBFseGy0q4NjH2yCK5DLp7f85lpd0ji/Ri7k6w4fAgHDwQ20NpAnkTmxNhR0JEUIMLsbCnREgTyJ/xIWY+ShLU8HkQ/n93H1U+8U18E2peQmUmxLyEyEpUQe6qjISUn5DYCBVckMpAQCLkN2Bugn7pvTBRh+eIiibHkgBTkhxLq0REVQQlJVYJoYMS00OiCkqtigmxXEJEQAclpwOlbEIBWtmEBoyyCQOgkoehIYCgVKYgQUwgqJQnKPCwRlVKQuTK8UpbjacxnJCiVo2Xdb3QhcsAQb/8qle7yBBqKINgNqjAQlxyxmiIjYD5CchIIDmvIH/fmRcgvolvwrszeRDm3UnCWw46PIju4NmLE1To8yE6g4AYScJ5G/YDPkQQBJt5mnC2w+EgaPIgHoPg42M4TxKT1cOwPwiC99flcmmxEpPrP3/vdkFIfPSncWL0Mn4YDvuYD2uzEtfhiwwI8eNH/Zio/3oZ/yTD4EdggxKPb5QIeBHY+Lj/JFrbt7eX8fiBGLgOOxG9T9ItIbpPq+1hGNgYFCLCqYgZzWPiYGBk0GUnyExFRkAI1FqRYWBjj/SLEGQYh7BACFTHxMEIkSEzcUNmIjLq9KC1iBEioVKIIMaACJRA083B2NdjJW6jycbIOLFF4uyNX083uFuHlXBub66vr9+GIfIyTy2Dz1uMNHgsg61wIEsnvZh716vtlgvRw5P1Gt8iocaKDzH++Xpqi6S1MvkQ96fvQLoWD2LU/r/dqulyzvQCo5DUGspIV4SiE6XAc0BN4vFZSPCMIPD5uOUIcAkw/xQMgdcRVUGk9rMTCn/1R3SDoyAhx3/buNg8bbBxN3x4JwIs/qVYSPzY1f6NjeZ4/J78savASujgsxo18PVx56VOTZ2NgEJ8k4UYv5/wGFKEAFkIKIE00Vk+bzZ2mgASvJyoUYESvffX291yOaEENWqXEYauUIAS5p/dnb/48/4+pQRN0Y3ThKGKeTa8Fv/cNH3852Z3n2u3SVSNT0LLu1jPWv6eavt59/00QqggMwGy7vupIaExX3OkfM8EhgDypLPu+wkQXIF8XSUAqOR9IpBBzmQdUsDQhNzP+xfqGeAsc0X+FgAAAABJRU5ErkJggg==); } #cboxOverlay{background:#000; opacity: 0.9; filter: alpha(opacity = 90);} #colorbox{outline:0;} #cboxContent{margin-top:20px;background:#000;} .cboxIframe{background:#fff;} #cboxError{padding:50px; border:1px solid #ccc;} #cboxLoadedContent{border:5px solid #000; background:#fff;} #cboxTitle{position:absolute; top:-20px; left:0; color:#ccc;} #cboxCurrent{position:absolute; top:-20px; right:0px; color:#ccc;} #cboxLoadingGraphic{background:url("data:image/gif;base64,R0lGODlhIAAgAPZBALGxsTU1NUBAQAoKCjAwMBcXFxgYGGNjYz4+PkNDQ1hYWFVVVWxsbDExMQcHB3Nzcy4uLnV1dZqamiMjI8rKyqCgoCEhIampqRAQEJmZmQEBAV5eXmBgYCUlJQMDAzo6OhUVFcnJyScnJxERESAgIImJiZeXl6qqqn5+fgAAAIeHhwwMDAgICAUFBWFhYaWlpc7Ozm5ubmhoaGdnZ56enpycnA4ODkxMTKGhoaysrEVFRUdHR2pqalBQUI6OjmVlZVxcXE5OTjw8PEhISFpaWre3t1FRURwcHFdXV8zMzB4eHkpKSigoKLW1tVNTU6Ojo7CwsNHR0Xd3d6enpywsLEFBQYqKihoaGoWFhTc3N9PT03p6ejMzM5GRkRMTE66uroGBgYyMjDg4OJWVlcPDw8XFxSoqKtXV1bOzs5CQkHBwcJOTk3Fxcbm5uYCAgLq6unx8fMHBwYODg3l5ecDAwMfHx76+vry8vNDQ0NfX1wAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh+QQEBQD/ACwAAAAAIAAgAEAH/4ApgoOEhYaHiINeGV8AX04pAxdaZwqCXhZXHomDJDMyoDNUnBgipkqchQMOgxamR4MaqbO0tSkjQ1WbhiwrtrFKIh02hiMdIle/ysvMnCA7BLFuUVoxzSkFchdQRdYpJKjYpiIDsx5CMjExC+WJGlcTJO2cDg4t15wkph2+xhMsKUqZInbNQ4ER+BIqXMiwkBceHHwxc4ACQA4jggbkoOQm1i8PMS58QQPgQwoOcdqICDiOYC0lYC7kuGEIwzEDthwMYCFrVk9OE9SweRBBSgNOI8aFQ6QhixMjQcTcc2eAxJF55mwAPDQAa60C4woIajHVwDivqUAIQ/jNVLIUmA2O7GpmVgTbhnjzJgwEACH5BAUFAAAALAUAAwAUABgAAAetgACCg4QAIAWFiYk7UE0IipAOGRQwXRqQXlVUgywvlFMOii1sTzQ3g554Uy2KI1Y0LzinDjUUeCaXg7kaBxIVUy8BAER2cT2QAF5SEjgXM4JMm8gAVxESNDvTiRhVH7naLSwOKdqDKVRIQBtDoeUDTuocLkzlAC06RvlGFvUpV1lCPpjxUE9QCg/fCupSSOgIQ0EgHgpSIhHAiA4VWVQshAgABoYavNhIQbJkikAAIfkEBQUAAAAsBQADABIAFgAAB6aAAIKDhCMuCgOEiooxcWQyi5EsEnFlNC2LGB8igysVcXUvkTNraTqCLDWgOIMsgjZwPmNrOwAtY6BdAA4xN4NIJWkmJg0ACm13QQAcJVSDIzIlXRkbAB4EBIJEAYoFM8FVi1eRNmLckYQpLZjoiiMfQ0MB7O0pDTo7QzdK7YIpZmICijHQT9CACSI6XNFQcJCGFA0jSpToZaKgIxYB2JiQcZ04QoEAACH5BAUFAAkALAYAAwATABYAAAesgAmCg4REToSIiQkzTW0HiooOaU1vJpAaFkeDA2NNdzSKKUNwKAiDXZ4ZgyAsghoccHJyAoJWnlaCbG8ZBgkpOxFwWCpUCU5fAEsJG3hnSQGCNgoRKCWHGlQQgipnZAcrg15I1GKJB01IiQME2okeV4gaHpCKLR0NASLz9IMG2QRcvPAbVECEQRE2BgryYMCChQIpFEqcSLHioBGK9kEqoMgCvwEJJlj0oJFfIAAh+QQFBQABACwGAAMAEwAYAAAHqYABgoODGEY6LISKixtTOUCLkYJYU19hkiktDoMsJRdfa5IgSC5cgg5YF1Bpg142gilZM2psWYIoFwBgKQExaDRKgmYcMmwRIgE3OFM6AUQhMFEKgiw7LjwRQ4JMZoJg0VE7gzbWPA2LHElaPgOELCIdvIotQksYgynykooaBRYWBvTtC2BDhEERKwaOI5RQYQANDiNKnEixokWFDkg4vMIP4sWPgkZICgQAIfkEBQUAAAAsBgADABUAFgAAB6uAAIKDgzZDAg6EiouCCxk1N4ySAC1SGRVgHpMAKSmEW5clLYItHSCEKWYCIoNzGThYml5wb1NMgwU9ChsQAB5sGU9zgnBkdSEuuENGQC4kAAlrGQIACnTHFAmDLQFLThwIgh2sHlZlIUlWA4QDXEsLt4oH6FYjiy1HR4wDS0ab/y0GaOA0ggSJAv8AUKECgMW6hPsgMkpxSqKgKywsatzIsaOgihxHefRkMRAAIfkEBQUAAAAsBgADABYAFQAAB6uAAIKDgxoTEymEiouDAmAqH4ySgzIqaWoak4wODJZwhB86A4ojIiCCLZVdc4IjEWhvB4QOXFU7E4IHKl0xgg9Fd3RpHoMsBKE3BgAfYFaRTmjBcQqEKUoNQkMEgha4GmBvdGRyiy0kDQhKi0B2ZFiSGiNekjtBNpr4AAYj+YsFa3S+CAHgoEM/ABvq2GmjokXBgyQEZGlgQdC8g4McDEqEsaPHjyBDLqqIMRAAIfkEBQUAAAAsBgADABYAFQAAB7GAAIKDgyktHoSJioRHQApXi5GCKUEPcEEpkoseCg8oMogAHlkCLIkaGCuCHkieaoIYDFNfG4QpR2YEBgAaTg9uBxotPCdQaCWEHh0iVAEjAAQMc1QAN7NoTU6JVyJMBBYAKQWQAHNfaEVwpolK3V6KSGhtKBiRqYssCUOa/IIF9bD6DfLx5sIHAC0ECvoRpeETBwkVHjhDsUJEhSAi1KhBQGEiD6E8ihxJsqRJXilSBgIAIfkEBQUAPgAsBgADABYAFQAAB6KAPoKDhCkphIiJhA4QBA6KkIMBGzIfkZAaOpQKGoMNlogpLI+COxs8HII2BxkVC4gFHRMYggkbDAuHLjU4LyiEGhY+Ih0DPh0KMx0+OiYVLxc3iiIiIIIj1j4xzycPkR02iT0vJxHhijbGiggJK5fv8JEgKgAvAj4eE/E+HCEUFDRa5NvHAYZBGoIwkNhXIoeEe/sGaVAXsaLFixgz+jBAKBAAIfkEBQUAAAAsBgAEABcAEwAAB6uAAIKDgykjXimEiouESjo3FoyShQ07TjqJgh1cDowtLYIalQtBGgArSCppQYsjhCkQO0g7AB4LVl0mbKaFSopXCUa+QqomErSKBosrrikuaSY1PJ2TK4s7Y9LWk5IOYgjc4YIeIEcYvOKDV24XUE9w2+kADHT1cXYf6OIzZf1ldEIA2JAHQM6UFy9ceCA4iIVDhgAa6GABcVAWOCoGVgTAxImIjYMwpBiZIhAAIfkEBQUAAAAsBgAEABgAFAAAB6qAAIKDhC0ehIiJiRhmDSOKkIgkEB8NgxpKVymRGoIpFhBCH5ssSxFSVIoYABaDkwgBABpDUihYTpuRghhUQgUAXA+2JQi6hA4rgk5wWFYbxpAIcmEc0JAtDWID1sZeV1fb3INKWzVPLyUi4oI8aGhN8CgaKSTcDG/4+CjrAAYoNDRqbKnHj1AncS10FCTkBA+eNAsBQMCRJ0qViEJO5EESEcCHBwVSiBQZCAAh+QQFBQAAACwGAAQAGAAVAAAHsoAAgoOEGimEiImJAxYkDoqQiEoiIkqDKS0akZqDJJQdgg5ZSDuPiSsWiCJME4IfBzxqIopHiRMiNgBMHDJsbJaRAF6CLaYJvVI9nJEDiVxqc04swcFmBNPU2SMGBoS52QBXamljJiitKSTgAAcvU+8XEYfrAD9f9/cRgs3gBRFja9Y8AEaPkIN56zxUqVIQkQwKIaw0HORDCx4KAiYC2BDFohONDti8KaFxEAgPKVKqDAQAIfkEBQUAAAAsBwAEABYAFQAAB6GAAIKDgymEh4iHDldXHomPg1eCIIQphpCHSoIaEwEkl4MsiSJHAClmN05OK4cGoYMTAwBHQ05ARDaHBYgeLYINRkAHCaCYg0xEPzsOxrwWE8zNjxoYICCistIFP24qJWwk0oIKYyYmGRk84gBAFe7uDOsgDCX1PKXrKQ7R6wgI64R+xLEjhxVAKxTq0BECkB2FhD0aAojRpIsmiV5aWNoYCAAh+QQFBQAAACwJAAUAFAAWAAAHoYAAgoOCBoSHiIWJi4wAKSNKA42IVw1CBCmDBY0jBB8JAh6DII1KnzcEhKKMBglBWS2ThCkGR7GyiSsjI6uyXkhqEVIbV7hBclgqyhu4TmlpPs8cuCMHcHBbHIa4g7eTA0s73IMHb01bGLIrAB5dcXdtcw6TcAIAG3Fxdk1ikxFjGgDAIaOvxyQkAAGsiNCExoRJO5AM0qBkhK8WKTJq3BgIACH5BAUFAAQALAkABQAUABYAAAevgASCgx4FXhqDiYqLBF6MiimPggM2kYkkkgQFHSIGmYoYIiJUHZaNmQWjXFeJiJIYVAEirp+DGIe1jCmULLSfGENALhxBGLlVamwPDxEIuTtw0dFVuRhIMQwMTja5gi0t3TZDAt2DHF8XbNyZZkoEDgRNUCdqLJJXUHfORG1NACc9JHWAoiUNgRYR+gEA4+ERlTZabKFog0aBQDtRgAwaIECAvUcDDhBhkaKkyZOBAAAh+QQFBQAAACwJAAUAFAAWAAAHoYAAgoMaIyMpg4mKi4yLiI2CLCyKDkokkIIdI4kgmIMiR56LIiIYoomkBo+nAAMrq6yDDgMtsJgsAUNBQ0y2jQ1EQBsbCiunATLJMhw2pwNLGxxIvbEeDh6nK1UfDrEAChUZM8aQHlShLSUXODU/mDwhTUIATjkXTzVDjQNQUUlWgmLYeyJFA6MRRfz5EGQjQo4pRiCp8KcgkRBukAp88xQIACH5BAUFAAIALAgABgAVABUAAAePgAKCgwIFhIeIiYctLYqOAiACEyuPgxaIBpWCHpqdnp+fHi0aoB4dXFkNGJ8WCTo7O2IpnkxGtkZCKUqdLEI3S1UjoIIas54fXI2gPWkqRAOaZleCcBldYUQOjzNxOWICQTUZa2FVjycUZHKCPzTjPI4YAOkqgisMNSZLj2AUcQuDWEAIoImDEwcpEipcGAgAIfkEBQUAAAAsCQAFABMAGAAAB62AAIKDghiEh4gAIImMjYIajowWLJGJi5WYjB2ZhJSchxoaKZkaVxMTVx6YIGZUEBAGmEcftB9HmC1UYmJMLZyQmCwNZoxMBIg7KBFBngA2ggdbggQiAB5qKm5zQb6DS009AC5tJ0IAOmEqYFtZgx0lMqpPdEVSKR5EPuoKo9Zeggaa0GljDcAAF1ZUVEnkBcpAFaoAODDW7dAAGnTeMOC040QNCJ9AjEhBsqTJQAAh+QQFBQAAACwJAAUAEwAYAAAHq4AAgoOCNoSHiIQjiYyJHo2NEyQtkIxelRqVmpucnCmdgxYGn5peIqciA5umqKqaGkcdE6OdKaSDR4+HLSIWuoNKQE0KiB8yHAgOgxgzZVooghAdgi4PDAcCujcUZ0k3AEBfNFkAQlvWP1TRX28/ACwSaCcMgj1bETECgyMggiMvaHLAycTCiBQGTBL9C+gmEwAPFo7cImSjApovUjpFCLikk5cFSxzYGkkyEAAh+QQFBQAAACwJAAUAEwAYAAAHoYAAgoMAGISHiImKi4QaKYyKSh6QiYaUhwOXmpucnYJenh0sl5YAopoGJEqlnlcLH4keRwYahAVPZyELiAROQxCTgkRaUUlbgmYWACk3HAtBVI8AUlEwZEMASBVpDQBcMxxIQSCCVBdoLoJpUxLpGgngSFeDGKCFElM1aoItCApCLSrho/FgUAoW0hCtGDOFBoNNDBom2DQiSIIWKTJq1BgIACH5BAUFAAAALAkACAATABUAAAeIgACCg4SCXhZHhYqLjI2Oj5CRkpOKI5SCEx6XmZcrl4QGTmKLKSM2KYU0MHFGihYfDUcagwdJIWQPABodiQBiQwgBvQARIWVvOgA9XW5mAExGQwJcLYJmOCdAAA5YJlYLggE9Q2LVijY+JmEHgh4dWQao52EmPj+E8owl9RyTB/VCJmHYEbBRIAAh+QQFBQAAACwHAAgAFQAVAAAHo4AAgoOEhQBXGoaKigOLjo+QkZKTlJMYlSODFhoTXFlVmZKbVD4VUiySR4MsGImVhEg6LYo2i0cmZW9OhiAiIleFIz5kdm0xgiQGgiIETCIghE7Eb1BDADtuMRMAR2LNJCmDMXRvaD+CUlhS1iki3krhgkwZU0CoK25Yc07hGldXDgrZKDBoBQosW5DEkzRgCxY4Rl45ecjl1YAPDTyk2MiRYyAAIfkEBQUAAAAsBgAOABYADwAAB52AKRgTFgCGh4iJADaCazRuMYWKkyQpI2hnZ1pBk5QpKTsvaG4DnYqlhzamq4cFRlWsk1dpbVBBn7iWphgqbWg5P4ZXXp9XIsfEuS5FvzgJKQgxREeWxyJKuS1daF9TThotMmwuYp8FHSIguSkyXxcuLSkDMWw/z58DjOsDH2IO+AzYzNCxrmDBFj8EIjDIEJcQNS6wNWSoQYmBiYEAACH5BAUFAAIALAcABwAUABYAAAeYgAKCg4SFKYWCR4iEIySLj5CRkpOUlQIYGJaCQwBFWCOVKwBapEuWXzAwSTeVSjoVOVuaAg6zhCA3Qo8DA4gGKjk4O4sdiygnLzVEAikjNpFEyDRdulwKOl6Xg1eDKi8VJqweSEA3TIIgAh2Zgi4VGUiCKxxAQQ2DLLX4AVz4QEA9+lXyEASIERGaDOzIskJTCg0pIkqcGAgAIfkEBQUABwAsBgANABUAEAAAB4yABwc2goWGh4c6OQBgiI4HJAMHJxRJSTuPiEoYU2VlZEuZjlUmTxGimSuool47WR6rhgVbNF0CoimGNg81Y2E9gisOiBiGThJjPmBcB0xVEJKyhlvJWFWCOjpcBoYT0YJIPipLsCw3OgFKhQ4tiARUGoItOzpZ6rGCKQ06Yl746xYK5PqXL4XBgwgDAQAh+QQFBQAAACwFAAkAFgATAAAHqoAAggAfVIOHiImCPCiGio+DVzhwZpCWBk5elogaNiMAHpuII3AXXzlyGKKCLD10dHFxZE6rgjdvuLg9tUcjcxU4Emw2q1cOABoYIzYptYojAgTOg15qYW5Z0yszYXJzCYIOLaJLVnJbMZVHZhMsiJqDHjFycA9iKRoNVCJXgxMkxw7dqCdAkAcu+w550JDIAZMOgzRA2NdvGoArZjoMsAggxQAHKUKKFBkIACH5BAUFAAAALAQABwAXABUAAAewgACCgywag4eIiYIQFQqKj4hbZ2hCkJYxWmdWIJaPBk9aZGadkAoChqSDKxg2qYgNchUvT3AjrgAtVk27RUUbrkctcl/ExE6uVwBUcmNjaTK2qS2C0xgrt482WWao2CMuWwxU2AADRHNqP1nUgwaqiQJSajMKFgAjHakpSGoyG+MpSIg45IUdIi4/gHAxpMHCwCODuiFKUQBECkEBB7ojBwDDBBIOOArSoCGFyZMnAwEAIfkEBQUAAAAsBAAHABUAFQAAB4+AAIKDAxiDh4iJVABoQImPhxEwURRCkJAySXhaMZeQNUl1O56PBQsIpIkrGqmDEFtjEhkRhq1uU1MXFydIrR5zFcHBN60ATFIqKmActcU2NgPFjysQFtKCNkY/CtbFLUsHREEi0iIuRD1VIJ4jhyJERjsT1w5iAhYp1wApHodKgl70DVCipIW+fSkSKkwYCAAh+QQFBQAAACwEAAcAFwAUAAAHloApgoMrAIaHiImKADhfRIuQiGplFGQfkZEHcXUUPJiQBWNxdAmfkT2XpogDNqqKTGolPmE8haoOHg8mJhkSEjuuVx4MacXFOq6GEzJSUmxOtskeAyssg9fY2dgsHVcpyYcDVT0CIOAAKWJBCQEGmAPZI0MJYmbRizbZNgIfEOaQFo540HZlwohP2hIeOZfIwZECGhIGAgAh+QQFBQAAACwEAAUAFQAWAAAHpIAAgoOEACA7hYmCXgWEcBVMioQBTycLggNQNJGSgg9vdm9IAANfY52DLkVvdHdCAC4qqIIgPkV3cQ+CjbMAFrZtRr2FIEE7HsMpLCsDw4MdB1soKC7OAD9YKiolVgLDGhtw4uKvw0pEMzMuO83WLAMO1okOBhjyAC0EWWY28h0BZkTwGuaAQMAO8jRMENFhBCoDGgo58NIPQIp7hK5gFORhYKFAACH5BAUFAAEALAQABQAVABYAAAeqgAGCg4QBXkA3DoWFGDsEhHNaUQeLgx5qADlGgydaZ1KVgitdX2hQToIXnkihgjIXX00AHwEccU0irQEFchdQRTGCJCC6gkpgFzk3xYsjQ1XMgw4DLNGDGEY8MTELA9EpOmwPERFSWd9VMurqDdY2Ak5OQWLV1ikODi3WlR429fsalIjosE9QARG5CqYgkbCYt0EprtgrpMGGooKVDAgagTEAiBEpQopMEQgAOw==") no-repeat center center;} /* these elements are buttons, and may need to have additional styles reset to avoid unwanted base styles */ #cboxPrevious, #cboxNext, #cboxSlideshow, #cboxClose {border:0; padding:0; margin:0; overflow:visible; width:auto; background:none; } /* avoid outlines on :active (mouseclick), but preserve outlines on :focus (tabbed navigating) */ #cboxPrevious:active, #cboxNext:active, #cboxSlideshow:active, #cboxClose:active {outline:0;} #cboxSlideshow{position:absolute; top:-20px; right:90px; color:#fff;} #cboxPrevious{position:absolute; top:50%; left:5px; margin-top:-32px; background: var(--controlsIcon) no-repeat top left; width:28px; height:65px; text-indent:-9999px;} #cboxPrevious:hover{background-position:bottom left;} #cboxNext{position:absolute; top:50%; right:5px; margin-top:-32px; background: var(--controlsIcon) no-repeat top right; width:28px; height:65px; text-indent:-9999px;} #cboxNext:hover{background-position:bottom right;} #cboxClose{position:absolute; top:5px; right:5px; display:block; background: var(--controlsIcon) no-repeat top center; width:38px; height:19px; text-indent:-9999px;} #cboxClose:hover{background-position:bottom center;} .pre-wrapper{ position:relative; } .pre-wrapper pre{ padding-top: 25px; } .pre-wrapper .copy-snippet { border-radius: 0; min-width:55px; background: none repeat scroll 0 0 transparent; border: 1px solid #bbb; color: #26589F; font-family: 'HELEVETICA',sans-serif; font-size: 12px; font-weight: normal; line-height: 1.42rem; margin: 0; padding: 0px 5px; text-align: center; text-decoration: none; text-indent: 0; position:absolute; background:#ccc; top:0; left:0; } .pre-wrapper .copy-snippet:disabled{ color:#555; } .copyButton {font-size: 9px;} .faq-article { width: 100%; height: auto; min-height: 600px; border-radius: 10px; display: flex; flex-direction: column; background-color: #1c2330; color: #fff; margin: 55px 0; } .faq-context { display: block; padding: 20px 50px 17px 30px; background-color: #262f41; color: #fff; border-top-left-radius: 10px; border-top-right-radius: 10px; box-shadow: #222 0 10px 12px -6px; z-index: 99; } .faq-customer, .faq-answer { max-width: 60%; margin: 20px 30px; padding: 10px 18px; border-radius: 15px; z-index: 9999; } .faq-customer { align-self: flex-end; background-image: linear-gradient(to left, #ffbd39, #fa9531); border-image: linear-gradient(to left, #FFBD39, #FA9531); box-shadow: #111 0 10px 12px -6px; opacity: 0; animation: 1s .5s forwards faq-fadeIn; } .faq-answer { align-self: flex-start; background-color: #262f41; color: #fff; margin-top: 10px; margin-bottom: 50px; box-shadow: #111 0 10px 12px -6px; opacity: 0; animation: 1s 1s forwards faq-fadeIn; } @keyframes faq-fadeIn { 0% { opacity: 0; } 100% { opacity: 1; } } @media (max-width: 700px) { .faq-customer, .faq-answer { max-width: 100%; } .faq-context { padding: 20px 20px 17px 20px; } } .page-article td { border: none; } table { width:100%; margin-top: 30px; } th.header { background-image: linear-gradient(to bottom right, rgb(255,189,57), rgb(250,149,49)); border-top-left-radius: 10px; border-top-right-radius:10px; border-bottom: none !important; color: white; } th, td { border-bottom: 1px solid #444 !important; } th { font-weight: bold; text-align: center; padding: 10px; } #mainButton { background: linear-gradient(90deg,#ffbd39 0,#fa9531 100%); } #mainButton:hover { background: linear-gradient(90deg,#ffbd39 0,#ffbd39 100%) !important; } .main_button, .main_button > *, .multiwidget, .multiwidget > *, .multiwidget li img { box-sizing: content-box !important; vertical-align: initial !important; } .main_button { position: fixed; bottom: 20px; right: 20px; padding: 10px 16px; border-radius: 15px; width: 165px; height: 56px; cursor: pointer; box-shadow: 0 0.25em 2em rgba(0,0,0,0.12); z-index: 9999; } .main_button img { width: 56px; border-radius: 50%; box-shadow: 0 0.25em 2em rgba(0,0,0,0.12); float: right; display: inline-block !important; padding: 0 !important; } .main_button span { position: relative; top: 15px; left: 5px; font-size: 16px; font-weight: 600; font-family: "Poppins","Helvetica Neue",Helvetica,Arial,sans-serif; color: white; } #multiwidget { bottom: -350px; opacity: 0; transition: .5s; } .multiwidget { background-color: white; font-family: "Poppins","Helvetica Neue",Helvetica,Arial,sans-serif; position: fixed; right: 20px; text-align: right; box-shadow: 0 0.25em 2em rgba(0,0,0,0.12); width: 260px; height: 370px; border-radius: 15px; z-index: 9999; } .multiwidget span { font-weight: 300; padding: 0px 10px; font-size: 40px; cursor: pointer; } .multiwidget ul { padding-right: 10px; padding-left: 10px; width: 240px; margin-top: 10px; } .multiwidget li { list-style-type: none; background-color: white; cursor: pointer; transition: .3s; margin-bottom: 6px; margin-left: 0; padding-top: 6px; padding-right: 6px; border-radius: 15px; font-weight: 600; } .multiwidget li img { width: 56px; margin-left: 16px; box-shadow: 0 0.25em 2em rgba(0,0,0,0.12); border-radius: 50%; display: inline-block !important; padding: 0 !important; } .multiwidget li font { position: relative; bottom: 22px; color: #333; font-size: 16px; } .multiwidget a { text-decoration: none; color: #111; } .multiwidget li.form:hover { background-color: #fee0e4; } .multiwidget li.mess:hover { background-color: #efe6f8; } .multiwidget li.what:hover { background-color: #daf4e7; } .multiwidget li.chat:hover { background-color: #feefe0; } .multiwidget li.ai:hover { background-color: #e4effd; } #service_status { width: 90%; height: auto; margin: 5%; position: relative; bottom: -20px; } .okay { background-color: #4cbb17; border: 2px solid #4cbb17; border-radius: 10px; padding: 5px 10px 5px 5px; text-align: left; height: 43px; } .outage { background-color: #e60000; border: 2px solid #e60000; border-radius: 10px; padding: 5px 10px 5px 5px; text-align: left; height: 43px; } .degradation { background-color: #ff7900; border: 2px solid #ff7900; border-radius: 10px; padding: 5px 10px 5px 5px; text-align: left; height: 43px; } .okay img, .outage img, .degradation img { width: 30px; border-radius: 50%; vertical-align: top; float: left; display: inline-block !important; padding: 0 !important; } .okay .status-title, .outage .status-title, .degradation .status-title { font-size: 12px; font-weight: 700; font-family: "Poppins","Helvetica Neue",Helvetica,Arial,sans-serif; color: white; float: left; margin: 0px 0px 0px 5px; } .okay .status-link a, .outage .status-link a, .degradation .status-link a { font-size: 10px; font-weight: 500; font-family: "Poppins", "Helvetica Neue", Helvetica, Arial, sans-serif; color: white; position: relative; top: -10px; left: 5px; } .okay.pulse-button { box-shadow: 0 0 0 0 rgba(76, 187, 23, 0.5); -webkit-animation: pulse 1.5s infinite; } .outage.pulse-button { box-shadow: 0 0 0 0 rgba(230, 0, 0, 0.5); -webkit-animation: pulse 1.5s infinite; } .degradation.pulse-button { box-shadow: 0 0 0 0 rgba(255, 121, 0, 0.5); -webkit-animation: pulse 1.5s infinite; } @-webkit-keyframes pulse { 0% { -moz-transform: scale(1); -ms-transform: scale(1); -webkit-transform: scale(1); transform: scale(1); } 70% { -moz-transform: scale(1.01); -ms-transform: scale(1.01); -webkit-transform: scale(1.01); transform: scale(1.01); box-shadow: 0 0 0 10px rgba(0, 0, 0, 0); } 100% { -moz-transform: scale(1); -ms-transform: scale(1); -webkit-transform: scale(1); transform: scale(1); box-shadow: 0 0 0 0 rgba(0, 0, 0, 0); } } #multiwidget_contact { background-color: #ffffff; position: fixed; bottom: -101%; right: 18px; border-radius: 18px; box-shadow: 0 5px 15px 0 #ddd; width: 400px; height: 550px; padding: 20px; transition: .5s; z-index: 9999; margin-bottom: 18px; } #multiwidget_contact span { position: absolute; right: 20px; font-weight: 300; font-size: 40px; cursor: pointer; } #multiwidget_contact iframe { height: 100% !important; } div[id*='b_82dc6d83'] { display: none; } .okay { visibility: hidden !important; } @media (max-width: 420px) { #multiwidget_contact { right: 0 !important; margin-bottom: 0 !important; border-radius: 0 !important; height: 100% !important; width: 100% !important; } } .main_button img { margin: 0 !important; } .multiwidget li img { margin: 0 0 0 16px !important; } .main_button span { top: 17px !important; } .okay img, .outage img, .degradation img { margin: 0 !important; } </style> <title>Complete API reference</title> <meta name="description" content="Complete LiveAgent API v1 reference" /> <meta name="keywords" content="api, reference, rest, call, php, API reference" /> <meta property="og:url" content="//support.liveagent.com/840770-Complete-API-reference" /> <meta property="og:title" content="Complete API reference" /> <meta property="og:description" content="Data fields formats (#dataformats) Return messages formats (#returnmsgs) Error messages formats (#errormsgs) Api v.1 (#apiv1) Agents (#apiv1_agents) Retrieves agent info and auth token (#f825ae04" /> <meta property="og:type" content="article" /> <meta property="og:image" content="//support.qualityunit.com/themes/kb/minimalist/img/default_logo.png" /> </head> <body class="montana page-article"> <div id="top"></div> <nav class="navbar"> <div class="container"> <a class="navbar-brand KBLogo" href="/"></a> <input class="menu-btn" type="checkbox" id="menu-btn"> <label class="menu-icon" for="menu-btn"><span class="navicon"></span></label> <div id="navbar" class="navbar-collapse collapse"> <ul id="menu-header-menu" class="nav navbar-nav"> <li id="menu-item-mytickets" class="menu-item"><a href="my_tickets#My-Tickets"><span class="glyphicon glyphicon-envelope" aria-hidden="true"></span> My tickets<div class="menu_overlay"> </div></a></li> <li id="menu-item-submitticket" class="menu-item"><a href="submit_ticket"><span class="glyphicon glyphicon-edit" aria-hidden="true"></span> Submit ticket<div class="menu_overlay"> </div></a></li> <li id="menu-item-login" class="menu-item"><a href="login"><span class="glyphicon glyphicon-off" aria-hidden="true"></span> Login<div class="menu_overlay"> </div></a></li> </ul> </div> </div> </nav> <!-- article --> <div itemscope itemtype="https://schema.org/Article"> <div class="jumbotron inner-jumbotron jumbotron-inner-fix jumbotron-smaller"> <div class="container inner-margin-top"> <div class="row"> <div class="col-md-12 col-sm-12" style="text-align:center"> <h1 class="inner-header" itemprop="name">Complete API reference</h1> <meta itemprop="author" content="Quality Unit Support"> <meta itemprop="headline" content="Complete API reference"> <meta itemscope itemprop="mainEntityOfPage" itemType="https://schema.org/WebPage" itemid="//support.liveagent.com/840770-Complete-API-reference"/> <span itemprop="publisher" itemscope itemtype="https://schema.org/Organization"> <meta itemprop="name" content="Quality Unit Support"> <span itemscope itemprop="logo" itemtype="https://schema.org/ImageObject"> <meta itemprop="url" content="/scripts/file.php?view=Y&file=2a2f2096ece5375232b72bead5de4c81"> <meta itemprop="width" content="300px"> <meta itemprop="height" content="200px"> </span> </span> <!-- breadcrumbs --> <p class="breadcrumbs" itemscope itemtype="https://schema.org/BreadcrumbList"> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <a itemprop="item" href="./" class="breadcrumb-link"> <span itemprop="name">Home</span> </a> <meta itemprop="position" content="1" /> </span> <span class="breadcrumb-divider">></span> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <a itemprop="item" href="//support.liveagent.com/806117-Technical-Support" class="breadcrumb-link"> <span itemprop="name">Technical Support</span> </a> <meta itemprop="position" content="2" /> </span> <span class="breadcrumb-divider">></span> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <a itemprop="item" href="//support.liveagent.com/066804-LiveAgent-API" class="breadcrumb-link"> <span itemprop="name">LiveAgent API</span> </a> <meta itemprop="position" content="3" /> </span> <span class="breadcrumb-divider">></span> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <a itemprop="item" href="//support.liveagent.com/802463-REST-API" class="breadcrumb-link"> <span itemprop="name">REST API</span> </a> <meta itemprop="position" content="4" /> </span> <span class="breadcrumb-divider">></span> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <a itemprop="item" href="//support.liveagent.com/642739-API-v1" class="breadcrumb-link"> <span itemprop="name">API v1</span> </a> <meta itemprop="position" content="5" /> </span> <span class="breadcrumb-divider">></span> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <a itemprop="item" href="//support.liveagent.com/167733-Documentation" class="breadcrumb-link"> <span itemprop="name">Documentation</span> </a> <meta itemprop="position" content="6" /> </span> <span class="breadcrumb-divider">></span> <span itemprop="itemListElement" itemscope itemtype="https://schema.org/ListItem"> <span itemprop="name">Complete API reference</span> <meta itemprop="position" content="7" /> </span> </p> </div> </div> </div> </div> <div class="container article-page margin-top margin-bottom"> <div class="row"> <div class="col-md-9"> <div class="article-content ArticleContent" itemprop="articleBody"> <br /> <style type="text/css">.xmlIcon { -moz-box-shadow:inset 0px 1px 0px 0px #fce2c1; -webkit-box-shadow:inset 0px 1px 0px 0px #fce2c1; box-shadow:inset 0px 1px 0px 0px #fce2c1; background-color:#ffc477; border:1px solid #eeb44f; display:inline-block; color:#ffffff; font-family:arial; font-size:10px; font-weight:bold; padding:1px 8px; text-decoration:none; text-shadow:1px 1px 0px #cc9f52; } .jsonIcon { -moz-box-shadow:inset 0px 1px 0px 0px #c1ed9c; -webkit-box-shadow:inset 0px 1px 0px 0px #c1ed9c; box-shadow:inset 0px 1px 0px 0px #c1ed9c; background:-webkit-gradient( linear, left top, left bottom, color-stop(0.05, #9dce2c), color-stop(1, #8cb82b) ); background:-moz-linear-gradient( center top, #9dce2c 5%, #8cb82b 100% ); filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#9dce2c', endColorstr='#8cb82b'); background-color:#9dce2c; border:1px solid #83c41a; display:inline-block; color:#ffffff; font-family:arial; font-size:10px; font-weight:bold; padding:1px 8px; text-decoration:none; text-shadow:1px 1px 0px #689324; } .exampleTable { border-top: 1px solid #E0E0E0; border-left: 1px solid #E0E0E0; } .exampleTableHeader { background-color: #E0E0E0; padding: 4px; } .exampleTableCellEven { border-bottom: 1px solid #E0E0E0; border-right: 1px solid #E0E0E0; background-color: #F8F8F8; padding: 4px; } .exampleTableCellOdd { border-bottom: 1px solid #E0E0E0; border-right: 1px solid #E0E0E0; padding: 4px; } .returnFieldsHeader { font-size: 14px; padding-right: 0px; padding-left: 0px; padding-top: 0px; padding-bottom: 4px; margin: 0px; } .returnFieldsTable { border-top: 1px solid #E0E0E0; border-left: 1px solid #E0E0E0; font-size:14px; } .returnFieldsTableHeader { background-color: #E0E0E0; text-align: left; padding: 4px; } .returnFieldsTableCellEven { border-bottom: 1px solid #E0E0E0; border-right: 1px solid #E0E0E0; background-color: #F8F8F8; padding: 4px; } .returnFieldsTableFieldHeader { border-bottom: 1px solid #E0E0E0; border-right: 1px solid #E0E0E0; font-style: italic; background-color: #E0E0E0; padding: 4px; } .returnFieldsTableCellOdd { border-bottom: 1px solid #E0E0E0; border-right: 1px solid #E0E0E0; padding: 4px; } .exampleCallUrl { margin: 0px; padding: 10px; background-color: #FFFFE8; border: 1px solid #E0E0E0; } .callTypeIcon { -moz-box-shadow:inset 0px 1px 0px 0px #bbdaf7; -webkit-box-shadow:inset 0px 1px 0px 0px #bbdaf7; box-shadow:inset 0px 1px 0px 0px #bbdaf7; background:-webkit-gradient( linear, left top, left bottom, color-stop(0.05, #79bbff), color-stop(1, #378de5) ); background:-moz-linear-gradient( center top, #79bbff 5%, #378de5 100% ); filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#79bbff', endColorstr='#378de5'); background-color:#79bbff; -moz-border-radius:4px; -webkit-border-radius:4px; border-radius:4px; border:1px solid #84bbf3; display:inline-block; color:#ffffff; font-family:arial; font-size:13px; font-weight:bold; padding:5px 6px; text-decoration:none; text-shadow:1px 1px 0px #528ecc; } div.tabsSwitcher { padding-bottom:10px; padding-top: 10px;} ul.tabsNavigation { margin:0 10px; padding:0; text-align:left; } ul.tabsNavigation li {display:inline-block;} ul.tabsNavigation li .headerContent { border:1px solid #E0E0E0; padding:3px 6px; background:#E0E0E0; font-size:14px; text-decoration:none; display:inline-block; cursor: pointer; padding-bottom: 4px; margin-left:5px;} ul.tabsNavigation li .headerContent.active { background:#fff; color:#222; border-bottom:1px solid #fff; cursor: default;} div.tabContent { border:1px solid #E0E0E0; padding:5px 15px 15px; margin-top:-1px; display:none; } div.tabContent.active { display:block; } pre.phpCode { display:block; background-color:#FFFFFF; margin:1em 0; padding:1em; font:normal normal 13px/1.4 Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,Monospace; color:#110390; overflow:auto; white-space:pre; word-wrap:normal; } pre code { font:inherit; color:inherit; } pre span.N {color:#8CD0D3} /* Numbers */ pre span.S {color:#A00000} /* Strings */ pre span.C {color:#7F9F7F} /* Comments */ pre span.K {color:#0600FF} /* Keywords */ pre span.V {color:#FC8600} /* Vars */ pre span.D {color:#FF0000} /* Defines */ pre span.P {color:#179403} /* Punctuations */ </style> <div id="apiv1"><a href="#dataformats" title="Format specifications of all possible datafields used in API">Data fields formats</a><br /> <a href="#returnmsgs" title="Return messages formats">Return messages formats</a><br /> <a href="#errormsgs" title="Example of common error messages">Error messages formats</a><br /> <a href="#apiv1" title="Api ver. 1 complete reference">Api v.1</a><br /> <a href="#apiv1_agents">Agents</a><br /> <a href="#f825ae04fd0a7fc028cb428684d17fe0">Retrieves agent info and auth token</a><br /> <a href="#apiv1_application">Application</a><br /> <a href="#af645efcdcd9029af737024b10f38b61">Return application installation date and latest version</a><br /> <a href="#apiv1_companies">Companies</a><br /> <a href="#ddf8329339a993d35f63e3f972f657d7">Retrieve list of companies</a><br /> <a href="#77fd57bc8e33ed000f883c12ac0cdbf0">Retrieve company info</a><br /> <a href="#apiv1_conversations">Conversations</a><br /> <a href="#7d91361d6ef18f0f338e76d18a6d41e1">Transfer conversation to another department and/or agent</a><br /> <a href="#a79c458da5cd983777e339cd460193ed">Delete conversation</a><br /> <a href="#246bd94b4c438d32ccfdda6946e39913">Delete custom field value in conversation</a><br /> <a href="#6009ef95d6c3d32706fe7084dc82e81d">Add custom field value to conversation</a><br /> <a href="#6d1698eaa7f970beec504017ce9f8ac4">Retrieves all conversations</a><br /> <a href="#87abf7ff1b8dd576caf5194e502354cf">Retrieves conversation info</a><br /> <a href="#d955243071fab7892f83eb2c72650bb0">Retrieves all conversation messages</a><br /> <a href="#c33cb0122a8537c90d18413dd4966b56">Create new message in conversation</a><br /> <a href="#c1c1ef54734a3a7fc45c5bfa66cb4545">Change status of the conversation</a><br /> <a href="#d0c0b602fdaed1299b71c5050b13cc27">Unassign a tag from a conversation</a><br /> <a href="#d15a56764c0f88a8bf5cc11dc5a94dac">Retrieve a list of tags assigned to a conversation</a><br /> <a href="#e521cbab8851729fedc5b7548357c40a">Assign tag to a conversation</a><br /> <a href="#apiv1_customers">Customers</a><br /> <a href="#b58b8a4a2e22985f73dc395d7a7d2b0c">Delete custom field value in user contact</a><br /> <a href="#c064fd82872dfaa5135c69f7810baead">Add custom field value to customer</a><br /> <a href="#353c125e9b99d39fe7ae7d87efa67dc4">Retrieves customer info</a><br /> <a href="#2c3f657707b74f4e57d34f904666e373">Remove customer from group</a><br /> <a href="#56c108737c8a081080ea7d194d854fed">Retrieve customer groups</a><br /> <a href="#4ee1474d1c6518f12703359bf459e83a">Add customer to group</a><br /> <a href="#apiv1_customers groups">Customers groups</a><br /> <a href="#a3559e1c7365a70597b4886a732e1768">Delete customers group</a><br /> <a href="#ebe7d1ee44ab317ba22c82ef478bbd5d">Retrieve customers group info</a><br /> <a href="#4293a66ad2a7ab5502eb5c3b292df6be">Retrieve all groups of all customers</a><br /> <a href="#7e998563ab9c7e240932fd527ce9dcdd">Add customers group</a><br /> <a href="#68f83547f6233a2e206c15a81eb5facf">Change customers group</a><br /> <a href="#apiv1_departments">Departments</a><br /> <a href="#7492dac92d066e148de4b67c72406f40">Retrieve list of departments</a><br /> <a href="#a0b6df46b19d3f24353297eaa74d8a0f">Retrieve department info</a><br /> <a href="#apiv1_files">Files</a><br /> <a href="#ccdb33f62f23cd4e801983d9954d5a01">Retrieve file</a><br /> <a href="#f6ee7d770d02e790089753359529196f">Add file</a><br /> <a href="#apiv1_knowledgebase">Knowledgebase</a><br /> <a href="#57c33ec1ca7308d3b3b87601b854c30e">Retrieve a list of all knowledgebase articles (deprecated)</a><br /> <a href="#c6edc62bfe2cc23498364bdafd3c288c">Add knowledgebase article</a><br /> <a href="#1b13a3ebec328caed53681f95b54a78a">Add knowledgebase category, suggestion category or forum</a><br /> <a href="#3132d52065ff4d341459cf1a19a74150">Remove knowledgebase entry</a><br /> <a href="#4cd19eba76cd0dc8079bbd8d00ff0d9a">Retrieve a list of all knowledgebase entries</a><br /> <a href="#4a20ae06a17d0cbba6c1eae28ac44b0a">Retrieve a list of all knowledgebases</a><br /> <a href="#cf2097163de9944be623df364439797b">Knowledgebase search</a><br /> <a href="#apiv1_online status">Online status</a><br /> <a href="#7b3dd9427f85cb1f63dec15a9a229c90">Agents</a><br /> <a href="#fb2b99f38a57f85e24e46943939a6989">Departments</a><br /> <a href="#apiv1_reports">Reports</a><br /> <a href="#5af8a3314bb3df2b40282a9fba9f416c">Agents report</a><br /> <a href="#55017028a0e45c555e73c0991a3b9078">Channels report</a><br /> <a href="#8486980c36f975e1060ced99e644329e">Departments report</a><br /> <a href="#4720451f26b6b7459e647c5c1077477a">Performance report</a><br /> <a href="#0b2eed2cb1d87da0fe652c5efcac84f9">Tags report</a><br /> <a href="#0eda602d53b5149bb339baec847844ac">Tickets Agent availability report</a><br /> <a href="#4c93c79a2e79c3940b14a7e63d93d7c0">Tickets Load report</a><br /> <a href="#346eed9d6da6dbba40da149843413bef">Tickets SLA Compliance report</a><br /> <a href="#716032b91115b50c876d5c8f65e03468">Tickets SLA Log report</a><br /> <a href="#f7ef9ffba7997a345e6797a104bb7551">Chats Agent availability report</a><br /> <a href="#a8b317f39f890797ae80cb838282f0bf">Chats availability report</a><br /> <a href="#a2bfc0f16204c1d9df4d293b9d1ca4ae">Chats Load report</a><br /> <a href="#302e9609ad815584c03332a74169be59">Chats SLA Compliance report</a><br /> <a href="#57611b60bd5e97b253c97701c656e695">Chats SLA log report</a><br /> <a href="#6e3224079b6c2d12697dff7d4c48f494">Calls Agent availability report</a><br /> <a href="#ac945e1666c8e3caeb944b87322951f1">Calls availability report</a><br /> <a href="#3ef3b0eb476a18278878ce0b9e269c66">Calls Load report</a><br /> <a href="#a3a77ba80d64e54a8db022a56b79cede">Calls SLA Compliance report</a><br /> <a href="#2bb237c46c72d7b6159874a4a340d5fb">Calls SLA log report</a><br /> <a href="#7de037ac421681057d4456260b72a81d">Ranking agents report</a><br /> <a href="#apiv1_suggestion categories">Suggestion categories</a><br /> <a href="#910788e8da771b2708bd0573a2968f82">Retrieves all suggestion categories</a><br /> <a href="#apiv1_tags">Tags</a><br /> <a href="#faa75f1d6c3624ba1084fe1e7155e6a0">Remove tag</a><br /> <a href="#9e3c623fae784121b81bdbc478f7e97d">Retrieve a list of all available tags</a><br /> <a href="#145fa45a529fae562f6167c326717db3">Retrieve tag info</a><br /> <a href="#ba8731016f9e887533d0dc10d9b27fb4">Add tag</a><br /> <a href="#ff0797a48ee4a651517e155aa0ffff04">Change tag</a><br /> <a href="#apiv1_widgets">Widgets</a><br /> <a href="#828199c9f8e5967e23a170850e4ee794">Retrieve all widgets</a><br /> <a href="#f366987dce791a4d3e6226afe688e4ed">Retrieve widget</a><br /> <a href="#d0ad1a4cefb1dbc3afd66538278b8557">Add widget</a><br /> <a href="#2b612690140e52bca6ac77a34b58e400">Change widget</a><br /> <a href="#apiv1_overview">Overview</a><br /> <a href="#79deeb1c61a26be22d9695600faa499a">Chats</a><br /> <a href="#bbcf4edc4ccb1f6cceae13bbb8125d28">Phone calls</a><br /> <br /> <a id="dataformats"></a> <h2>Datafield formats</h2> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">valid format: YYYY-MM-DD HH:MM:SS. <i>Note: values are in time zone defined in '/accounts/settings.php' or in "GMT" timezone by default.</i></td> </tr> <tr> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">could be any string or empty</td> </tr> <tr> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">could be only one instance of finite set. Possible values are named in specifice field description.</td> </tr> <tr> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">integer value greater or equal to zero.</td> </tr> <tr> <td class="returnFieldsTableCellEven">array</td> <td class="returnFieldsTableCellEven">list of entities. All entities have the same column definition</td> </tr> <tr> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">list of entities. Every entity has its specific column definition.</td> </tr> <tr> <td class="returnFieldsTableCellEven">opdatetime</td> <td class="returnFieldsTableCellEven">datetime with operator. This field has the same format as 'datetime' except you can use various operators with it.<br /> Possible operators:<br /> <b>eq:</b> equals, example 'eq:2009-11-12 05:02:01' or just '2009-11-12 05:02:01'<br /> <b>neq:</b> NOT equals, example 'neq:2009-11-12 05:02:01'<br /> <b>gt:</b> greater than, example 'gt:2009-11-12 05:02:01'<br /> <b>lt:</b> less than, example 'lt:2009-11-12 05:02:01'<br /> <b>gte:</b> greater than or equals, example 'gte:2009-11-12 05:02:01'<br /> <b>lte:</b> less than or equals, example 'lte:2009-11-12 05:02:01'<br /> <b>btw:</b> between, example 'btw:2009-11-12 05:02:01,2010-10-11 04:01:59'<br /> <b>lk:</b> like, example 'lk:2009-11-12 05:02:01' or you can use wildcard characters '%' (for any number of characters) or ? (for one character) 'lk:2009-01-%' or 'lk:2011-12-01 ??:59:59'<br /> <i>note: if you do not enter any operator, 'eq' will be used as default.</i></td> </tr> </tbody> </table> <br /> <br /> <a id="returnmsgs"></a> <h2>Return messages formats</h2> <br /> Return messages are in JSON format by default. But you can change this to XML by adding <b>.xml</b> at the end of call URL.This will give response in JSON: <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/agents/john@agent.com</div> <br /> We add <b>.xml</b> to call URL and we have response in XML format <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/agents/john@agent.com<span style="color:#C94444;">.xml</span></div> <br /> <i>Note: if y ou have <a href="http://www.php.net/manual/en/book.yaml.php" target="_blank">PHP YAML</a> extension enabled in your PHP, you could also use <b>.yaml</b> to get response in YAML format.</i><br /> <br /> <a id="errormsgs"></a> <h2>Error messages formats</h2> <br /> <b>400 - Bad request error</b><br /> You can get this in case your athentification with API key failed because of problem with API key in application.<br /> <br /> <b>401 - Forbidden</b><br /> You can get this in case of failed authentification with wrong key<br /> <br /> <b>404 - Not found error</b><br /> You can get this in case "agnet with email agent@email.com not found"<br /> <br /> <b>500 - Common porcessing error</b><br /> This is the most common error type. You can get this in case "parameter message is missing" or "unable to load conversation"<br /> <br /> <b>503 - Service Unavailable</b><br /> You can get this in case application is unavaliable to process requests - in case of updating and/or installing.<br /> <br /> <b>Error response example</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_29249_xmlTab_41539_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_72821_jsonTab_71134_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_29249_xmlTab_41539_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>ERROR<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>500<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"><<font color="#808000">errormessage</font>></font>Example error message<font color="#0000FF"></<font color="#808000">errormessage</font>></font> <font color="#0000FF"><<font color="#808000">debugmessage</font>></font>debug info<font color="#0000FF"></<font color="#808000">debugmessage</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_72821_jsonTab_71134_content"> <pre style="font-size:12px;"> { "response":{ "status":"ERROR", "statuscode":500, "errormessage":"Example error message", "debugmessage":"debug info" } }</pre> </div> </div> <br /> <a id="apiv1"></a> <h1><a id="apiv1">API version 1</a></h1> <br /> <a id="apiv1_agents"></a> <h2>Agents</h2> <br /> <a id="f825ae04fd0a7fc028cb428684d17fe0"></a> <h3>Retrieves agent info and auth token</h3> Avaliable from application version: 2.8.2.1 <div style="font-size:14px; padding-top:0px; margin:0px;">Avaliable examples: <a href="https://support.liveagent.com/060256-Single-sign-on-example-for-WordPress" target="_blank" title="WordPress plugin example">WordPress plugin example</a></div> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_20060_generalTab_95305_header">General</div> </li> <li> <div class="headerContent" id="tab_12680_phpTab_69869_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_20060_generalTab_95305_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/agents/<span style="color:#5640E6;">[agentidentifier]</span></div> </div> <div class="tabContent" id="tab_12680_phpTab_69869_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>agents<span class="P">/[</span>agentidentifier<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[agentidentifier]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier. Can be email or userid.</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of agent contact.</td> </tr> <tr> <td class="returnFieldsTableCellEven">userid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of agent, also known as userid.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">email</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent email.</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent first name.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent last name.</td> </tr> <tr> <td class="returnFieldsTableCellEven">systemname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent system name.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">authtoken</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent auth token.</td> </tr> <tr> <td class="returnFieldsTableCellEven">browsercookiename</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent browser cookie name.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">gender</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Agent gender. (Possible values: <i>M</i> - Male, <i>F</i> - Female, <i>O</i> - Other)</td> </tr> <tr> <td class="returnFieldsTableCellEven">role</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Agent role. (Possible values: <i>D</i> - Administrator, <i>A</i> - Agent, <i>O</i> - Owner)</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_24265_xmlTab_15395_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_74411_jsonTab_13079_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_24265_xmlTab_15395_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>d44t87a5<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid1234<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">email</font>></font>example@agent.com<font color="#0000FF"></<font color="#808000">email</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>John<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Williams<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">systemname</font>></font>system001<font color="#0000FF"></<font color="#808000">systemname</font>></font> <font color="#0000FF"><<font color="#808000">authtoken</font>></font>5ceef21647f1db39a18cafc0bc2de015<font color="#0000FF"></<font color="#808000">authtoken</font>></font> <font color="#0000FF"><<font color="#808000">browsercookiename</font>></font>A_auth<font color="#0000FF"></<font color="#808000">browsercookiename</font>></font> <font color="#0000FF"><<font color="#808000">gender</font>></font>F<font color="#0000FF"></<font color="#808000">gender</font>></font> <font color="#0000FF"><<font color="#808000">role</font>></font>D<font color="#0000FF"></<font color="#808000">role</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_74411_jsonTab_13079_content"> <pre style="font-size:12px;"> { "response":{ "contactid":"d44t87a5", "userid":"uid1234", "email":"example@agent.com", "firstname":"John", "lastname":"Williams", "systemname":"system001", "authtoken":"5ceef21647f1db39a18cafc0bc2de015", "browsercookiename":"A_auth", "gender":"F", "role":"D" } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_application"></a> <h2>Application</h2> <br /> <a id="af645efcdcd9029af737024b10f38b61"></a> <h3>Return application installation date and latest version</h3> Avaliable from application version: 2.8.12.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_25172_generalTab_90193_header">General</div> </li> <li> <div class="headerContent" id="tab_37615_phpTab_42982_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_25172_generalTab_90193_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/application/status</div> </div> <div class="tabContent" id="tab_37615_phpTab_42982_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>application<span class="P">/</span>status<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">liveagentversion</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Latest application version</td> </tr> <tr> <td class="returnFieldsTableCellEven">gpfversion</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Latest framework version</td> </tr> <tr> <td class="returnFieldsTableCellOdd">dateinstalled</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date of Application installation</td> </tr> <tr> <td class="returnFieldsTableCellEven">datelatestupdate</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date of latest update</td> </tr> <tr> <td class="returnFieldsTableCellOdd">current_server_time</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Current server time</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_44103_xmlTab_78673_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_46250_jsonTab_62221_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_44103_xmlTab_78673_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">liveagentversion</font>></font>2.8.5.4<font color="#0000FF"></<font color="#808000">liveagentversion</font>></font> <font color="#0000FF"><<font color="#808000">gpfversion</font>></font>1.7.8.4<font color="#0000FF"></<font color="#808000">gpfversion</font>></font> <font color="#0000FF"><<font color="#808000">dateinstalled</font>></font>2012-04-05 11:22:31<font color="#0000FF"></<font color="#808000">dateinstalled</font>></font> <font color="#0000FF"><<font color="#808000">datelatestupdate</font>></font>2012-08-05 12:13:05<font color="#0000FF"></<font color="#808000">datelatestupdate</font>></font> <font color="#0000FF"><<font color="#808000">current_server_time</font>></font>2014-08-09 10:14:00<font color="#0000FF"></<font color="#808000">current_server_time</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_46250_jsonTab_62221_content"> <pre style="font-size:12px;"> { "response":{ "liveagentversion":"2.8.5.4", "gpfversion":"1.7.8.4", "dateinstalled":"2012-04-05 11:22:31", "datelatestupdate":"2012-08-05 12:13:05", "current_server_time":"2014-08-09 10:14:00" } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_companies"></a> <h2>Companies</h2> <br /> <a id="ddf8329339a993d35f63e3f972f657d7"></a> <h3>Retrieve list of companies</h3> Avaliable from application version: 4.23.0.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_28533_generalTab_74148_header">General</div> </li> <li> <div class="headerContent" id="tab_94719_phpTab_34335_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_28533_generalTab_74148_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/companies</div> </div> <div class="tabContent" id="tab_94719_phpTab_34335_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>companies<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">companies</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">list of all companies</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>companies</u> has 5 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">unique identifier of company</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">name of the company</td> </tr> <tr> <td class="returnFieldsTableCellEven">emails</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">email addresses associated with the company</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datecreated</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">date, when company was created</td> </tr> <tr> <td class="returnFieldsTableCellEven">ip</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">IP address of company</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_64732_xmlTab_73223_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_50299_jsonTab_95146_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_64732_xmlTab_73223_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">companies</font>></font> <font color="#0000FF"><<font color="#808000">companie</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>d8f6ba6d<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Company Co.<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">emails</font>></font>ceo@companyco.com<font color="#0000FF"></<font color="#808000">emails</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2015-05-28 06:25:07<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">ip</font>></font>10.10.1.1<font color="#0000FF"></<font color="#808000">ip</font>></font> <font color="#0000FF"></<font color="#808000">companie</font>></font> <font color="#0000FF"></<font color="#808000">companies</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_50299_jsonTab_95146_content"> <pre style="font-size:12px;"> { "response":{ "companies":[ { "id":"d8f6ba6d", "name":"Company Co.", "emails":"ceo@companyco.com", "datecreated":"2015-05-28 06:25:07", "ip":"10.10.1.1" } ] } }</pre> </div> </div> <br /> <br /> <a id="77fd57bc8e33ed000f883c12ac0cdbf0"></a> <h3>Retrieve company info</h3> Avaliable from application version: 4.23.0.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_74391_generalTab_74969_header">General</div> </li> <li> <div class="headerContent" id="tab_70004_phpTab_93419_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_74391_generalTab_74969_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/companies/<span style="color:#5640E6;">[companyid]</span></div> </div> <div class="tabContent" id="tab_70004_phpTab_93419_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>companies<span class="P">/[</span>companyid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[companyid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Company ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of the company</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Company name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datecreated</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Date, when company was created</td> </tr> <tr> <td class="returnFieldsTableCellEven">language</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Language associated with company</td> </tr> <tr> <td class="returnFieldsTableCellOdd">ip</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">IP address of company</td> </tr> <tr> <td class="returnFieldsTableCellEven">emails</td> <td class="returnFieldsTableCellEven">array</td> <td class="returnFieldsTableCellEven">List of company emails</td> </tr> <tr> <td class="returnFieldsTableCellOdd">phones</td> <td class="returnFieldsTableCellOdd">array</td> <td class="returnFieldsTableCellOdd">List of company phones</td> </tr> <tr> <td class="returnFieldsTableCellEven">groups</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">List of groups, which company is part of</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>groups</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">groupid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of group</td> </tr> <tr> <td class="returnFieldsTableCellEven">groupname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of group</td> </tr> <tr> <td class="returnFieldsTableCellOdd">custom_fields</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Custom field values</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>custom_fields</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Custom field code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">value</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Custom field value</td> </tr> <tr> <td class="returnFieldsTableCellEven">unique_fields</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Unique company identifiers</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>unique_fields</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">code</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Unique field code.</td> </tr> <tr> <td class="returnFieldsTableCellEven">value</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Unique field value.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_90857_xmlTab_67939_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_14158_jsonTab_39028_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_90857_xmlTab_67939_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>d8f6ba6d<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Company Co.<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2015-05-28 06:25:07<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">language</font>></font>en<font color="#0000FF"></<font color="#808000">language</font>></font> <font color="#0000FF"><<font color="#808000">ip</font>></font>15.1.1.10<font color="#0000FF"></<font color="#808000">ip</font>></font> <font color="#0000FF"><<font color="#808000">emails</font>></font> <font color="#0000FF"><<font color="#808000">email</font>></font>support@companyco.com<font color="#0000FF"></<font color="#808000">email</font>></font> <font color="#0000FF"><<font color="#808000">email</font>></font>boss@companyco.com<font color="#0000FF"></<font color="#808000">email</font>></font> <font color="#0000FF"></<font color="#808000">emails</font>></font> <font color="#0000FF"><<font color="#808000">phones</font>></font> <font color="#0000FF"><<font color="#808000">phone</font>></font>+214101254896<font color="#0000FF"></<font color="#808000">phone</font>></font> <font color="#0000FF"><<font color="#808000">phone</font>></font>0909 111 111<font color="#0000FF"></<font color="#808000">phone</font>></font> <font color="#0000FF"></<font color="#808000">phones</font>></font> <font color="#0000FF"><<font color="#808000">groups</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">groupid</font>></font>456rs<font color="#0000FF"></<font color="#808000">groupid</font>></font> <font color="#0000FF"><<font color="#808000">groupname</font>></font>Super group<font color="#0000FF"></<font color="#808000">groupname</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">groupid</font>></font>orj5s<font color="#0000FF"></<font color="#808000">groupid</font>></font> <font color="#0000FF"><<font color="#808000">groupname</font>></font>Rito pls<font color="#0000FF"></<font color="#808000">groupname</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"></<font color="#808000">groups</font>></font> <font color="#0000FF"><<font color="#808000">custom_fields</font>></font> <font color="#0000FF"><<font color="#808000">custom_field</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>n. of people<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>42<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">custom_field</font>></font> <font color="#0000FF"><<font color="#808000">custom_field</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>favourite drink<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>coffee<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">custom_field</font>></font> <font color="#0000FF"></<font color="#808000">custom_fields</font>></font> <font color="#0000FF"><<font color="#808000">unique_fields</font>></font> <font color="#0000FF"><<font color="#808000">unique_field</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>email<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>support@companyco.com<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">unique_field</font>></font> <font color="#0000FF"><<font color="#808000">unique_field</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>email<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>boss@companyco.com<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">unique_field</font>></font> <font color="#0000FF"><<font color="#808000">unique_field</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>phone<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>+19837987987<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">unique_field</font>></font> <font color="#0000FF"></<font color="#808000">unique_fields</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_14158_jsonTab_39028_content"> <pre style="font-size:12px;"> { "response":{ "id":"d8f6ba6d", "name":"Company Co.", "datecreated":"2015-05-28 06:25:07", "language":"en", "ip":"15.1.1.10", "emails":[ "support@companyco.com", "boss@companyco.com" ], "phones":[ "+214101254896", "0909 111 111" ], "groups":[ { "groupid":"456rs", "groupname":"Super group" }, { "groupid":"orj5s", "groupname":"Rito pls" } ], "custom_fields":[ { "code":"n. of people", "value":"42" }, { "code":"favourite drink", "value":"coffee" } ], "unique_fields":[ { "code":"email", "value":"support@companyco.com" }, { "code":"email", "value":"boss@companyco.com" }, { "code":"phone", "value":"+19837987987" } ] } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_conversations"></a> <h2>Conversations</h2> <br /> <a id="7d91361d6ef18f0f338e76d18a6d41e1"></a> <h3>Transfer conversation to another department and/or agent</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_37491_generalTab_32554_header">General</div> </li> <li> <div class="headerContent" id="tab_48556_phpTab_75480_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_37491_generalTab_32554_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">PUT</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/attendants</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as PUT fields.</i></span></div> <div class="tabContent" id="tab_48556_phpTab_75480_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>attendants"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">PUT</span>"<span class="P">)</span>; <span class="V">$curl_put_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>agentidentifier<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>useridentifier<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>department<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>note<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_put_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">agentidentifier</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier. Could be mail or userid.</td> </tr> <tr> <td class="returnFieldsTableCellEven">useridentifier</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User identifier (could be mail or userid) who will transfer the conversation. If undefined, user "System" will be used.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">department</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of the department.</td> </tr> <tr> <td class="returnFieldsTableCellEven">note</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Transfer note.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_97966_xmlTab_12343_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_18535_jsonTab_30442_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_97966_xmlTab_12343_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_18535_jsonTab_30442_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="a79c458da5cd983777e339cd460193ed"></a> <h3>Delete conversation</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_81930_generalTab_55721_header">General</div> </li> <li> <div class="headerContent" id="tab_29504_phpTab_92992_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_81930_generalTab_55721_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span></div> </div> <div class="tabContent" id="tab_29504_phpTab_92992_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>note<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>useridentifier<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[conversationid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">note</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Delete note</td> </tr> <tr> <td class="returnFieldsTableCellOdd">useridentifier</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier. Could be mail or userid. If not set, user "System" will be used.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_89318_xmlTab_53479_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_19976_jsonTab_63054_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_89318_xmlTab_53479_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_19976_jsonTab_63054_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="246bd94b4c438d32ccfdda6946e39913"></a> <h3>Delete custom field value in conversation</h3> Avaliable from application version: 4.16.4.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_45685_generalTab_73302_header">General</div> </li> <li> <div class="headerContent" id="tab_90270_phpTab_68829_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_45685_generalTab_73302_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/fields</div> </div> <div class="tabContent" id="tab_90270_phpTab_68829_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>fields"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>code<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Custom field name to be deleted from conversation. If not specified, all fields will be deleted from conversation.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_40311_xmlTab_93083_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_86001_jsonTab_46826_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_40311_xmlTab_93083_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_86001_jsonTab_46826_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="6009ef95d6c3d32706fe7084dc82e81d"></a> <h3>Add custom field value to conversation</h3> Avaliable from application version: 4.16.4.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_50066_generalTab_19547_header">General</div> </li> <li> <div class="headerContent" id="tab_59272_phpTab_81258_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_50066_generalTab_19547_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/fields</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_59272_phpTab_81258_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>customfields<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>fields"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[conversationid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">customfields</td> <td class="returnFieldsTableCellOdd">json</td> <td class="returnFieldsTableCellOdd">Add custom field values (Same field can be added multiple times, if you need to update existing field value, delete it first). Json encoded array of custom fields. Example value: [{"code":"varsymbol","value":"43894209"},{"code":"anotherfield","value":"test value"}]</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_12190_xmlTab_95009_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_73111_jsonTab_33334_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_12190_xmlTab_95009_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_73111_jsonTab_33334_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="6d1698eaa7f970beec504017ce9f8ac4"></a> <h3>Retrieves all conversations</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_34426_generalTab_51010_header">General</div> </li> <li> <div class="headerContent" id="tab_55758_phpTab_12967_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_34426_generalTab_51010_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/conversations</div> </div> <div class="tabContent" id="tab_55758_phpTab_12967_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">owneridentifier</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversations owner identifier. Could be mail.</td> </tr> <tr> <td class="returnFieldsTableCellEven">department</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agent</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier. Could be userid or mail.</td> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Load only conversations with given status. It can contain one specific status, or multiple statuses separated by comma. Example: status=R,T,C. <i>This parameter is avaliable from version 2.8.12.1</i></td> </tr> <tr> <td class="returnFieldsTableCellOdd">datefrom</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Load only conversations older than this date (valid format: YYYY-MM-DD HH:MM:SS).</td> </tr> <tr> <td class="returnFieldsTableCellEven">dateto</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Load only conversations younger than this date (valid format: YYYY-MM-DD HH:MM:SS).</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datechanged</td> <td class="returnFieldsTableCellOdd">opdatetime</td> <td class="returnFieldsTableCellOdd">Date of last conversation change</td> </tr> <tr> <td class="returnFieldsTableCellEven">subject</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Load only conversations with specific subject - <i>avail. from version 3.0.1.2</i></td> </tr> <tr> <td class="returnFieldsTableCellOdd">limit</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Limit number of returned rows. Default value: 100, Max value: 1000</td> </tr> <tr> <td class="returnFieldsTableCellEven">offset</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Return articles from defined row number. Default value 0.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">channel_type</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Load only conversations with given channel type. It can contain one specific channel type, or multiple channel types separated by comma. Example: channel_type=E,F,T. <i>This parameter is available from version 4.25.5.1</i></td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">conversations</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Conversations list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>conversations</u> has 17 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">conversationid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of conversation</td> </tr> <tr> <td class="returnFieldsTableCellOdd">code</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation code</td> </tr> <tr> <td class="returnFieldsTableCellEven">datecreated</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date created</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datechanged</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date of last change</td> </tr> <tr> <td class="returnFieldsTableCellEven">datedue</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Due date (if sla is set)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department name</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Conversation status (Possible values: <i>A</i> - Answered, <i>P</i> - Calling, <i>T</i> - Chatting, <i>X</i> - Deleted, <i>B</i> - Spam, <i>I</i> - Init, <i>C</i> - Open, <i>R</i> - Resolved, <i>N</i> - New, <i>W</i> - Postponed)</td> </tr> <tr> <td class="returnFieldsTableCellEven">ownername</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of conversation owner</td> </tr> <tr> <td class="returnFieldsTableCellOdd">owneremail</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Email of conversation owner</td> </tr> <tr> <td class="returnFieldsTableCellEven">subject</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation subject</td> </tr> <tr> <td class="returnFieldsTableCellOdd">preview</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation preview</td> </tr> <tr> <td class="returnFieldsTableCellEven">publicurlcode</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Public URL code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">tags</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Tags assigned to ticket.</td> </tr> <tr> <td class="returnFieldsTableCellEven">channel_type</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Conversation channel (Possible values: <i>E</i> - Email, <i>B</i> - Contact button, <i>M</i> - Contact form, <i>I</i> - Invitation, <i>C</i> - Call, <i>W</i> - Call button, <i>F</i> - Facebook, <i>A</i> - Facebook message, <i>T</i> - Twitter, <i>Q</i> - Forum, <i>S</i> - Suggestion)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">messagegroupsin</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Incoming messages.</td> </tr> <tr> <td class="returnFieldsTableCellEven">messagegroupsout</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Outgoing messages.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_98364_xmlTab_53510_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_14682_jsonTab_60835_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_98364_xmlTab_53510_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">conversations</font>></font> <font color="#0000FF"><<font color="#808000">conversation</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>s4y7t5s7<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>AX4-B4T-FD8<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-03-02 11:21:04<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2012-03-02 11:21:05<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">departmentname</font>></font>Department 1<font color="#0000FF"></<font color="#808000">departmentname</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>a5j9t4d8<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>A<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">ownername</font>></font>John Owner<font color="#0000FF"></<font color="#808000">ownername</font>></font> <font color="#0000FF"><<font color="#808000">owneremail</font>></font>john@owner.com<font color="#0000FF"></<font color="#808000">owneremail</font>></font> <font color="#0000FF"><<font color="#808000">subject</font>></font>Test ticket<font color="#0000FF"></<font color="#808000">subject</font>></font> <font color="#0000FF"><<font color="#808000">preview</font>></font>this is test ticket<font color="#0000FF"></<font color="#808000">preview</font>></font> <font color="#0000FF"><<font color="#808000">publicurlcode</font>></font>bI5fR3oN40708G65<font color="#0000FF"></<font color="#808000">publicurlcode</font>></font> <font color="#0000FF"><<font color="#808000">tags</font>></font>tagid1,tagid2<font color="#0000FF"></<font color="#808000">tags</font>></font> <font color="#0000FF"><<font color="#808000">channel_type</font>></font>E<font color="#0000FF"></<font color="#808000">channel_type</font>></font> <font color="#0000FF"><<font color="#808000">messagegroupsin</font>></font>2<font color="#0000FF"></<font color="#808000">messagegroupsin</font>></font> <font color="#0000FF"><<font color="#808000">messagegroupsout</font>></font>5<font color="#0000FF"></<font color="#808000">messagegroupsout</font>></font> <font color="#0000FF"></<font color="#808000">conversation</font>></font> <font color="#0000FF"><<font color="#808000">conversation</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>5h7t58d9<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>D5S-55S-A9A<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-03-02 12:21:04<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2012-03-02 12:21:05<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">departmentname</font>></font>Department 1<font color="#0000FF"></<font color="#808000">departmentname</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>a5j9t4d8<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>A<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">ownername</font>></font>John Silver<font color="#0000FF"></<font color="#808000">ownername</font>></font> <font color="#0000FF"><<font color="#808000">owneremail</font>></font>john@silver.com<font color="#0000FF"></<font color="#808000">owneremail</font>></font> <font color="#0000FF"><<font color="#808000">subject</font>></font>My ticet<font color="#0000FF"></<font color="#808000">subject</font>></font> <font color="#0000FF"><<font color="#808000">preview</font>></font>this my ticket<font color="#0000FF"></<font color="#808000">preview</font>></font> <font color="#0000FF"><<font color="#808000">publicurlcode</font>></font>xU6fR3zN40708G65<font color="#0000FF"></<font color="#808000">publicurlcode</font>></font> <font color="#0000FF"><<font color="#808000">tags</font>></font>tagid1,tagid2<font color="#0000FF"></<font color="#808000">tags</font>></font> <font color="#0000FF"><<font color="#808000">channel_type</font>></font>F<font color="#0000FF"></<font color="#808000">channel_type</font>></font> <font color="#0000FF"><<font color="#808000">messagegroupsin</font>></font>1<font color="#0000FF"></<font color="#808000">messagegroupsin</font>></font> <font color="#0000FF"><<font color="#808000">messagegroupsout</font>></font>2<font color="#0000FF"></<font color="#808000">messagegroupsout</font>></font> <font color="#0000FF"></<font color="#808000">conversation</font>></font> <font color="#0000FF"></<font color="#808000">conversations</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_14682_jsonTab_60835_content"> <pre style="font-size:12px;"> { "response":{ "conversations":[ { "conversationid":"s4y7t5s7", "code":"AX4-B4T-FD8", "datecreated":"2012-03-02 11:21:04", "datechanged":"2012-03-02 11:21:05", "departmentname":"Department 1", "departmentid":"a5j9t4d8", "status":"A", "ownername":"John Owner", "owneremail":"john@owner.com", "subject":"Test ticket", "preview":"this is test ticket", "publicurlcode":"bI5fR3oN40708G65", "tags":"tagid1, tagid2", "channel_type":"E", "messagegroupsin":"2", "messagegroupsout":"5" }, { "conversationid":"5h7t58d9", "code":"D5S-55S-A9A", "datecreated":"2012-03-02 12:21:04", "datechanged":"2012-03-02 12:21:05", "departmentname":"Department 1", "departmentid":"a5j9t4d8", "status":"A", "ownername":"John Silver", "owneremail":"john@silver.com", "subject":"My ticet", "preview":"this my ticket", "publicurlcode":"xU6fR3zN40708G65", "tags":"tagid1, tagid2", "channel_type":"F", "messagegroupsin":"1", "messagegroupsout":"2" } ] } }</pre> </div> </div> <br /> <br /> <a id="87abf7ff1b8dd576caf5194e502354cf"></a> <h3>Retrieves conversation info</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_56359_generalTab_88398_header">General</div> </li> <li> <div class="headerContent" id="tab_67131_phpTab_85848_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_56359_generalTab_88398_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span></div> </div> <div class="tabContent" id="tab_67131_phpTab_85848_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">conversationid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of conversation</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datecreated</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date created</td> </tr> <tr> <td class="returnFieldsTableCellEven">datechanged</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date of last change</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datedue</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Due date (if sla is set)</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department id</td> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Conversation status (Possible values: <i>A</i> - Answered, <i>P</i> - Calling, <i>T</i> - Chatting, <i>X</i> - Deleted, <i>B</i> - Spam, <i>I</i> - Init, <i>C</i> - Open, <i>R</i> - Resolved, <i>N</i> - New, <i>W</i> - Postponed)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">ownername</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of conversation owner</td> </tr> <tr> <td class="returnFieldsTableCellEven">owneremail</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Email of conversation owner</td> </tr> <tr> <td class="returnFieldsTableCellOdd">subject</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation subject</td> </tr> <tr> <td class="returnFieldsTableCellEven">ownernote</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation owner note - <i>avail. from version 2.8.12.X+</i></td> </tr> <tr> <td class="returnFieldsTableCellOdd">preview</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation preview</td> </tr> <tr> <td class="returnFieldsTableCellEven">publicurlcode</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Public URL code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">assignedto</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Identifier of agent which is this conversation assigned to</td> </tr> <tr> <td class="returnFieldsTableCellEven">tags</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tags assigned to ticket</td> </tr> <tr> <td class="returnFieldsTableCellOdd">channel_type</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Conversation channel (Possible values: <i>E</i> - Email, <i>B</i> - Contact button, <i>M</i> - Contact form, <i>I</i> - Invitation, <i>C</i> - Call, <i>W</i> - Call button, <i>F</i> - Facebook, <i>A</i> - Facebook message, <i>T</i> - Twitter, <i>Q</i> - Forum, <i>S</i> - Suggestion)</td> </tr> <tr> <td class="returnFieldsTableCellEven">messagegroupsin</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Incoming messages.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">messagegroupsout</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Outgoing messages.</td> </tr> <tr> <td class="returnFieldsTableCellEven">customfields</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Custom field values</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>customfields</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">code</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Custom field code.</td> </tr> <tr> <td class="returnFieldsTableCellEven">value</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Custom field value.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_84417_xmlTab_56997_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_11184_jsonTab_48749_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_84417_xmlTab_56997_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>a1b2c3d4<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>ABC-DEFGH-123<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-04-01 00:15:11<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2012-04-01 00:15:21<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">datedue</font>/></font> <font color="#0000FF"><<font color="#808000">departmentname</font>></font>Department 1<font color="#0000FF"></<font color="#808000">departmentname</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>dep1s5a4<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>R<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">ownername</font>></font>John Doe<font color="#0000FF"></<font color="#808000">ownername</font>></font> <font color="#0000FF"><<font color="#808000">owneremail</font>></font>owner@example.com<font color="#0000FF"></<font color="#808000">owneremail</font>></font> <font color="#0000FF"><<font color="#808000">subject</font>></font>My first ticket<font color="#0000FF"></<font color="#808000">subject</font>></font> <font color="#0000FF"><<font color="#808000">ownernote</font>/></font> <font color="#0000FF"><<font color="#808000">preview</font>></font>Hello, this is my first ticket...<font color="#0000FF"></<font color="#808000">preview</font>></font> <font color="#0000FF"><<font color="#808000">publicurlcode</font>></font>bI5fR3oN40708G65<font color="#0000FF"></<font color="#808000">publicurlcode</font>></font> <font color="#0000FF"><<font color="#808000">assignedto</font>/></font> <font color="#0000FF"><<font color="#808000">tags</font>></font>tagid1<font color="#0000FF"></<font color="#808000">tags</font>></font> <font color="#0000FF"><<font color="#808000">channel_type</font>></font>F<font color="#0000FF"></<font color="#808000">channel_type</font>></font> <font color="#0000FF"><<font color="#808000">messagegroupsin</font>></font>1<font color="#0000FF"></<font color="#808000">messagegroupsin</font>></font> <font color="#0000FF"><<font color="#808000">messagegroupsout</font>></font>3<font color="#0000FF"></<font color="#808000">messagegroupsout</font>></font> <font color="#0000FF"><<font color="#808000">customfields</font>></font> <font color="#0000FF"><<font color="#808000">customfield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>varsymbol<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>423874698<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">customfield</font>></font> <font color="#0000FF"><<font color="#808000">customfield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>other_var<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>Example value of custom field<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">customfield</font>></font> <font color="#0000FF"></<font color="#808000">customfields</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_11184_jsonTab_48749_content"> <pre style="font-size:12px;"> { "response":{ "conversationid":"a1b2c3d4", "code":"ABC-DEFGH-123", "datecreated":"2012-04-01 00:15:11", "datechanged":"2012-04-01 00:15:21", "datedue":null, "departmentname":"Department 1", "departmentid":"dep1s5a4", "status":"R", "ownername":"John Doe", "owneremail":"owner@example.com", "subject":"My first ticket", "ownernote":null, "preview":"Hello, this is my first ticket...", "publicurlcode":"bI5fR3oN40708G65", "assignedto":null, "tags":"tagid1", "channel_type":"F", "messagegroupsin":"1", "messagegroupsout":"3", "customfields":[ { "code":"varsymbol", "value":"423874698" }, { "code":"other_var", "value":"Example value of custom field" } ] } }</pre> </div> </div> <br /> <br /> <a id="d955243071fab7892f83eb2c72650bb0"></a> <h3>Retrieves all conversation messages</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_56601_generalTab_35178_header">General</div> </li> <li> <div class="headerContent" id="tab_88394_phpTab_30049_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_56601_generalTab_35178_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/messages</div> </div> <div class="tabContent" id="tab_88394_phpTab_30049_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>messages<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">datefrom</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Load messages only older than this date (valid format: YYYY-MM-DD HH:MM:SS).</td> </tr> <tr> <td class="returnFieldsTableCellEven">dateto</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Load messages only newer than this date (valid format: YYYY-MM-DD HH:MM:SS).</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">groups</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Message groups list.</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>groups</u> has 7 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">messagegroupid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of the group.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">userid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of the user who created the group.</td> </tr> <tr> <td class="returnFieldsTableCellEven">rtype</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Type of the group. (Possible values: <i>P</i> - Type call, <i>V</i> - Type outgoing call, <i>1</i> - Type internal call, <i>C</i> - Type chat, <i>X</i> - Type delete, <i>F</i> - Type facebook, <i>I</i> - Type internal, <i>Z</i> - Type internal (collapsed by default), <i>K</i> - Type knowledgebase, <i>A</i> - Type knowledgebase start, <i>5</i> - Type offline, <i>M</i> - Type offline legacy, <i>U</i> - Type internal offline, <i>R</i> - Type resolve, <i>Y</i> - Type retweet, <i>S</i> - Type startinfo, <i>G</i> - Type tag, <i>T</i> - Type transfer, <i>W</i> - Type twitter, <i>O</i> - Type forwarded, <i>Q</i> - Type reply to forward, <i>J</i> - Type postpone, <i>B</i> - Type spam, <i>L</i> - Type split, <i>2</i> - Type merged, <i>3</i> - Type incoming email, <i>4</i> - Type outgoing email)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rstatus</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status of the group (Possible values: <i>D</i> - Status deleted, <i>P</i> - Status promoted, <i>V</i> - Status visible, <i>S</i> - Status splitted, <i>M</i> - Status merged, <i>I</i> - Status initializing, <i>C</i> - Status calling, <i>R</i> - Status connecting)</td> </tr> <tr> <td class="returnFieldsTableCellEven">datecreated</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date of creation</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datefinished</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date ofter latest message</td> </tr> <tr> <td class="returnFieldsTableCellEven">messages</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">List of messages</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>messages</u> has 5 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">messageid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of the message</td> </tr> <tr> <td class="returnFieldsTableCellEven">userid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of the message user</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Type of the message (Possible values: <i>D</i> - Type disconnected, <i>E</i> - Type end, <i>F</i> - Type file, <i>Z</i> - Type formfield, <i>H</i> - Type header, <i>I</i> - Type internal, <i>M</i> - Type message, <i>B</i> - Type split, <i>X</i> - Type mixed message, <i>N</i> - Type note, <i>L</i> - Type note file, <i>Q</i> - Type quoted text, <i>C</i> - Type rating comment, <i>P</i> - Type positive rating, <i>W</i> - Type negative rating, <i>J</i> - Type status, <i>S</i> - Type system, <i>G</i> - Type tag, <i>O</i> - Type footer, <i>A</i> - Type header, <i>T</i> - Type title, <i>R</i> - Type transfer, <i>U</i> - Type useragent, <i>V</i> - Type voice, <i>1</i> - Type voice internal, <i>2</i> - Type merged, <i>0</i> - Type error footer, <i>Y</i> - Type message legacy, <i>K</i> - Type system public, <i>3</i> - Type invitation reroute)</td> </tr> <tr> <td class="returnFieldsTableCellEven">datecreated</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date of message creation</td> </tr> <tr> <td class="returnFieldsTableCellOdd">message</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Message body</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_91570_xmlTab_65810_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_28588_jsonTab_70571_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_91570_xmlTab_65810_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">groups</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid12345<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>M<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>V<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-04-03 12:21:21<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datefinished</font>></font>2012-04-03 12:31:21<font color="#0000FF"></<font color="#808000">datefinished</font>></font> <font color="#0000FF"><<font color="#808000">messages</font>></font> <font color="#0000FF"><<font color="#808000">message</font>></font> <font color="#0000FF"><<font color="#808000">messageid</font>></font>mid00003<font color="#0000FF"></<font color="#808000">messageid</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid00001<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>M<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-04-03 12:25:21<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">message</font>></font>hello, this is example message<font color="#0000FF"></<font color="#808000">message</font>></font> <font color="#0000FF"></<font color="#808000">message</font>></font> <font color="#0000FF"></<font color="#808000">messages</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid12346<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>M<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>V<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-04-03 12:41:21<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datefinished</font>></font>2012-04-03 13:21:21<font color="#0000FF"></<font color="#808000">datefinished</font>></font> <font color="#0000FF"><<font color="#808000">messages</font>></font> <font color="#0000FF"><<font color="#808000">message</font>></font> <font color="#0000FF"><<font color="#808000">messageid</font>></font>mid00004<font color="#0000FF"></<font color="#808000">messageid</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid00001<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>M<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-04-03 18:21:21<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">message</font>></font>hello, this is example message<font color="#0000FF"></<font color="#808000">message</font>></font> <font color="#0000FF"></<font color="#808000">message</font>></font> <font color="#0000FF"><<font color="#808000">message</font>></font> <font color="#0000FF"><<font color="#808000">messageid</font>></font>mid00005<font color="#0000FF"></<font color="#808000">messageid</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid00001<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>M<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-04-03 19:21:21<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">message</font>></font>hello, this is example message<font color="#0000FF"></<font color="#808000">message</font>></font> <font color="#0000FF"></<font color="#808000">message</font>></font> <font color="#0000FF"></<font color="#808000">messages</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"></<font color="#808000">groups</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_28588_jsonTab_70571_content"> <pre style="font-size:12px;"> { "response":{ "groups":[ { "userid":"uid12345", "rtype":"M", "rstatus":"V", "datecreated":"2012-04-03 12:21:21", "datefinished":"2012-04-03 12:31:21", "messages":[ { "messageid":"mid00003", "userid":"uid00001", "rtype":"M", "datecreated":"2012-04-03 12:25:21", "message":"hello, this is example message" } ] }, { "userid":"uid12346", "rtype":"M", "rstatus":"V", "datecreated":"2012-04-03 12:41:21", "datefinished":"2012-04-03 13:21:21", "messages":[ { "messageid":"mid00004", "userid":"uid00001", "rtype":"M", "datecreated":"2012-04-03 18:21:21", "message":"hello, this is example message" }, { "messageid":"mid00005", "userid":"uid00001", "rtype":"M", "datecreated":"2012-04-03 19:21:21", "message":"hello, this is example message" } ] } ] } }</pre> </div> </div> <br /> <br /> <a id="c33cb0122a8537c90d18413dd4966b56"></a> <h3>Create new message in conversation</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_86657_generalTab_97128_header">General</div> </li> <li> <div class="headerContent" id="tab_73627_phpTab_66271_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_86657_generalTab_97128_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/messages</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_73627_phpTab_66271_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>message<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>useridentifier<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>type<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>mail_messsage_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>do_not_send_mail<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>is_html_message<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>use_template<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>attachments<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>messages"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[conversationid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">message</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Message body (must be UTF-8)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">useridentifier</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier. Could be mail or userid. If not set, user "System" will be used.</td> </tr> <tr> <td class="returnFieldsTableCellEven">type</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Message type. (Possible values: <i>M</i> - Message, <i>N</i> - Note)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">mail_messsage_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Mail message id. If specified, all reply emails which will have given mail message id in in-reply-to header will be assigned to this conversation.</td> </tr> <tr> <td class="returnFieldsTableCellEven">do_not_send_mail</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Disables sending mail to customer. Can be used when mail was already sent by an external system (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">is_html_message</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Set this to Y is the message text is formatted in html (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> <tr> <td class="returnFieldsTableCellEven">use_template</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Use department mail template and add message into mail template text. (Default Yes) (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">attachments</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Message attachments. Comma separated file identifiers of files uploaded using files API. Example value: "3a1d0a821ea3a63594ba826efad0a379, 001908318230609832c2c07b7bac3658". Available from version 4.29</td> </tr> </tbody> </table> <br /> <br /> <i>Note: When useridentifier is empty only notes are created - even when type="M"</i><br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_16620_xmlTab_33346_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_97573_jsonTab_27459_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_16620_xmlTab_33346_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_97573_jsonTab_27459_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="c1c1ef54734a3a7fc45c5bfa66cb4545"></a> <h3>Change status of the conversation</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_35510_generalTab_50694_header">General</div> </li> <li> <div class="headerContent" id="tab_27402_phpTab_28559_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_35510_generalTab_50694_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">PUT</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/status</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as PUT fields.</i></span></div> <div class="tabContent" id="tab_27402_phpTab_28559_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>status"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">PUT</span>"<span class="P">)</span>; <span class="V">$curl_put_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>status<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>useridentifier<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>note<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_put_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Conversation status. (Possible values: <i>A</i> - Answered, <i>R</i> - Resolved, <i>C</i> - Open)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">useridentifier</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent identifier. Could be mail or userid. If not set, user "System" will be used.</td> </tr> <tr> <td class="returnFieldsTableCellEven">note</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Note</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_63429_xmlTab_16629_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_51944_jsonTab_93886_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_63429_xmlTab_16629_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_51944_jsonTab_93886_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="d0c0b602fdaed1299b71c5050b13cc27"></a> <h3>Unassign a tag from a conversation</h3> Avaliable from application version: 4.0.36.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_76726_generalTab_30734_header">General</div> </li> <li> <div class="headerContent" id="tab_13944_phpTab_79268_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_76726_generalTab_30734_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/tags</div> </div> <div class="tabContent" id="tab_13944_phpTab_79268_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>tags"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[conversationid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Identifier of the tag. Either id or name must be specified.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of the tag. Either id or name must be specified.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_88862_xmlTab_16732_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_37674_jsonTab_36534_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_88862_xmlTab_16732_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_37674_jsonTab_36534_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="d15a56764c0f88a8bf5cc11dc5a94dac"></a> <h3>Retrieve a list of tags assigned to a conversation</h3> Avaliable from application version: 4.0.30.6<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_41851_generalTab_65995_header">General</div> </li> <li> <div class="headerContent" id="tab_80192_phpTab_99295_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_41851_generalTab_65995_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/tags</div> </div> <div class="tabContent" id="tab_80192_phpTab_99295_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>tags<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">tags</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">The list of tags assigned.</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>tags</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">The identifier of the tag.</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of the tag.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_26283_xmlTab_17448_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_65790_jsonTab_48219_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_26283_xmlTab_17448_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">tags</font>></font> <font color="#0000FF"><<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>sh3j<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>8sd5<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Support<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">tag</font>></font> <font color="#0000FF"></<font color="#808000">tags</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_65790_jsonTab_48219_content"> <pre style="font-size:12px;"> { "response":{ "tags":[ { "id":"sh3j", "name":"VIP" }, { "id":"8sd5", "name":"Support" } ] } }</pre> </div> </div> <br /> <br /> <a id="e521cbab8851729fedc5b7548357c40a"></a> <h3>Assign tag to a conversation</h3> Avaliable from application version: 4.0.30.6<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_87531_generalTab_82403_header">General</div> </li> <li> <div class="headerContent" id="tab_71213_phpTab_99431_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_87531_generalTab_82403_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/conversations/<span style="color:#5640E6;">[conversationid]</span>/tags</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_71213_phpTab_99431_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>conversations<span class="P">/[</span>conversationid<span class="P">]/</span>tags"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[conversationid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID (eg. 12ab34cd) or code (eg. ABC-DEFGH-123) or public url code (eg. m6uoFJd2e4I8Z18q)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Identifier of the tag.</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of the tag.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_75306_xmlTab_89231_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_87663_jsonTab_40749_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_75306_xmlTab_89231_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_87663_jsonTab_40749_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_customers"></a> <h2>Customers</h2> <br /> <a id="b58b8a4a2e22985f73dc395d7a7d2b0c"></a> <h3>Delete custom field value in user contact</h3> Avaliable from application version: 4.16.4.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_83522_generalTab_75016_header">General</div> </li> <li> <div class="headerContent" id="tab_98771_phpTab_95157_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_83522_generalTab_75016_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/customers/<span style="color:#5640E6;">[customeridentifier]</span>/fields</div> </div> <div class="tabContent" id="tab_98771_phpTab_95157_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customers<span class="P">/[</span>customeridentifier<span class="P">]/</span>fields"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>code<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[customeridentifier]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer identifier (email or contactid)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Custom field name to be deleted from contact. If not specified, all custom fields will be deleted from contact.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_34876_xmlTab_84742_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_78686_jsonTab_67913_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_34876_xmlTab_84742_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_78686_jsonTab_67913_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="c064fd82872dfaa5135c69f7810baead"></a> <h3>Add custom field value to customer</h3> Avaliable from application version: 4.16.4.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_40843_generalTab_71004_header">General</div> </li> <li> <div class="headerContent" id="tab_63070_phpTab_16067_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_40843_generalTab_71004_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/customers/<span style="color:#5640E6;">[customeridentifier]</span>/fields</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_63070_phpTab_16067_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>customfields<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customers<span class="P">/[</span>customeridentifier<span class="P">]/</span>fields"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[customeridentifier]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer identifier (email or contactid)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">customfields</td> <td class="returnFieldsTableCellOdd">json</td> <td class="returnFieldsTableCellOdd">Add custom field values (Same field can be added multiple times, if you need to update existing field value, delete it first). Json encoded array of custom fields. Example value: [{"code":"varsymbol","value":"43894209"},{"code":"another_field","value":"test value"}]</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_51527_xmlTab_70106_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_78311_jsonTab_14974_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_51527_xmlTab_70106_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_78311_jsonTab_14974_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="353c125e9b99d39fe7ae7d87efa67dc4"></a> <h3>Retrieves customer info</h3> Avaliable from application version: 2.9.5.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_48495_generalTab_61005_header">General</div> </li> <li> <div class="headerContent" id="tab_92113_phpTab_87617_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_48495_generalTab_61005_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/customers/<span style="color:#5640E6;">[customeridentifier]</span></div> </div> <div class="tabContent" id="tab_92113_phpTab_87617_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customers<span class="P">/[</span>customeridentifier<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[customeridentifier]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer identifier (email or contactid)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of customer contact</td> </tr> <tr> <td class="returnFieldsTableCellEven">email</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer email</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer first name</td> </tr> <tr> <td class="returnFieldsTableCellEven">lastname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer last name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">systemname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer system name</td> </tr> <tr> <td class="returnFieldsTableCellEven">authtoken</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer browser cookie identification</td> </tr> <tr> <td class="returnFieldsTableCellOdd">browsercookiename</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Customer browser cookie name (Possible values: <i>V_auth</i> - Registerd visitor cookie name, <i>LaVisitorId_c3RhbmRhbG9uZS5sYS5sb2NhbGhvc3QvTGl2ZUFnZW50L3NlcnZlci8</i> - Not yet registered visitor cookie name)</td> </tr> <tr> <td class="returnFieldsTableCellEven">role</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Customer role. (Possible values: <i>V</i> - Visitor, <i>R</i> - Registered visitor)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">gender</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Customer gender (Possible values: <i>M</i> - Male, <i>F</i> - Female, <i>O</i> - Other)</td> </tr> <tr> <td class="returnFieldsTableCellEven">companyid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Company id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">userid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer userid</td> </tr> <tr> <td class="returnFieldsTableCellEven">datecreated</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date created</td> </tr> <tr> <td class="returnFieldsTableCellOdd">note</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer note</td> </tr> <tr> <td class="returnFieldsTableCellEven">ip</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer IP</td> </tr> <tr> <td class="returnFieldsTableCellOdd">customfields</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Custom field values</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>customfields</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Custom field code.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">value</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Custom field value.</td> </tr> <tr> <td class="returnFieldsTableCellEven">uniquefields</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Unique customer identifiers</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>uniquefields</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">code</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Unique field code.</td> </tr> <tr> <td class="returnFieldsTableCellEven">value</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Unique field value.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_59978_xmlTab_54922_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_70931_jsonTab_47008_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_59978_xmlTab_54922_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>cid00001<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">email</font>></font>john@example.com<font color="#0000FF"></<font color="#808000">email</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>John<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Doe<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">systemname</font>></font>system001<font color="#0000FF"></<font color="#808000">systemname</font>></font> <font color="#0000FF"><<font color="#808000">authtoken</font>></font>4fsd5f4s6f4s56f4s56f4s56f4sd56<font color="#0000FF"></<font color="#808000">authtoken</font>></font> <font color="#0000FF"><<font color="#808000">browsercookiename</font>></font>V_auth<font color="#0000FF"></<font color="#808000">browsercookiename</font>></font> <font color="#0000FF"><<font color="#808000">role</font>></font>V<font color="#0000FF"></<font color="#808000">role</font>></font> <font color="#0000FF"><<font color="#808000">gender</font>></font>M<font color="#0000FF"></<font color="#808000">gender</font>></font> <font color="#0000FF"><<font color="#808000">companyid</font>></font>d22537s9<font color="#0000FF"></<font color="#808000">companyid</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>uid00001<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2012-03-02 11:21:04<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">note</font>/></font> <font color="#0000FF"><<font color="#808000">ip</font>></font>20.1.1.10<font color="#0000FF"></<font color="#808000">ip</font>></font> <font color="#0000FF"><<font color="#808000">customfields</font>></font> <font color="#0000FF"><<font color="#808000">customfield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>varsymbol<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>423874698<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">customfield</font>></font> <font color="#0000FF"><<font color="#808000">customfield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>other_var<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>Example value of custom field<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">customfield</font>></font> <font color="#0000FF"></<font color="#808000">customfields</font>></font> <font color="#0000FF"><<font color="#808000">uniquefields</font>></font> <font color="#0000FF"><<font color="#808000">uniquefield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>phone<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>+1985457398709<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">uniquefield</font>></font> <font color="#0000FF"><<font color="#808000">uniquefield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>email<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>john@example.com<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">uniquefield</font>></font> <font color="#0000FF"><<font color="#808000">uniquefield</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>email<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">value</font>></font>john@example.com<font color="#0000FF"></<font color="#808000">value</font>></font> <font color="#0000FF"></<font color="#808000">uniquefield</font>></font> <font color="#0000FF"></<font color="#808000">uniquefields</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_70931_jsonTab_47008_content"> <pre style="font-size:12px;"> { "response":{ "contactid":"cid00001", "email":"john@example.com", "firstname":"John", "lastname":"Doe", "systemname":"system001", "authtoken":"4fsd5f4s6f4s56f4s56f4s56f4sd56", "browsercookiename":"V_auth", "role":"V", "gender":"M", "companyid":"d22537s9", "userid":"uid00001", "datecreated":"2012-03-02 11:21:04", "note":null, "ip":"20.1.1.10", "customfields":[ { "code":"varsymbol", "value":"423874698" }, { "code":"other_var", "value":"Example value of custom field" } ], "uniquefields":[ { "code":"phone", "value":"+1985457398709" }, { "code":"email", "value":"john@example.com" }, { "code":"email", "value":"john@example.com" } ] } }</pre> </div> </div> <br /> <br /> <a id="2c3f657707b74f4e57d34f904666e373"></a> <h3>Remove customer from group</h3> Avaliable from application version: 2.9.5.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_57767_generalTab_75918_header">General</div> </li> <li> <div class="headerContent" id="tab_95278_phpTab_50744_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_57767_generalTab_75918_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/customers/<span style="color:#5640E6;">[customeridentifier]</span>/groups?<span style="color:#C94444;">name=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_95278_phpTab_50744_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customers<span class="P">/[</span>customeridentifier<span class="P">]/</span>groups"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[customeridentifier]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer identifier (email or contactid)</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer group name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_80966_xmlTab_18863_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_25798_jsonTab_85518_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_80966_xmlTab_18863_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_25798_jsonTab_85518_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="56c108737c8a081080ea7d194d854fed"></a> <h3>Retrieve customer groups</h3> Avaliable from application version: 2.9.5.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_88236_generalTab_50345_header">General</div> </li> <li> <div class="headerContent" id="tab_44024_phpTab_86705_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_88236_generalTab_50345_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/customers/<span style="color:#5640E6;">[customeridentifier]</span>/groups</div> </div> <div class="tabContent" id="tab_44024_phpTab_86705_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customers<span class="P">/[</span>customeridentifier<span class="P">]/</span>groups<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[customeridentifier]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer identifier (email or contactid)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">groups</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">List of all customer groups</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>groups</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">groupid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Group id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">groupname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Group name</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_28673_xmlTab_40734_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_41380_jsonTab_69390_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_28673_xmlTab_40734_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">groups</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">groupid</font>></font>ag0h<font color="#0000FF"></<font color="#808000">groupid</font>></font> <font color="#0000FF"><<font color="#808000">groupname</font>></font>VIP<font color="#0000FF"></<font color="#808000">groupname</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">groupid</font>></font>2kt8<font color="#0000FF"></<font color="#808000">groupid</font>></font> <font color="#0000FF"><<font color="#808000">groupname</font>></font>Premium<font color="#0000FF"></<font color="#808000">groupname</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"></<font color="#808000">groups</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_41380_jsonTab_69390_content"> <pre style="font-size:12px;"> { "response":{ "groups":[ { "groupid":"ag0h", "groupname":"VIP" }, { "groupid":"2kt8", "groupname":"Premium" } ] } }</pre> </div> </div> <br /> <br /> <a id="4ee1474d1c6518f12703359bf459e83a"></a> <h3>Add customer to group</h3> Avaliable from application version: 2.9.5.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_15003_generalTab_68441_header">General</div> </li> <li> <div class="headerContent" id="tab_56481_phpTab_87586_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_15003_generalTab_68441_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/customers/<span style="color:#5640E6;">[customeridentifier]</span>/groups</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_56481_phpTab_87586_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customers<span class="P">/[</span>customeridentifier<span class="P">]/</span>groups"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[customeridentifier]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customer identifier (email or contactid)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customer group name</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_31340_xmlTab_54746_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_56859_jsonTab_12704_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_31340_xmlTab_54746_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_56859_jsonTab_12704_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_customers groups"></a> <h2>Customers groups</h2> <br /> <a id="a3559e1c7365a70597b4886a732e1768"></a> <h3>Delete customers group</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_54494_generalTab_17281_header">General</div> </li> <li> <div class="headerContent" id="tab_49122_phpTab_45983_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_54494_generalTab_17281_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/customersgroups/<span style="color:#5640E6;">[groupid]</span></div> </div> <div class="tabContent" id="tab_49122_phpTab_45983_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customersgroups<span class="P">/[</span>groupid<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[groupid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customers group ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_94912_xmlTab_44576_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_54949_jsonTab_95427_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_94912_xmlTab_44576_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_54949_jsonTab_95427_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="ebe7d1ee44ab317ba22c82ef478bbd5d"></a> <h3>Retrieve customers group info</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_11117_generalTab_51262_header">General</div> </li> <li> <div class="headerContent" id="tab_73005_phpTab_92983_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_11117_generalTab_51262_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/customersgroups/<span style="color:#5640E6;">[groupid]</span></div> </div> <div class="tabContent" id="tab_73005_phpTab_92983_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customersgroups<span class="P">/[</span>groupid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[groupid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Customers group ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Id of customers group</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of the customers group</td> </tr> <tr> <td class="returnFieldsTableCellOdd">color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for title</td> </tr> <tr> <td class="returnFieldsTableCellEven">bg_color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for background</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_20281_xmlTab_42778_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_83499_jsonTab_19501_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_20281_xmlTab_42778_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>sh3j<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">color</font>></font>FFFFFF<font color="#0000FF"></<font color="#808000">color</font>></font> <font color="#0000FF"><<font color="#808000">bg_color</font>></font>0000FF<font color="#0000FF"></<font color="#808000">bg_color</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_83499_jsonTab_19501_content"> <pre style="font-size:12px;"> { "response":{ "id":"sh3j", "name":"VIP", "color":"FFFFFF", "bg_color":"0000FF" } }</pre> </div> </div> <br /> <br /> <a id="4293a66ad2a7ab5502eb5c3b292df6be"></a> <h3>Retrieve all groups of all customers</h3> Avaliable from application version: 4.0.19.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_12738_generalTab_39653_header">General</div> </li> <li> <div class="headerContent" id="tab_35974_phpTab_85012_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_12738_generalTab_39653_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/customersgroups</div> </div> <div class="tabContent" id="tab_35974_phpTab_85012_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customersgroups<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">groups</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">List all groups of all customers</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>groups</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Group id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Group name</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_40282_xmlTab_56312_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_44879_jsonTab_49894_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_40282_xmlTab_56312_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">groups</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>ag0h<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">group</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>2kt8<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Premium<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">group</font>></font> <font color="#0000FF"></<font color="#808000">groups</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_44879_jsonTab_49894_content"> <pre style="font-size:12px;"> { "response":{ "groups":[ { "id":"ag0h", "name":"VIP" }, { "id":"2kt8", "name":"Premium" } ] } }</pre> </div> </div> <br /> <br /> <a id="7e998563ab9c7e240932fd527ce9dcdd"></a> <h3>Add customers group</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_42205_generalTab_99766_header">General</div> </li> <li> <div class="headerContent" id="tab_90708_phpTab_91382_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_42205_generalTab_99766_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/customersgroups</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_90708_phpTab_91382_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>bg_color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customersgroups"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of the customers group</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for name</td> </tr> <tr> <td class="returnFieldsTableCellEven">bg_color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for background</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of tag</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of tag</td> </tr> <tr> <td class="returnFieldsTableCellEven">color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">bg_color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for background</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_46806_xmlTab_85592_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_21660_jsonTab_28210_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_46806_xmlTab_85592_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>sh3j<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">color</font>></font>FFFFFF<font color="#0000FF"></<font color="#808000">color</font>></font> <font color="#0000FF"><<font color="#808000">bg_color</font>></font>0000FF<font color="#0000FF"></<font color="#808000">bg_color</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_21660_jsonTab_28210_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":"0", "id":"sh3j", "name":"VIP", "color":"FFFFFF", "bg_color":"0000FF" } }</pre> </div> </div> <br /> <br /> <a id="68f83547f6233a2e206c15a81eb5facf"></a> <h3>Change customers group</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_16688_generalTab_46727_header">General</div> </li> <li> <div class="headerContent" id="tab_29529_phpTab_19367_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_16688_generalTab_46727_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">PUT</div> http://example.com/api/customersgroups/<span style="color:#5640E6;">[groupid]</span></div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as PUT fields.</i></span></div> <div class="tabContent" id="tab_29529_phpTab_19367_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>customersgroups<span class="P">/[</span>groupid<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">PUT</span>"<span class="P">)</span>; <span class="V">$curl_put_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>bg_color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_put_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[groupid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Customers group ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of the customers group</td> </tr> <tr> <td class="returnFieldsTableCellEven">color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">bg_color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for background</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_32669_xmlTab_92333_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_61074_jsonTab_54545_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_32669_xmlTab_92333_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_61074_jsonTab_54545_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_departments"></a> <h2>Departments</h2> <br /> <a id="7492dac92d066e148de4b67c72406f40"></a> <h3>Retrieve list of departments</h3> Avaliable from application version: 2.8.2.1 <div style="font-size:14px; padding-top:0px; margin:0px;">Avaliable examples: <a href="https://support.liveagent.com/876517-Online-agents-widget-for-WordPress" target="_blank" title="Wordpress widget example">Wordpress widget example</a></div> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_26257_generalTab_94359_header">General</div> </li> <li> <div class="headerContent" id="tab_97728_phpTab_60406_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_26257_generalTab_94359_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/departments</div> </div> <div class="tabContent" id="tab_97728_phpTab_60406_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>departments<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">departments</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">list of all departments</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>departments</u> has 4 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">id of the department</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of the department</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinestatus</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Online status of department - services online in department. Combination of values T, P, M (T - chat, P - phone, M - automatic ticket solving)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">deleted</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">If department was deleted (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_32621_xmlTab_68080_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_61008_jsonTab_26306_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_32621_xmlTab_68080_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">departments</font>></font> <font color="#0000FF"><<font color="#808000">department</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>d1s58gs4<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Department 1<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">onlinestatus</font>></font>M<font color="#0000FF"></<font color="#808000">onlinestatus</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"></<font color="#808000">department</font>></font> <font color="#0000FF"><<font color="#808000">department</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>d2s58gs4<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Department 2<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">onlinestatus</font>></font>R<font color="#0000FF"></<font color="#808000">onlinestatus</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"></<font color="#808000">department</font>></font> <font color="#0000FF"></<font color="#808000">departments</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_61008_jsonTab_26306_content"> <pre style="font-size:12px;"> { "response":{ "departments":[ { "departmentid":"d1s58gs4", "name":"Department 1", "onlinestatus":"M", "deleted":"N" }, { "departmentid":"d2s58gs4", "name":"Department 2", "onlinestatus":"R", "deleted":"N" } ] } }</pre> </div> </div> <br /> <br /> <a id="a0b6df46b19d3f24353297eaa74d8a0f"></a> <h3>Retrieve department info</h3> Avaliable from application version: 2.8.2.1 <div style="font-size:14px; padding-top:0px; margin:0px;">Avaliable examples: <a href="https://support.liveagent.com/876517-Online-agents-widget-for-WordPress" target="_blank" title="Wordpress widget example">Wordpress widget example</a></div> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_85252_generalTab_80894_header">General</div> </li> <li> <div class="headerContent" id="tab_58122_phpTab_60526_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_85252_generalTab_80894_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/departments/<span style="color:#5640E6;">[departmentid]</span></div> </div> <div class="tabContent" id="tab_58122_phpTab_60526_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>departments<span class="P">/[</span>departmentid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[departmentid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of the department</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of the department</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinestatus</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department online status - services online in department. Combination of values T, P, M (T - chat, P - phone, M - automatic ticket solving)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">deleted</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">If department was deleted (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_46276_xmlTab_28688_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_57500_jsonTab_44460_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_46276_xmlTab_28688_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>e4y7g8s8<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Support<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">onlinestatus</font>></font>M<font color="#0000FF"></<font color="#808000">onlinestatus</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_57500_jsonTab_44460_content"> <pre style="font-size:12px;"> { "response":{ "departmentid":"e4y7g8s8", "name":"Support", "onlinestatus":"M", "deleted":"N" } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_files"></a> <h2>Files</h2> <br /> <a id="ccdb33f62f23cd4e801983d9954d5a01"></a> <h3>Retrieve file</h3> Avaliable from application version: 4.25.2.4<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_82933_generalTab_63348_header">General</div> </li> <li> <div class="headerContent" id="tab_48338_phpTab_37222_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_82933_generalTab_63348_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/files/<span style="color:#5640E6;">[fileid]</span></div> </div> <div class="tabContent" id="tab_48338_phpTab_37222_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>files<span class="P">/[</span>fileid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[fileid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd"> </td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <i>Note: From version 5.25 the returned 'downloadUrl' may be incorrect. Ticket attachments use different endpoint for download. Use 'download_url' returned from 'api/v3/ticket/{ticket_id}/messages'</i><br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">fileid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">File identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">created</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">File creation date</td> </tr> <tr> <td class="returnFieldsTableCellOdd">filename</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">File name</td> </tr> <tr> <td class="returnFieldsTableCellEven">filesize</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">File size (in bytes)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">filetype</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">File MIME type (e.g. "image/jpeg" or "application/pdf")</td> </tr> <tr> <td class="returnFieldsTableCellEven">downloads</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Count of file downloads</td> </tr> <tr> <td class="returnFieldsTableCellOdd">downloadUrl</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Url to download the file. Note: From version 4.47 to download the file, you have to add 'apikey' either as GET or POST parameter. From version 5.25 ticket attachments use different endpoint for download. Use the URL returned from 'api/v3/ticket/{ticket_id}/messages'</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_33758_xmlTab_59439_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_76267_jsonTab_81226_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_33758_xmlTab_59439_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">fileid</font>></font>1234567890abcdef1234567890abcdef<font color="#0000FF"></<font color="#808000">fileid</font>></font> <font color="#0000FF"><<font color="#808000">created</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">created</font>></font> <font color="#0000FF"><<font color="#808000">filename</font>></font>image1.jpg<font color="#0000FF"></<font color="#808000">filename</font>></font> <font color="#0000FF"><<font color="#808000">filesize</font>></font>12456<font color="#0000FF"></<font color="#808000">filesize</font>></font> <font color="#0000FF"><<font color="#808000">filetype</font>></font>image/jpg<font color="#0000FF"></<font color="#808000">filetype</font>></font> <font color="#0000FF"><<font color="#808000">downloads</font>></font>5<font color="#0000FF"></<font color="#808000">downloads</font>></font> <font color="#0000FF"><<font color="#808000">downloadUrl</font>></font>//yourdomain.com/scripts/file.php?view=Y&amp;file=1234567890abcdef1234567890abcdef<font color="#0000FF"></<font color="#808000">downloadUrl</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_76267_jsonTab_81226_content"> <pre style="font-size:12px;"> { "response":{ "fileid":"1234567890abcdef1234567890abcdef", "created":"2022-06-13 14:41:41", "filename":"image1.jpg", "filesize":"12456", "filetype":"image\/jpg", "downloads":"5", "downloadUrl":"\/\/yourdomain.com\/scripts\/file.php?view=Y&file=1234567890abcdef1234567890abcdef" } }</pre> </div> </div> <br /> <br /> <a id="f6ee7d770d02e790089753359529196f"></a> <h3>Add file</h3> Avaliable from application version: 4.25.2.4<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_17717_generalTab_93363_header">General</div> </li> <li> <div class="headerContent" id="tab_71099_phpTab_40671_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_17717_generalTab_93363_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/files</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_71099_phpTab_40671_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>type<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>data<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>downloadUrl<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>files"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">File name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">type</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">File type</td> </tr> <tr> <td class="returnFieldsTableCellEven">data</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">File data, base64 encoded. If data is set, name and type must also be set, and downloadUrl is ignored.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">downloadUrl</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">File download URL, from where the API will download the file content. This parameter is used only if data is not set. Name and type are optional.</td> </tr> </tbody> </table> <br /> <br /> <i>Note: Be aware that if file is not used (e.g. as a message attachment or in a contact widget, etc.), the file will be automatically deleted after 2 weeks.</i><br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">fileid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">File identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">created</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">File creation date</td> </tr> <tr> <td class="returnFieldsTableCellEven">filename</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">File name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">filesize</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">File size (in bytes)</td> </tr> <tr> <td class="returnFieldsTableCellEven">filetype</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">File MIME type (e.g. "image/jpeg" or "application/pdf")</td> </tr> <tr> <td class="returnFieldsTableCellOdd">downloads</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Count of file downloads</td> </tr> <tr> <td class="returnFieldsTableCellEven">downloadUrl</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Url to download the file. Note: From version 4.47 to download the file, you have to add 'apikey' either as GET or POST parameter. From version 5.25 ticket attachments use different endpoint for download. Use the URL returned from 'api/v3/ticket/{ticket_id}/messages'</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_57804_xmlTab_52709_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_95439_jsonTab_14457_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_57804_xmlTab_52709_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">fileid</font>></font>1234567890abcdef1234567890abcdef<font color="#0000FF"></<font color="#808000">fileid</font>></font> <font color="#0000FF"><<font color="#808000">created</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">created</font>></font> <font color="#0000FF"><<font color="#808000">filename</font>></font>image1.jpg<font color="#0000FF"></<font color="#808000">filename</font>></font> <font color="#0000FF"><<font color="#808000">filesize</font>></font>12456<font color="#0000FF"></<font color="#808000">filesize</font>></font> <font color="#0000FF"><<font color="#808000">filetype</font>></font>image/jpg<font color="#0000FF"></<font color="#808000">filetype</font>></font> <font color="#0000FF"><<font color="#808000">downloads</font>></font>5<font color="#0000FF"></<font color="#808000">downloads</font>></font> <font color="#0000FF"><<font color="#808000">downloadUrl</font>></font>//yourdomain.com/scripts/file.php?view=Y&amp;file=1234567890abcdef1234567890abcdef<font color="#0000FF"></<font color="#808000">downloadUrl</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_95439_jsonTab_14457_content"> <pre style="font-size:12px;"> { "response":{ "fileid":"1234567890abcdef1234567890abcdef", "created":"2022-06-13 14:41:41", "filename":"image1.jpg", "filesize":"12456", "filetype":"image\/jpg", "downloads":"5", "downloadUrl":"\/\/yourdomain.com\/scripts\/file.php?view=Y&file=1234567890abcdef1234567890abcdef" } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_knowledgebase"></a> <h2>Knowledgebase</h2> <br /> <a id="57c33ec1ca7308d3b3b87601b854c30e"></a> <h3>Retrieve a list of all knowledgebase articles (deprecated)</h3> Avaliable from application version: 4.16.3.2<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_69577_generalTab_33299_header">General</div> </li> <li> <div class="headerContent" id="tab_77678_phpTab_72026_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_69577_generalTab_33299_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/knowledgebase/articles</div> </div> <div class="tabContent" id="tab_77678_phpTab_72026_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>articles<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledgebase ID.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limit</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Limit number of returned rows. Default value: 10, Max value: 500</td> </tr> <tr> <td class="returnFieldsTableCellEven">offset</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Return articles from defined row number. Default value 0.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">tree_path</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Return just articles with tree path starting with selected value (e.g. if you need to return all sub-articles of specific category). Example value: 0|23|</td> </tr> <tr> <td class="returnFieldsTableCellEven">parent_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Return just articles with specific parent ID (e.g. if you need to return just first level of sub-articles of specific category). Example value: 288</td> </tr> <tr> <td class="returnFieldsTableCellOdd">article_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Return just specific article with given ID. Example value: 288</td> </tr> </tbody> </table> <br /> <br /> <i>Note: This API is deprecated. Please use GET Knowledgebase/Entries</i><br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">articles</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">The list of all knowledgebase articles.</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>articles</u> has 22 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledge base ID.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_entry_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Article ID.</td> </tr> <tr> <td class="returnFieldsTableCellEven">parent_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Parent article ID.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Article type. (Possible values: <i>H</i> - Home, <i>C</i> - Category, <i>A</i> - Article, <i>Q</i> - Forum, <i>R</i> - Topic, <i>G</i> - Suggestion category, <i>S</i> - Suggestion)</td> </tr> <tr> <td class="returnFieldsTableCellEven">rstatus</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Status. (Possible values: <i>N</i> - New, <i>C</i> - Completed, <i>P</i> - Published, <i>D</i> - Draft, <i>I</i> - Init, <i>U</i> - Review, <i>L</i> - Planned, <i>S</i> - Started, <i>X</i> - Declined)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">access</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Article access level. (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access_inherited</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Inherited access level. (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">urlcode</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">URL Code.</td> </tr> <tr> <td class="returnFieldsTableCellEven">treepath</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tree path.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rorder</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Order.</td> </tr> <tr> <td class="returnFieldsTableCellEven">title</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Article Title.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">metadescription</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">HTML Meta description.</td> </tr> <tr> <td class="returnFieldsTableCellEven">keywords</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">HTML Meta Keywords.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">content</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Article Content.</td> </tr> <tr> <td class="returnFieldsTableCellEven">conversationid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation ID.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department ID.</td> </tr> <tr> <td class="returnFieldsTableCellEven">views</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of views.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">votes</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of votes.</td> </tr> <tr> <td class="returnFieldsTableCellEven">datecreated</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date when was article created.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datechanged</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date of last change.</td> </tr> <tr> <td class="returnFieldsTableCellEven">deleted</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Is article deleted? (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Description.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_24992_xmlTab_75467_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_82571_jsonTab_85888_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_24992_xmlTab_75467_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">articles</font>></font> <font color="#0000FF"><<font color="#808000">article</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>15<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">parent_entry_id</font>/></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>376829<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">rorder</font>></font>9<font color="#0000FF"></<font color="#808000">rorder</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>General Questions<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">metadescription</font>></font>General Questions not related to Quality Unit products<font color="#0000FF"></<font color="#808000">metadescription</font>></font> <font color="#0000FF"><<font color="#808000">keywords</font>></font>faq, questions<font color="#0000FF"></<font color="#808000">keywords</font>></font> <font color="#0000FF"><<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[Article content]]</font>></font> <font color="#0000FF"></<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>/></font> <font color="#0000FF"><<font color="#808000">departmentid</font>/></font> <font color="#0000FF"><<font color="#808000">views</font>></font>1244<font color="#0000FF"></<font color="#808000">views</font>></font> <font color="#0000FF"><<font color="#808000">votes</font>></font>0<font color="#0000FF"></<font color="#808000">votes</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2007-08-02 12:24:51<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2011-12-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"><<font color="#808000">description</font>/></font> <font color="#0000FF"></<font color="#808000">article</font>></font> <font color="#0000FF"><<font color="#808000">article</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>132<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">parent_entry_id</font>/></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>376118<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">rorder</font>></font>10<font color="#0000FF"></<font color="#808000">rorder</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>Another article<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">metadescription</font>/></font> <font color="#0000FF"><<font color="#808000">keywords</font>></font>test article<font color="#0000FF"></<font color="#808000">keywords</font>></font> <font color="#0000FF"><<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[This is test content that can contain html and because of that it is in construct]]</font>></font> <font color="#0000FF"></<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>/></font> <font color="#0000FF"><<font color="#808000">departmentid</font>/></font> <font color="#0000FF"><<font color="#808000">views</font>></font>66<font color="#0000FF"></<font color="#808000">views</font>></font> <font color="#0000FF"><<font color="#808000">votes</font>></font>0<font color="#0000FF"></<font color="#808000">votes</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2004-02-02 12:24:11<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2014-11-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"><<font color="#808000">description</font>/></font> <font color="#0000FF"></<font color="#808000">article</font>></font> <font color="#0000FF"></<font color="#808000">articles</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_82571_jsonTab_85888_content"> <pre style="font-size:12px;"> { "response":{ "articles":[ { "kb_entry_id":"15", "parent_entry_id":"", "rtype":"C", "rstatus":"P", "access":"P", "access_inherited":"P", "urlcode":"376829", "treepath":"0", "rorder":"9", "title":"General Questions", "metadescription":"General Questions not related to Quality Unit products", "keywords":"faq, questions", "content":"Article content", "conversationid":"", "departmentid":"", "views":"1244", "votes":"0", "datecreated":"2007-08-02 12:24:51", "datechanged":"2011-12-22 16:33:40", "deleted":"N", "description":"" }, { "kb_entry_id":"132", "parent_entry_id":"", "rtype":"C", "rstatus":"P", "access":"P", "access_inherited":"P", "urlcode":"376118", "treepath":"0", "rorder":"10", "title":"Another article", "metadescription":"", "keywords":"test article", "content":"This is test content that can contain html and because of that it is in construct", "conversationid":"", "departmentid":"", "views":"66", "votes":"0", "datecreated":"2004-02-02 12:24:11", "datechanged":"2014-11-22 16:33:40", "deleted":"N", "description":"" } ] } }</pre> </div> </div> <br /> <br /> <a id="c6edc62bfe2cc23498364bdafd3c288c"></a> <h3>Add knowledgebase article</h3> Avaliable from application version: 4.26.0.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_12016_generalTab_16750_header">General</div> </li> <li> <div class="headerContent" id="tab_71201_phpTab_69610_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_12016_generalTab_16750_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/knowledgebase/articles</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_71201_phpTab_69610_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>content<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>title<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>kb_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>parent_entry_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>rstatus<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>access<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>rorder<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>keywords<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>full_preview<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>articles"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">content</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Article content HTML</td> </tr> <tr> <td class="returnFieldsTableCellEven">title</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Title</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase identifier, default value: kb_defa</td> </tr> <tr> <td class="returnFieldsTableCellEven">parent_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Parent category identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rstatus</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>P</i> - Published, <i>D</i> - Draft)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Access (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rorder</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Order of article within category</td> </tr> <tr> <td class="returnFieldsTableCellEven">keywords</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Keywords</td> </tr> <tr> <td class="returnFieldsTableCellOdd">full_preview</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Display whole article in list of articles (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledgebase identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_entry_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase article identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">parent_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Parent article identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">urlcode</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">URL Code</td> </tr> <tr> <td class="returnFieldsTableCellEven">title</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Article title</td> </tr> <tr> <td class="returnFieldsTableCellOdd">content</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Article content HTML</td> </tr> <tr> <td class="returnFieldsTableCellEven">content_text</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Article content converted to text</td> </tr> <tr> <td class="returnFieldsTableCellOdd">content_simple_html</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Article content HTML with images removed</td> </tr> <tr> <td class="returnFieldsTableCellEven">treepath</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tree path</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rstatus</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>N</i> - New, <i>C</i> - Completed, <i>P</i> - Published, <i>D</i> - Draft, <i>I</i> - Init, <i>U</i> - Review, <i>L</i> - Planned, <i>S</i> - Started, <i>X</i> - Declined)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Article access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">access_inherited</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Inherited access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellEven">rorder</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Order of article within category</td> </tr> <tr> <td class="returnFieldsTableCellOdd">keywords</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">HTML Meta Keywords</td> </tr> <tr> <td class="returnFieldsTableCellEven">datecreated</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date when was article created</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datechanged</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date of last change</td> </tr> <tr> <td class="returnFieldsTableCellEven">views</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of views</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_42845_xmlTab_47475_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_32943_jsonTab_15834_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_42845_xmlTab_47475_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>38<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">parent_entry_id</font>></font>16<font color="#0000FF"></<font color="#808000">parent_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>376829<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>General Questions<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[Article <<font color="#808000">b</font>></font>content<font color="#0000FF"></<font color="#808000">b</font>></font> <font color="#0000FF"><<font color="#808000">img</font> <font color="#800080">src</font>=<font color="#FF00FF">"pix.gif"</font>></font>]]</font>> <font color="#0000FF"></<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">content_text</font>></font>Article content<font color="#0000FF"></<font color="#808000">content_text</font>></font> <font color="#0000FF"><<font color="#808000">content_simple_html</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[Article <<font color="#808000">b</font>></font>content<font color="#0000FF"></<font color="#808000">b></font>]]</font>> <font color="#0000FF"></<font color="#808000">content_simple_html</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0|7|16<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">rorder</font>></font>0<font color="#0000FF"></<font color="#808000">rorder</font>></font> <font color="#0000FF"><<font color="#808000">keywords</font>></font>faq, questions<font color="#0000FF"></<font color="#808000">keywords</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2015-08-02 12:24:51<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2015-10-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">views</font>></font>1244<font color="#0000FF"></<font color="#808000">views</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_32943_jsonTab_15834_content"> <pre style="font-size:12px;"> { "response":{ "kb_id":"kb_defa", "kb_entry_id":"38", "parent_entry_id":"16", "urlcode":"376829", "title":"General Questions", "content":"Article <b>content<\/b><img src=\"pix.gif\">", "content_text":"Article content", "content_simple_html":"Article <b>content<\/b>", "treepath":"0|7|16", "rstatus":"P", "access":"P", "access_inherited":"P", "rorder":"0", "keywords":"faq, questions", "datecreated":"2015-08-02 12:24:51", "datechanged":"2015-10-22 16:33:40", "views":"1244" } }</pre> </div> </div> <br /> <br /> <a id="1b13a3ebec328caed53681f95b54a78a"></a> <h3>Add knowledgebase category, suggestion category or forum</h3> Avaliable from application version: 4.26.0.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_26250_generalTab_97172_header">General</div> </li> <li> <div class="headerContent" id="tab_45297_phpTab_91794_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_26250_generalTab_97172_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/knowledgebase/categories</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_45297_phpTab_91794_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>title<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>kb_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>parent_entry_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>rtype<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>access<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>rorder<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>keywords<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>departmentid<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>description<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>categories"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">title</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Title</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase identifier, default value: kb_defa</td> </tr> <tr> <td class="returnFieldsTableCellEven">parent_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Parent category identifier, default value: 0 (root category)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Category type, default value: Category (Possible values: <i>C</i> - Category, <i>Q</i> - Forum, <i>G</i> - Suggestion category)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Access, default value: Public (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rorder</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Order within category, new items are added at the top by default</td> </tr> <tr> <td class="returnFieldsTableCellOdd">keywords</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Keywords (used only for category)</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department identifier (used for forum and suggestion category, defines which department handles tickets from this category)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Description (used for forum and suggestion category)</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledgebase entry identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">parent_entry_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Parent category identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">urlcode</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">URL Code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">title</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Title</td> </tr> <tr> <td class="returnFieldsTableCellEven">treepath</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tree path</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Type of category</td> </tr> <tr> <td class="returnFieldsTableCellEven">rstatus</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Status (Possible values: <i>N</i> - New, <i>C</i> - Completed, <i>P</i> - Published, <i>D</i> - Draft, <i>I</i> - Init, <i>U</i> - Review, <i>L</i> - Planned, <i>S</i> - Started, <i>X</i> - Declined)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">access</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access_inherited</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Inherited access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rorder</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Order within parent category</td> </tr> <tr> <td class="returnFieldsTableCellEven">keywords</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">HTML Meta Keywords</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datecreated</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date when article was created</td> </tr> <tr> <td class="returnFieldsTableCellEven">datechanged</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date of last change</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">views</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of views</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Description</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_17573_xmlTab_58614_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_98799_jsonTab_91303_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_17573_xmlTab_58614_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>16<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">parent_entry_id</font>></font>7<font color="#0000FF"></<font color="#808000">parent_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>365432<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>General Questions<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0|7<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">rorder</font>></font>0<font color="#0000FF"></<font color="#808000">rorder</font>></font> <font color="#0000FF"><<font color="#808000">keywords</font>></font>faq, questions<font color="#0000FF"></<font color="#808000">keywords</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2007-08-02 12:24:51<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2011-12-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>default<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">views</font>></font>1244<font color="#0000FF"></<font color="#808000">views</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>Category description<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_98799_jsonTab_91303_content"> <pre style="font-size:12px;"> { "response":{ "kb_id":"kb_defa", "kb_entry_id":"16", "parent_entry_id":"7", "urlcode":"365432", "title":"General Questions", "treepath":"0|7", "rtype":"C", "rstatus":"P", "access":"P", "access_inherited":"P", "rorder":"0", "keywords":"faq, questions", "datecreated":"2007-08-02 12:24:51", "datechanged":"2011-12-22 16:33:40", "departmentid":"default", "views":"1244", "description":"Category description" } }</pre> </div> </div> <br /> <br /> <a id="3132d52065ff4d341459cf1a19a74150"></a> <h3>Remove knowledgebase entry</h3> Avaliable from application version: 4.26.0.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_28455_generalTab_90803_header">General</div> </li> <li> <div class="headerContent" id="tab_74650_phpTab_49810_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_28455_generalTab_90803_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/knowledgebase/entries/<span style="color:#5640E6;">[entry_id]</span></div> </div> <div class="tabContent" id="tab_74650_phpTab_49810_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>entries<span class="P">/[</span>entry_id<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[entry_id]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase entry ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <i>Note: Be aware that if the knowledgebase entry being deleted is a category, forum or suggestion category, this API call will delete the entry and all child entries under it (the entire subtree). This action can not be undone.</i><br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_48106_xmlTab_74978_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_38400_jsonTab_46719_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_48106_xmlTab_74978_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_38400_jsonTab_46719_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="4cd19eba76cd0dc8079bbd8d00ff0d9a"></a> <h3>Retrieve a list of all knowledgebase entries</h3> Avaliable from application version: 4.26.0.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_54296_generalTab_63927_header">General</div> </li> <li> <div class="headerContent" id="tab_36134_phpTab_13084_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_54296_generalTab_63927_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/knowledgebase/entries</div> </div> <div class="tabContent" id="tab_36134_phpTab_13084_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>entries<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">limit</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Limit number of returned rows. Default value: 50, Max value: 500</td> </tr> <tr> <td class="returnFieldsTableCellEven">offset</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Return articles from defined row number. Default value 0</td> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">tree_path</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Return just entries with tree path starting with selected value (e.g. if you need to return all sub-entries of specific category). Example value: 0|23|</td> </tr> <tr> <td class="returnFieldsTableCellOdd">parent_entry_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Return just entries with specific parent ID (e.g. if you need to return just first level of sub-entries of specific category). Example value: 288</td> </tr> <tr> <td class="returnFieldsTableCellEven">entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Return just specific entry with given ID. Example value: 288</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_changed</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Return just entries with date change after specific date. Example value: 2014-11-24</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">entries</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">The list of all knowledgebase entries</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>entries</u> has 22 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledgebase entry identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">parent_entry_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Parent category identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">rtype</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Knowledgebase entry type (Possible values: <i>H</i> - Home, <i>C</i> - Category, <i>A</i> - Article, <i>Q</i> - Forum, <i>R</i> - Topic, <i>G</i> - Suggestion category, <i>S</i> - Suggestion)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rstatus</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>N</i> - New, <i>C</i> - Completed, <i>P</i> - Published, <i>D</i> - Draft, <i>I</i> - Init, <i>U</i> - Review, <i>L</i> - Planned, <i>S</i> - Started, <i>X</i> - Declined)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Knowledgebase entry access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">access_inherited</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Inherited access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellEven">urlcode</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">URL Code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">treepath</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Tree path</td> </tr> <tr> <td class="returnFieldsTableCellEven">rorder</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Order within parent category</td> </tr> <tr> <td class="returnFieldsTableCellOdd">title</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase entry title</td> </tr> <tr> <td class="returnFieldsTableCellEven">metadescription</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">HTML Meta description</td> </tr> <tr> <td class="returnFieldsTableCellOdd">keywords</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">HTML Meta Keywords</td> </tr> <tr> <td class="returnFieldsTableCellEven">content</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Article content</td> </tr> <tr> <td class="returnFieldsTableCellOdd">conversationid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Related ticket identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">views</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of views</td> </tr> <tr> <td class="returnFieldsTableCellEven">votes</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of votes</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datecreated</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date when entry was created</td> </tr> <tr> <td class="returnFieldsTableCellEven">datechanged</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date of last change</td> </tr> <tr> <td class="returnFieldsTableCellOdd">deleted</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Was the entry deleted? (suggestion and topic only) (Possible values: <i>Y</i> - Yes, <i>N</i> - No)</td> </tr> <tr> <td class="returnFieldsTableCellEven">description</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Description</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_99715_xmlTab_10167_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_97519_jsonTab_48633_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_99715_xmlTab_10167_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">entries</font>></font> <font color="#0000FF"><<font color="#808000">entrie</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>16<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">parent_entry_id</font>></font>7<font color="#0000FF"></<font color="#808000">parent_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>365432<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0|7<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">rorder</font>></font>0<font color="#0000FF"></<font color="#808000">rorder</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>General Questions Category<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">metadescription</font>></font>General Questions about life, universe and everything<font color="#0000FF"></<font color="#808000">metadescription</font>></font> <font color="#0000FF"><<font color="#808000">keywords</font>></font>faq, questions<font color="#0000FF"></<font color="#808000">keywords</font>></font> <font color="#0000FF"><<font color="#808000">content</font>/></font> <font color="#0000FF"><<font color="#808000">conversationid</font>/></font> <font color="#0000FF"><<font color="#808000">departmentid</font>/></font> <font color="#0000FF"><<font color="#808000">views</font>></font>1244<font color="#0000FF"></<font color="#808000">views</font>></font> <font color="#0000FF"><<font color="#808000">votes</font>></font>0<font color="#0000FF"></<font color="#808000">votes</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2007-08-02 12:24:51<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2011-12-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>Description of category<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"></<font color="#808000">entrie</font>></font> <font color="#0000FF"><<font color="#808000">entrie</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>38<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">parent_entry_id</font>></font>16<font color="#0000FF"></<font color="#808000">parent_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>A<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>376829<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0|7|16<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">rorder</font>></font>0<font color="#0000FF"></<font color="#808000">rorder</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>Article 42<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">metadescription</font>/></font> <font color="#0000FF"><<font color="#808000">keywords</font>></font>test article<font color="#0000FF"></<font color="#808000">keywords</font>></font> <font color="#0000FF"><<font color="#808000">content</font>></font>This is test content that can contain &lt;b&gt;html&lt;/b&gt; and images &lt;img <font color="#800080">src</font>=<font color="#FF00FF">"pix.gif"</font>&gt;<font color="#0000FF"></<font color="#808000">content</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>/></font> <font color="#0000FF"><<font color="#808000">departmentid</font>/></font> <font color="#0000FF"><<font color="#808000">views</font>></font>66<font color="#0000FF"></<font color="#808000">views</font>></font> <font color="#0000FF"><<font color="#808000">votes</font>></font>0<font color="#0000FF"></<font color="#808000">votes</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2004-02-02 12:24:11<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2014-11-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">deleted</font>></font>N<font color="#0000FF"></<font color="#808000">deleted</font>></font> <font color="#0000FF"><<font color="#808000">description</font>/></font> <font color="#0000FF"></<font color="#808000">entrie</font>></font> <font color="#0000FF"></<font color="#808000">entries</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_97519_jsonTab_48633_content"> <pre style="font-size:12px;"> { "response":{ "entries":[ { "kb_id":"kb_defa", "kb_entry_id":"16", "parent_entry_id":"7", "rtype":"C", "rstatus":"P", "access":"P", "access_inherited":"P", "urlcode":"365432", "treepath":"0|7", "rorder":"0", "title":"General Questions Category", "metadescription":"General Questions about life, universe and everything", "keywords":"faq, questions", "content":"", "conversationid":"", "departmentid":"", "views":"1244", "votes":"0", "datecreated":"2007-08-02 12:24:51", "datechanged":"2011-12-22 16:33:40", "deleted":"N", "description":"Description of category" }, { "kb_id":"kb_defa", "kb_entry_id":"38", "parent_entry_id":"16", "rtype":"A", "rstatus":"P", "access":"P", "access_inherited":"P", "urlcode":"376829", "treepath":"0|7|16", "rorder":"0", "title":"Article 42", "metadescription":"", "keywords":"test article", "content":"This is test content that can contain <b>html<\/b> and images <img src=\"pix.gif\">", "conversationid":"", "departmentid":"", "views":"66", "votes":"0", "datecreated":"2004-02-02 12:24:11", "datechanged":"2014-11-22 16:33:40", "deleted":"N", "description":"" } ] } }</pre> </div> </div> <br /> <br /> <a id="4a20ae06a17d0cbba6c1eae28ac44b0a"></a> <h3>Retrieve a list of all knowledgebases</h3> Avaliable from application version: 4.26.0.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_70322_generalTab_93248_header">General</div> </li> <li> <div class="headerContent" id="tab_95886_phpTab_28894_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_70322_generalTab_93248_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/knowledgebase/knowledgebases</div> </div> <div class="tabContent" id="tab_95886_phpTab_28894_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>knowledgebases<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">limit</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Limit number of returned rows. Default value: 10, Max value: 500</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offset</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Return rows from defined row number. Default value 0.</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">knowledgebases</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Knowledgebases list.</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>knowledgebases</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledgebase identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase name</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_16223_xmlTab_37115_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_50155_jsonTab_44451_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_16223_xmlTab_37115_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">knowledgebases</font>></font> <font color="#0000FF"><<font color="#808000">knowledgebase</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Knowledgebase 1<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">knowledgebase</font>></font> <font color="#0000FF"><<font color="#808000">knowledgebase</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>ec4d78df<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Knowledgebase 2<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">knowledgebase</font>></font> <font color="#0000FF"></<font color="#808000">knowledgebases</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_50155_jsonTab_44451_content"> <pre style="font-size:12px;"> { "response":{ "knowledgebases":[ { "kb_id":"kb_defa", "name":"Knowledgebase 1" }, { "kb_id":"ec4d78df", "name":"Knowledgebase 2" } ] } }</pre> </div> </div> <br /> <br /> <a id="cf2097163de9944be623df364439797b"></a> <h3>Knowledgebase search</h3> Avaliable from application version: 4.7.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_39685_generalTab_28815_header">General</div> </li> <li> <div class="headerContent" id="tab_76434_phpTab_25969_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_39685_generalTab_28815_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/knowledgebase/search?<span style="color:#C94444;">query=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_76434_phpTab_25969_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>knowledgebase<span class="P">/</span>search<span class="P">?</span>&query<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">query</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Query string</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledgebase ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">top_article_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Top article ID. Search will start from given ID and if it is a category, all subcategories will be searched. Leave empty if all articles should be searched.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limit</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Limit number of returned rows. Default value: 10, Max value: 500</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">entries</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">The search list of all knowledgebase entries.</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>entries</u> has 16 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledgebase ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_entry_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Entry ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Entry type (Possible values: <i>H</i> - Home, <i>C</i> - Category, <i>A</i> - Article, <i>Q</i> - Forum, <i>R</i> - Topic, <i>G</i> - Suggestion category, <i>S</i> - Suggestion)</td> </tr> <tr> <td class="returnFieldsTableCellEven">rstatus</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Status (Possible values: <i>N</i> - New, <i>C</i> - Completed, <i>P</i> - Published, <i>D</i> - Draft, <i>I</i> - Init, <i>U</i> - Review, <i>L</i> - Planned, <i>S</i> - Started, <i>X</i> - Declined)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">access</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Entry access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellEven">access_inherited</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Inherited access level (Possible values: <i>I</i> - Internal, <i>P</i> - Public)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">urlcode</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">URL Code</td> </tr> <tr> <td class="returnFieldsTableCellEven">treepath</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tree path</td> </tr> <tr> <td class="returnFieldsTableCellOdd">title</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Title</td> </tr> <tr> <td class="returnFieldsTableCellEven">title_clear</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Title clear</td> </tr> <tr> <td class="returnFieldsTableCellOdd">content_text</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Entry content (text)</td> </tr> <tr> <td class="returnFieldsTableCellEven">content_simple_html</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Entry content (html)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">conversationid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">votesCount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of votes</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datechanged</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date of last change</td> </tr> <tr> <td class="returnFieldsTableCellEven">url</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Entry Url</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_43253_xmlTab_14740_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_46334_jsonTab_21875_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_43253_xmlTab_14740_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">entries</font>></font> <font color="#0000FF"><<font color="#808000">entrie</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>1<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>A<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>376829<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>Article 1<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">title_clear</font>></font>Article 1<font color="#0000FF"></<font color="#808000">title_clear</font>></font> <font color="#0000FF"><<font color="#808000">content_text</font>></font>Article content<font color="#0000FF"></<font color="#808000">content_text</font>></font> <font color="#0000FF"><<font color="#808000">content_simple_html</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[Article content]]</font>></font> <font color="#0000FF"></<font color="#808000">content_simple_html</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>/></font> <font color="#0000FF"><<font color="#808000">votesCount</font>></font>0<font color="#0000FF"></<font color="#808000">votesCount</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2011-12-22 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">url</font>></font>//support.example.com/376829-Article-1<font color="#0000FF"></<font color="#808000">url</font>></font> <font color="#0000FF"></<font color="#808000">entrie</font>></font> <font color="#0000FF"><<font color="#808000">entrie</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb_defa<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">kb_entry_id</font>></font>2<font color="#0000FF"></<font color="#808000">kb_entry_id</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>A<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">rstatus</font>></font>P<font color="#0000FF"></<font color="#808000">rstatus</font>></font> <font color="#0000FF"><<font color="#808000">access</font>></font>P<font color="#0000FF"></<font color="#808000">access</font>></font> <font color="#0000FF"><<font color="#808000">access_inherited</font>></font>P<font color="#0000FF"></<font color="#808000">access_inherited</font>></font> <font color="#0000FF"><<font color="#808000">urlcode</font>></font>376832<font color="#0000FF"></<font color="#808000">urlcode</font>></font> <font color="#0000FF"><<font color="#808000">treepath</font>></font>0<font color="#0000FF"></<font color="#808000">treepath</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>Article 2<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">title_clear</font>></font>Article 2<font color="#0000FF"></<font color="#808000">title_clear</font>></font> <font color="#0000FF"><<font color="#808000">content_text</font>></font>Article content<font color="#0000FF"></<font color="#808000">content_text</font>></font> <font color="#0000FF"><<font color="#808000">content_simple_html</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[Article content]]</font>></font> <font color="#0000FF"></<font color="#808000">content_simple_html</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>/></font> <font color="#0000FF"><<font color="#808000">votesCount</font>></font>0<font color="#0000FF"></<font color="#808000">votesCount</font>></font> <font color="#0000FF"><<font color="#808000">datechanged</font>></font>2011-12-05 16:33:40<font color="#0000FF"></<font color="#808000">datechanged</font>></font> <font color="#0000FF"><<font color="#808000">url</font>></font>//support.example.com/376832-Article-2<font color="#0000FF"></<font color="#808000">url</font>></font> <font color="#0000FF"></<font color="#808000">entrie</font>></font> <font color="#0000FF"></<font color="#808000">entries</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_46334_jsonTab_21875_content"> <pre style="font-size:12px;"> { "response":{ "entries":[ { "kb_id":"kb_defa", "kb_entry_id":"1", "rtype":"A", "rstatus":"P", "access":"P", "access_inherited":"P", "urlcode":"376829", "treepath":"0", "title":"Article 1", "title_clear":"Article 1", "content_text":"Article content", "content_simple_html":"Article content", "conversationid":"", "votesCount":"0", "datechanged":"2011-12-22 16:33:40", "url":"\/\/support.example.com\/376829-Article-1" }, { "kb_id":"kb_defa", "kb_entry_id":"2", "rtype":"A", "rstatus":"P", "access":"P", "access_inherited":"P", "urlcode":"376832", "treepath":"0", "title":"Article 2", "title_clear":"Article 2", "content_text":"Article content", "content_simple_html":"Article content", "conversationid":"", "votesCount":"0", "datechanged":"2011-12-05 16:33:40", "url":"\/\/support.example.com\/376832-Article-2" } ] } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_online status"></a> <h2>Online status</h2> <br /> <a id="7b3dd9427f85cb1f63dec15a9a229c90"></a> <h3>Agents</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_28439_generalTab_94022_header">General</div> </li> <li> <div class="headerContent" id="tab_31497_phpTab_52067_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_28439_generalTab_94022_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/onlinestatus/agents</div> </div> <div class="tabContent" id="tab_31497_phpTab_52067_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>onlinestatus<span class="P">/</span>agents<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">agentsOnlineStates</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Online state of agents</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>agentsOnlineStates</u> has 8 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User id of agent</td> </tr> <tr> <td class="returnFieldsTableCellOdd">contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Contact id of agent</td> </tr> <tr> <td class="returnFieldsTableCellEven">username</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent's username (email)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstname</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Agent's first name</td> </tr> <tr> <td class="returnFieldsTableCellEven">lastname</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Agent's last name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avatar_url</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Agent's avatar url</td> </tr> <tr> <td class="returnFieldsTableCellEven">presetStatus</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Agent's preset online status (string consisting of: M-messages, P-phone, T-chat, R-read or F-offline)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlineStatus</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Agent's current online status (string consisting of: M-messages, P-phone, T-chat, R-read or F-offline)</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_94787_xmlTab_33115_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_37055_jsonTab_26348_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_94787_xmlTab_33115_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">agentsOnlineStates</font>></font> <font color="#0000FF"><<font color="#808000">agentsOnlineState</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>56df98rt<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>46c8f67a<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">username</font>></font>john.doe@example.com<font color="#0000FF"></<font color="#808000">username</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>John<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Doe<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">avatar_url</font>></font>themes/agent/_common_templates/img/user05.png<font color="#0000FF"></<font color="#808000">avatar_url</font>></font> <font color="#0000FF"><<font color="#808000">presetStatus</font>></font>MPRT<font color="#0000FF"></<font color="#808000">presetStatus</font>></font> <font color="#0000FF"><<font color="#808000">onlineStatus</font>></font>MPRT<font color="#0000FF"></<font color="#808000">onlineStatus</font>></font> <font color="#0000FF"></<font color="#808000">agentsOnlineState</font>></font> <font color="#0000FF"></<font color="#808000">agentsOnlineStates</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_37055_jsonTab_26348_content"> <pre style="font-size:12px;"> { "response":{ "agentsOnlineStates":[ { "id":"56df98rt", "contactid":"46c8f67a", "username":"john.doe@example.com", "firstname":"John", "lastname":"Doe", "avatar_url":"themes\/agent\/_common_templates\/img\/user05.png", "presetStatus":"MPRT", "onlineStatus":"MPRT" } ] } }</pre> </div> </div> <br /> <br /> <a id="fb2b99f38a57f85e24e46943939a6989"></a> <h3>Departments</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_45674_generalTab_40357_header">General</div> </li> <li> <div class="headerContent" id="tab_97449_phpTab_75287_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_45674_generalTab_40357_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/onlinestatus/departments</div> </div> <div class="tabContent" id="tab_97449_phpTab_75287_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>onlinestatus<span class="P">/</span>departments<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <i>Note: All count fields are deprecated and shouldn't be used</i><br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">departmentsOnlineStates</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Online state of departments</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>departmentsOnlineStates</u> has 8 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Identifier of department</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Name of department</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlineStatus</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Current online status of department (string consisting of: M-messages, P-phone, T-chat, R-read or F-offline)</td> </tr> <tr> <td class="returnFieldsTableCellEven">chat_count</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">(deprecated) Number of running chats in department</td> </tr> <tr> <td class="returnFieldsTableCellOdd">new_count</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">(deprecated) Number of tickets in New state in department</td> </tr> <tr> <td class="returnFieldsTableCellEven">customer_reply_count</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">(deprecated) Number of customer replies in department</td> </tr> <tr> <td class="returnFieldsTableCellOdd">total_count</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">(deprecated) Total number of new, open and chatting tickets in department</td> </tr> <tr> <td class="returnFieldsTableCellEven">max_count</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">(deprecated) Maximum number of new, open and chatting tickets in any of departments</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_32434_xmlTab_48015_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_93316_jsonTab_68334_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_32434_xmlTab_48015_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">departmentsOnlineStates</font>></font> <font color="#0000FF"><<font color="#808000">departmentsOnlineState</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>8750f3cd<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Technical<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">onlineStatus</font>></font>F<font color="#0000FF"></<font color="#808000">onlineStatus</font>></font> <font color="#0000FF"><<font color="#808000">chat_count</font>></font>2<font color="#0000FF"></<font color="#808000">chat_count</font>></font> <font color="#0000FF"><<font color="#808000">new_count</font>></font>7<font color="#0000FF"></<font color="#808000">new_count</font>></font> <font color="#0000FF"><<font color="#808000">customer_reply_count</font>></font>11<font color="#0000FF"></<font color="#808000">customer_reply_count</font>></font> <font color="#0000FF"><<font color="#808000">total_count</font>></font>1587<font color="#0000FF"></<font color="#808000">total_count</font>></font> <font color="#0000FF"><<font color="#808000">max_count</font>></font>1587<font color="#0000FF"></<font color="#808000">max_count</font>></font> <font color="#0000FF"></<font color="#808000">departmentsOnlineState</font>></font> <font color="#0000FF"></<font color="#808000">departmentsOnlineStates</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_93316_jsonTab_68334_content"> <pre style="font-size:12px;"> { "response":{ "departmentsOnlineStates":[ { "id":"8750f3cd", "name":"Technical", "onlineStatus":"F", "chat_count":"2", "new_count":"7", "customer_reply_count":"11", "total_count":"1587", "max_count":"1587" } ] } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_reports"></a> <h2>Reports</h2> <br /> <a id="5af8a3314bb3df2b40282a9fba9f416c"></a> <h3>Agents report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_76650_generalTab_87778_header">General</div> </li> <li> <div class="headerContent" id="tab_68323_phpTab_59279_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_76650_generalTab_87778_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/agents?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_68323_phpTab_59279_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>agents<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">agents</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Agents list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>agents</u> has 53 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">User contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">First name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Last name</td> </tr> <tr> <td class="returnFieldsTableCellEven">worktime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Worktime in minutes</td> </tr> <tr> <td class="returnFieldsTableCellOdd">answers</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of answers</td> </tr> <tr> <td class="returnFieldsTableCellEven">answers_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of answers per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">newAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">New answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">newAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">New answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">nextAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Open answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">nextAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Open answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of answered calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">calls_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of answered calls per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">missed_calls</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of missed calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">missed_calls_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of missed calls per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call time total (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_seconds_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Call time total (in seconds) per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of responded chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">chats_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of responded chats per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chat_answers</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of chat messages</td> </tr> <tr> <td class="returnFieldsTableCellEven">chat_answers_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of chat messages per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">missed_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of missed chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">missed_chats_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of missed chats per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chat_pickup</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of picked up chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">chatPickupAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Chat pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chatAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Average time spent in chat (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">not_ranked</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of not rated</td> </tr> <tr> <td class="returnFieldsTableCellOdd">not_ranked_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Not rated [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">not_ranked_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of not rated per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rewards</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of positive ratings</td> </tr> <tr> <td class="returnFieldsTableCellEven">rewards_p</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Positive ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rewards_ph</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Positive ratings per hour</td> </tr> <tr> <td class="returnFieldsTableCellEven">punishments</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of negative ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">punishments_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Negative ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">punishments_ph</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Negative ratings per hour</td> </tr> <tr> <td class="returnFieldsTableCellOdd">created_tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">resolved_tickets</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of resolved tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">u_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of unanswered chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">u_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of unanswered calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">notes</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of notes</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstAssignAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First assign average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstAssignAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First assign average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstResolveAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First resolve average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstResolveAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First resolve average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">calls_outgoing</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of outgoing calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_outgoing_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Outgoing calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_outgoing_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Outgoing calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_pickup_avg_time</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Call average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls_internal</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of internal calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_internal_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Internal calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_internal_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Internal calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">o_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of offline calls</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_89317_xmlTab_33695_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_84553_jsonTab_18604_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_89317_xmlTab_33695_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">agents</font>></font> <font color="#0000FF"><<font color="#808000">agent</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>hji78r9u<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>456edf8y<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>Firstname<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Lastname<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">worktime</font>></font>60<font color="#0000FF"></<font color="#808000">worktime</font>></font> <font color="#0000FF"><<font color="#808000">answers</font>></font>0<font color="#0000FF"></<font color="#808000">answers</font>></font> <font color="#0000FF"><<font color="#808000">answers_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">answers_ph</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">calls</font>></font>0<font color="#0000FF"></<font color="#808000">calls</font>></font> <font color="#0000FF"><<font color="#808000">calls_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">calls_ph</font>></font> <font color="#0000FF"><<font color="#808000">missed_calls</font>></font>0<font color="#0000FF"></<font color="#808000">missed_calls</font>></font> <font color="#0000FF"><<font color="#808000">missed_calls_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">missed_calls_ph</font>></font> <font color="#0000FF"><<font color="#808000">call_seconds</font>></font>0<font color="#0000FF"></<font color="#808000">call_seconds</font>></font> <font color="#0000FF"><<font color="#808000">call_seconds_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">call_seconds_ph</font>></font> <font color="#0000FF"><<font color="#808000">chats</font>></font>0<font color="#0000FF"></<font color="#808000">chats</font>></font> <font color="#0000FF"><<font color="#808000">chats_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">chats_ph</font>></font> <font color="#0000FF"><<font color="#808000">chat_answers</font>></font>0<font color="#0000FF"></<font color="#808000">chat_answers</font>></font> <font color="#0000FF"><<font color="#808000">chat_answers_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">chat_answers_ph</font>></font> <font color="#0000FF"><<font color="#808000">missed_chats</font>></font>0<font color="#0000FF"></<font color="#808000">missed_chats</font>></font> <font color="#0000FF"><<font color="#808000">missed_chats_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">missed_chats_ph</font>></font> <font color="#0000FF"><<font color="#808000">chat_pickup</font>></font>0<font color="#0000FF"></<font color="#808000">chat_pickup</font>></font> <font color="#0000FF"><<font color="#808000">chatPickupAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatPickupAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">chatAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked</font>></font>0<font color="#0000FF"></<font color="#808000">not_ranked</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">not_ranked_p</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">not_ranked_ph</font>></font> <font color="#0000FF"><<font color="#808000">rewards</font>></font>0<font color="#0000FF"></<font color="#808000">rewards</font>></font> <font color="#0000FF"><<font color="#808000">rewards_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">rewards_p</font>></font> <font color="#0000FF"><<font color="#808000">rewards_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">rewards_ph</font>></font> <font color="#0000FF"><<font color="#808000">punishments</font>></font>0<font color="#0000FF"></<font color="#808000">punishments</font>></font> <font color="#0000FF"><<font color="#808000">punishments_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">punishments_p</font>></font> <font color="#0000FF"><<font color="#808000">punishments_ph</font>></font>0.00<font color="#0000FF"></<font color="#808000">punishments_ph</font>></font> <font color="#0000FF"></<font color="#808000">agent</font>></font> <font color="#0000FF"></<font color="#808000">agents</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_84553_jsonTab_18604_content"> <pre style="font-size:12px;"> { "response":{ "agents":[ { "id":"hji78r9u", "contactid":"456edf8y", "firstname":"Firstname", "lastname":"Lastname", "worktime":"60", "answers":"0", "answers_ph":"0.00", "newAnswerAvgTime":"0", "newAnswerAvgTimeSla":"0", "nextAnswerAvgTime":"0", "nextAnswerAvgTimeSla":"0", "calls":"0", "calls_ph":"0.00", "missed_calls":"0", "missed_calls_ph":"0.00", "call_seconds":"0", "call_seconds_ph":"0.00", "chats":"0", "chats_ph":"0.00", "chat_answers":"0", "chat_answers_ph":"0.00", "missed_chats":"0", "missed_chats_ph":"0.00", "chat_pickup":"0", "chatPickupAvgTime":"0", "chatAvgTime":"0", "not_ranked":"0", "not_ranked_p":"0.00", "not_ranked_ph":"0.00", "rewards":"0", "rewards_p":"0.00", "rewards_ph":"0.00", "punishments":"0", "punishments_p":"0.00", "punishments_ph":"0.00" } ] } }</pre> </div> </div> <br /> <br /> <a id="55017028a0e45c555e73c0991a3b9078"></a> <h3>Channels report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_18913_generalTab_68003_header">General</div> </li> <li> <div class="headerContent" id="tab_25598_phpTab_45864_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_18913_generalTab_68003_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/channels?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_25598_phpTab_45864_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>channels<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">channels</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Channels list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>channels</u> has 45 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Channel identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">channelName</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Channel name</td> </tr> <tr> <td class="returnFieldsTableCellEven">answers</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of answers</td> </tr> <tr> <td class="returnFieldsTableCellOdd">newAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">New answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">newAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">New answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">nextAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Open answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">nextAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Open answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chat_answers</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of chat messages</td> </tr> <tr> <td class="returnFieldsTableCellEven">chats</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of responded chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">missed_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of missed chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">chat_pickup</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of picked up chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chatPickupAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Chat pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">chatAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average time spent in chat (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of answered calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">missed_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of missed calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call time total (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">not_ranked</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of not rated</td> </tr> <tr> <td class="returnFieldsTableCellOdd">not_ranked_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Not rated [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">rewards</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of positive ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rewards_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Positive ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">punishments</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of negative ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">punishments_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Negative ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_messages</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming messages</td> </tr> <tr> <td class="returnFieldsTableCellOdd">i_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of incoming chats (including not responded)</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming calls (including not answered)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">f_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of finished chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">f_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of finished calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">created_tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">resolved_tickets</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of resolved tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">u_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of unanswered chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">u_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of unanswered calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">notes</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of notes</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstAssignAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First assign average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstAssignAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First assign average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstResolveAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First resolve average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstResolveAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First resolve average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">calls_outgoing</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of outgoing calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_outgoing_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Outgoing calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_outgoing_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Outgoing calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_pickup_avg_time</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Call average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls_internal</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of internal calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_internal_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Internal calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_internal_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Internal calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">o_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of offline calls</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_27983_xmlTab_35792_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_29035_jsonTab_98022_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_27983_xmlTab_35792_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">channels</font>></font> <font color="#0000FF"><<font color="#808000">channel</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>2<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">channelName</font>></font>Facebook<font color="#0000FF"></<font color="#808000">channelName</font>></font> <font color="#0000FF"><<font color="#808000">answers</font>></font>0<font color="#0000FF"></<font color="#808000">answers</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">chat_answers</font>></font>0<font color="#0000FF"></<font color="#808000">chat_answers</font>></font> <font color="#0000FF"><<font color="#808000">chats</font>></font>0<font color="#0000FF"></<font color="#808000">chats</font>></font> <font color="#0000FF"><<font color="#808000">missed_chats</font>></font>0<font color="#0000FF"></<font color="#808000">missed_chats</font>></font> <font color="#0000FF"><<font color="#808000">chat_pickup</font>></font>0<font color="#0000FF"></<font color="#808000">chat_pickup</font>></font> <font color="#0000FF"><<font color="#808000">chatPickupAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatPickupAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">chatAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">calls</font>></font>0<font color="#0000FF"></<font color="#808000">calls</font>></font> <font color="#0000FF"><<font color="#808000">missed_calls</font>></font>0<font color="#0000FF"></<font color="#808000">missed_calls</font>></font> <font color="#0000FF"><<font color="#808000">call_seconds</font>></font>0<font color="#0000FF"></<font color="#808000">call_seconds</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked</font>></font>0<font color="#0000FF"></<font color="#808000">not_ranked</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">not_ranked_p</font>></font> <font color="#0000FF"><<font color="#808000">rewards</font>></font>0<font color="#0000FF"></<font color="#808000">rewards</font>></font> <font color="#0000FF"><<font color="#808000">rewards_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">rewards_p</font>></font> <font color="#0000FF"><<font color="#808000">punishments</font>></font>0<font color="#0000FF"></<font color="#808000">punishments</font>></font> <font color="#0000FF"><<font color="#808000">punishments_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">punishments_p</font>></font> <font color="#0000FF"><<font color="#808000">i_messages</font>></font>0<font color="#0000FF"></<font color="#808000">i_messages</font>></font> <font color="#0000FF"><<font color="#808000">i_chats</font>></font>0<font color="#0000FF"></<font color="#808000">i_chats</font>></font> <font color="#0000FF"><<font color="#808000">i_calls</font>></font>0<font color="#0000FF"></<font color="#808000">i_calls</font>></font> <font color="#0000FF"></<font color="#808000">channel</font>></font> <font color="#0000FF"></<font color="#808000">channels</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_29035_jsonTab_98022_content"> <pre style="font-size:12px;"> { "response":{ "channels":[ { "id":"2", "channelName":"Facebook", "answers":"0", "newAnswerAvgTime":"0", "newAnswerAvgTimeSla":"0", "nextAnswerAvgTime":"0", "nextAnswerAvgTimeSla":"0", "chat_answers":"0", "chats":"0", "missed_chats":"0", "chat_pickup":"0", "chatPickupAvgTime":"0", "chatAvgTime":"0", "calls":"0", "missed_calls":"0", "call_seconds":"0", "not_ranked":"0", "not_ranked_p":"0.00", "rewards":"0", "rewards_p":"0.00", "punishments":"0", "punishments_p":"0.00", "i_messages":"0", "i_chats":"0", "i_calls":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="8486980c36f975e1060ced99e644329e"></a> <h3>Departments report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_31967_generalTab_12334_header">General</div> </li> <li> <div class="headerContent" id="tab_98636_phpTab_49553_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_31967_generalTab_12334_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/departments?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_98636_phpTab_49553_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>departments<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">departments</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Departments list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>departments</u> has 45 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentName</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department name</td> </tr> <tr> <td class="returnFieldsTableCellEven">answers</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of answers</td> </tr> <tr> <td class="returnFieldsTableCellOdd">newAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">New answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">newAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">New answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">nextAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Open answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">nextAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Open answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chat_answers</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of chat messages</td> </tr> <tr> <td class="returnFieldsTableCellEven">chats</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of responded chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">missed_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of missed chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">chat_pickup</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of picked up chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chatPickupAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Chat pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">chatAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average time spent in chat (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of answered calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">missed_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of missed calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call time total (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">not_ranked</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of not rated</td> </tr> <tr> <td class="returnFieldsTableCellOdd">not_ranked_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Not rated [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">rewards</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of positive ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rewards_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Positive ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">punishments</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of negative ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">punishments_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Negative ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_messages</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming messages</td> </tr> <tr> <td class="returnFieldsTableCellOdd">i_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of incoming chats (including not responded)</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming calls (including not answered)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">f_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of finished chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">f_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of finished calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">created_tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">resolved_tickets</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of resolved tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">u_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of unanswered chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">u_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of unanswered calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">notes</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of notes</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstAssignAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First assign average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstAssignAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First assign average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstResolveAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First resolve average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstResolveAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First resolve average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">calls_outgoing</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of outgoing calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_outgoing_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Outgoing calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_outgoing_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Outgoing calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_pickup_avg_time</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Call average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls_internal</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of internal calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_internal_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Internal calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_internal_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Internal calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">o_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of offline calls</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_94179_xmlTab_89508_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_48141_jsonTab_39635_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_94179_xmlTab_89508_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">departments</font>></font> <font color="#0000FF"><<font color="#808000">department</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>1234asdf<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">departmentName</font>></font>General<font color="#0000FF"></<font color="#808000">departmentName</font>></font> <font color="#0000FF"><<font color="#808000">answers</font>></font>0<font color="#0000FF"></<font color="#808000">answers</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">chat_answers</font>></font>0<font color="#0000FF"></<font color="#808000">chat_answers</font>></font> <font color="#0000FF"><<font color="#808000">chats</font>></font>0<font color="#0000FF"></<font color="#808000">chats</font>></font> <font color="#0000FF"><<font color="#808000">missed_chats</font>></font>0<font color="#0000FF"></<font color="#808000">missed_chats</font>></font> <font color="#0000FF"><<font color="#808000">chat_pickup</font>></font>0<font color="#0000FF"></<font color="#808000">chat_pickup</font>></font> <font color="#0000FF"><<font color="#808000">chatPickupAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatPickupAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">chatAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">calls</font>></font>0<font color="#0000FF"></<font color="#808000">calls</font>></font> <font color="#0000FF"><<font color="#808000">missed_calls</font>></font>0<font color="#0000FF"></<font color="#808000">missed_calls</font>></font> <font color="#0000FF"><<font color="#808000">call_seconds</font>></font>0<font color="#0000FF"></<font color="#808000">call_seconds</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked</font>></font>0<font color="#0000FF"></<font color="#808000">not_ranked</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">not_ranked_p</font>></font> <font color="#0000FF"><<font color="#808000">rewards</font>></font>0<font color="#0000FF"></<font color="#808000">rewards</font>></font> <font color="#0000FF"><<font color="#808000">rewards_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">rewards_p</font>></font> <font color="#0000FF"><<font color="#808000">punishments</font>></font>0<font color="#0000FF"></<font color="#808000">punishments</font>></font> <font color="#0000FF"><<font color="#808000">punishments_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">punishments_p</font>></font> <font color="#0000FF"><<font color="#808000">i_messages</font>></font>0<font color="#0000FF"></<font color="#808000">i_messages</font>></font> <font color="#0000FF"><<font color="#808000">i_chats</font>></font>0<font color="#0000FF"></<font color="#808000">i_chats</font>></font> <font color="#0000FF"><<font color="#808000">i_calls</font>></font>0<font color="#0000FF"></<font color="#808000">i_calls</font>></font> <font color="#0000FF"></<font color="#808000">department</font>></font> <font color="#0000FF"></<font color="#808000">departments</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_48141_jsonTab_39635_content"> <pre style="font-size:12px;"> { "response":{ "departments":[ { "id":"1234asdf", "departmentName":"General", "answers":"0", "newAnswerAvgTime":"0", "newAnswerAvgTimeSla":"0", "nextAnswerAvgTime":"0", "nextAnswerAvgTimeSla":"0", "chat_answers":"0", "chats":"0", "missed_chats":"0", "chat_pickup":"0", "chatPickupAvgTime":"0", "chatAvgTime":"0", "calls":"0", "missed_calls":"0", "call_seconds":"0", "not_ranked":"0", "not_ranked_p":"0.00", "rewards":"0", "rewards_p":"0.00", "punishments":"0", "punishments_p":"0.00", "i_messages":"0", "i_chats":"0", "i_calls":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="4720451f26b6b7459e647c5c1077477a"></a> <h3>Performance report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_12630_generalTab_89259_header">General</div> </li> <li> <div class="headerContent" id="tab_91328_phpTab_23226_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_12630_generalTab_89259_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/performance?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_91328_phpTab_23226_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>performance<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">columns</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitcount</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitfrom</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellOdd">group_by</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Group by time interval (allowed values: hour, day, week, month)</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">performance</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Performance list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>performance</u> has 45 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from</td> </tr> <tr> <td class="returnFieldsTableCellOdd">dateto</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to</td> </tr> <tr> <td class="returnFieldsTableCellEven">answers</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of answers</td> </tr> <tr> <td class="returnFieldsTableCellOdd">newAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">New answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">newAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">New answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">nextAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Open answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">nextAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Open answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chat_answers</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of chat messages</td> </tr> <tr> <td class="returnFieldsTableCellEven">chats</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of responded chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">missed_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of missed chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">chat_pickup</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of picked up chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chatPickupAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Chat pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">chatAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average time spent in chat (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of answered calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">missed_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of missed calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call time total (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">not_ranked</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of not rated</td> </tr> <tr> <td class="returnFieldsTableCellOdd">not_ranked_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Not rated [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">rewards</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of positive ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rewards_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Positive ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">punishments</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of negative ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">punishments_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Negative ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_messages</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming messages</td> </tr> <tr> <td class="returnFieldsTableCellOdd">i_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of incoming chats (including not responded)</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming calls (including not answered)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">f_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of finished chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">f_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of finished calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">created_tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">resolved_tickets</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of resolved tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">u_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of unanswered chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">u_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of unanswered calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">notes</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of notes</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstAssignAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First assign average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstAssignAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First assign average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstResolveAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First resolve average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstResolveAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First resolve average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">calls_outgoing</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of outgoing calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_outgoing_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Outgoing calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_outgoing_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Outgoing calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_pickup_avg_time</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Call average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls_internal</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of internal calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_internal_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Internal calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_internal_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Internal calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">o_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of offline calls</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_50902_xmlTab_87964_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_60859_jsonTab_73060_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_50902_xmlTab_87964_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">performance</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">datetime</font>></font>2014-01-25<font color="#0000FF"></<font color="#808000">datetime</font>></font> <font color="#0000FF"><<font color="#808000">dateto</font>></font>2014-01-27 23:59:59<font color="#0000FF"></<font color="#808000">dateto</font>></font> <font color="#0000FF"><<font color="#808000">answers</font>></font>0<font color="#0000FF"></<font color="#808000">answers</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">chat_answers</font>></font>0<font color="#0000FF"></<font color="#808000">chat_answers</font>></font> <font color="#0000FF"><<font color="#808000">chats</font>></font>0<font color="#0000FF"></<font color="#808000">chats</font>></font> <font color="#0000FF"><<font color="#808000">missed_chats</font>></font>0<font color="#0000FF"></<font color="#808000">missed_chats</font>></font> <font color="#0000FF"><<font color="#808000">chat_pickup</font>></font>0<font color="#0000FF"></<font color="#808000">chat_pickup</font>></font> <font color="#0000FF"><<font color="#808000">chatPickupAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatPickupAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">chatAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">calls</font>></font>0<font color="#0000FF"></<font color="#808000">calls</font>></font> <font color="#0000FF"><<font color="#808000">missed_calls</font>></font>0<font color="#0000FF"></<font color="#808000">missed_calls</font>></font> <font color="#0000FF"><<font color="#808000">call_seconds</font>></font>0<font color="#0000FF"></<font color="#808000">call_seconds</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked</font>></font>0<font color="#0000FF"></<font color="#808000">not_ranked</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">not_ranked_p</font>></font> <font color="#0000FF"><<font color="#808000">rewards</font>></font>0<font color="#0000FF"></<font color="#808000">rewards</font>></font> <font color="#0000FF"><<font color="#808000">rewards_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">rewards_p</font>></font> <font color="#0000FF"><<font color="#808000">punishments</font>></font>0<font color="#0000FF"></<font color="#808000">punishments</font>></font> <font color="#0000FF"><<font color="#808000">punishments_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">punishments_p</font>></font> <font color="#0000FF"><<font color="#808000">i_messages</font>></font>0<font color="#0000FF"></<font color="#808000">i_messages</font>></font> <font color="#0000FF"><<font color="#808000">i_chats</font>></font>0<font color="#0000FF"></<font color="#808000">i_chats</font>></font> <font color="#0000FF"><<font color="#808000">i_calls</font>></font>0<font color="#0000FF"></<font color="#808000">i_calls</font>></font> <font color="#0000FF"><<font color="#808000">created_tickets</font>></font>0<font color="#0000FF"></<font color="#808000">created_tickets</font>></font> <font color="#0000FF"><<font color="#808000">resolved_tickets</font>></font>0<font color="#0000FF"></<font color="#808000">resolved_tickets</font>></font> <font color="#0000FF"><<font color="#808000">u_chats</font>></font>0<font color="#0000FF"></<font color="#808000">u_chats</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">performance</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_60859_jsonTab_73060_content"> <pre style="font-size:12px;"> { "response":{ "performance":[ { "datetime":"2014-01-25", "dateto":"2014-01-27 23:59:59", "answers":"0", "newAnswerAvgTime":"0", "newAnswerAvgTimeSla":"0", "nextAnswerAvgTime":"0", "nextAnswerAvgTimeSla":"0", "chat_answers":"0", "chats":"0", "missed_chats":"0", "chat_pickup":"0", "chatPickupAvgTime":"0", "chatAvgTime":"0", "calls":"0", "missed_calls":"0", "call_seconds":"0", "not_ranked":"0", "not_ranked_p":"0.00", "rewards":"0", "rewards_p":"0.00", "punishments":"0", "punishments_p":"0.00", "i_messages":"0", "i_chats":"0", "i_calls":"0", "created_tickets":"0", "resolved_tickets":"0", "u_chats":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="0b2eed2cb1d87da0fe652c5efcac84f9"></a> <h3>Tags report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_37204_generalTab_79129_header">General</div> </li> <li> <div class="headerContent" id="tab_22604_phpTab_51131_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_37204_generalTab_79129_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/tags?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_22604_phpTab_51131_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>tags<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">tags</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Tags list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>tags</u> has 45 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tag identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">tagName</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Tag name</td> </tr> <tr> <td class="returnFieldsTableCellEven">answers</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of answers</td> </tr> <tr> <td class="returnFieldsTableCellOdd">newAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">New answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">newAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">New answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">nextAnswerAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Open answer average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">nextAnswerAvgTimeSla</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Open answer average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chat_answers</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of chat messages</td> </tr> <tr> <td class="returnFieldsTableCellEven">chats</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of responded chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">missed_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of missed chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">chat_pickup</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of picked up chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chatPickupAvgTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Chat pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">chatAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average time spent in chat (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of answered calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">missed_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of missed calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call time total (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">not_ranked</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of not rated</td> </tr> <tr> <td class="returnFieldsTableCellOdd">not_ranked_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Not rated [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">rewards</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of positive ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rewards_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Positive ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">punishments</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of negative ratings</td> </tr> <tr> <td class="returnFieldsTableCellOdd">punishments_p</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Negative ratings [%]</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_messages</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming messages</td> </tr> <tr> <td class="returnFieldsTableCellOdd">i_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of incoming chats (including not responded)</td> </tr> <tr> <td class="returnFieldsTableCellEven">i_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of incoming calls (including not answered)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">f_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of finished chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">f_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of finished calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">created_tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">resolved_tickets</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of resolved tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">u_chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of unanswered chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">u_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of unanswered calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">notes</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of notes</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstAssignAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First assign average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstAssignAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First assign average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstResolveAvgTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">First resolve average time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstResolveAvgTimeSla</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">First resolve average time (in seconds) within SLA business hours</td> </tr> <tr> <td class="returnFieldsTableCellEven">calls_outgoing</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of outgoing calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_outgoing_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Outgoing calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_outgoing_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Outgoing calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_pickup_avg_time</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Call pickup average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Call average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">calls_internal</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of internal calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">call_internal_avg_time</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Internal calls average time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">call_internal_seconds</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Internal calls time (in seconds)</td> </tr> <tr> <td class="returnFieldsTableCellEven">o_calls</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of offline calls</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_70465_xmlTab_17710_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_21380_jsonTab_16455_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_70465_xmlTab_17710_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">tags</font>></font> <font color="#0000FF"><<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>4gh5<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">tagName</font>></font>Urgent<font color="#0000FF"></<font color="#808000">tagName</font>></font> <font color="#0000FF"><<font color="#808000">answers</font>></font>0<font color="#0000FF"></<font color="#808000">answers</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">newAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">newAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">nextAnswerAvgTimeSla</font>></font>0<font color="#0000FF"></<font color="#808000">nextAnswerAvgTimeSla</font>></font> <font color="#0000FF"><<font color="#808000">chat_answers</font>></font>0<font color="#0000FF"></<font color="#808000">chat_answers</font>></font> <font color="#0000FF"><<font color="#808000">chats</font>></font>0<font color="#0000FF"></<font color="#808000">chats</font>></font> <font color="#0000FF"><<font color="#808000">missed_chats</font>></font>0<font color="#0000FF"></<font color="#808000">missed_chats</font>></font> <font color="#0000FF"><<font color="#808000">chat_pickup</font>></font>0<font color="#0000FF"></<font color="#808000">chat_pickup</font>></font> <font color="#0000FF"><<font color="#808000">chatPickupAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatPickupAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">chatAvgTime</font>></font>0<font color="#0000FF"></<font color="#808000">chatAvgTime</font>></font> <font color="#0000FF"><<font color="#808000">calls</font>></font>0<font color="#0000FF"></<font color="#808000">calls</font>></font> <font color="#0000FF"><<font color="#808000">missed_calls</font>></font>0<font color="#0000FF"></<font color="#808000">missed_calls</font>></font> <font color="#0000FF"><<font color="#808000">call_seconds</font>></font>0<font color="#0000FF"></<font color="#808000">call_seconds</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked</font>></font>0<font color="#0000FF"></<font color="#808000">not_ranked</font>></font> <font color="#0000FF"><<font color="#808000">not_ranked_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">not_ranked_p</font>></font> <font color="#0000FF"><<font color="#808000">rewards</font>></font>0<font color="#0000FF"></<font color="#808000">rewards</font>></font> <font color="#0000FF"><<font color="#808000">rewards_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">rewards_p</font>></font> <font color="#0000FF"><<font color="#808000">punishments</font>></font>0<font color="#0000FF"></<font color="#808000">punishments</font>></font> <font color="#0000FF"><<font color="#808000">punishments_p</font>></font>0.00<font color="#0000FF"></<font color="#808000">punishments_p</font>></font> <font color="#0000FF"><<font color="#808000">i_messages</font>></font>0<font color="#0000FF"></<font color="#808000">i_messages</font>></font> <font color="#0000FF"><<font color="#808000">i_chats</font>></font>0<font color="#0000FF"></<font color="#808000">i_chats</font>></font> <font color="#0000FF"><<font color="#808000">i_calls</font>></font>0<font color="#0000FF"></<font color="#808000">i_calls</font>></font> <font color="#0000FF"></<font color="#808000">tag</font>></font> <font color="#0000FF"></<font color="#808000">tags</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_21380_jsonTab_16455_content"> <pre style="font-size:12px;"> { "response":{ "tags":[ { "id":"4gh5", "tagName":"Urgent", "answers":"0", "newAnswerAvgTime":"0", "newAnswerAvgTimeSla":"0", "nextAnswerAvgTime":"0", "nextAnswerAvgTimeSla":"0", "chat_answers":"0", "chats":"0", "missed_chats":"0", "chat_pickup":"0", "chatPickupAvgTime":"0", "chatAvgTime":"0", "calls":"0", "missed_calls":"0", "call_seconds":"0", "not_ranked":"0", "not_ranked_p":"0.00", "rewards":"0", "rewards_p":"0.00", "punishments":"0", "punishments_p":"0.00", "i_messages":"0", "i_chats":"0", "i_calls":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="0eda602d53b5149bb339baec847844ac"></a> <h3>Tickets Agent availability report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_57893_generalTab_72804_header">General</div> </li> <li> <div class="headerContent" id="tab_53817_phpTab_72862_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_57893_generalTab_72804_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/tickets/agentsavailability</div> </div> <div class="tabContent" id="tab_53817_phpTab_72862_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>tickets<span class="P">/</span>agentsavailability<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">agentsavailability</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Agents availability list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>agentsavailability</u> has 10 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Availability identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">userid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">User identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User first name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">User last name</td> </tr> <tr> <td class="returnFieldsTableCellEven">contactid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">department_name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">hours_online</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Number of hours online</td> </tr> <tr> <td class="returnFieldsTableCellEven">from_date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from</td> </tr> <tr> <td class="returnFieldsTableCellOdd">to_date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_29636_xmlTab_79067_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_64595_jsonTab_89001_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_29636_xmlTab_79067_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">agentsavailability</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>363662<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>1245asdf<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>Firstname<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Lastname<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>hjkl78io<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>drty894g<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">department_name</font>></font>Test<font color="#0000FF"></<font color="#808000">department_name</font>></font> <font color="#0000FF"><<font color="#808000">hours_online</font>></font>00:08:31<font color="#0000FF"></<font color="#808000">hours_online</font>></font> <font color="#0000FF"><<font color="#808000">from_date</font>></font>2014-07-24 16:25:06<font color="#0000FF"></<font color="#808000">from_date</font>></font> <font color="#0000FF"><<font color="#808000">to_date</font>></font>now<font color="#0000FF"></<font color="#808000">to_date</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">agentsavailability</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_64595_jsonTab_89001_content"> <pre style="font-size:12px;"> { "response":{ "agentsavailability":[ { "id":"363662", "userid":"1245asdf", "firstname":"Firstname", "lastname":"Lastname", "contactid":"hjkl78io", "departmentid":"drty894g", "department_name":"Test", "hours_online":"00:08:31", "from_date":"2014-07-24 16:25:06", "to_date":"now" } ] } }</pre> </div> </div> <br /> <br /> <a id="4c93c79a2e79c3940b14a7e63d93d7c0"></a> <h3>Tickets Load report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_58054_generalTab_50644_header">General</div> </li> <li> <div class="headerContent" id="tab_99401_phpTab_14623_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_58054_generalTab_50644_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/tickets/load</div> </div> <div class="tabContent" id="tab_99401_phpTab_14623_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>tickets<span class="P">/</span>load<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">loads</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Tickets load list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>loads</u> has 10 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgQueue</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Average tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxQueue</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellEven">minQueue</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avgSlots</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Average agents</td> </tr> <tr> <td class="returnFieldsTableCellEven">maxSlots</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Maximum agents</td> </tr> <tr> <td class="returnFieldsTableCellOdd">minSlots</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Minimum agents</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgService</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Average work in progress tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxService</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum work in progress tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">minService</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum work in progress tickets</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_65936_xmlTab_70689_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_29415_jsonTab_87535_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_65936_xmlTab_70689_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">loads</font>></font> <font color="#0000FF"><<font color="#808000">load</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">avgQueue</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgQueue</font>></font> <font color="#0000FF"><<font color="#808000">maxQueue</font>></font>0<font color="#0000FF"></<font color="#808000">maxQueue</font>></font> <font color="#0000FF"><<font color="#808000">minQueue</font>></font>0<font color="#0000FF"></<font color="#808000">minQueue</font>></font> <font color="#0000FF"><<font color="#808000">avgSlots</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgSlots</font>></font> <font color="#0000FF"><<font color="#808000">maxSlots</font>></font>0<font color="#0000FF"></<font color="#808000">maxSlots</font>></font> <font color="#0000FF"><<font color="#808000">minSlots</font>></font>0<font color="#0000FF"></<font color="#808000">minSlots</font>></font> <font color="#0000FF"><<font color="#808000">avgService</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgService</font>></font> <font color="#0000FF"><<font color="#808000">maxService</font>></font>0<font color="#0000FF"></<font color="#808000">maxService</font>></font> <font color="#0000FF"><<font color="#808000">minService</font>></font>0<font color="#0000FF"></<font color="#808000">minService</font>></font> <font color="#0000FF"></<font color="#808000">load</font>></font> <font color="#0000FF"></<font color="#808000">loads</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_29415_jsonTab_87535_content"> <pre style="font-size:12px;"> { "response":{ "loads":[ { "date":"2014-07-26 15:00:00", "avgQueue":"0.00", "maxQueue":"0", "minQueue":"0", "avgSlots":"0.00", "maxSlots":"0", "minSlots":"0", "avgService":"0.00", "maxService":"0", "minService":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="346eed9d6da6dbba40da149843413bef"></a> <h3>Tickets SLA Compliance report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_57921_generalTab_59531_header">General</div> </li> <li> <div class="headerContent" id="tab_61635_phpTab_98929_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_57921_generalTab_59531_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/tickets/slacompliance</div> </div> <div class="tabContent" id="tab_61635_phpTab_98929_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>tickets<span class="P">/</span>slacompliance<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Date constraint (L30D = last 30 days (default), TM = this month, LM = last month, 2014-06 = whole june of 2014)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">userid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Assigned to user identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">slalevelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">slacompliances</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">SLA Compliances list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>slacompliances</u> has 9 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date</td> </tr> <tr> <td class="returnFieldsTableCellOdd">fulfilled</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Fulfilled</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgFulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxFulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">minFulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">unfulfilled</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Unfulfilled</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgUnfulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxUnfulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">minUnfulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_95083_xmlTab_30899_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_31376_jsonTab_26601_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_95083_xmlTab_30899_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">slacompliances</font>></font> <font color="#0000FF"><<font color="#808000">slacompliance</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">fulfilled</font>></font>0<font color="#0000FF"></<font color="#808000">fulfilled</font>></font> <font color="#0000FF"><<font color="#808000">avgFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">avgFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">maxFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">maxFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">minFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">minFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">unfulfilled</font>></font>0<font color="#0000FF"></<font color="#808000">unfulfilled</font>></font> <font color="#0000FF"><<font color="#808000">avgUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">avgUnfulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">maxUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">maxUnfulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">minUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">minUnfulfilledTime</font>></font> <font color="#0000FF"></<font color="#808000">slacompliance</font>></font> <font color="#0000FF"></<font color="#808000">slacompliances</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_31376_jsonTab_26601_content"> <pre style="font-size:12px;"> { "response":{ "slacompliances":[ { "date":"2014-07-26 15:00:00", "fulfilled":"0", "avgFulfilledTime":"0", "maxFulfilledTime":"0", "minFulfilledTime":"0", "unfulfilled":"0", "avgUnfulfilledTime":"0", "maxUnfulfilledTime":"0", "minUnfulfilledTime":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="716032b91115b50c876d5c8f65e03468"></a> <h3>Tickets SLA Log report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_31512_generalTab_89655_header">General</div> </li> <li> <div class="headerContent" id="tab_71529_phpTab_98733_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_31512_generalTab_89655_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/tickets/slalog?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_71529_phpTab_98733_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>tickets<span class="P">/</span>slalog<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrows the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">requesterid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">slalevelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">slalogs</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">SLA Compliances list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>slalogs</u> has 20 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">SLA Log identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">conversationid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">department_name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">levelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Level identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">sla_level_name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">SLA level name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">sla</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA offset</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_created</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_closed</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">server_date_closed</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_due</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">server_date_due</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">sla_level_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">agentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agent_firstname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent first name</td> </tr> <tr> <td class="returnFieldsTableCellEven">agent_lastname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent last name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">req_contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Requester contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">req_firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester first name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">req_lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Requester last name</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_79759_xmlTab_21377_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_48121_jsonTab_44964_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_79759_xmlTab_21377_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">slalogs</font>></font> <font color="#0000FF"><<font color="#808000">slalog</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>41355<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>bf7b09ae<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>code<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>XXX-XXXXX-XXX<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">department_name</font>></font>General<font color="#0000FF"></<font color="#808000">department_name</font>></font> <font color="#0000FF"><<font color="#808000">levelid</font>></font>3bd9cf58<font color="#0000FF"></<font color="#808000">levelid</font>></font> <font color="#0000FF"><<font color="#808000">sla_level_name</font>></font>Urgent<font color="#0000FF"></<font color="#808000">sla_level_name</font>></font> <font color="#0000FF"><<font color="#808000">sla</font>></font>-01:56:53<font color="#0000FF"></<font color="#808000">sla</font>></font> <font color="#0000FF"><<font color="#808000">date_created</font>></font>2014-08-26 09:38:29<font color="#0000FF"></<font color="#808000">date_created</font>></font> <font color="#0000FF"><<font color="#808000">date_closed</font>></font>2014-08-26 09:42:36<font color="#0000FF"></<font color="#808000">date_closed</font>></font> <font color="#0000FF"><<font color="#808000">server_date_closed</font>></font>2014-08-26 07:42:36<font color="#0000FF"></<font color="#808000">server_date_closed</font>></font> <font color="#0000FF"><<font color="#808000">date_due</font>></font>2014-08-26 09:39:29<font color="#0000FF"></<font color="#808000">date_due</font>></font> <font color="#0000FF"><<font color="#808000">server_date_due</font>></font>2014-08-26 09:39:29<font color="#0000FF"></<font color="#808000">server_date_due</font>></font> <font color="#0000FF"><<font color="#808000">sla_level_id</font>></font>gtrt7895<font color="#0000FF"></<font color="#808000">sla_level_id</font>></font> <font color="#0000FF"><<font color="#808000">agentid</font>/></font> <font color="#0000FF"><<font color="#808000">agent_firstname</font>/></font> <font color="#0000FF"><<font color="#808000">agent_lastname</font>/></font> <font color="#0000FF"><<font color="#808000">req_contactid</font>></font>2fe9e7c7<font color="#0000FF"></<font color="#808000">req_contactid</font>></font> <font color="#0000FF"><<font color="#808000">req_firstname</font>></font>Customer firstname<font color="#0000FF"></<font color="#808000">req_firstname</font>></font> <font color="#0000FF"><<font color="#808000">req_lastname</font>></font>Customer lastname<font color="#0000FF"></<font color="#808000">req_lastname</font>></font> <font color="#0000FF"></<font color="#808000">slalog</font>></font> <font color="#0000FF"></<font color="#808000">slalogs</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_48121_jsonTab_44964_content"> <pre style="font-size:12px;"> { "response":{ "slalogs":[ { "id":"41355", "conversationid":"bf7b09ae", "code":"code", "departmentid":"XXX-XXXXX-XXX", "department_name":"General", "levelid":"3bd9cf58", "sla_level_name":"Urgent", "sla":"-01:56:53", "date_created":"2014-08-26 09:38:29", "date_closed":"2014-08-26 09:42:36", "server_date_closed":"2014-08-26 07:42:36", "date_due":"2014-08-26 09:39:29", "server_date_due":"2014-08-26 09:39:29", "sla_level_id":"gtrt7895", "agentid":"", "agent_firstname":"", "agent_lastname":"", "req_contactid":"2fe9e7c7", "req_firstname":"Customer firstname", "req_lastname":"Customer lastname" } ] } }</pre> </div> </div> <br /> <br /> <a id="f7ef9ffba7997a345e6797a104bb7551"></a> <h3>Chats Agent availability report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_26524_generalTab_16562_header">General</div> </li> <li> <div class="headerContent" id="tab_21287_phpTab_56422_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_26524_generalTab_16562_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/chats/agentsavailability</div> </div> <div class="tabContent" id="tab_21287_phpTab_56422_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>chats<span class="P">/</span>agentsavailability<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">agentsavailability</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Agents availability list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>agentsavailability</u> has 10 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Availability identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">userid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">firstname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">User first name</td> </tr> <tr> <td class="returnFieldsTableCellEven">lastname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User last name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">department_name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department name</td> </tr> <tr> <td class="returnFieldsTableCellEven">hours_online</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Number of hours online</td> </tr> <tr> <td class="returnFieldsTableCellOdd">from_date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from</td> </tr> <tr> <td class="returnFieldsTableCellEven">to_date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_93461_xmlTab_99879_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_41895_jsonTab_41673_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_93461_xmlTab_99879_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">agentsavailability</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>363662<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>1245asdf<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>Firstname<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Lastname<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>hjkl78io<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>drty894g<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">department_name</font>></font>Test<font color="#0000FF"></<font color="#808000">department_name</font>></font> <font color="#0000FF"><<font color="#808000">hours_online</font>></font>00:08:31<font color="#0000FF"></<font color="#808000">hours_online</font>></font> <font color="#0000FF"><<font color="#808000">from_date</font>></font>2014-07-24 16:25:06<font color="#0000FF"></<font color="#808000">from_date</font>></font> <font color="#0000FF"><<font color="#808000">to_date</font>></font>now<font color="#0000FF"></<font color="#808000">to_date</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">agentsavailability</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_41895_jsonTab_41673_content"> <pre style="font-size:12px;"> { "response":{ "agentsavailability":[ { "id":"363662", "userid":"1245asdf", "firstname":"Firstname", "lastname":"Lastname", "contactid":"hjkl78io", "departmentid":"drty894g", "department_name":"Test", "hours_online":"00:08:31", "from_date":"2014-07-24 16:25:06", "to_date":"now" } ] } }</pre> </div> </div> <br /> <br /> <a id="a8b317f39f890797ae80cb838282f0bf"></a> <h3>Chats availability report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_84547_generalTab_20673_header">General</div> </li> <li> <div class="headerContent" id="tab_49593_phpTab_11250_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_84547_generalTab_20673_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/chats/availability</div> </div> <div class="tabContent" id="tab_49593_phpTab_11250_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>chats<span class="P">/</span>availability<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">availability</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Chats availability list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>availability</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date</td> </tr> <tr> <td class="returnFieldsTableCellOdd">mins</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Availability (in minutes)</td> </tr> <tr> <td class="returnFieldsTableCellEven">pct</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Availability (in percentage)</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_97112_xmlTab_94646_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_35036_jsonTab_73398_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_97112_xmlTab_94646_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">availability</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">mins</font>></font>59<font color="#0000FF"></<font color="#808000">mins</font>></font> <font color="#0000FF"><<font color="#808000">pct</font>></font>98.3333<font color="#0000FF"></<font color="#808000">pct</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">availability</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_35036_jsonTab_73398_content"> <pre style="font-size:12px;"> { "response":{ "availability":[ { "date":"2014-07-26 15:00:00", "mins":"59", "pct":"98.3333" } ] } }</pre> </div> </div> <br /> <br /> <a id="a2bfc0f16204c1d9df4d293b9d1ca4ae"></a> <h3>Chats Load report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_80535_generalTab_40386_header">General</div> </li> <li> <div class="headerContent" id="tab_37373_phpTab_76165_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_80535_generalTab_40386_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/chats/load</div> </div> <div class="tabContent" id="tab_37373_phpTab_76165_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>chats<span class="P">/</span>load<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">loads</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Chats load list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>loads</u> has 10 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avgQueue</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Average tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellEven">maxQueue</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Maximum tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellOdd">minQueue</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Minimum tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgSlots</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Average agents</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxSlots</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum agents</td> </tr> <tr> <td class="returnFieldsTableCellEven">minSlots</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum agents</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avgService</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Average work in progress tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">maxService</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Maximum work in progress tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">minService</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Minimum work in progress tickets</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_24232_xmlTab_36682_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_47835_jsonTab_72125_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_24232_xmlTab_36682_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">loads</font>></font> <font color="#0000FF"><<font color="#808000">load</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">avgQueue</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgQueue</font>></font> <font color="#0000FF"><<font color="#808000">maxQueue</font>></font>0<font color="#0000FF"></<font color="#808000">maxQueue</font>></font> <font color="#0000FF"><<font color="#808000">minQueue</font>></font>0<font color="#0000FF"></<font color="#808000">minQueue</font>></font> <font color="#0000FF"><<font color="#808000">avgSlots</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgSlots</font>></font> <font color="#0000FF"><<font color="#808000">maxSlots</font>></font>0<font color="#0000FF"></<font color="#808000">maxSlots</font>></font> <font color="#0000FF"><<font color="#808000">minSlots</font>></font>0<font color="#0000FF"></<font color="#808000">minSlots</font>></font> <font color="#0000FF"><<font color="#808000">avgService</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgService</font>></font> <font color="#0000FF"><<font color="#808000">maxService</font>></font>0<font color="#0000FF"></<font color="#808000">maxService</font>></font> <font color="#0000FF"><<font color="#808000">minService</font>></font>0<font color="#0000FF"></<font color="#808000">minService</font>></font> <font color="#0000FF"></<font color="#808000">load</font>></font> <font color="#0000FF"></<font color="#808000">loads</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_47835_jsonTab_72125_content"> <pre style="font-size:12px;"> { "response":{ "loads":[ { "date":"2014-07-26 15:00:00", "avgQueue":"0.00", "maxQueue":"0", "minQueue":"0", "avgSlots":"0.00", "maxSlots":"0", "minSlots":"0", "avgService":"0.00", "maxService":"0", "minService":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="302e9609ad815584c03332a74169be59"></a> <h3>Chats SLA Compliance report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_43344_generalTab_52285_header">General</div> </li> <li> <div class="headerContent" id="tab_29205_phpTab_31198_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_43344_generalTab_52285_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/chats/slacompliance</div> </div> <div class="tabContent" id="tab_29205_phpTab_31198_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>chats<span class="P">/</span>slacompliance<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Date constraint (L30D = last 30 days (default), TM = this month, LM = last month, 2014-06 = whole june of 2014)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">userid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Assigned to user identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">slalevelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">slacompliances</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">SLA Compliances list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>slacompliances</u> has 9 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date</td> </tr> <tr> <td class="returnFieldsTableCellEven">fulfilled</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Fulfilled</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avgFulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Average fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">maxFulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Maximum fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">minFulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Minimum fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">unfulfilled</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Unfulfilled</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avgUnfulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Average unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">maxUnfulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Maximum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">minUnfulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_35856_xmlTab_68827_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_73444_jsonTab_10916_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_35856_xmlTab_68827_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">slacompliances</font>></font> <font color="#0000FF"><<font color="#808000">slacompliance</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">fulfilled</font>></font>0<font color="#0000FF"></<font color="#808000">fulfilled</font>></font> <font color="#0000FF"><<font color="#808000">avgFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">avgFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">maxFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">maxFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">minFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">minFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">unfulfilled</font>></font>0<font color="#0000FF"></<font color="#808000">unfulfilled</font>></font> <font color="#0000FF"><<font color="#808000">avgUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">avgUnfulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">maxUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">maxUnfulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">minUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">minUnfulfilledTime</font>></font> <font color="#0000FF"></<font color="#808000">slacompliance</font>></font> <font color="#0000FF"></<font color="#808000">slacompliances</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_73444_jsonTab_10916_content"> <pre style="font-size:12px;"> { "response":{ "slacompliances":[ { "date":"2014-07-26 15:00:00", "fulfilled":"0", "avgFulfilledTime":"0", "maxFulfilledTime":"0", "minFulfilledTime":"0", "unfulfilled":"0", "avgUnfulfilledTime":"0", "maxUnfulfilledTime":"0", "minUnfulfilledTime":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="57611b60bd5e97b253c97701c656e695"></a> <h3>Chats SLA log report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_90362_generalTab_16546_header">General</div> </li> <li> <div class="headerContent" id="tab_54645_phpTab_54325_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_90362_generalTab_16546_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/chats/slalog?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_54645_phpTab_54325_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>chats<span class="P">/</span>slalog<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrows the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">requesterid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">slalevelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">slalogs</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">SLA Compliances list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>slalogs</u> has 20 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA Log identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">conversationid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">code</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation code</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">department_name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department name</td> </tr> <tr> <td class="returnFieldsTableCellEven">levelid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Level identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">sla_level_name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level name</td> </tr> <tr> <td class="returnFieldsTableCellEven">sla</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">SLA offset</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_created</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_closed</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">server_date_closed</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_due</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">server_date_due</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">sla_level_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">SLA level identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">agent_firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent first name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agent_lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent last name</td> </tr> <tr> <td class="returnFieldsTableCellEven">req_contactid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">req_firstname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Requester first name</td> </tr> <tr> <td class="returnFieldsTableCellEven">req_lastname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester last name</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_17933_xmlTab_74133_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_51062_jsonTab_34911_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_17933_xmlTab_74133_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">slalogs</font>></font> <font color="#0000FF"><<font color="#808000">slalog</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>41355<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>bf7b09ae<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>code<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>XXX-XXXXX-XXX<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">department_name</font>></font>General<font color="#0000FF"></<font color="#808000">department_name</font>></font> <font color="#0000FF"><<font color="#808000">levelid</font>></font>3bd9cf58<font color="#0000FF"></<font color="#808000">levelid</font>></font> <font color="#0000FF"><<font color="#808000">sla_level_name</font>></font>Urgent<font color="#0000FF"></<font color="#808000">sla_level_name</font>></font> <font color="#0000FF"><<font color="#808000">sla</font>></font>-01:56:53<font color="#0000FF"></<font color="#808000">sla</font>></font> <font color="#0000FF"><<font color="#808000">date_created</font>></font>2014-08-26 09:38:29<font color="#0000FF"></<font color="#808000">date_created</font>></font> <font color="#0000FF"><<font color="#808000">date_closed</font>></font>2014-08-26 09:42:36<font color="#0000FF"></<font color="#808000">date_closed</font>></font> <font color="#0000FF"><<font color="#808000">server_date_closed</font>></font>2014-08-26 07:42:36<font color="#0000FF"></<font color="#808000">server_date_closed</font>></font> <font color="#0000FF"><<font color="#808000">date_due</font>></font>2014-08-26 09:39:29<font color="#0000FF"></<font color="#808000">date_due</font>></font> <font color="#0000FF"><<font color="#808000">server_date_due</font>></font>2014-08-26 09:39:29<font color="#0000FF"></<font color="#808000">server_date_due</font>></font> <font color="#0000FF"><<font color="#808000">sla_level_id</font>></font>gtrt7895<font color="#0000FF"></<font color="#808000">sla_level_id</font>></font> <font color="#0000FF"><<font color="#808000">agentid</font>/></font> <font color="#0000FF"><<font color="#808000">agent_firstname</font>/></font> <font color="#0000FF"><<font color="#808000">agent_lastname</font>/></font> <font color="#0000FF"><<font color="#808000">req_contactid</font>></font>2fe9e7c7<font color="#0000FF"></<font color="#808000">req_contactid</font>></font> <font color="#0000FF"><<font color="#808000">req_firstname</font>></font>Customer firstname<font color="#0000FF"></<font color="#808000">req_firstname</font>></font> <font color="#0000FF"><<font color="#808000">req_lastname</font>></font>Customer lastname<font color="#0000FF"></<font color="#808000">req_lastname</font>></font> <font color="#0000FF"></<font color="#808000">slalog</font>></font> <font color="#0000FF"></<font color="#808000">slalogs</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_51062_jsonTab_34911_content"> <pre style="font-size:12px;"> { "response":{ "slalogs":[ { "id":"41355", "conversationid":"bf7b09ae", "code":"code", "departmentid":"XXX-XXXXX-XXX", "department_name":"General", "levelid":"3bd9cf58", "sla_level_name":"Urgent", "sla":"-01:56:53", "date_created":"2014-08-26 09:38:29", "date_closed":"2014-08-26 09:42:36", "server_date_closed":"2014-08-26 07:42:36", "date_due":"2014-08-26 09:39:29", "server_date_due":"2014-08-26 09:39:29", "sla_level_id":"gtrt7895", "agentid":"", "agent_firstname":"", "agent_lastname":"", "req_contactid":"2fe9e7c7", "req_firstname":"Customer firstname", "req_lastname":"Customer lastname" } ] } }</pre> </div> </div> <br /> <br /> <a id="6e3224079b6c2d12697dff7d4c48f494"></a> <h3>Calls Agent availability report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_76787_generalTab_84287_header">General</div> </li> <li> <div class="headerContent" id="tab_93184_phpTab_10325_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_76787_generalTab_84287_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/calls/agentsavailability</div> </div> <div class="tabContent" id="tab_93184_phpTab_10325_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>calls<span class="P">/</span>agentsavailability<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">agentsavailability</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Agents availability list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>agentsavailability</u> has 10 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Availability identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">userid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">User identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">User first name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">User last name</td> </tr> <tr> <td class="returnFieldsTableCellEven">contactid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">department_name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">hours_online</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Number of hours online</td> </tr> <tr> <td class="returnFieldsTableCellEven">from_date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from</td> </tr> <tr> <td class="returnFieldsTableCellOdd">to_date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_69011_xmlTab_25166_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_61361_jsonTab_91411_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_69011_xmlTab_25166_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">agentsavailability</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>363662<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">userid</font>></font>1245asdf<font color="#0000FF"></<font color="#808000">userid</font>></font> <font color="#0000FF"><<font color="#808000">firstname</font>></font>Firstname<font color="#0000FF"></<font color="#808000">firstname</font>></font> <font color="#0000FF"><<font color="#808000">lastname</font>></font>Lastname<font color="#0000FF"></<font color="#808000">lastname</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>hjkl78io<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>drty894g<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">department_name</font>></font>Test<font color="#0000FF"></<font color="#808000">department_name</font>></font> <font color="#0000FF"><<font color="#808000">hours_online</font>></font>00:08:31<font color="#0000FF"></<font color="#808000">hours_online</font>></font> <font color="#0000FF"><<font color="#808000">from_date</font>></font>2014-07-24 16:25:06<font color="#0000FF"></<font color="#808000">from_date</font>></font> <font color="#0000FF"><<font color="#808000">to_date</font>></font>now<font color="#0000FF"></<font color="#808000">to_date</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">agentsavailability</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_61361_jsonTab_91411_content"> <pre style="font-size:12px;"> { "response":{ "agentsavailability":[ { "id":"363662", "userid":"1245asdf", "firstname":"Firstname", "lastname":"Lastname", "contactid":"hjkl78io", "departmentid":"drty894g", "department_name":"Test", "hours_online":"00:08:31", "from_date":"2014-07-24 16:25:06", "to_date":"now" } ] } }</pre> </div> </div> <br /> <br /> <a id="ac945e1666c8e3caeb944b87322951f1"></a> <h3>Calls availability report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_34386_generalTab_62055_header">General</div> </li> <li> <div class="headerContent" id="tab_45068_phpTab_40790_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_34386_generalTab_62055_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/calls/availability</div> </div> <div class="tabContent" id="tab_45068_phpTab_40790_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>calls<span class="P">/</span>availability<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">availability</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Calls availability list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>availability</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date</td> </tr> <tr> <td class="returnFieldsTableCellEven">mins</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Availability (in minutes)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">pct</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Availability (in percentage)</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_90336_xmlTab_53817_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_45629_jsonTab_97991_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_90336_xmlTab_53817_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">availability</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">mins</font>></font>59<font color="#0000FF"></<font color="#808000">mins</font>></font> <font color="#0000FF"><<font color="#808000">pct</font>></font>98.3333<font color="#0000FF"></<font color="#808000">pct</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">availability</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_45629_jsonTab_97991_content"> <pre style="font-size:12px;"> { "response":{ "availability":[ { "date":"2014-07-26 15:00:00", "mins":"59", "pct":"98.3333" } ] } }</pre> </div> </div> <br /> <br /> <a id="3ef3b0eb476a18278878ce0b9e269c66"></a> <h3>Calls Load report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_40282_generalTab_86761_header">General</div> </li> <li> <div class="headerContent" id="tab_74772_phpTab_60149_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_40282_generalTab_86761_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/calls/load</div> </div> <div class="tabContent" id="tab_74772_phpTab_60149_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>calls<span class="P">/</span>load<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific agent id</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">loads</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Calls load list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>loads</u> has 10 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgQueue</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Average tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxQueue</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellEven">minQueue</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum tickets in queue</td> </tr> <tr> <td class="returnFieldsTableCellOdd">avgSlots</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Average agents</td> </tr> <tr> <td class="returnFieldsTableCellEven">maxSlots</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Maximum agents</td> </tr> <tr> <td class="returnFieldsTableCellOdd">minSlots</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Minimum agents</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgService</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Average work in progress tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxService</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum work in progress tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">minService</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum work in progress tickets</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_91952_xmlTab_72167_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_17316_jsonTab_76583_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_91952_xmlTab_72167_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">loads</font>></font> <font color="#0000FF"><<font color="#808000">load</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">avgQueue</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgQueue</font>></font> <font color="#0000FF"><<font color="#808000">maxQueue</font>></font>0<font color="#0000FF"></<font color="#808000">maxQueue</font>></font> <font color="#0000FF"><<font color="#808000">minQueue</font>></font>0<font color="#0000FF"></<font color="#808000">minQueue</font>></font> <font color="#0000FF"><<font color="#808000">avgSlots</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgSlots</font>></font> <font color="#0000FF"><<font color="#808000">maxSlots</font>></font>0<font color="#0000FF"></<font color="#808000">maxSlots</font>></font> <font color="#0000FF"><<font color="#808000">minSlots</font>></font>0<font color="#0000FF"></<font color="#808000">minSlots</font>></font> <font color="#0000FF"><<font color="#808000">avgService</font>></font>0.00<font color="#0000FF"></<font color="#808000">avgService</font>></font> <font color="#0000FF"><<font color="#808000">maxService</font>></font>0<font color="#0000FF"></<font color="#808000">maxService</font>></font> <font color="#0000FF"><<font color="#808000">minService</font>></font>0<font color="#0000FF"></<font color="#808000">minService</font>></font> <font color="#0000FF"></<font color="#808000">load</font>></font> <font color="#0000FF"></<font color="#808000">loads</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_17316_jsonTab_76583_content"> <pre style="font-size:12px;"> { "response":{ "loads":[ { "date":"2014-07-26 15:00:00", "avgQueue":"0.00", "maxQueue":"0", "minQueue":"0", "avgSlots":"0.00", "maxSlots":"0", "minSlots":"0", "avgService":"0.00", "maxService":"0", "minService":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="a3a77ba80d64e54a8db022a56b79cede"></a> <h3>Calls SLA Compliance report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_39865_generalTab_19116_header">General</div> </li> <li> <div class="headerContent" id="tab_13229_phpTab_95413_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_39865_generalTab_19116_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/calls/slacompliance</div> </div> <div class="tabContent" id="tab_13229_phpTab_95413_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>calls<span class="P">/</span>slacompliance<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">date_from</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_to</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Date constraint (L30D = last 30 days (default), TM = this month, LM = last month, 2014-06 = whole june of 2014)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Narrow the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">userid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Assigned to user identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">slalevelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">slacompliances</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">SLA Compliances list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>slacompliances</u> has 9 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">date</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date</td> </tr> <tr> <td class="returnFieldsTableCellOdd">fulfilled</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Fulfilled</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgFulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxFulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">minFulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum fulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">unfulfilled</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Unfulfilled</td> </tr> <tr> <td class="returnFieldsTableCellEven">avgUnfulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Average unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">maxUnfulfilledTime</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Maximum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">minUnfulfilledTime</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_99517_xmlTab_36505_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_85123_jsonTab_65452_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_99517_xmlTab_36505_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">slacompliances</font>></font> <font color="#0000FF"><<font color="#808000">slacompliance</font>></font> <font color="#0000FF"><<font color="#808000">date</font>></font>2014-07-26 15:00:00<font color="#0000FF"></<font color="#808000">date</font>></font> <font color="#0000FF"><<font color="#808000">fulfilled</font>></font>0<font color="#0000FF"></<font color="#808000">fulfilled</font>></font> <font color="#0000FF"><<font color="#808000">avgFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">avgFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">maxFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">maxFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">minFulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">minFulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">unfulfilled</font>></font>0<font color="#0000FF"></<font color="#808000">unfulfilled</font>></font> <font color="#0000FF"><<font color="#808000">avgUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">avgUnfulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">maxUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">maxUnfulfilledTime</font>></font> <font color="#0000FF"><<font color="#808000">minUnfulfilledTime</font>></font>0<font color="#0000FF"></<font color="#808000">minUnfulfilledTime</font>></font> <font color="#0000FF"></<font color="#808000">slacompliance</font>></font> <font color="#0000FF"></<font color="#808000">slacompliances</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_85123_jsonTab_65452_content"> <pre style="font-size:12px;"> { "response":{ "slacompliances":[ { "date":"2014-07-26 15:00:00", "fulfilled":"0", "avgFulfilledTime":"0", "maxFulfilledTime":"0", "minFulfilledTime":"0", "unfulfilled":"0", "avgUnfulfilledTime":"0", "maxUnfulfilledTime":"0", "minUnfulfilledTime":"0" } ] } }</pre> </div> </div> <br /> <br /> <a id="2bb237c46c72d7b6159874a4a340d5fb"></a> <h3>Calls SLA log report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_69921_generalTab_14569_header">General</div> </li> <li> <div class="headerContent" id="tab_58157_phpTab_61859_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_69921_generalTab_14569_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/calls/slalog?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_58157_phpTab_61859_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>calls<span class="P">/</span>slalog<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">columns</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Narrows the report to specific department identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">requesterid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">slalevelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">slalogs</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">SLA Compliances list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>slalogs</u> has 20 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">SLA Log identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">conversationid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Conversation identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">department_name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">levelid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Level identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">sla_level_name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">SLA level name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">sla</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA offset</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_created</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_closed</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">server_date_closed</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">date_due</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellEven">server_date_due</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Minimum unfulfilled time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">sla_level_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">SLA level identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">agentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agent_firstname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent first name</td> </tr> <tr> <td class="returnFieldsTableCellEven">agent_lastname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent last name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">req_contactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Requester contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">req_firstname</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester first name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">req_lastname</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Requester last name</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_80249_xmlTab_42388_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_20287_jsonTab_39613_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_80249_xmlTab_42388_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">slalogs</font>></font> <font color="#0000FF"><<font color="#808000">slalog</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>41355<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>bf7b09ae<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">code</font>></font>code<font color="#0000FF"></<font color="#808000">code</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>XXX-XXXXX-XXX<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">department_name</font>></font>General<font color="#0000FF"></<font color="#808000">department_name</font>></font> <font color="#0000FF"><<font color="#808000">levelid</font>></font>3bd9cf58<font color="#0000FF"></<font color="#808000">levelid</font>></font> <font color="#0000FF"><<font color="#808000">sla_level_name</font>></font>Urgent<font color="#0000FF"></<font color="#808000">sla_level_name</font>></font> <font color="#0000FF"><<font color="#808000">sla</font>></font>-01:56:53<font color="#0000FF"></<font color="#808000">sla</font>></font> <font color="#0000FF"><<font color="#808000">date_created</font>></font>2014-08-26 09:38:29<font color="#0000FF"></<font color="#808000">date_created</font>></font> <font color="#0000FF"><<font color="#808000">date_closed</font>></font>2014-08-26 09:42:36<font color="#0000FF"></<font color="#808000">date_closed</font>></font> <font color="#0000FF"><<font color="#808000">server_date_closed</font>></font>2014-08-26 07:42:36<font color="#0000FF"></<font color="#808000">server_date_closed</font>></font> <font color="#0000FF"><<font color="#808000">date_due</font>></font>2014-08-26 09:39:29<font color="#0000FF"></<font color="#808000">date_due</font>></font> <font color="#0000FF"><<font color="#808000">server_date_due</font>></font>2014-08-26 09:39:29<font color="#0000FF"></<font color="#808000">server_date_due</font>></font> <font color="#0000FF"><<font color="#808000">sla_level_id</font>></font>gtrt7895<font color="#0000FF"></<font color="#808000">sla_level_id</font>></font> <font color="#0000FF"><<font color="#808000">agentid</font>/></font> <font color="#0000FF"><<font color="#808000">agent_firstname</font>/></font> <font color="#0000FF"><<font color="#808000">agent_lastname</font>/></font> <font color="#0000FF"><<font color="#808000">req_contactid</font>></font>2fe9e7c7<font color="#0000FF"></<font color="#808000">req_contactid</font>></font> <font color="#0000FF"><<font color="#808000">req_firstname</font>></font>Customer firstname<font color="#0000FF"></<font color="#808000">req_firstname</font>></font> <font color="#0000FF"><<font color="#808000">req_lastname</font>></font>Customer lastname<font color="#0000FF"></<font color="#808000">req_lastname</font>></font> <font color="#0000FF"></<font color="#808000">slalog</font>></font> <font color="#0000FF"></<font color="#808000">slalogs</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_20287_jsonTab_39613_content"> <pre style="font-size:12px;"> { "response":{ "slalogs":[ { "id":"41355", "conversationid":"bf7b09ae", "code":"code", "departmentid":"XXX-XXXXX-XXX", "department_name":"General", "levelid":"3bd9cf58", "sla_level_name":"Urgent", "sla":"-01:56:53", "date_created":"2014-08-26 09:38:29", "date_closed":"2014-08-26 09:42:36", "server_date_closed":"2014-08-26 07:42:36", "date_due":"2014-08-26 09:39:29", "server_date_due":"2014-08-26 09:39:29", "sla_level_id":"gtrt7895", "agentid":"", "agent_firstname":"", "agent_lastname":"", "req_contactid":"2fe9e7c7", "req_firstname":"Customer firstname", "req_lastname":"Customer lastname" } ] } }</pre> </div> </div> <br /> <br /> <a id="7de037ac421681057d4456260b72a81d"></a> <h3>Ranking agents report</h3> Avaliable from application version: 4.11.3.0<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_79265_generalTab_29344_header">General</div> </li> <li> <div class="headerContent" id="tab_70543_phpTab_23308_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_79265_generalTab_29344_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/reports/ranking?<span style="color:#C94444;">date_from=<i>[value]</i></span>&<span style="color:#C94444;">date_to=<i>[value]</i></span></div> </div> <div class="tabContent" id="tab_70543_phpTab_23308_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>reports<span class="P">/</span>ranking<span class="P">?</span>&date_from<span class="P">=</span>value&date_to<span class="P">=</span>value&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">date_from</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date from (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 00:00:00)</td> </tr> <tr> <td class="returnFieldsTableCellEven">date_to</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Date to (format: YYYY-MM-DD, eg: 2014-01-24 or YYYY-MM-DD HH:MM:SS, e.g. 2014-01-24 23:59:59)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">columns</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Columns (comma delimeted) to be returned (see return fields)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitcount</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitfrom</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Start from specified row number</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent contact identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">contactid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Contact user identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">types</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Comma-separated rating type identifiers (allowed values: W - positive, P - negative)</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">ranks</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">List of agents' ratings</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>ranks</u> has 11 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Rating identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">rankingType</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Rating type (W = positive, P = negative)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">datecreated</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Date created</td> </tr> <tr> <td class="returnFieldsTableCellEven">conversationid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Conversation identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agentcontactid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent identifier</td> </tr> <tr> <td class="returnFieldsTableCellEven">agentEmail</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Agent email</td> </tr> <tr> <td class="returnFieldsTableCellOdd">agent</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Agent full name</td> </tr> <tr> <td class="returnFieldsTableCellEven">contactid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester identifier</td> </tr> <tr> <td class="returnFieldsTableCellOdd">requesterEmail</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Requester email</td> </tr> <tr> <td class="returnFieldsTableCellEven">requester</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Requester full name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">comment</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Rating comment</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_96571_xmlTab_14086_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_72125_jsonTab_39983_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_96571_xmlTab_14086_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">ranks</font>></font> <font color="#0000FF"><<font color="#808000">rank</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>49481<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">rankingType</font>></font>W<font color="#0000FF"></<font color="#808000">rankingType</font>></font> <font color="#0000FF"><<font color="#808000">datecreated</font>></font>2014-08-26 07:06:30<font color="#0000FF"></<font color="#808000">datecreated</font>></font> <font color="#0000FF"><<font color="#808000">conversationid</font>></font>dfr895e3<font color="#0000FF"></<font color="#808000">conversationid</font>></font> <font color="#0000FF"><<font color="#808000">agentcontactid</font>></font>56df98rt<font color="#0000FF"></<font color="#808000">agentcontactid</font>></font> <font color="#0000FF"><<font color="#808000">agentEmail</font>></font>agent@example.com<font color="#0000FF"></<font color="#808000">agentEmail</font>></font> <font color="#0000FF"><<font color="#808000">agent</font>></font>Agent Name<font color="#0000FF"></<font color="#808000">agent</font>></font> <font color="#0000FF"><<font color="#808000">contactid</font>></font>ert889d6<font color="#0000FF"></<font color="#808000">contactid</font>></font> <font color="#0000FF"><<font color="#808000">requesterEmail</font>></font>customer@example.com<font color="#0000FF"></<font color="#808000">requesterEmail</font>></font> <font color="#0000FF"><<font color="#808000">requester</font>></font>Customer Name<font color="#0000FF"></<font color="#808000">requester</font>></font> <font color="#0000FF"><<font color="#808000">comment</font>></font>super<font color="#0000FF"></<font color="#808000">comment</font>></font> <font color="#0000FF"></<font color="#808000">rank</font>></font> <font color="#0000FF"></<font color="#808000">ranks</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_72125_jsonTab_39983_content"> <pre style="font-size:12px;"> { "response":{ "ranks":[ { "id":"49481", "rankingType":"W", "datecreated":"2014-08-26 07:06:30", "conversationid":"dfr895e3", "agentcontactid":"56df98rt", "agentEmail":"agent@example.com", "agent":"Agent Name", "contactid":"ert889d6", "requesterEmail":"customer@example.com", "requester":"Customer Name", "comment":"super" } ] } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_suggestion categories"></a> <h2>Suggestion categories</h2> <br /> <a id="910788e8da771b2708bd0573a2968f82"></a> <h3>Retrieves all suggestion categories</h3> Avaliable from application version: 2.8.2.1<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_64321_generalTab_77470_header">General</div> </li> <li> <div class="headerContent" id="tab_31410_phpTab_45244_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_64321_generalTab_77470_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/suggestioncategories</div> </div> <div class="tabContent" id="tab_31410_phpTab_45244_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>suggestioncategories<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">suggestioncategories</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">List of categories</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>suggestioncategories</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of the category</td> </tr> <tr> <td class="returnFieldsTableCellOdd">title</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Title of the category</td> </tr> <tr> <td class="returnFieldsTableCellEven">path</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Path of the category</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_71331_xmlTab_59888_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_18726_jsonTab_68895_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_71331_xmlTab_59888_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">suggestioncategories</font>></font> <font color="#0000FF"><<font color="#808000">suggestioncategorie</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>15<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>Suggestions<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">path</font>></font>Product1 / Suggestion<font color="#0000FF"></<font color="#808000">path</font>></font> <font color="#0000FF"></<font color="#808000">suggestioncategorie</font>></font> <font color="#0000FF"><<font color="#808000">suggestioncategorie</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>16<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">title</font>></font>Ideas<font color="#0000FF"></<font color="#808000">title</font>></font> <font color="#0000FF"><<font color="#808000">path</font>></font>Product2 / Ideas<font color="#0000FF"></<font color="#808000">path</font>></font> <font color="#0000FF"></<font color="#808000">suggestioncategorie</font>></font> <font color="#0000FF"></<font color="#808000">suggestioncategories</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_18726_jsonTab_68895_content"> <pre style="font-size:12px;"> { "response":{ "suggestioncategories":[ { "id":"15", "title":"Suggestions", "path":"Product1 \/ Suggestion" }, { "id":"16", "title":"Ideas", "path":"Product2 \/ Ideas" } ] } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_tags"></a> <h2>Tags</h2> <br /> <a id="faa75f1d6c3624ba1084fe1e7155e6a0"></a> <h3>Remove tag</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_26493_generalTab_89770_header">General</div> </li> <li> <div class="headerContent" id="tab_78309_phpTab_89000_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_26493_generalTab_89770_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">DELETE</div> http://example.com/api/tags/<span style="color:#5640E6;">[tagid]</span></div> </div> <div class="tabContent" id="tab_78309_phpTab_89000_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>tags<span class="P">/[</span>tagid<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">DELETE</span>"<span class="P">)</span>; <span class="V">$curl_delete_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_delete_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[tagid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Tag ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">OK</td> </tr> <tr> <td class="returnFieldsTableCellEven">statuscode</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_71621_xmlTab_91222_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_25859_jsonTab_53587_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_71621_xmlTab_91222_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_25859_jsonTab_53587_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <a id="9e3c623fae784121b81bdbc478f7e97d"></a> <h3>Retrieve a list of all available tags</h3> Avaliable from application version: 4.0.30.6<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_15635_generalTab_25417_header">General</div> </li> <li> <div class="headerContent" id="tab_94593_phpTab_90360_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_15635_generalTab_25417_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/tags</div> </div> <div class="tabContent" id="tab_94593_phpTab_90360_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>tags<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">tags</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">The list of tags.</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>tags</u> has 2 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">An identifier of the tag.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">A name of the tag.</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_44379_xmlTab_61329_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_57918_jsonTab_18178_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_44379_xmlTab_61329_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">tags</font>></font> <font color="#0000FF"><<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>sh3j<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">tag</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>8sd5<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>Support<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"></<font color="#808000">tag</font>></font> <font color="#0000FF"></<font color="#808000">tags</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_57918_jsonTab_18178_content"> <pre style="font-size:12px;"> { "response":{ "tags":[ { "id":"sh3j", "name":"VIP" }, { "id":"8sd5", "name":"Support" } ] } }</pre> </div> </div> <br /> <br /> <a id="145fa45a529fae562f6167c326717db3"></a> <h3>Retrieve tag info</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_53430_generalTab_46119_header">General</div> </li> <li> <div class="headerContent" id="tab_49705_phpTab_82363_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_53430_generalTab_46119_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/tags/<span style="color:#5640E6;">[tagid]</span></div> </div> <div class="tabContent" id="tab_49705_phpTab_82363_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>tags<span class="P">/[</span>tagid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[tagid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tag ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of tag</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of the tag</td> </tr> <tr> <td class="returnFieldsTableCellEven">color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for title</td> </tr> <tr> <td class="returnFieldsTableCellOdd">bg_color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for background</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_92716_xmlTab_65869_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_53219_jsonTab_58320_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_92716_xmlTab_65869_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>sh3j<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">color</font>></font>FFFFFF<font color="#0000FF"></<font color="#808000">color</font>></font> <font color="#0000FF"><<font color="#808000">bg_color</font>></font>0000FF<font color="#0000FF"></<font color="#808000">bg_color</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_53219_jsonTab_58320_content"> <pre style="font-size:12px;"> { "response":{ "id":"sh3j", "name":"VIP", "color":"FFFFFF", "bg_color":"0000FF" } }</pre> </div> </div> <br /> <br /> <a id="ba8731016f9e887533d0dc10d9b27fb4"></a> <h3>Add tag</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_17564_generalTab_84496_header">General</div> </li> <li> <div class="headerContent" id="tab_92946_phpTab_88322_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_17564_generalTab_84496_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/tags</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_92946_phpTab_88322_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>bg_color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>tags"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Name of the tag</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for name</td> </tr> <tr> <td class="returnFieldsTableCellEven">bg_color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for background</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> <tr> <td class="returnFieldsTableCellEven">id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Id of tag</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of tag</td> </tr> <tr> <td class="returnFieldsTableCellEven">color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">bg_color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for background</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_49853_xmlTab_24278_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_81047_jsonTab_27293_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_49853_xmlTab_24278_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"><<font color="#808000">id</font>></font>sh3j<font color="#0000FF"></<font color="#808000">id</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>VIP<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">color</font>></font>FFFFFF<font color="#0000FF"></<font color="#808000">color</font>></font> <font color="#0000FF"><<font color="#808000">bg_color</font>></font>0000FF<font color="#0000FF"></<font color="#808000">bg_color</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_81047_jsonTab_27293_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":"0", "id":"sh3j", "name":"VIP", "color":"FFFFFF", "bg_color":"0000FF" } }</pre> </div> </div> <br /> <br /> <a id="ff0797a48ee4a651517e155aa0ffff04"></a> <h3>Change tag</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_14171_generalTab_94554_header">General</div> </li> <li> <div class="headerContent" id="tab_86910_phpTab_26845_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_14171_generalTab_94554_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">PUT</div> http://example.com/api/tags/<span style="color:#5640E6;">[tagid]</span></div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as PUT fields.</i></span></div> <div class="tabContent" id="tab_86910_phpTab_26845_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>tags<span class="P">/[</span>tagid<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">PUT</span>"<span class="P">)</span>; <span class="V">$curl_put_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>bg_color<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_put_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">[tagid]</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tag ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Name of the tag</td> </tr> <tr> <td class="returnFieldsTableCellEven">color</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Color for name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">bg_color</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Color for background</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">OK</td> </tr> <tr> <td class="returnFieldsTableCellOdd">statuscode</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Status code of executed request</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_77075_xmlTab_29244_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_70883_jsonTab_71124_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_77075_xmlTab_29244_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>OK<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">statuscode</font>></font>0<font color="#0000FF"></<font color="#808000">statuscode</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_70883_jsonTab_71124_content"> <pre style="font-size:12px;"> { "response":{ "status":"OK", "statuscode":0 } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_widgets"></a> <h2>Widgets</h2> <br /> <a id="828199c9f8e5967e23a170850e4ee794"></a> <h3>Retrieve all widgets</h3> Avaliable from application version: 4.25.2.4<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_20138_generalTab_77424_header">General</div> </li> <li> <div class="headerContent" id="tab_50743_phpTab_78912_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_20138_generalTab_77424_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/widgets</div> </div> <div class="tabContent" id="tab_50743_phpTab_78912_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>widgets<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">provide</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Load widgets by provide</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Load widgets by departmentid</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Load widgets by type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellEven">usecode</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Load widgets by usecode (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Load widgets by status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellEven">limitcount</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Max count of returned rows (Max allowed value is 1000, Default value is 100)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">limitfrom</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Start from specified row number</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">widgets</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Contact widgets list</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>widgets</u> has 23 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">contactwidgetid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget name</td> </tr> <tr> <td class="returnFieldsTableCellEven">provide</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Provides services</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledge base ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellEven">usecode</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Use code (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellEven">description</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Description</td> </tr> <tr> <td class="returnFieldsTableCellOdd">impressions</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Impressions</td> </tr> <tr> <td class="returnFieldsTableCellEven">tickets</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">language</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Language</td> </tr> <tr> <td class="returnFieldsTableCellEven">last_display_time</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Last display time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">last_display_url</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Last display url</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_ieold</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_ieold</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_css</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online CSS code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_ieold_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_css</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline CSS code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_ieold_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">integration_code</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Integration HTML code</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_49341_xmlTab_53379_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_80817_jsonTab_56374_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_49341_xmlTab_53379_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">widgets</font>></font> <font color="#0000FF"><<font color="#808000">widget</font>></font> <font color="#0000FF"><<font color="#808000">contactwidgetid</font>></font>widget1<font color="#0000FF"></<font color="#808000">contactwidgetid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>widget1<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">provide</font>></font>F<font color="#0000FF"></<font color="#808000">provide</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>dep00001<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb00001<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">usecode</font>></font>F<font color="#0000FF"></<font color="#808000">usecode</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>N<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>description of widget no 1<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"><<font color="#808000">impressions</font>></font>0<font color="#0000FF"></<font color="#808000">impressions</font>></font> <font color="#0000FF"><<font color="#808000">tickets</font>></font>0<font color="#0000FF"></<font color="#808000">tickets</font>></font> <font color="#0000FF"><<font color="#808000">language</font>></font>en-US<font color="#0000FF"></<font color="#808000">language</font>></font> <font color="#0000FF"><<font color="#808000">last_display_time</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">last_display_time</font>></font> <font color="#0000FF"><<font color="#808000">last_display_url</font>></font>www.widget01.com<font color="#0000FF"></<font color="#808000">last_display_url</font>></font> <font color="#0000FF"></<font color="#808000">widget</font>></font> <font color="#0000FF"><<font color="#808000">widget</font>></font> <font color="#0000FF"><<font color="#808000">contactwidgetid</font>></font>widget2<font color="#0000FF"></<font color="#808000">contactwidgetid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>widget2<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">provide</font>></font>BFC<font color="#0000FF"></<font color="#808000">provide</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>dep00002<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb00002<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">usecode</font>></font>N<font color="#0000FF"></<font color="#808000">usecode</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>F<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>description of widget no 2<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"><<font color="#808000">impressions</font>></font>0<font color="#0000FF"></<font color="#808000">impressions</font>></font> <font color="#0000FF"><<font color="#808000">tickets</font>></font>0<font color="#0000FF"></<font color="#808000">tickets</font>></font> <font color="#0000FF"><<font color="#808000">language</font>></font>en-US<font color="#0000FF"></<font color="#808000">language</font>></font> <font color="#0000FF"><<font color="#808000">last_display_time</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">last_display_time</font>></font> <font color="#0000FF"><<font color="#808000">last_display_url</font>></font>www.widget2.com<font color="#0000FF"></<font color="#808000">last_display_url</font>></font> <font color="#0000FF"></<font color="#808000">widget</font>></font> <font color="#0000FF"></<font color="#808000">widgets</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_80817_jsonTab_56374_content"> <pre style="font-size:12px;"> { "response":{ "widgets":[ { "contactwidgetid":"widget1", "name":"widget1", "provide":"F", "departmentid":"dep00001", "kb_id":"kb00001", "rtype":"C", "usecode":"F", "status":"N", "description":"description of widget no 1", "impressions":"0", "tickets":"0", "language":"en-US", "last_display_time":"2022-06-13 14:41:41", "last_display_url":"www.widget01.com" }, { "contactwidgetid":"widget2", "name":"widget2", "provide":"BFC", "departmentid":"dep00002", "kb_id":"kb00002", "rtype":"C", "usecode":"N", "status":"F", "description":"description of widget no 2", "impressions":"0", "tickets":"0", "language":"en-US", "last_display_time":"2022-06-13 14:41:41", "last_display_url":"www.widget2.com" } ] } }</pre> </div> </div> <br /> <br /> <a id="f366987dce791a4d3e6226afe688e4ed"></a> <h3>Retrieve widget</h3> Avaliable from application version: 4.25.2.4<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_62994_generalTab_34140_header">General</div> </li> <li> <div class="headerContent" id="tab_98196_phpTab_98818_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_62994_generalTab_34140_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/widgets/<span style="color:#5640E6;">[contactwidgetid]</span></div> </div> <div class="tabContent" id="tab_98196_phpTab_98818_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>widgets<span class="P">/[</span>contactwidgetid<span class="P">]?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[contactwidgetid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd"> </td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">contactwidgetid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget contact id</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">provide</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Provides services</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellEven">usecode</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Usecode (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledge base id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Description</td> </tr> <tr> <td class="returnFieldsTableCellEven">impressions</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Impressions</td> </tr> <tr> <td class="returnFieldsTableCellOdd">tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of created tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">language</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Language</td> </tr> <tr> <td class="returnFieldsTableCellOdd">last_display_time</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Last display time</td> </tr> <tr> <td class="returnFieldsTableCellEven">last_display_url</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Last display url</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online code</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_ieold</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline code</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_ieold</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online CSS code</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_ieold_css</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline CSS code</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_ieold_CSS</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">integration_code</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Integration HTML code</td> </tr> <tr> <td class="returnFieldsTableCellEven">attributes</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Widget attributes</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>attributes</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Attribute name</td> </tr> <tr> <td class="returnFieldsTableCellEven">section</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Attribute section</td> </tr> <tr> <td class="returnFieldsTableCellOdd">value</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Attribute Value</td> </tr> <tr> <td class="returnFieldsTableCellEven">form_fields</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Widget form fields</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>form_fields</u> has 9 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">formid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form id</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field name</td> </tr> <tr> <td class="returnFieldsTableCellEven">description</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field description</td> </tr> <tr> <td class="returnFieldsTableCellOdd">validator</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field validator</td> </tr> <tr> <td class="returnFieldsTableCellEven">visibility</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field visibility</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field type</td> </tr> <tr> <td class="returnFieldsTableCellEven">rstatus</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field status</td> </tr> <tr> <td class="returnFieldsTableCellOdd">availablevalues</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field available values</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_86855_xmlTab_39223_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_26181_jsonTab_90941_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_86855_xmlTab_39223_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">contactwidgetid</font>></font>widget1<font color="#0000FF"></<font color="#808000">contactwidgetid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>widget1<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">provide</font>></font>B<font color="#0000FF"></<font color="#808000">provide</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>dep00002<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">usecode</font>></font>N<font color="#0000FF"></<font color="#808000">usecode</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>F<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb00002<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>description of widget no 1<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"><<font color="#808000">impressions</font>></font>688<font color="#0000FF"></<font color="#808000">impressions</font>></font> <font color="#0000FF"><<font color="#808000">tickets</font>></font>24<font color="#0000FF"></<font color="#808000">tickets</font>></font> <font color="#0000FF"><<font color="#808000">language</font>></font>en-US<font color="#0000FF"></<font color="#808000">language</font>></font> <font color="#0000FF"><<font color="#808000">last_display_time</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">last_display_time</font>></font> <font color="#0000FF"><<font color="#808000">last_display_url</font>></font>www.widget02.com<font color="#0000FF"></<font color="#808000">last_display_url</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[<<font color="#808000">span</font>></font>Example Html online code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">onlinecode</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html online ieold code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">onlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html offline code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">offlinecode</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html offline ieold code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">offlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">onlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_ieold_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">onlinecode_ieold_css</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">offlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_ieold_CSS</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">offlinecode_ieold_CSS</font>></font> <font color="#0000FF"><<font color="#808000">integration_code</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">script</font> <font color="#800080">type</font>=<font color="#FF00FF">"text/javascript"</font>></font> (function(d, src, c) { var t=d.scripts[d.scripts.length - <font color="#800080">1],s=d.createElement('script');s.id</font>=<font color="#FF00FF">'la_x2s6df8d'</font>;s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){var <font color="#800080">rs=this.readyState;if(rs&&(rs!='complete')&&(rs!</font>=<font color="#FF00FF">'loaded'</font>)){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, '//standalone.la.localhost/LiveAgent/server/scripts/track.js', function(e){ LiveAgent.createButton('widget02', e); }); <font color="#0000FF"></<font color="#808000">script></font>]]</font>> <font color="#0000FF"></<font color="#808000">integration_code</font>></font> <font color="#0000FF"><<font color="#808000">attributes</font>/></font> <font color="#0000FF"><<font color="#808000">form_fields</font>/></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_26181_jsonTab_90941_content"> <pre style="font-size:12px;"> { "response":{ "contactwidgetid":"widget1", "name":"widget1", "provide":"B", "departmentid":"dep00002", "rtype":"C", "usecode":"N", "status":"F", "kb_id":"kb00002", "description":"description of widget no 1", "impressions":"688", "tickets":"24", "language":"en-US", "last_display_time":"2022-06-13 14:41:41", "last_display_url":"www.widget02.com", "onlinecode":"<span>Example Html online code<\/span>", "onlinecode_ieold":"<span>Example Html online ieold code<\/span>", "offlinecode":"<span>Example Html offline code<\/span>", "offlinecode_ieold":"<span>Example Html offline ieold code<\/span>", "onlinecode_css":null, "onlinecode_ieold_css":null, "offlinecode_css":null, "offlinecode_ieold_CSS":null, "integration_code":"<script type=\"text\/javascript\">\n(function(d, src, c) { var t=d.scripts[ d.scripts.length - 1 ], s=d.createElement('script');s.id='la_x2s6df8d';s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){ var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){ return; }c(this); };t.parentElement.insertBefore(s, t.nextSibling); })(document, \n'\/\/standalone.la.localhost\/LiveAgent\/server\/scripts\/track.js', \nfunction(e){ LiveAgent.createButton('widget02', e); });\n<\/script>", "attributes":[ ], "form_fields":[ ] } }</pre> </div> </div> <br /> <br /> <a id="d0ad1a4cefb1dbc3afd66538278b8557"></a> <h3>Add widget</h3> Avaliable from application version: 4.25.2.4<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_11362_generalTab_24281_header">General</div> </li> <li> <div class="headerContent" id="tab_46535_phpTab_13356_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_11362_generalTab_24281_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">POST</div> http://example.com/api/widgets</div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as POST fields.</i></span></div> <div class="tabContent" id="tab_46535_phpTab_13356_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; <span class="V">$curl_post_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>provide<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>departmentid<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>rtype<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>usecode<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>status<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>attributes<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>kb_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>description<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>language<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>last_display_time<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>last_display_url<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode_ieold<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode_ieold<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode_ieold_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode_ieold_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>form_fields<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>widgets"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POST</span><span class="P">,</span> <span class="K">true</span><span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span> <span class="V">$curl_post_data</span><span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget name</td> </tr> <tr> <td class="returnFieldsTableCellEven">provide</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Provides services</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">rtype</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">usecode</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Use code (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellEven">attributes</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget attributes</td> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledge base ID</td> </tr> <tr> <td class="returnFieldsTableCellEven">description</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Description</td> </tr> <tr> <td class="returnFieldsTableCellOdd">language</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Language</td> </tr> <tr> <td class="returnFieldsTableCellEven">last_display_time</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Last display time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">last_display_url</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Last display url</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Online code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_ieold</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Online code ieold</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Offline code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_ieold</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Offline code ieold</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_css</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Online CSS code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_ieold_css</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Online CSS code ieold</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_css</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Offline CSS code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_ieold_css</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Offline CSS code ieold</td> </tr> <tr> <td class="returnFieldsTableCellOdd">form_fields</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form fields</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">contactwidgetid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget contact id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget name</td> </tr> <tr> <td class="returnFieldsTableCellEven">provide</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Provides services</td> </tr> <tr> <td class="returnFieldsTableCellOdd">departmentid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department id</td> </tr> <tr> <td class="returnFieldsTableCellEven">rtype</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">usecode</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Usecode (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellEven">status</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">kb_id</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Knowledge base id</td> </tr> <tr> <td class="returnFieldsTableCellEven">description</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Description</td> </tr> <tr> <td class="returnFieldsTableCellOdd">impressions</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Impressions</td> </tr> <tr> <td class="returnFieldsTableCellEven">tickets</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of created tickets</td> </tr> <tr> <td class="returnFieldsTableCellOdd">language</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Language</td> </tr> <tr> <td class="returnFieldsTableCellEven">last_display_time</td> <td class="returnFieldsTableCellEven">datetime</td> <td class="returnFieldsTableCellEven">Last display time</td> </tr> <tr> <td class="returnFieldsTableCellOdd">last_display_url</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Last display url</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_ieold</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_ieold</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_css</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online CSS code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_ieold_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_css</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline CSS code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_ieold_CSS</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellEven">integration_code</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Integration HTML code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">attributes</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Widget attributes</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>attributes</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Attribute name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">section</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Attribute section</td> </tr> <tr> <td class="returnFieldsTableCellEven">value</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Attribute Value</td> </tr> <tr> <td class="returnFieldsTableCellOdd">form_fields</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Widget form fields</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>form_fields</u> has 9 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">formid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">code</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field code</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field description</td> </tr> <tr> <td class="returnFieldsTableCellEven">validator</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field validator</td> </tr> <tr> <td class="returnFieldsTableCellOdd">visibility</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field visibility</td> </tr> <tr> <td class="returnFieldsTableCellEven">rtype</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field type</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rstatus</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field status</td> </tr> <tr> <td class="returnFieldsTableCellEven">availablevalues</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field available values</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_58013_xmlTab_16583_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_70519_jsonTab_51049_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_58013_xmlTab_16583_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">contactwidgetid</font>></font>widget1<font color="#0000FF"></<font color="#808000">contactwidgetid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>widget1<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">provide</font>></font>B<font color="#0000FF"></<font color="#808000">provide</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>dep00002<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">usecode</font>></font>N<font color="#0000FF"></<font color="#808000">usecode</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>F<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb00002<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>description of widget no 1<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"><<font color="#808000">impressions</font>></font>688<font color="#0000FF"></<font color="#808000">impressions</font>></font> <font color="#0000FF"><<font color="#808000">tickets</font>></font>24<font color="#0000FF"></<font color="#808000">tickets</font>></font> <font color="#0000FF"><<font color="#808000">language</font>></font>en-US<font color="#0000FF"></<font color="#808000">language</font>></font> <font color="#0000FF"><<font color="#808000">last_display_time</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">last_display_time</font>></font> <font color="#0000FF"><<font color="#808000">last_display_url</font>></font>www.widget02.com<font color="#0000FF"></<font color="#808000">last_display_url</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[<<font color="#808000">span</font>></font>Example Html online code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">onlinecode</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html online ieold code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">onlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html offline code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">offlinecode</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html offline ieold code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">offlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">onlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_ieold_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">onlinecode_ieold_css</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">offlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_ieold_CSS</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">offlinecode_ieold_CSS</font>></font> <font color="#0000FF"><<font color="#808000">integration_code</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">script</font> <font color="#800080">type</font>=<font color="#FF00FF">"text/javascript"</font>></font> (function(d, src, c) { var t=d.scripts[d.scripts.length - <font color="#800080">1],s=d.createElement('script');s.id</font>=<font color="#FF00FF">'la_x2s6df8d'</font>;s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){var <font color="#800080">rs=this.readyState;if(rs&&(rs!='complete')&&(rs!</font>=<font color="#FF00FF">'loaded'</font>)){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, '//standalone.la.localhost/LiveAgent/server/scripts/track.js', function(e){ LiveAgent.createButton('widget02', e); }); <font color="#0000FF"></<font color="#808000">script></font>]]</font>> <font color="#0000FF"></<font color="#808000">integration_code</font>></font> <font color="#0000FF"><<font color="#808000">attributes</font>/></font> <font color="#0000FF"><<font color="#808000">form_fields</font>/></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_70519_jsonTab_51049_content"> <pre style="font-size:12px;"> { "response":{ "contactwidgetid":"widget1", "name":"widget1", "provide":"B", "departmentid":"dep00002", "rtype":"C", "usecode":"N", "status":"F", "kb_id":"kb00002", "description":"description of widget no 1", "impressions":"688", "tickets":"24", "language":"en-US", "last_display_time":"2022-06-13 14:41:41", "last_display_url":"www.widget02.com", "onlinecode":"<span>Example Html online code<\/span>", "onlinecode_ieold":"<span>Example Html online ieold code<\/span>", "offlinecode":"<span>Example Html offline code<\/span>", "offlinecode_ieold":"<span>Example Html offline ieold code<\/span>", "onlinecode_css":null, "onlinecode_ieold_css":null, "offlinecode_css":null, "offlinecode_ieold_CSS":null, "integration_code":"<script type=\"text\/javascript\">\n(function(d, src, c) { var t=d.scripts[ d.scripts.length - 1 ], s=d.createElement('script');s.id='la_x2s6df8d';s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){ var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){ return; }c(this); };t.parentElement.insertBefore(s, t.nextSibling); })(document, \n'\/\/standalone.la.localhost\/LiveAgent\/server\/scripts\/track.js', \nfunction(e){ LiveAgent.createButton('widget02', e); });\n<\/script>", "attributes":[ ], "form_fields":[ ] } }</pre> </div> </div> <br /> <br /> <a id="2b612690140e52bca6ac77a34b58e400"></a> <h3>Change widget</h3> Avaliable from application version: 4.25.2.4<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_63802_generalTab_49446_header">General</div> </li> <li> <div class="headerContent" id="tab_43465_phpTab_47318_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_63802_generalTab_49446_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">PUT</div> http://example.com/api/widgets/<span style="color:#5640E6;">[contactwidgetid]</span></div> <span style="font-size:14px;"><i>Note: You must <a href="https://support.liveagent.com/061754-How-to-make-REST-calls-in-PHP">send parameters</a> for this call as PUT fields.</i></span></div> <div class="tabContent" id="tab_43465_phpTab_47318_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>widgets<span class="P">/[</span>contactwidgetid<span class="P">]</span>"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_CUSTOMREQUEST</span><span class="P">,</span> "<span class="D">PUT</span>"<span class="P">)</span>; <span class="V">$curl_put_data</span> <span class="P">=</span> <span class="K">array</span><span class="P">(</span> <span class="P">/*</span> These are mandatory params <span class="P">*/</span> <span class="P">'</span>name<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>provide<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>departmentid<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>rtype<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>usecode<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>status<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>attributes<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>form_fields<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>apikey<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">/*</span> <span class="P">...</span>and these are optional <span class="P">*/</span> <span class="P">'</span>kb_id<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>description<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>language<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>last_display_time<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>last_display_url<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode_ieold<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode_ieold<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>onlinecode_ieold_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">'</span>offlinecode_ieold_css<span class="P">'</span> <span class="P">=</span>> <span class="P">'...',</span> <span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span> <span class="D">CURLOPT_POSTFIELDS</span><span class="P">,</span>http_build_query<span class="P">(</span><span class="V">$curl_put_data</span><span class="P">))</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">[contactwidgetid]</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd"> </td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">provide</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Provides services</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellEven">usecode</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Use code (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">attributes</td> <td class="returnFieldsTableCellOdd">json</td> <td class="returnFieldsTableCellOdd">Widget attributes</td> </tr> <tr> <td class="returnFieldsTableCellEven">form_fields</td> <td class="returnFieldsTableCellEven">json</td> <td class="returnFieldsTableCellEven">Widget form fields</td> </tr> <tr> <td class="returnFieldsTableCellOdd">apikey</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledge base ID</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Description</td> </tr> <tr> <td class="returnFieldsTableCellEven">language</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Language</td> </tr> <tr> <td class="returnFieldsTableCellOdd">last_display_time</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Last display time</td> </tr> <tr> <td class="returnFieldsTableCellEven">last_display_url</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Last display url</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Online code</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_ieold</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Online code ieold</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Offline code</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_ieold</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Offline code ieold</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_css</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Online CSS code</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_ieold_css</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Online CSS code ieold</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_css</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Offline CSS code</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_ieold_css</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Offline code CSS ieold</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">contactwidgetid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget contact id</td> </tr> <tr> <td class="returnFieldsTableCellEven">name</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget name</td> </tr> <tr> <td class="returnFieldsTableCellOdd">provide</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Provides services</td> </tr> <tr> <td class="returnFieldsTableCellEven">departmentid</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Department id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Type (Possible values: <i>C</i> - Chat button, <i>O</i> - Contact form, <i>U</i> - Invitation html, <i>M</i> - Invitation image, <i>G</i> - Chat window, <i>B</i> - Contact form, <i>K</i> - Search, <i>W</i> - Knowledge base, <i>S</i> - Suggest button, <i>P</i> - Twilio button)</td> </tr> <tr> <td class="returnFieldsTableCellEven">usecode</td> <td class="returnFieldsTableCellEven">constlist</td> <td class="returnFieldsTableCellEven">Usecode (Possible values: <i>N</i> - Online, <i>F</i> - Offline, <i>B</i> - Both)</td> </tr> <tr> <td class="returnFieldsTableCellOdd">status</td> <td class="returnFieldsTableCellOdd">constlist</td> <td class="returnFieldsTableCellOdd">Status (Possible values: <i>A</i> - Active, <i>C</i> - Create, <i>I</i> - Inactive, <i>F</i> - Offline, <i>N</i> - Online)</td> </tr> <tr> <td class="returnFieldsTableCellEven">kb_id</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Knowledge base id</td> </tr> <tr> <td class="returnFieldsTableCellOdd">description</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Description</td> </tr> <tr> <td class="returnFieldsTableCellEven">impressions</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Impressions</td> </tr> <tr> <td class="returnFieldsTableCellOdd">tickets</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of created tickets</td> </tr> <tr> <td class="returnFieldsTableCellEven">language</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Language</td> </tr> <tr> <td class="returnFieldsTableCellOdd">last_display_time</td> <td class="returnFieldsTableCellOdd">datetime</td> <td class="returnFieldsTableCellOdd">Last display time</td> </tr> <tr> <td class="returnFieldsTableCellEven">last_display_url</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Last display url</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online code</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_ieold</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline code</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_ieold</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">onlinecode_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Online CSS code</td> </tr> <tr> <td class="returnFieldsTableCellEven">onlinecode_ieold_css</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Online CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">offlinecode_css</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Offline CSS code</td> </tr> <tr> <td class="returnFieldsTableCellEven">offlinecode_ieold_CSS</td> <td class="returnFieldsTableCellEven">html</td> <td class="returnFieldsTableCellEven">Offline CSS code for Internet Explorer 9.0 or older.</td> </tr> <tr> <td class="returnFieldsTableCellOdd">integration_code</td> <td class="returnFieldsTableCellOdd">html</td> <td class="returnFieldsTableCellOdd">Integration HTML code</td> </tr> <tr> <td class="returnFieldsTableCellEven">attributes</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Widget attributes</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>attributes</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Attribute name</td> </tr> <tr> <td class="returnFieldsTableCellEven">section</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Attribute section</td> </tr> <tr> <td class="returnFieldsTableCellOdd">value</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Attribute Value</td> </tr> <tr> <td class="returnFieldsTableCellEven">form_fields</td> <td class="returnFieldsTableCellEven">list</td> <td class="returnFieldsTableCellEven">Widget form fields</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>form_fields</u> has 9 columns:</td> </tr> <tr> <td class="returnFieldsTableCellOdd">formid</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form id</td> </tr> <tr> <td class="returnFieldsTableCellEven">code</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field code</td> </tr> <tr> <td class="returnFieldsTableCellOdd">name</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field name</td> </tr> <tr> <td class="returnFieldsTableCellEven">description</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field description</td> </tr> <tr> <td class="returnFieldsTableCellOdd">validator</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field validator</td> </tr> <tr> <td class="returnFieldsTableCellEven">visibility</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field visibility</td> </tr> <tr> <td class="returnFieldsTableCellOdd">rtype</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field type</td> </tr> <tr> <td class="returnFieldsTableCellEven">rstatus</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">Widget form field status</td> </tr> <tr> <td class="returnFieldsTableCellOdd">availablevalues</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Widget form field available values</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_54687_xmlTab_69928_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_85200_jsonTab_64225_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_54687_xmlTab_69928_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">contactwidgetid</font>></font>widget1<font color="#0000FF"></<font color="#808000">contactwidgetid</font>></font> <font color="#0000FF"><<font color="#808000">name</font>></font>widget1<font color="#0000FF"></<font color="#808000">name</font>></font> <font color="#0000FF"><<font color="#808000">provide</font>></font>B<font color="#0000FF"></<font color="#808000">provide</font>></font> <font color="#0000FF"><<font color="#808000">departmentid</font>></font>dep00002<font color="#0000FF"></<font color="#808000">departmentid</font>></font> <font color="#0000FF"><<font color="#808000">rtype</font>></font>C<font color="#0000FF"></<font color="#808000">rtype</font>></font> <font color="#0000FF"><<font color="#808000">usecode</font>></font>N<font color="#0000FF"></<font color="#808000">usecode</font>></font> <font color="#0000FF"><<font color="#808000">status</font>></font>F<font color="#0000FF"></<font color="#808000">status</font>></font> <font color="#0000FF"><<font color="#808000">kb_id</font>></font>kb00002<font color="#0000FF"></<font color="#808000">kb_id</font>></font> <font color="#0000FF"><<font color="#808000">description</font>></font>description of widget no 1<font color="#0000FF"></<font color="#808000">description</font>></font> <font color="#0000FF"><<font color="#808000">impressions</font>></font>688<font color="#0000FF"></<font color="#808000">impressions</font>></font> <font color="#0000FF"><<font color="#808000">tickets</font>></font>24<font color="#0000FF"></<font color="#808000">tickets</font>></font> <font color="#0000FF"><<font color="#808000">language</font>></font>en-US<font color="#0000FF"></<font color="#808000">language</font>></font> <font color="#0000FF"><<font color="#808000">last_display_time</font>></font>2022-06-13 14:41:41<font color="#0000FF"></<font color="#808000">last_display_time</font>></font> <font color="#0000FF"><<font color="#808000">last_display_url</font>></font>www.widget02.com<font color="#0000FF"></<font color="#808000">last_display_url</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[<<font color="#808000">span</font>></font>Example Html online code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">onlinecode</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html online ieold code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">onlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html offline code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">offlinecode</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">span</font>></font>Example Html offline ieold code<font color="#0000FF"></<font color="#808000">span></font>]]</font>> <font color="#0000FF"></<font color="#808000">offlinecode_ieold</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">onlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">onlinecode_ieold_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">onlinecode_ieold_css</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">offlinecode_css</font>></font> <font color="#0000FF"><<font color="#808000">offlinecode_ieold_CSS</font>></font> <font color="#0000FF"><<font color="#808000">!</font><font color="#800080">[CDATA[]]</font>></font> <font color="#0000FF"></<font color="#808000">offlinecode_ieold_CSS</font>></font> <font color="#0000FF"><<font color="#808000">integration_code</font>></font> <font color="#0000FF"><<font color="#808000">!</font>[CDATA[<<font color="#808000">script</font> <font color="#800080">type</font>=<font color="#FF00FF">"text/javascript"</font>></font> (function(d, src, c) { var t=d.scripts[d.scripts.length - <font color="#800080">1],s=d.createElement('script');s.id</font>=<font color="#FF00FF">'la_x2s6df8d'</font>;s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){var <font color="#800080">rs=this.readyState;if(rs&&(rs!='complete')&&(rs!</font>=<font color="#FF00FF">'loaded'</font>)){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, '//standalone.la.localhost/LiveAgent/server/scripts/track.js', function(e){ LiveAgent.createButton('widget02', e); }); <font color="#0000FF"></<font color="#808000">script></font>]]</font>> <font color="#0000FF"></<font color="#808000">integration_code</font>></font> <font color="#0000FF"><<font color="#808000">attributes</font>/></font> <font color="#0000FF"><<font color="#808000">form_fields</font>/></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_85200_jsonTab_64225_content"> <pre style="font-size:12px;"> { "response":{ "contactwidgetid":"widget1", "name":"widget1", "provide":"B", "departmentid":"dep00002", "rtype":"C", "usecode":"N", "status":"F", "kb_id":"kb00002", "description":"description of widget no 1", "impressions":"688", "tickets":"24", "language":"en-US", "last_display_time":"2022-06-13 14:41:41", "last_display_url":"www.widget02.com", "onlinecode":"<span>Example Html online code<\/span>", "onlinecode_ieold":"<span>Example Html online ieold code<\/span>", "offlinecode":"<span>Example Html offline code<\/span>", "offlinecode_ieold":"<span>Example Html offline ieold code<\/span>", "onlinecode_css":null, "onlinecode_ieold_css":null, "offlinecode_css":null, "offlinecode_ieold_CSS":null, "integration_code":"<script type=\"text\/javascript\">\n(function(d, src, c) { var t=d.scripts[ d.scripts.length - 1 ], s=d.createElement('script');s.id='la_x2s6df8d';s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){ var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){ return; }c(this); };t.parentElement.insertBefore(s, t.nextSibling); })(document, \n'\/\/standalone.la.localhost\/LiveAgent\/server\/scripts\/track.js', \nfunction(e){ LiveAgent.createButton('widget02', e); });\n<\/script>", "attributes":[ ], "form_fields":[ ] } }</pre> </div> </div> <br /> <br /> <br /> <a id="apiv1_overview"></a> <h2>Overview</h2> <br /> <a id="79deeb1c61a26be22d9695600faa499a"></a> <h3>Chats</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_84546_generalTab_75248_header">General</div> </li> <li> <div class="headerContent" id="tab_91091_phpTab_37998_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_84546_generalTab_75248_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/chats/overview</div> </div> <div class="tabContent" id="tab_91091_phpTab_37998_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>chats<span class="P">/</span>overview<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">department</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">chatsOverview</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Overview of chats</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>chatsOverview</u> has 5 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">visitors</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of visitors</td> </tr> <tr> <td class="returnFieldsTableCellOdd">chats</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of running chats</td> </tr> <tr> <td class="returnFieldsTableCellEven">ringing</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of ringing chats</td> </tr> <tr> <td class="returnFieldsTableCellOdd">queue</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of chats in queue</td> </tr> <tr> <td class="returnFieldsTableCellEven">agents</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of agents available for chat</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_67433_xmlTab_84567_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_75244_jsonTab_32474_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_67433_xmlTab_84567_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">chatsOverview</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">visitors</font>></font>26<font color="#0000FF"></<font color="#808000">visitors</font>></font> <font color="#0000FF"><<font color="#808000">chats</font>></font>8<font color="#0000FF"></<font color="#808000">chats</font>></font> <font color="#0000FF"><<font color="#808000">ringing</font>></font>2<font color="#0000FF"></<font color="#808000">ringing</font>></font> <font color="#0000FF"><<font color="#808000">queue</font>></font>2<font color="#0000FF"></<font color="#808000">queue</font>></font> <font color="#0000FF"><<font color="#808000">agents</font>></font>5<font color="#0000FF"></<font color="#808000">agents</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">chatsOverview</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_75244_jsonTab_32474_content"> <pre style="font-size:12px;"> { "response":{ "chatsOverview":[ { "visitors":26, "chats":8, "ringing":2, "queue":2, "agents":5 } ] } }</pre> </div> </div> <br /> <br /> <a id="bbcf4edc4ccb1f6cceae13bbb8125d28"></a> <h3>Phone calls</h3> Avaliable from application version: 4.17.1.3<br /> <br /> <b>Example call</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_26360_generalTab_37883_header">General</div> </li> <li> <div class="headerContent" id="tab_42438_phpTab_24818_header">PHP</div> </li> </ul> <div class="tabContent active" id="tab_26360_generalTab_37883_content"> <div class="exampleCallUrl"> <div class="callTypeIcon">GET</div> http://example.com/api/calls/overview</div> </div> <div class="tabContent" id="tab_42438_phpTab_24818_content"> <pre class="phpCode"> <code><<span class="P">?</span>php <span class="V">$ch</span> <span class="P">=</span> curl_init<span class="P">()</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_URL<span class="P">,</span>"http<span class="P">://</span>example<span class="P">.</span>com<span class="P">/</span>api<span class="P">/</span>calls<span class="P">/</span>overview<span class="P">?</span>&apikey<span class="P">=</span>value"<span class="P">)</span>; curl_setopt<span class="P">(</span><span class="V">$ch</span><span class="P">,</span>CURLOPT_RETURNTRANSFER<span class="P">,</span>true<span class="P">)</span>; <span class="V">$curl_response</span><span class="P">=</span>curl_exec<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">if</span> <span class="P">(</span><span class="V">$curl_response</span> <span class="P">===</span> <span class="K">false</span><span class="P">)</span> <span class="P">{</span> <span class="V">$info</span> <span class="P">=</span> curl_error<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="K">die</span><span class="P">(</span>"error occurred during curl exec<span class="P">.</span> Additional info<span class="P">:</span> " <span class="P">.</span> var_export<span class="P">(</span><span class="V">$info</span><span class="P">,</span> <span class="K">true</span><span class="P">))</span>; <span class="P">}</span> curl_close<span class="P">(</span><span class="V">$ch</span><span class="P">)</span>; <span class="P">/*</span> process <span class="V">$curl_response</span> here <span class="P">*/</span> print_r<span class="P">(</span>json_decode<span class="P">(</span><span class="V">$curl_response</span><span class="P">))</span>; </code></pre> </div> </div> <p class="returnFieldsHeader">Mandatory parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellEven">apikey</td> <td class="returnFieldsTableCellEven">text</td> <td class="returnFieldsTableCellEven">API key</td> </tr> </tbody> </table> <p class="returnFieldsHeader">Optional parameters</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">department</td> <td class="returnFieldsTableCellOdd">text</td> <td class="returnFieldsTableCellOdd">Department identifier</td> </tr> </tbody> </table> <br /> <br /> <b>Call response description</b><br /> <p class="returnFieldsHeader">Return fields</p> <table cellpadding="0" cellspacing="0" class="returnFieldsTable"> <tbody> <tr> <th class="returnFieldsTableHeader">Name</th> <th class="returnFieldsTableHeader">Type</th> <th class="returnFieldsTableHeader">Description</th> </tr> <tr> <td class="returnFieldsTableCellOdd">callsOverview</td> <td class="returnFieldsTableCellOdd">list</td> <td class="returnFieldsTableCellOdd">Overview of calls</td> </tr> <tr> <td class="returnFieldsTableFieldHeader" colspan="3">Field <u>callsOverview</u> has 3 columns:</td> </tr> <tr> <td class="returnFieldsTableCellEven">running</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of running calls</td> </tr> <tr> <td class="returnFieldsTableCellOdd">ringing</td> <td class="returnFieldsTableCellOdd">int</td> <td class="returnFieldsTableCellOdd">Number of ringing calls</td> </tr> <tr> <td class="returnFieldsTableCellEven">inqueue</td> <td class="returnFieldsTableCellEven">int</td> <td class="returnFieldsTableCellEven">Number of calls in queue</td> </tr> </tbody> </table> <br /> <b>Example responses</b> <div class="tabsSwitcher"> <ul class="tabsNavigation"> <li> <div class="headerContent active" id="tab_33987_xmlTab_70731_header"> <div class="xmlIcon">XML</div> </div> </li> <li> <div class="headerContent" id="tab_75242_jsonTab_25809_header"> <div class="jsonIcon">JSON</div> </div> </li> </ul> <div class="tabContent active" id="tab_33987_xmlTab_70731_content"> <pre style="font-size:12px;"> <font color="#0000FF"><font color="#800000"><?xml <font color="#800080">version</font>=<font color="#FF00FF">'1.0'</font> <font color="#800080">encoding</font>=<font color="#FF00FF">'utf-8'</font>?></font></font> <font color="#0000FF"><<font color="#808000">response</font>></font> <font color="#0000FF"><<font color="#808000">callsOverview</font>></font> <font color="#0000FF"><<font color="#808000">item</font>></font> <font color="#0000FF"><<font color="#808000">running</font>></font>3<font color="#0000FF"></<font color="#808000">running</font>></font> <font color="#0000FF"><<font color="#808000">ringing</font>></font>1<font color="#0000FF"></<font color="#808000">ringing</font>></font> <font color="#0000FF"><<font color="#808000">inqueue</font>></font>5<font color="#0000FF"></<font color="#808000">inqueue</font>></font> <font color="#0000FF"></<font color="#808000">item</font>></font> <font color="#0000FF"></<font color="#808000">callsOverview</font>></font> <font color="#0000FF"></<font color="#808000">response</font>></font> </pre> </div> <div class="tabContent" id="tab_75242_jsonTab_25809_content"> <pre style="font-size:12px;"> { "response":{ "callsOverview":[ { "running":3, "ringing":1, "inqueue":5 } ] } }</pre> </div> </div> <br /> </div> <script type="text/javascript">document.getElementById("tab_29249_xmlTab_41539_header").addEventListener("click", function () {document.getElementById("tab_29249_xmlTab_41539_header").className += " active"; document.getElementById("tab_29249_xmlTab_41539_content").className += " active"; document.getElementById("tab_72821_jsonTab_71134_header").className = "headerContent"; document.getElementById("tab_72821_jsonTab_71134_content").className = "tabContent"; }) document.getElementById("tab_72821_jsonTab_71134_header").addEventListener("click", function () {document.getElementById("tab_29249_xmlTab_41539_header").className = "headerContent"; document.getElementById("tab_29249_xmlTab_41539_content").className = "tabContent"; document.getElementById("tab_72821_jsonTab_71134_header").className += " active"; document.getElementById("tab_72821_jsonTab_71134_content").className += " active"; }) document.getElementById("tab_20060_generalTab_95305_header").addEventListener("click", function () {document.getElementById("tab_20060_generalTab_95305_header").className += " active"; document.getElementById("tab_20060_generalTab_95305_content").className += " active"; document.getElementById("tab_12680_phpTab_69869_header").className = "headerContent"; document.getElementById("tab_12680_phpTab_69869_content").className = "tabContent"; }) document.getElementById("tab_12680_phpTab_69869_header").addEventListener("click", function () {document.getElementById("tab_20060_generalTab_95305_header").className = "headerContent"; document.getElementById("tab_20060_generalTab_95305_content").className = "tabContent"; document.getElementById("tab_12680_phpTab_69869_header").className += " active"; document.getElementById("tab_12680_phpTab_69869_content").className += " active"; }) document.getElementById("tab_24265_xmlTab_15395_header").addEventListener("click", function () {document.getElementById("tab_24265_xmlTab_15395_header").className += " active"; document.getElementById("tab_24265_xmlTab_15395_content").className += " active"; document.getElementById("tab_74411_jsonTab_13079_header").className = "headerContent"; document.getElementById("tab_74411_jsonTab_13079_content").className = "tabContent"; }) document.getElementById("tab_74411_jsonTab_13079_header").addEventListener("click", function () {document.getElementById("tab_24265_xmlTab_15395_header").className = "headerContent"; document.getElementById("tab_24265_xmlTab_15395_content").className = "tabContent"; document.getElementById("tab_74411_jsonTab_13079_header").className += " active"; document.getElementById("tab_74411_jsonTab_13079_content").className += " active"; }) document.getElementById("tab_25172_generalTab_90193_header").addEventListener("click", function () {document.getElementById("tab_25172_generalTab_90193_header").className += " active"; document.getElementById("tab_25172_generalTab_90193_content").className += " active"; document.getElementById("tab_37615_phpTab_42982_header").className = "headerContent"; document.getElementById("tab_37615_phpTab_42982_content").className = "tabContent"; }) document.getElementById("tab_37615_phpTab_42982_header").addEventListener("click", function () {document.getElementById("tab_25172_generalTab_90193_header").className = "headerContent"; document.getElementById("tab_25172_generalTab_90193_content").className = "tabContent"; document.getElementById("tab_37615_phpTab_42982_header").className += " active"; document.getElementById("tab_37615_phpTab_42982_content").className += " active"; }) document.getElementById("tab_44103_xmlTab_78673_header").addEventListener("click", function () {document.getElementById("tab_44103_xmlTab_78673_header").className += " active"; document.getElementById("tab_44103_xmlTab_78673_content").className += " active"; document.getElementById("tab_46250_jsonTab_62221_header").className = "headerContent"; document.getElementById("tab_46250_jsonTab_62221_content").className = "tabContent"; }) document.getElementById("tab_46250_jsonTab_62221_header").addEventListener("click", function () {document.getElementById("tab_44103_xmlTab_78673_header").className = "headerContent"; document.getElementById("tab_44103_xmlTab_78673_content").className = "tabContent"; document.getElementById("tab_46250_jsonTab_62221_header").className += " active"; document.getElementById("tab_46250_jsonTab_62221_content").className += " active"; }) document.getElementById("tab_28533_generalTab_74148_header").addEventListener("click", function () {document.getElementById("tab_28533_generalTab_74148_header").className += " active"; document.getElementById("tab_28533_generalTab_74148_content").className += " active"; document.getElementById("tab_94719_phpTab_34335_header").className = "headerContent"; document.getElementById("tab_94719_phpTab_34335_content").className = "tabContent"; }) document.getElementById("tab_94719_phpTab_34335_header").addEventListener("click", function () {document.getElementById("tab_28533_generalTab_74148_header").className = "headerContent"; document.getElementById("tab_28533_generalTab_74148_content").className = "tabContent"; document.getElementById("tab_94719_phpTab_34335_header").className += " active"; document.getElementById("tab_94719_phpTab_34335_content").className += " active"; }) document.getElementById("tab_64732_xmlTab_73223_header").addEventListener("click", function () {document.getElementById("tab_64732_xmlTab_73223_header").className += " active"; document.getElementById("tab_64732_xmlTab_73223_content").className += " active"; document.getElementById("tab_50299_jsonTab_95146_header").className = "headerContent"; document.getElementById("tab_50299_jsonTab_95146_content").className = "tabContent"; }) document.getElementById("tab_50299_jsonTab_95146_header").addEventListener("click", function () {document.getElementById("tab_64732_xmlTab_73223_header").className = "headerContent"; document.getElementById("tab_64732_xmlTab_73223_content").className = "tabContent"; document.getElementById("tab_50299_jsonTab_95146_header").className += " active"; document.getElementById("tab_50299_jsonTab_95146_content").className += " active"; }) document.getElementById("tab_74391_generalTab_74969_header").addEventListener("click", function () {document.getElementById("tab_74391_generalTab_74969_header").className += " active"; document.getElementById("tab_74391_generalTab_74969_content").className += " active"; document.getElementById("tab_70004_phpTab_93419_header").className = "headerContent"; document.getElementById("tab_70004_phpTab_93419_content").className = "tabContent"; }) document.getElementById("tab_70004_phpTab_93419_header").addEventListener("click", function () {document.getElementById("tab_74391_generalTab_74969_header").className = "headerContent"; document.getElementById("tab_74391_generalTab_74969_content").className = "tabContent"; document.getElementById("tab_70004_phpTab_93419_header").className += " active"; document.getElementById("tab_70004_phpTab_93419_content").className += " active"; }) document.getElementById("tab_90857_xmlTab_67939_header").addEventListener("click", function () {document.getElementById("tab_90857_xmlTab_67939_header").className += " active"; document.getElementById("tab_90857_xmlTab_67939_content").className += " active"; document.getElementById("tab_14158_jsonTab_39028_header").className = "headerContent"; document.getElementById("tab_14158_jsonTab_39028_content").className = "tabContent"; }) document.getElementById("tab_14158_jsonTab_39028_header").addEventListener("click", function () {document.getElementById("tab_90857_xmlTab_67939_header").className = "headerContent"; document.getElementById("tab_90857_xmlTab_67939_content").className = "tabContent"; document.getElementById("tab_14158_jsonTab_39028_header").className += " active"; document.getElementById("tab_14158_jsonTab_39028_content").className += " active"; }) document.getElementById("tab_37491_generalTab_32554_header").addEventListener("click", function () {document.getElementById("tab_37491_generalTab_32554_header").className += " active"; document.getElementById("tab_37491_generalTab_32554_content").className += " active"; document.getElementById("tab_48556_phpTab_75480_header").className = "headerContent"; document.getElementById("tab_48556_phpTab_75480_content").className = "tabContent"; }) document.getElementById("tab_48556_phpTab_75480_header").addEventListener("click", function () {document.getElementById("tab_37491_generalTab_32554_header").className = "headerContent"; document.getElementById("tab_37491_generalTab_32554_content").className = "tabContent"; document.getElementById("tab_48556_phpTab_75480_header").className += " active"; document.getElementById("tab_48556_phpTab_75480_content").className += " active"; }) document.getElementById("tab_97966_xmlTab_12343_header").addEventListener("click", function () {document.getElementById("tab_97966_xmlTab_12343_header").className += " active"; document.getElementById("tab_97966_xmlTab_12343_content").className += " active"; document.getElementById("tab_18535_jsonTab_30442_header").className = "headerContent"; document.getElementById("tab_18535_jsonTab_30442_content").className = "tabContent"; }) document.getElementById("tab_18535_jsonTab_30442_header").addEventListener("click", function () {document.getElementById("tab_97966_xmlTab_12343_header").className = "headerContent"; document.getElementById("tab_97966_xmlTab_12343_content").className = "tabContent"; document.getElementById("tab_18535_jsonTab_30442_header").className += " active"; document.getElementById("tab_18535_jsonTab_30442_content").className += " active"; }) document.getElementById("tab_81930_generalTab_55721_header").addEventListener("click", function () {document.getElementById("tab_81930_generalTab_55721_header").className += " active"; document.getElementById("tab_81930_generalTab_55721_content").className += " active"; document.getElementById("tab_29504_phpTab_92992_header").className = "headerContent"; document.getElementById("tab_29504_phpTab_92992_content").className = "tabContent"; }) document.getElementById("tab_29504_phpTab_92992_header").addEventListener("click", function () {document.getElementById("tab_81930_generalTab_55721_header").className = "headerContent"; document.getElementById("tab_81930_generalTab_55721_content").className = "tabContent"; document.getElementById("tab_29504_phpTab_92992_header").className += " active"; document.getElementById("tab_29504_phpTab_92992_content").className += " active"; }) document.getElementById("tab_89318_xmlTab_53479_header").addEventListener("click", function () {document.getElementById("tab_89318_xmlTab_53479_header").className += " active"; document.getElementById("tab_89318_xmlTab_53479_content").className += " active"; document.getElementById("tab_19976_jsonTab_63054_header").className = "headerContent"; document.getElementById("tab_19976_jsonTab_63054_content").className = "tabContent"; }) document.getElementById("tab_19976_jsonTab_63054_header").addEventListener("click", function () {document.getElementById("tab_89318_xmlTab_53479_header").className = "headerContent"; document.getElementById("tab_89318_xmlTab_53479_content").className = "tabContent"; document.getElementById("tab_19976_jsonTab_63054_header").className += " active"; document.getElementById("tab_19976_jsonTab_63054_content").className += " active"; }) document.getElementById("tab_45685_generalTab_73302_header").addEventListener("click", function () {document.getElementById("tab_45685_generalTab_73302_header").className += " active"; document.getElementById("tab_45685_generalTab_73302_content").className += " active"; document.getElementById("tab_90270_phpTab_68829_header").className = "headerContent"; document.getElementById("tab_90270_phpTab_68829_content").className = "tabContent"; }) document.getElementById("tab_90270_phpTab_68829_header").addEventListener("click", function () {document.getElementById("tab_45685_generalTab_73302_header").className = "headerContent"; document.getElementById("tab_45685_generalTab_73302_content").className = "tabContent"; document.getElementById("tab_90270_phpTab_68829_header").className += " active"; document.getElementById("tab_90270_phpTab_68829_content").className += " active"; }) document.getElementById("tab_40311_xmlTab_93083_header").addEventListener("click", function () {document.getElementById("tab_40311_xmlTab_93083_header").className += " active"; document.getElementById("tab_40311_xmlTab_93083_content").className += " active"; document.getElementById("tab_86001_jsonTab_46826_header").className = "headerContent"; document.getElementById("tab_86001_jsonTab_46826_content").className = "tabContent"; }) document.getElementById("tab_86001_jsonTab_46826_header").addEventListener("click", function () {document.getElementById("tab_40311_xmlTab_93083_header").className = "headerContent"; document.getElementById("tab_40311_xmlTab_93083_content").className = "tabContent"; document.getElementById("tab_86001_jsonTab_46826_header").className += " active"; document.getElementById("tab_86001_jsonTab_46826_content").className += " active"; }) document.getElementById("tab_50066_generalTab_19547_header").addEventListener("click", function () {document.getElementById("tab_50066_generalTab_19547_header").className += " active"; document.getElementById("tab_50066_generalTab_19547_content").className += " active"; document.getElementById("tab_59272_phpTab_81258_header").className = "headerContent"; document.getElementById("tab_59272_phpTab_81258_content").className = "tabContent"; }) document.getElementById("tab_59272_phpTab_81258_header").addEventListener("click", function () {document.getElementById("tab_50066_generalTab_19547_header").className = "headerContent"; document.getElementById("tab_50066_generalTab_19547_content").className = "tabContent"; document.getElementById("tab_59272_phpTab_81258_header").className += " active"; document.getElementById("tab_59272_phpTab_81258_content").className += " active"; }) document.getElementById("tab_12190_xmlTab_95009_header").addEventListener("click", function () {document.getElementById("tab_12190_xmlTab_95009_header").className += " active"; document.getElementById("tab_12190_xmlTab_95009_content").className += " active"; document.getElementById("tab_73111_jsonTab_33334_header").className = "headerContent"; document.getElementById("tab_73111_jsonTab_33334_content").className = "tabContent"; }) document.getElementById("tab_73111_jsonTab_33334_header").addEventListener("click", function () {document.getElementById("tab_12190_xmlTab_95009_header").className = "headerContent"; document.getElementById("tab_12190_xmlTab_95009_content").className = "tabContent"; document.getElementById("tab_73111_jsonTab_33334_header").className += " active"; document.getElementById("tab_73111_jsonTab_33334_content").className += " active"; }) document.getElementById("tab_34426_generalTab_51010_header").addEventListener("click", function () {document.getElementById("tab_34426_generalTab_51010_header").className += " active"; document.getElementById("tab_34426_generalTab_51010_content").className += " active"; document.getElementById("tab_55758_phpTab_12967_header").className = "headerContent"; document.getElementById("tab_55758_phpTab_12967_content").className = "tabContent"; }) document.getElementById("tab_55758_phpTab_12967_header").addEventListener("click", function () {document.getElementById("tab_34426_generalTab_51010_header").className = "headerContent"; document.getElementById("tab_34426_generalTab_51010_content").className = "tabContent"; document.getElementById("tab_55758_phpTab_12967_header").className += " active"; document.getElementById("tab_55758_phpTab_12967_content").className += " active"; }) document.getElementById("tab_98364_xmlTab_53510_header").addEventListener("click", function () {document.getElementById("tab_98364_xmlTab_53510_header").className += " active"; document.getElementById("tab_98364_xmlTab_53510_content").className += " active"; document.getElementById("tab_14682_jsonTab_60835_header").className = "headerContent"; document.getElementById("tab_14682_jsonTab_60835_content").className = "tabContent"; }) document.getElementById("tab_14682_jsonTab_60835_header").addEventListener("click", function () {document.getElementById("tab_98364_xmlTab_53510_header").className = "headerContent"; document.getElementById("tab_98364_xmlTab_53510_content").className = "tabContent"; document.getElementById("tab_14682_jsonTab_60835_header").className += " active"; document.getElementById("tab_14682_jsonTab_60835_content").className += " active"; }) document.getElementById("tab_56359_generalTab_88398_header").addEventListener("click", function () {document.getElementById("tab_56359_generalTab_88398_header").className += " active"; document.getElementById("tab_56359_generalTab_88398_content").className += " active"; document.getElementById("tab_67131_phpTab_85848_header").className = "headerContent"; document.getElementById("tab_67131_phpTab_85848_content").className = "tabContent"; }) document.getElementById("tab_67131_phpTab_85848_header").addEventListener("click", function () {document.getElementById("tab_56359_generalTab_88398_header").className = "headerContent"; document.getElementById("tab_56359_generalTab_88398_content").className = "tabContent"; document.getElementById("tab_67131_phpTab_85848_header").className += " active"; document.getElementById("tab_67131_phpTab_85848_content").className += " active"; }) document.getElementById("tab_84417_xmlTab_56997_header").addEventListener("click", function () {document.getElementById("tab_84417_xmlTab_56997_header").className += " active"; document.getElementById("tab_84417_xmlTab_56997_content").className += " active"; document.getElementById("tab_11184_jsonTab_48749_header").className = "headerContent"; document.getElementById("tab_11184_jsonTab_48749_content").className = "tabContent"; }) document.getElementById("tab_11184_jsonTab_48749_header").addEventListener("click", function () {document.getElementById("tab_84417_xmlTab_56997_header").className = "headerContent"; document.getElementById("tab_84417_xmlTab_56997_content").className = "tabContent"; document.getElementById("tab_11184_jsonTab_48749_header").className += " active"; document.getElementById("tab_11184_jsonTab_48749_content").className += " active"; }) document.getElementById("tab_56601_generalTab_35178_header").addEventListener("click", function () {document.getElementById("tab_56601_generalTab_35178_header").className += " active"; document.getElementById("tab_56601_generalTab_35178_content").className += " active"; document.getElementById("tab_88394_phpTab_30049_header").className = "headerContent"; document.getElementById("tab_88394_phpTab_30049_content").className = "tabContent"; }) document.getElementById("tab_88394_phpTab_30049_header").addEventListener("click", function () {document.getElementById("tab_56601_generalTab_35178_header").className = "headerContent"; document.getElementById("tab_56601_generalTab_35178_content").className = "tabContent"; document.getElementById("tab_88394_phpTab_30049_header").className += " active"; document.getElementById("tab_88394_phpTab_30049_content").className += " active"; }) document.getElementById("tab_91570_xmlTab_65810_header").addEventListener("click", function () {document.getElementById("tab_91570_xmlTab_65810_header").className += " active"; document.getElementById("tab_91570_xmlTab_65810_content").className += " active"; document.getElementById("tab_28588_jsonTab_70571_header").className = "headerContent"; document.getElementById("tab_28588_jsonTab_70571_content").className = "tabContent"; }) document.getElementById("tab_28588_jsonTab_70571_header").addEventListener("click", function () {document.getElementById("tab_91570_xmlTab_65810_header").className = "headerContent"; document.getElementById("tab_91570_xmlTab_65810_content").className = "tabContent"; document.getElementById("tab_28588_jsonTab_70571_header").className += " active"; document.getElementById("tab_28588_jsonTab_70571_content").className += " active"; }) document.getElementById("tab_86657_generalTab_97128_header").addEventListener("click", function () {document.getElementById("tab_86657_generalTab_97128_header").className += " active"; document.getElementById("tab_86657_generalTab_97128_content").className += " active"; document.getElementById("tab_73627_phpTab_66271_header").className = "headerContent"; document.getElementById("tab_73627_phpTab_66271_content").className = "tabContent"; }) document.getElementById("tab_73627_phpTab_66271_header").addEventListener("click", function () {document.getElementById("tab_86657_generalTab_97128_header").className = "headerContent"; document.getElementById("tab_86657_generalTab_97128_content").className = "tabContent"; document.getElementById("tab_73627_phpTab_66271_header").className += " active"; document.getElementById("tab_73627_phpTab_66271_content").className += " active"; }) document.getElementById("tab_16620_xmlTab_33346_header").addEventListener("click", function () {document.getElementById("tab_16620_xmlTab_33346_header").className += " active"; document.getElementById("tab_16620_xmlTab_33346_content").className += " active"; document.getElementById("tab_97573_jsonTab_27459_header").className = "headerContent"; document.getElementById("tab_97573_jsonTab_27459_content").className = "tabContent"; }) document.getElementById("tab_97573_jsonTab_27459_header").addEventListener("click", function () {document.getElementById("tab_16620_xmlTab_33346_header").className = "headerContent"; document.getElementById("tab_16620_xmlTab_33346_content").className = "tabContent"; document.getElementById("tab_97573_jsonTab_27459_header").className += " active"; document.getElementById("tab_97573_jsonTab_27459_content").className += " active"; }) document.getElementById("tab_35510_generalTab_50694_header").addEventListener("click", function () {document.getElementById("tab_35510_generalTab_50694_header").className += " active"; document.getElementById("tab_35510_generalTab_50694_content").className += " active"; document.getElementById("tab_27402_phpTab_28559_header").className = "headerContent"; document.getElementById("tab_27402_phpTab_28559_content").className = "tabContent"; }) document.getElementById("tab_27402_phpTab_28559_header").addEventListener("click", function () {document.getElementById("tab_35510_generalTab_50694_header").className = "headerContent"; document.getElementById("tab_35510_generalTab_50694_content").className = "tabContent"; document.getElementById("tab_27402_phpTab_28559_header").className += " active"; document.getElementById("tab_27402_phpTab_28559_content").className += " active"; }) document.getElementById("tab_63429_xmlTab_16629_header").addEventListener("click", function () {document.getElementById("tab_63429_xmlTab_16629_header").className += " active"; document.getElementById("tab_63429_xmlTab_16629_content").className += " active"; document.getElementById("tab_51944_jsonTab_93886_header").className = "headerContent"; document.getElementById("tab_51944_jsonTab_93886_content").className = "tabContent"; }) document.getElementById("tab_51944_jsonTab_93886_header").addEventListener("click", function () {document.getElementById("tab_63429_xmlTab_16629_header").className = "headerContent"; document.getElementById("tab_63429_xmlTab_16629_content").className = "tabContent"; document.getElementById("tab_51944_jsonTab_93886_header").className += " active"; document.getElementById("tab_51944_jsonTab_93886_content").className += " active"; }) document.getElementById("tab_76726_generalTab_30734_header").addEventListener("click", function () {document.getElementById("tab_76726_generalTab_30734_header").className += " active"; document.getElementById("tab_76726_generalTab_30734_content").className += " active"; document.getElementById("tab_13944_phpTab_79268_header").className = "headerContent"; document.getElementById("tab_13944_phpTab_79268_content").className = "tabContent"; }) document.getElementById("tab_13944_phpTab_79268_header").addEventListener("click", function () {document.getElementById("tab_76726_generalTab_30734_header").className = "headerContent"; document.getElementById("tab_76726_generalTab_30734_content").className = "tabContent"; document.getElementById("tab_13944_phpTab_79268_header").className += " active"; document.getElementById("tab_13944_phpTab_79268_content").className += " active"; }) document.getElementById("tab_88862_xmlTab_16732_header").addEventListener("click", function () {document.getElementById("tab_88862_xmlTab_16732_header").className += " active"; document.getElementById("tab_88862_xmlTab_16732_content").className += " active"; document.getElementById("tab_37674_jsonTab_36534_header").className = "headerContent"; document.getElementById("tab_37674_jsonTab_36534_content").className = "tabContent"; }) document.getElementById("tab_37674_jsonTab_36534_header").addEventListener("click", function () {document.getElementById("tab_88862_xmlTab_16732_header").className = "headerContent"; document.getElementById("tab_88862_xmlTab_16732_content").className = "tabContent"; document.getElementById("tab_37674_jsonTab_36534_header").className += " active"; document.getElementById("tab_37674_jsonTab_36534_content").className += " active"; }) document.getElementById("tab_41851_generalTab_65995_header").addEventListener("click", function () {document.getElementById("tab_41851_generalTab_65995_header").className += " active"; document.getElementById("tab_41851_generalTab_65995_content").className += " active"; document.getElementById("tab_80192_phpTab_99295_header").className = "headerContent"; document.getElementById("tab_80192_phpTab_99295_content").className = "tabContent"; }) document.getElementById("tab_80192_phpTab_99295_header").addEventListener("click", function () {document.getElementById("tab_41851_generalTab_65995_header").className = "headerContent"; document.getElementById("tab_41851_generalTab_65995_content").className = "tabContent"; document.getElementById("tab_80192_phpTab_99295_header").className += " active"; document.getElementById("tab_80192_phpTab_99295_content").className += " active"; }) document.getElementById("tab_26283_xmlTab_17448_header").addEventListener("click", function () {document.getElementById("tab_26283_xmlTab_17448_header").className += " active"; document.getElementById("tab_26283_xmlTab_17448_content").className += " active"; document.getElementById("tab_65790_jsonTab_48219_header").className = "headerContent"; document.getElementById("tab_65790_jsonTab_48219_content").className = "tabContent"; }) document.getElementById("tab_65790_jsonTab_48219_header").addEventListener("click", function () {document.getElementById("tab_26283_xmlTab_17448_header").className = "headerContent"; document.getElementById("tab_26283_xmlTab_17448_content").className = "tabContent"; document.getElementById("tab_65790_jsonTab_48219_header").className += " active"; document.getElementById("tab_65790_jsonTab_48219_content").className += " active"; }) document.getElementById("tab_87531_generalTab_82403_header").addEventListener("click", function () {document.getElementById("tab_87531_generalTab_82403_header").className += " active"; document.getElementById("tab_87531_generalTab_82403_content").className += " active"; document.getElementById("tab_71213_phpTab_99431_header").className = "headerContent"; document.getElementById("tab_71213_phpTab_99431_content").className = "tabContent"; }) document.getElementById("tab_71213_phpTab_99431_header").addEventListener("click", function () {document.getElementById("tab_87531_generalTab_82403_header").className = "headerContent"; document.getElementById("tab_87531_generalTab_82403_content").className = "tabContent"; document.getElementById("tab_71213_phpTab_99431_header").className += " active"; document.getElementById("tab_71213_phpTab_99431_content").className += " active"; }) document.getElementById("tab_75306_xmlTab_89231_header").addEventListener("click", function () {document.getElementById("tab_75306_xmlTab_89231_header").className += " active"; document.getElementById("tab_75306_xmlTab_89231_content").className += " active"; document.getElementById("tab_87663_jsonTab_40749_header").className = "headerContent"; document.getElementById("tab_87663_jsonTab_40749_content").className = "tabContent"; }) document.getElementById("tab_87663_jsonTab_40749_header").addEventListener("click", function () {document.getElementById("tab_75306_xmlTab_89231_header").className = "headerContent"; document.getElementById("tab_75306_xmlTab_89231_content").className = "tabContent"; document.getElementById("tab_87663_jsonTab_40749_header").className += " active"; document.getElementById("tab_87663_jsonTab_40749_content").className += " active"; }) document.getElementById("tab_83522_generalTab_75016_header").addEventListener("click", function () {document.getElementById("tab_83522_generalTab_75016_header").className += " active"; document.getElementById("tab_83522_generalTab_75016_content").className += " active"; document.getElementById("tab_98771_phpTab_95157_header").className = "headerContent"; document.getElementById("tab_98771_phpTab_95157_content").className = "tabContent"; }) document.getElementById("tab_98771_phpTab_95157_header").addEventListener("click", function () {document.getElementById("tab_83522_generalTab_75016_header").className = "headerContent"; document.getElementById("tab_83522_generalTab_75016_content").className = "tabContent"; document.getElementById("tab_98771_phpTab_95157_header").className += " active"; document.getElementById("tab_98771_phpTab_95157_content").className += " active"; }) document.getElementById("tab_34876_xmlTab_84742_header").addEventListener("click", function () {document.getElementById("tab_34876_xmlTab_84742_header").className += " active"; document.getElementById("tab_34876_xmlTab_84742_content").className += " active"; document.getElementById("tab_78686_jsonTab_67913_header").className = "headerContent"; document.getElementById("tab_78686_jsonTab_67913_content").className = "tabContent"; }) document.getElementById("tab_78686_jsonTab_67913_header").addEventListener("click", function () {document.getElementById("tab_34876_xmlTab_84742_header").className = "headerContent"; document.getElementById("tab_34876_xmlTab_84742_content").className = "tabContent"; document.getElementById("tab_78686_jsonTab_67913_header").className += " active"; document.getElementById("tab_78686_jsonTab_67913_content").className += " active"; }) document.getElementById("tab_40843_generalTab_71004_header").addEventListener("click", function () {document.getElementById("tab_40843_generalTab_71004_header").className += " active"; document.getElementById("tab_40843_generalTab_71004_content").className += " active"; document.getElementById("tab_63070_phpTab_16067_header").className = "headerContent"; document.getElementById("tab_63070_phpTab_16067_content").className = "tabContent"; }) document.getElementById("tab_63070_phpTab_16067_header").addEventListener("click", function () {document.getElementById("tab_40843_generalTab_71004_header").className = "headerContent"; document.getElementById("tab_40843_generalTab_71004_content").className = "tabContent"; document.getElementById("tab_63070_phpTab_16067_header").className += " active"; document.getElementById("tab_63070_phpTab_16067_content").className += " active"; }) document.getElementById("tab_51527_xmlTab_70106_header").addEventListener("click", function () {document.getElementById("tab_51527_xmlTab_70106_header").className += " active"; document.getElementById("tab_51527_xmlTab_70106_content").className += " active"; document.getElementById("tab_78311_jsonTab_14974_header").className = "headerContent"; document.getElementById("tab_78311_jsonTab_14974_content").className = "tabContent"; }) document.getElementById("tab_78311_jsonTab_14974_header").addEventListener("click", function () {document.getElementById("tab_51527_xmlTab_70106_header").className = "headerContent"; document.getElementById("tab_51527_xmlTab_70106_content").className = "tabContent"; document.getElementById("tab_78311_jsonTab_14974_header").className += " active"; document.getElementById("tab_78311_jsonTab_14974_content").className += " active"; }) document.getElementById("tab_48495_generalTab_61005_header").addEventListener("click", function () {document.getElementById("tab_48495_generalTab_61005_header").className += " active"; document.getElementById("tab_48495_generalTab_61005_content").className += " active"; document.getElementById("tab_92113_phpTab_87617_header").className = "headerContent"; document.getElementById("tab_92113_phpTab_87617_content").className = "tabContent"; }) document.getElementById("tab_92113_phpTab_87617_header").addEventListener("click", function () {document.getElementById("tab_48495_generalTab_61005_header").className = "headerContent"; document.getElementById("tab_48495_generalTab_61005_content").className = "tabContent"; document.getElementById("tab_92113_phpTab_87617_header").className += " active"; document.getElementById("tab_92113_phpTab_87617_content").className += " active"; }) document.getElementById("tab_59978_xmlTab_54922_header").addEventListener("click", function () {document.getElementById("tab_59978_xmlTab_54922_header").className += " active"; document.getElementById("tab_59978_xmlTab_54922_content").className += " active"; document.getElementById("tab_70931_jsonTab_47008_header").className = "headerContent"; document.getElementById("tab_70931_jsonTab_47008_content").className = "tabContent"; }) document.getElementById("tab_70931_jsonTab_47008_header").addEventListener("click", function () {document.getElementById("tab_59978_xmlTab_54922_header").className = "headerContent"; document.getElementById("tab_59978_xmlTab_54922_content").className = "tabContent"; document.getElementById("tab_70931_jsonTab_47008_header").className += " active"; document.getElementById("tab_70931_jsonTab_47008_content").className += " active"; }) document.getElementById("tab_57767_generalTab_75918_header").addEventListener("click", function () {document.getElementById("tab_57767_generalTab_75918_header").className += " active"; document.getElementById("tab_57767_generalTab_75918_content").className += " active"; document.getElementById("tab_95278_phpTab_50744_header").className = "headerContent"; document.getElementById("tab_95278_phpTab_50744_content").className = "tabContent"; }) document.getElementById("tab_95278_phpTab_50744_header").addEventListener("click", function () {document.getElementById("tab_57767_generalTab_75918_header").className = "headerContent"; document.getElementById("tab_57767_generalTab_75918_content").className = "tabContent"; document.getElementById("tab_95278_phpTab_50744_header").className += " active"; document.getElementById("tab_95278_phpTab_50744_content").className += " active"; }) document.getElementById("tab_80966_xmlTab_18863_header").addEventListener("click", function () {document.getElementById("tab_80966_xmlTab_18863_header").className += " active"; document.getElementById("tab_80966_xmlTab_18863_content").className += " active"; document.getElementById("tab_25798_jsonTab_85518_header").className = "headerContent"; document.getElementById("tab_25798_jsonTab_85518_content").className = "tabContent"; }) document.getElementById("tab_25798_jsonTab_85518_header").addEventListener("click", function () {document.getElementById("tab_80966_xmlTab_18863_header").className = "headerContent"; document.getElementById("tab_80966_xmlTab_18863_content").className = "tabContent"; document.getElementById("tab_25798_jsonTab_85518_header").className += " active"; document.getElementById("tab_25798_jsonTab_85518_content").className += " active"; }) document.getElementById("tab_88236_generalTab_50345_header").addEventListener("click", function () {document.getElementById("tab_88236_generalTab_50345_header").className += " active"; document.getElementById("tab_88236_generalTab_50345_content").className += " active"; document.getElementById("tab_44024_phpTab_86705_header").className = "headerContent"; document.getElementById("tab_44024_phpTab_86705_content").className = "tabContent"; }) document.getElementById("tab_44024_phpTab_86705_header").addEventListener("click", function () {document.getElementById("tab_88236_generalTab_50345_header").className = "headerContent"; document.getElementById("tab_88236_generalTab_50345_content").className = "tabContent"; document.getElementById("tab_44024_phpTab_86705_header").className += " active"; document.getElementById("tab_44024_phpTab_86705_content").className += " active"; }) document.getElementById("tab_28673_xmlTab_40734_header").addEventListener("click", function () {document.getElementById("tab_28673_xmlTab_40734_header").className += " active"; document.getElementById("tab_28673_xmlTab_40734_content").className += " active"; document.getElementById("tab_41380_jsonTab_69390_header").className = "headerContent"; document.getElementById("tab_41380_jsonTab_69390_content").className = "tabContent"; }) document.getElementById("tab_41380_jsonTab_69390_header").addEventListener("click", function () {document.getElementById("tab_28673_xmlTab_40734_header").className = "headerContent"; document.getElementById("tab_28673_xmlTab_40734_content").className = "tabContent"; document.getElementById("tab_41380_jsonTab_69390_header").className += " active"; document.getElementById("tab_41380_jsonTab_69390_content").className += " active"; }) document.getElementById("tab_15003_generalTab_68441_header").addEventListener("click", function () {document.getElementById("tab_15003_generalTab_68441_header").className += " active"; document.getElementById("tab_15003_generalTab_68441_content").className += " active"; document.getElementById("tab_56481_phpTab_87586_header").className = "headerContent"; document.getElementById("tab_56481_phpTab_87586_content").className = "tabContent"; }) document.getElementById("tab_56481_phpTab_87586_header").addEventListener("click", function () {document.getElementById("tab_15003_generalTab_68441_header").className = "headerContent"; document.getElementById("tab_15003_generalTab_68441_content").className = "tabContent"; document.getElementById("tab_56481_phpTab_87586_header").className += " active"; document.getElementById("tab_56481_phpTab_87586_content").className += " active"; }) document.getElementById("tab_31340_xmlTab_54746_header").addEventListener("click", function () {document.getElementById("tab_31340_xmlTab_54746_header").className += " active"; document.getElementById("tab_31340_xmlTab_54746_content").className += " active"; document.getElementById("tab_56859_jsonTab_12704_header").className = "headerContent"; document.getElementById("tab_56859_jsonTab_12704_content").className = "tabContent"; }) document.getElementById("tab_56859_jsonTab_12704_header").addEventListener("click", function () {document.getElementById("tab_31340_xmlTab_54746_header").className = "headerContent"; document.getElementById("tab_31340_xmlTab_54746_content").className = "tabContent"; document.getElementById("tab_56859_jsonTab_12704_header").className += " active"; document.getElementById("tab_56859_jsonTab_12704_content").className += " active"; }) document.getElementById("tab_54494_generalTab_17281_header").addEventListener("click", function () {document.getElementById("tab_54494_generalTab_17281_header").className += " active"; document.getElementById("tab_54494_generalTab_17281_content").className += " active"; document.getElementById("tab_49122_phpTab_45983_header").className = "headerContent"; document.getElementById("tab_49122_phpTab_45983_content").className = "tabContent"; }) document.getElementById("tab_49122_phpTab_45983_header").addEventListener("click", function () {document.getElementById("tab_54494_generalTab_17281_header").className = "headerContent"; document.getElementById("tab_54494_generalTab_17281_content").className = "tabContent"; document.getElementById("tab_49122_phpTab_45983_header").className += " active"; document.getElementById("tab_49122_phpTab_45983_content").className += " active"; }) document.getElementById("tab_94912_xmlTab_44576_header").addEventListener("click", function () {document.getElementById("tab_94912_xmlTab_44576_header").className += " active"; document.getElementById("tab_94912_xmlTab_44576_content").className += " active"; document.getElementById("tab_54949_jsonTab_95427_header").className = "headerContent"; document.getElementById("tab_54949_jsonTab_95427_content").className = "tabContent"; }) document.getElementById("tab_54949_jsonTab_95427_header").addEventListener("click", function () {document.getElementById("tab_94912_xmlTab_44576_header").className = "headerContent"; document.getElementById("tab_94912_xmlTab_44576_content").className = "tabContent"; document.getElementById("tab_54949_jsonTab_95427_header").className += " active"; document.getElementById("tab_54949_jsonTab_95427_content").className += " active"; }) document.getElementById("tab_11117_generalTab_51262_header").addEventListener("click", function () {document.getElementById("tab_11117_generalTab_51262_header").className += " active"; document.getElementById("tab_11117_generalTab_51262_content").className += " active"; document.getElementById("tab_73005_phpTab_92983_header").className = "headerContent"; document.getElementById("tab_73005_phpTab_92983_content").className = "tabContent"; }) document.getElementById("tab_73005_phpTab_92983_header").addEventListener("click", function () {document.getElementById("tab_11117_generalTab_51262_header").className = "headerContent"; document.getElementById("tab_11117_generalTab_51262_content").className = "tabContent"; document.getElementById("tab_73005_phpTab_92983_header").className += " active"; document.getElementById("tab_73005_phpTab_92983_content").className += " active"; }) document.getElementById("tab_20281_xmlTab_42778_header").addEventListener("click", function () {document.getElementById("tab_20281_xmlTab_42778_header").className += " active"; document.getElementById("tab_20281_xmlTab_42778_content").className += " active"; document.getElementById("tab_83499_jsonTab_19501_header").className = "headerContent"; document.getElementById("tab_83499_jsonTab_19501_content").className = "tabContent"; }) document.getElementById("tab_83499_jsonTab_19501_header").addEventListener("click", function () {document.getElementById("tab_20281_xmlTab_42778_header").className = "headerContent"; document.getElementById("tab_20281_xmlTab_42778_content").className = "tabContent"; document.getElementById("tab_83499_jsonTab_19501_header").className += " active"; document.getElementById("tab_83499_jsonTab_19501_content").className += " active"; }) document.getElementById("tab_12738_generalTab_39653_header").addEventListener("click", function () {document.getElementById("tab_12738_generalTab_39653_header").className += " active"; document.getElementById("tab_12738_generalTab_39653_content").className += " active"; document.getElementById("tab_35974_phpTab_85012_header").className = "headerContent"; document.getElementById("tab_35974_phpTab_85012_content").className = "tabContent"; }) document.getElementById("tab_35974_phpTab_85012_header").addEventListener("click", function () {document.getElementById("tab_12738_generalTab_39653_header").className = "headerContent"; document.getElementById("tab_12738_generalTab_39653_content").className = "tabContent"; document.getElementById("tab_35974_phpTab_85012_header").className += " active"; document.getElementById("tab_35974_phpTab_85012_content").className += " active"; }) document.getElementById("tab_40282_xmlTab_56312_header").addEventListener("click", function () {document.getElementById("tab_40282_xmlTab_56312_header").className += " active"; document.getElementById("tab_40282_xmlTab_56312_content").className += " active"; document.getElementById("tab_44879_jsonTab_49894_header").className = "headerContent"; document.getElementById("tab_44879_jsonTab_49894_content").className = "tabContent"; }) document.getElementById("tab_44879_jsonTab_49894_header").addEventListener("click", function () {document.getElementById("tab_40282_xmlTab_56312_header").className = "headerContent"; document.getElementById("tab_40282_xmlTab_56312_content").className = "tabContent"; document.getElementById("tab_44879_jsonTab_49894_header").className += " active"; document.getElementById("tab_44879_jsonTab_49894_content").className += " active"; }) document.getElementById("tab_42205_generalTab_99766_header").addEventListener("click", function () {document.getElementById("tab_42205_generalTab_99766_header").className += " active"; document.getElementById("tab_42205_generalTab_99766_content").className += " active"; document.getElementById("tab_90708_phpTab_91382_header").className = "headerContent"; document.getElementById("tab_90708_phpTab_91382_content").className = "tabContent"; }) document.getElementById("tab_90708_phpTab_91382_header").addEventListener("click", function () {document.getElementById("tab_42205_generalTab_99766_header").className = "headerContent"; document.getElementById("tab_42205_generalTab_99766_content").className = "tabContent"; document.getElementById("tab_90708_phpTab_91382_header").className += " active"; document.getElementById("tab_90708_phpTab_91382_content").className += " active"; }) document.getElementById("tab_46806_xmlTab_85592_header").addEventListener("click", function () {document.getElementById("tab_46806_xmlTab_85592_header").className += " active"; document.getElementById("tab_46806_xmlTab_85592_content").className += " active"; document.getElementById("tab_21660_jsonTab_28210_header").className = "headerContent"; document.getElementById("tab_21660_jsonTab_28210_content").className = "tabContent"; }) document.getElementById("tab_21660_jsonTab_28210_header").addEventListener("click", function () {document.getElementById("tab_46806_xmlTab_85592_header").className = "headerContent"; document.getElementById("tab_46806_xmlTab_85592_content").className = "tabContent"; document.getElementById("tab_21660_jsonTab_28210_header").className += " active"; document.getElementById("tab_21660_jsonTab_28210_content").className += " active"; }) document.getElementById("tab_16688_generalTab_46727_header").addEventListener("click", function () {document.getElementById("tab_16688_generalTab_46727_header").className += " active"; document.getElementById("tab_16688_generalTab_46727_content").className += " active"; document.getElementById("tab_29529_phpTab_19367_header").className = "headerContent"; document.getElementById("tab_29529_phpTab_19367_content").className = "tabContent"; }) document.getElementById("tab_29529_phpTab_19367_header").addEventListener("click", function () {document.getElementById("tab_16688_generalTab_46727_header").className = "headerContent"; document.getElementById("tab_16688_generalTab_46727_content").className = "tabContent"; document.getElementById("tab_29529_phpTab_19367_header").className += " active"; document.getElementById("tab_29529_phpTab_19367_content").className += " active"; }) document.getElementById("tab_32669_xmlTab_92333_header").addEventListener("click", function () {document.getElementById("tab_32669_xmlTab_92333_header").className += " active"; document.getElementById("tab_32669_xmlTab_92333_content").className += " active"; document.getElementById("tab_61074_jsonTab_54545_header").className = "headerContent"; document.getElementById("tab_61074_jsonTab_54545_content").className = "tabContent"; }) document.getElementById("tab_61074_jsonTab_54545_header").addEventListener("click", function () {document.getElementById("tab_32669_xmlTab_92333_header").className = "headerContent"; document.getElementById("tab_32669_xmlTab_92333_content").className = "tabContent"; document.getElementById("tab_61074_jsonTab_54545_header").className += " active"; document.getElementById("tab_61074_jsonTab_54545_content").className += " active"; }) document.getElementById("tab_26257_generalTab_94359_header").addEventListener("click", function () {document.getElementById("tab_26257_generalTab_94359_header").className += " active"; document.getElementById("tab_26257_generalTab_94359_content").className += " active"; document.getElementById("tab_97728_phpTab_60406_header").className = "headerContent"; document.getElementById("tab_97728_phpTab_60406_content").className = "tabContent"; }) document.getElementById("tab_97728_phpTab_60406_header").addEventListener("click", function () {document.getElementById("tab_26257_generalTab_94359_header").className = "headerContent"; document.getElementById("tab_26257_generalTab_94359_content").className = "tabContent"; document.getElementById("tab_97728_phpTab_60406_header").className += " active"; document.getElementById("tab_97728_phpTab_60406_content").className += " active"; }) document.getElementById("tab_32621_xmlTab_68080_header").addEventListener("click", function () {document.getElementById("tab_32621_xmlTab_68080_header").className += " active"; document.getElementById("tab_32621_xmlTab_68080_content").className += " active"; document.getElementById("tab_61008_jsonTab_26306_header").className = "headerContent"; document.getElementById("tab_61008_jsonTab_26306_content").className = "tabContent"; }) document.getElementById("tab_61008_jsonTab_26306_header").addEventListener("click", function () {document.getElementById("tab_32621_xmlTab_68080_header").className = "headerContent"; document.getElementById("tab_32621_xmlTab_68080_content").className = "tabContent"; document.getElementById("tab_61008_jsonTab_26306_header").className += " active"; document.getElementById("tab_61008_jsonTab_26306_content").className += " active"; }) document.getElementById("tab_85252_generalTab_80894_header").addEventListener("click", function () {document.getElementById("tab_85252_generalTab_80894_header").className += " active"; document.getElementById("tab_85252_generalTab_80894_content").className += " active"; document.getElementById("tab_58122_phpTab_60526_header").className = "headerContent"; document.getElementById("tab_58122_phpTab_60526_content").className = "tabContent"; }) document.getElementById("tab_58122_phpTab_60526_header").addEventListener("click", function () {document.getElementById("tab_85252_generalTab_80894_header").className = "headerContent"; document.getElementById("tab_85252_generalTab_80894_content").className = "tabContent"; document.getElementById("tab_58122_phpTab_60526_header").className += " active"; document.getElementById("tab_58122_phpTab_60526_content").className += " active"; }) document.getElementById("tab_46276_xmlTab_28688_header").addEventListener("click", function () {document.getElementById("tab_46276_xmlTab_28688_header").className += " active"; document.getElementById("tab_46276_xmlTab_28688_content").className += " active"; document.getElementById("tab_57500_jsonTab_44460_header").className = "headerContent"; document.getElementById("tab_57500_jsonTab_44460_content").className = "tabContent"; }) document.getElementById("tab_57500_jsonTab_44460_header").addEventListener("click", function () {document.getElementById("tab_46276_xmlTab_28688_header").className = "headerContent"; document.getElementById("tab_46276_xmlTab_28688_content").className = "tabContent"; document.getElementById("tab_57500_jsonTab_44460_header").className += " active"; document.getElementById("tab_57500_jsonTab_44460_content").className += " active"; }) document.getElementById("tab_82933_generalTab_63348_header").addEventListener("click", function () {document.getElementById("tab_82933_generalTab_63348_header").className += " active"; document.getElementById("tab_82933_generalTab_63348_content").className += " active"; document.getElementById("tab_48338_phpTab_37222_header").className = "headerContent"; document.getElementById("tab_48338_phpTab_37222_content").className = "tabContent"; }) document.getElementById("tab_48338_phpTab_37222_header").addEventListener("click", function () {document.getElementById("tab_82933_generalTab_63348_header").className = "headerContent"; document.getElementById("tab_82933_generalTab_63348_content").className = "tabContent"; document.getElementById("tab_48338_phpTab_37222_header").className += " active"; document.getElementById("tab_48338_phpTab_37222_content").className += " active"; }) document.getElementById("tab_33758_xmlTab_59439_header").addEventListener("click", function () {document.getElementById("tab_33758_xmlTab_59439_header").className += " active"; document.getElementById("tab_33758_xmlTab_59439_content").className += " active"; document.getElementById("tab_76267_jsonTab_81226_header").className = "headerContent"; document.getElementById("tab_76267_jsonTab_81226_content").className = "tabContent"; }) document.getElementById("tab_76267_jsonTab_81226_header").addEventListener("click", function () {document.getElementById("tab_33758_xmlTab_59439_header").className = "headerContent"; document.getElementById("tab_33758_xmlTab_59439_content").className = "tabContent"; document.getElementById("tab_76267_jsonTab_81226_header").className += " active"; document.getElementById("tab_76267_jsonTab_81226_content").className += " active"; }) document.getElementById("tab_17717_generalTab_93363_header").addEventListener("click", function () {document.getElementById("tab_17717_generalTab_93363_header").className += " active"; document.getElementById("tab_17717_generalTab_93363_content").className += " active"; document.getElementById("tab_71099_phpTab_40671_header").className = "headerContent"; document.getElementById("tab_71099_phpTab_40671_content").className = "tabContent"; }) document.getElementById("tab_71099_phpTab_40671_header").addEventListener("click", function () {document.getElementById("tab_17717_generalTab_93363_header").className = "headerContent"; document.getElementById("tab_17717_generalTab_93363_content").className = "tabContent"; document.getElementById("tab_71099_phpTab_40671_header").className += " active"; document.getElementById("tab_71099_phpTab_40671_content").className += " active"; }) document.getElementById("tab_57804_xmlTab_52709_header").addEventListener("click", function () {document.getElementById("tab_57804_xmlTab_52709_header").className += " active"; document.getElementById("tab_57804_xmlTab_52709_content").className += " active"; document.getElementById("tab_95439_jsonTab_14457_header").className = "headerContent"; document.getElementById("tab_95439_jsonTab_14457_content").className = "tabContent"; }) document.getElementById("tab_95439_jsonTab_14457_header").addEventListener("click", function () {document.getElementById("tab_57804_xmlTab_52709_header").className = "headerContent"; document.getElementById("tab_57804_xmlTab_52709_content").className = "tabContent"; document.getElementById("tab_95439_jsonTab_14457_header").className += " active"; document.getElementById("tab_95439_jsonTab_14457_content").className += " active"; }) document.getElementById("tab_69577_generalTab_33299_header").addEventListener("click", function () {document.getElementById("tab_69577_generalTab_33299_header").className += " active"; document.getElementById("tab_69577_generalTab_33299_content").className += " active"; document.getElementById("tab_77678_phpTab_72026_header").className = "headerContent"; document.getElementById("tab_77678_phpTab_72026_content").className = "tabContent"; }) document.getElementById("tab_77678_phpTab_72026_header").addEventListener("click", function () {document.getElementById("tab_69577_generalTab_33299_header").className = "headerContent"; document.getElementById("tab_69577_generalTab_33299_content").className = "tabContent"; document.getElementById("tab_77678_phpTab_72026_header").className += " active"; document.getElementById("tab_77678_phpTab_72026_content").className += " active"; }) document.getElementById("tab_24992_xmlTab_75467_header").addEventListener("click", function () {document.getElementById("tab_24992_xmlTab_75467_header").className += " active"; document.getElementById("tab_24992_xmlTab_75467_content").className += " active"; document.getElementById("tab_82571_jsonTab_85888_header").className = "headerContent"; document.getElementById("tab_82571_jsonTab_85888_content").className = "tabContent"; }) document.getElementById("tab_82571_jsonTab_85888_header").addEventListener("click", function () {document.getElementById("tab_24992_xmlTab_75467_header").className = "headerContent"; document.getElementById("tab_24992_xmlTab_75467_content").className = "tabContent"; document.getElementById("tab_82571_jsonTab_85888_header").className += " active"; document.getElementById("tab_82571_jsonTab_85888_content").className += " active"; }) document.getElementById("tab_12016_generalTab_16750_header").addEventListener("click", function () {document.getElementById("tab_12016_generalTab_16750_header").className += " active"; document.getElementById("tab_12016_generalTab_16750_content").className += " active"; document.getElementById("tab_71201_phpTab_69610_header").className = "headerContent"; document.getElementById("tab_71201_phpTab_69610_content").className = "tabContent"; }) document.getElementById("tab_71201_phpTab_69610_header").addEventListener("click", function () {document.getElementById("tab_12016_generalTab_16750_header").className = "headerContent"; document.getElementById("tab_12016_generalTab_16750_content").className = "tabContent"; document.getElementById("tab_71201_phpTab_69610_header").className += " active"; document.getElementById("tab_71201_phpTab_69610_content").className += " active"; }) document.getElementById("tab_42845_xmlTab_47475_header").addEventListener("click", function () {document.getElementById("tab_42845_xmlTab_47475_header").className += " active"; document.getElementById("tab_42845_xmlTab_47475_content").className += " active"; document.getElementById("tab_32943_jsonTab_15834_header").className = "headerContent"; document.getElementById("tab_32943_jsonTab_15834_content").className = "tabContent"; }) document.getElementById("tab_32943_jsonTab_15834_header").addEventListener("click", function () {document.getElementById("tab_42845_xmlTab_47475_header").className = "headerContent"; document.getElementById("tab_42845_xmlTab_47475_content").className = "tabContent"; document.getElementById("tab_32943_jsonTab_15834_header").className += " active"; document.getElementById("tab_32943_jsonTab_15834_content").className += " active"; }) document.getElementById("tab_26250_generalTab_97172_header").addEventListener("click", function () {document.getElementById("tab_26250_generalTab_97172_header").className += " active"; document.getElementById("tab_26250_generalTab_97172_content").className += " active"; document.getElementById("tab_45297_phpTab_91794_header").className = "headerContent"; document.getElementById("tab_45297_phpTab_91794_content").className = "tabContent"; }) document.getElementById("tab_45297_phpTab_91794_header").addEventListener("click", function () {document.getElementById("tab_26250_generalTab_97172_header").className = "headerContent"; document.getElementById("tab_26250_generalTab_97172_content").className = "tabContent"; document.getElementById("tab_45297_phpTab_91794_header").className += " active"; document.getElementById("tab_45297_phpTab_91794_content").className += " active"; }) document.getElementById("tab_17573_xmlTab_58614_header").addEventListener("click", function () {document.getElementById("tab_17573_xmlTab_58614_header").className += " active"; document.getElementById("tab_17573_xmlTab_58614_content").className += " active"; document.getElementById("tab_98799_jsonTab_91303_header").className = "headerContent"; document.getElementById("tab_98799_jsonTab_91303_content").className = "tabContent"; }) document.getElementById("tab_98799_jsonTab_91303_header").addEventListener("click", function () {document.getElementById("tab_17573_xmlTab_58614_header").className = "headerContent"; document.getElementById("tab_17573_xmlTab_58614_content").className = "tabContent"; document.getElementById("tab_98799_jsonTab_91303_header").className += " active"; document.getElementById("tab_98799_jsonTab_91303_content").className += " active"; }) document.getElementById("tab_28455_generalTab_90803_header").addEventListener("click", function () {document.getElementById("tab_28455_generalTab_90803_header").className += " active"; document.getElementById("tab_28455_generalTab_90803_content").className += " active"; document.getElementById("tab_74650_phpTab_49810_header").className = "headerContent"; document.getElementById("tab_74650_phpTab_49810_content").className = "tabContent"; }) document.getElementById("tab_74650_phpTab_49810_header").addEventListener("click", function () {document.getElementById("tab_28455_generalTab_90803_header").className = "headerContent"; document.getElementById("tab_28455_generalTab_90803_content").className = "tabContent"; document.getElementById("tab_74650_phpTab_49810_header").className += " active"; document.getElementById("tab_74650_phpTab_49810_content").className += " active"; }) document.getElementById("tab_48106_xmlTab_74978_header").addEventListener("click", function () {document.getElementById("tab_48106_xmlTab_74978_header").className += " active"; document.getElementById("tab_48106_xmlTab_74978_content").className += " active"; document.getElementById("tab_38400_jsonTab_46719_header").className = "headerContent"; document.getElementById("tab_38400_jsonTab_46719_content").className = "tabContent"; }) document.getElementById("tab_38400_jsonTab_46719_header").addEventListener("click", function () {document.getElementById("tab_48106_xmlTab_74978_header").className = "headerContent"; document.getElementById("tab_48106_xmlTab_74978_content").className = "tabContent"; document.getElementById("tab_38400_jsonTab_46719_header").className += " active"; document.getElementById("tab_38400_jsonTab_46719_content").className += " active"; }) document.getElementById("tab_54296_generalTab_63927_header").addEventListener("click", function () {document.getElementById("tab_54296_generalTab_63927_header").className += " active"; document.getElementById("tab_54296_generalTab_63927_content").className += " active"; document.getElementById("tab_36134_phpTab_13084_header").className = "headerContent"; document.getElementById("tab_36134_phpTab_13084_content").className = "tabContent"; }) document.getElementById("tab_36134_phpTab_13084_header").addEventListener("click", function () {document.getElementById("tab_54296_generalTab_63927_header").className = "headerContent"; document.getElementById("tab_54296_generalTab_63927_content").className = "tabContent"; document.getElementById("tab_36134_phpTab_13084_header").className += " active"; document.getElementById("tab_36134_phpTab_13084_content").className += " active"; }) document.getElementById("tab_99715_xmlTab_10167_header").addEventListener("click", function () {document.getElementById("tab_99715_xmlTab_10167_header").className += " active"; document.getElementById("tab_99715_xmlTab_10167_content").className += " active"; document.getElementById("tab_97519_jsonTab_48633_header").className = "headerContent"; document.getElementById("tab_97519_jsonTab_48633_content").className = "tabContent"; }) document.getElementById("tab_97519_jsonTab_48633_header").addEventListener("click", function () {document.getElementById("tab_99715_xmlTab_10167_header").className = "headerContent"; document.getElementById("tab_99715_xmlTab_10167_content").className = "tabContent"; document.getElementById("tab_97519_jsonTab_48633_header").className += " active"; document.getElementById("tab_97519_jsonTab_48633_content").className += " active"; }) document.getElementById("tab_70322_generalTab_93248_header").addEventListener("click", function () {document.getElementById("tab_70322_generalTab_93248_header").className += " active"; document.getElementById("tab_70322_generalTab_93248_content").className += " active"; document.getElementById("tab_95886_phpTab_28894_header").className = "headerContent"; document.getElementById("tab_95886_phpTab_28894_content").className = "tabContent"; }) document.getElementById("tab_95886_phpTab_28894_header").addEventListener("click", function () {document.getElementById("tab_70322_generalTab_93248_header").className = "headerContent"; document.getElementById("tab_70322_generalTab_93248_content").className = "tabContent"; document.getElementById("tab_95886_phpTab_28894_header").className += " active"; document.getElementById("tab_95886_phpTab_28894_content").className += " active"; }) document.getElementById("tab_16223_xmlTab_37115_header").addEventListener("click", function () {document.getElementById("tab_16223_xmlTab_37115_header").className += " active"; document.getElementById("tab_16223_xmlTab_37115_content").className += " active"; document.getElementById("tab_50155_jsonTab_44451_header").className = "headerContent"; document.getElementById("tab_50155_jsonTab_44451_content").className = "tabContent"; }) document.getElementById("tab_50155_jsonTab_44451_header").addEventListener("click", function () {document.getElementById("tab_16223_xmlTab_37115_header").className = "headerContent"; document.getElementById("tab_16223_xmlTab_37115_content").className = "tabContent"; document.getElementById("tab_50155_jsonTab_44451_header").className += " active"; document.getElementById("tab_50155_jsonTab_44451_content").className += " active"; }) document.getElementById("tab_39685_generalTab_28815_header").addEventListener("click", function () {document.getElementById("tab_39685_generalTab_28815_header").className += " active"; document.getElementById("tab_39685_generalTab_28815_content").className += " active"; document.getElementById("tab_76434_phpTab_25969_header").className = "headerContent"; document.getElementById("tab_76434_phpTab_25969_content").className = "tabContent"; }) document.getElementById("tab_76434_phpTab_25969_header").addEventListener("click", function () {document.getElementById("tab_39685_generalTab_28815_header").className = "headerContent"; document.getElementById("tab_39685_generalTab_28815_content").className = "tabContent"; document.getElementById("tab_76434_phpTab_25969_header").className += " active"; document.getElementById("tab_76434_phpTab_25969_content").className += " active"; }) document.getElementById("tab_43253_xmlTab_14740_header").addEventListener("click", function () {document.getElementById("tab_43253_xmlTab_14740_header").className += " active"; document.getElementById("tab_43253_xmlTab_14740_content").className += " active"; document.getElementById("tab_46334_jsonTab_21875_header").className = "headerContent"; document.getElementById("tab_46334_jsonTab_21875_content").className = "tabContent"; }) document.getElementById("tab_46334_jsonTab_21875_header").addEventListener("click", function () {document.getElementById("tab_43253_xmlTab_14740_header").className = "headerContent"; document.getElementById("tab_43253_xmlTab_14740_content").className = "tabContent"; document.getElementById("tab_46334_jsonTab_21875_header").className += " active"; document.getElementById("tab_46334_jsonTab_21875_content").className += " active"; }) document.getElementById("tab_28439_generalTab_94022_header").addEventListener("click", function () {document.getElementById("tab_28439_generalTab_94022_header").className += " active"; document.getElementById("tab_28439_generalTab_94022_content").className += " active"; document.getElementById("tab_31497_phpTab_52067_header").className = "headerContent"; document.getElementById("tab_31497_phpTab_52067_content").className = "tabContent"; }) document.getElementById("tab_31497_phpTab_52067_header").addEventListener("click", function () {document.getElementById("tab_28439_generalTab_94022_header").className = "headerContent"; document.getElementById("tab_28439_generalTab_94022_content").className = "tabContent"; document.getElementById("tab_31497_phpTab_52067_header").className += " active"; document.getElementById("tab_31497_phpTab_52067_content").className += " active"; }) document.getElementById("tab_94787_xmlTab_33115_header").addEventListener("click", function () {document.getElementById("tab_94787_xmlTab_33115_header").className += " active"; document.getElementById("tab_94787_xmlTab_33115_content").className += " active"; document.getElementById("tab_37055_jsonTab_26348_header").className = "headerContent"; document.getElementById("tab_37055_jsonTab_26348_content").className = "tabContent"; }) document.getElementById("tab_37055_jsonTab_26348_header").addEventListener("click", function () {document.getElementById("tab_94787_xmlTab_33115_header").className = "headerContent"; document.getElementById("tab_94787_xmlTab_33115_content").className = "tabContent"; document.getElementById("tab_37055_jsonTab_26348_header").className += " active"; document.getElementById("tab_37055_jsonTab_26348_content").className += " active"; }) document.getElementById("tab_45674_generalTab_40357_header").addEventListener("click", function () {document.getElementById("tab_45674_generalTab_40357_header").className += " active"; document.getElementById("tab_45674_generalTab_40357_content").className += " active"; document.getElementById("tab_97449_phpTab_75287_header").className = "headerContent"; document.getElementById("tab_97449_phpTab_75287_content").className = "tabContent"; }) document.getElementById("tab_97449_phpTab_75287_header").addEventListener("click", function () {document.getElementById("tab_45674_generalTab_40357_header").className = "headerContent"; document.getElementById("tab_45674_generalTab_40357_content").className = "tabContent"; document.getElementById("tab_97449_phpTab_75287_header").className += " active"; document.getElementById("tab_97449_phpTab_75287_content").className += " active"; }) document.getElementById("tab_32434_xmlTab_48015_header").addEventListener("click", function () {document.getElementById("tab_32434_xmlTab_48015_header").className += " active"; document.getElementById("tab_32434_xmlTab_48015_content").className += " active"; document.getElementById("tab_93316_jsonTab_68334_header").className = "headerContent"; document.getElementById("tab_93316_jsonTab_68334_content").className = "tabContent"; }) document.getElementById("tab_93316_jsonTab_68334_header").addEventListener("click", function () {document.getElementById("tab_32434_xmlTab_48015_header").className = "headerContent"; document.getElementById("tab_32434_xmlTab_48015_content").className = "tabContent"; document.getElementById("tab_93316_jsonTab_68334_header").className += " active"; document.getElementById("tab_93316_jsonTab_68334_content").className += " active"; }) document.getElementById("tab_76650_generalTab_87778_header").addEventListener("click", function () {document.getElementById("tab_76650_generalTab_87778_header").className += " active"; document.getElementById("tab_76650_generalTab_87778_content").className += " active"; document.getElementById("tab_68323_phpTab_59279_header").className = "headerContent"; document.getElementById("tab_68323_phpTab_59279_content").className = "tabContent"; }) document.getElementById("tab_68323_phpTab_59279_header").addEventListener("click", function () {document.getElementById("tab_76650_generalTab_87778_header").className = "headerContent"; document.getElementById("tab_76650_generalTab_87778_content").className = "tabContent"; document.getElementById("tab_68323_phpTab_59279_header").className += " active"; document.getElementById("tab_68323_phpTab_59279_content").className += " active"; }) document.getElementById("tab_89317_xmlTab_33695_header").addEventListener("click", function () {document.getElementById("tab_89317_xmlTab_33695_header").className += " active"; document.getElementById("tab_89317_xmlTab_33695_content").className += " active"; document.getElementById("tab_84553_jsonTab_18604_header").className = "headerContent"; document.getElementById("tab_84553_jsonTab_18604_content").className = "tabContent"; }) document.getElementById("tab_84553_jsonTab_18604_header").addEventListener("click", function () {document.getElementById("tab_89317_xmlTab_33695_header").className = "headerContent"; document.getElementById("tab_89317_xmlTab_33695_content").className = "tabContent"; document.getElementById("tab_84553_jsonTab_18604_header").className += " active"; document.getElementById("tab_84553_jsonTab_18604_content").className += " active"; }) document.getElementById("tab_18913_generalTab_68003_header").addEventListener("click", function () {document.getElementById("tab_18913_generalTab_68003_header").className += " active"; document.getElementById("tab_18913_generalTab_68003_content").className += " active"; document.getElementById("tab_25598_phpTab_45864_header").className = "headerContent"; document.getElementById("tab_25598_phpTab_45864_content").className = "tabContent"; }) document.getElementById("tab_25598_phpTab_45864_header").addEventListener("click", function () {document.getElementById("tab_18913_generalTab_68003_header").className = "headerContent"; document.getElementById("tab_18913_generalTab_68003_content").className = "tabContent"; document.getElementById("tab_25598_phpTab_45864_header").className += " active"; document.getElementById("tab_25598_phpTab_45864_content").className += " active"; }) document.getElementById("tab_27983_xmlTab_35792_header").addEventListener("click", function () {document.getElementById("tab_27983_xmlTab_35792_header").className += " active"; document.getElementById("tab_27983_xmlTab_35792_content").className += " active"; document.getElementById("tab_29035_jsonTab_98022_header").className = "headerContent"; document.getElementById("tab_29035_jsonTab_98022_content").className = "tabContent"; }) document.getElementById("tab_29035_jsonTab_98022_header").addEventListener("click", function () {document.getElementById("tab_27983_xmlTab_35792_header").className = "headerContent"; document.getElementById("tab_27983_xmlTab_35792_content").className = "tabContent"; document.getElementById("tab_29035_jsonTab_98022_header").className += " active"; document.getElementById("tab_29035_jsonTab_98022_content").className += " active"; }) document.getElementById("tab_31967_generalTab_12334_header").addEventListener("click", function () {document.getElementById("tab_31967_generalTab_12334_header").className += " active"; document.getElementById("tab_31967_generalTab_12334_content").className += " active"; document.getElementById("tab_98636_phpTab_49553_header").className = "headerContent"; document.getElementById("tab_98636_phpTab_49553_content").className = "tabContent"; }) document.getElementById("tab_98636_phpTab_49553_header").addEventListener("click", function () {document.getElementById("tab_31967_generalTab_12334_header").className = "headerContent"; document.getElementById("tab_31967_generalTab_12334_content").className = "tabContent"; document.getElementById("tab_98636_phpTab_49553_header").className += " active"; document.getElementById("tab_98636_phpTab_49553_content").className += " active"; }) document.getElementById("tab_94179_xmlTab_89508_header").addEventListener("click", function () {document.getElementById("tab_94179_xmlTab_89508_header").className += " active"; document.getElementById("tab_94179_xmlTab_89508_content").className += " active"; document.getElementById("tab_48141_jsonTab_39635_header").className = "headerContent"; document.getElementById("tab_48141_jsonTab_39635_content").className = "tabContent"; }) document.getElementById("tab_48141_jsonTab_39635_header").addEventListener("click", function () {document.getElementById("tab_94179_xmlTab_89508_header").className = "headerContent"; document.getElementById("tab_94179_xmlTab_89508_content").className = "tabContent"; document.getElementById("tab_48141_jsonTab_39635_header").className += " active"; document.getElementById("tab_48141_jsonTab_39635_content").className += " active"; }) document.getElementById("tab_12630_generalTab_89259_header").addEventListener("click", function () {document.getElementById("tab_12630_generalTab_89259_header").className += " active"; document.getElementById("tab_12630_generalTab_89259_content").className += " active"; document.getElementById("tab_91328_phpTab_23226_header").className = "headerContent"; document.getElementById("tab_91328_phpTab_23226_content").className = "tabContent"; }) document.getElementById("tab_91328_phpTab_23226_header").addEventListener("click", function () {document.getElementById("tab_12630_generalTab_89259_header").className = "headerContent"; document.getElementById("tab_12630_generalTab_89259_content").className = "tabContent"; document.getElementById("tab_91328_phpTab_23226_header").className += " active"; document.getElementById("tab_91328_phpTab_23226_content").className += " active"; }) document.getElementById("tab_50902_xmlTab_87964_header").addEventListener("click", function () {document.getElementById("tab_50902_xmlTab_87964_header").className += " active"; document.getElementById("tab_50902_xmlTab_87964_content").className += " active"; document.getElementById("tab_60859_jsonTab_73060_header").className = "headerContent"; document.getElementById("tab_60859_jsonTab_73060_content").className = "tabContent"; }) document.getElementById("tab_60859_jsonTab_73060_header").addEventListener("click", function () {document.getElementById("tab_50902_xmlTab_87964_header").className = "headerContent"; document.getElementById("tab_50902_xmlTab_87964_content").className = "tabContent"; document.getElementById("tab_60859_jsonTab_73060_header").className += " active"; document.getElementById("tab_60859_jsonTab_73060_content").className += " active"; }) document.getElementById("tab_37204_generalTab_79129_header").addEventListener("click", function () {document.getElementById("tab_37204_generalTab_79129_header").className += " active"; document.getElementById("tab_37204_generalTab_79129_content").className += " active"; document.getElementById("tab_22604_phpTab_51131_header").className = "headerContent"; document.getElementById("tab_22604_phpTab_51131_content").className = "tabContent"; }) document.getElementById("tab_22604_phpTab_51131_header").addEventListener("click", function () {document.getElementById("tab_37204_generalTab_79129_header").className = "headerContent"; document.getElementById("tab_37204_generalTab_79129_content").className = "tabContent"; document.getElementById("tab_22604_phpTab_51131_header").className += " active"; document.getElementById("tab_22604_phpTab_51131_content").className += " active"; }) document.getElementById("tab_70465_xmlTab_17710_header").addEventListener("click", function () {document.getElementById("tab_70465_xmlTab_17710_header").className += " active"; document.getElementById("tab_70465_xmlTab_17710_content").className += " active"; document.getElementById("tab_21380_jsonTab_16455_header").className = "headerContent"; document.getElementById("tab_21380_jsonTab_16455_content").className = "tabContent"; }) document.getElementById("tab_21380_jsonTab_16455_header").addEventListener("click", function () {document.getElementById("tab_70465_xmlTab_17710_header").className = "headerContent"; document.getElementById("tab_70465_xmlTab_17710_content").className = "tabContent"; document.getElementById("tab_21380_jsonTab_16455_header").className += " active"; document.getElementById("tab_21380_jsonTab_16455_content").className += " active"; }) document.getElementById("tab_57893_generalTab_72804_header").addEventListener("click", function () {document.getElementById("tab_57893_generalTab_72804_header").className += " active"; document.getElementById("tab_57893_generalTab_72804_content").className += " active"; document.getElementById("tab_53817_phpTab_72862_header").className = "headerContent"; document.getElementById("tab_53817_phpTab_72862_content").className = "tabContent"; }) document.getElementById("tab_53817_phpTab_72862_header").addEventListener("click", function () {document.getElementById("tab_57893_generalTab_72804_header").className = "headerContent"; document.getElementById("tab_57893_generalTab_72804_content").className = "tabContent"; document.getElementById("tab_53817_phpTab_72862_header").className += " active"; document.getElementById("tab_53817_phpTab_72862_content").className += " active"; }) document.getElementById("tab_29636_xmlTab_79067_header").addEventListener("click", function () {document.getElementById("tab_29636_xmlTab_79067_header").className += " active"; document.getElementById("tab_29636_xmlTab_79067_content").className += " active"; document.getElementById("tab_64595_jsonTab_89001_header").className = "headerContent"; document.getElementById("tab_64595_jsonTab_89001_content").className = "tabContent"; }) document.getElementById("tab_64595_jsonTab_89001_header").addEventListener("click", function () {document.getElementById("tab_29636_xmlTab_79067_header").className = "headerContent"; document.getElementById("tab_29636_xmlTab_79067_content").className = "tabContent"; document.getElementById("tab_64595_jsonTab_89001_header").className += " active"; document.getElementById("tab_64595_jsonTab_89001_content").className += " active"; }) document.getElementById("tab_58054_generalTab_50644_header").addEventListener("click", function () {document.getElementById("tab_58054_generalTab_50644_header").className += " active"; document.getElementById("tab_58054_generalTab_50644_content").className += " active"; document.getElementById("tab_99401_phpTab_14623_header").className = "headerContent"; document.getElementById("tab_99401_phpTab_14623_content").className = "tabContent"; }) document.getElementById("tab_99401_phpTab_14623_header").addEventListener("click", function () {document.getElementById("tab_58054_generalTab_50644_header").className = "headerContent"; document.getElementById("tab_58054_generalTab_50644_content").className = "tabContent"; document.getElementById("tab_99401_phpTab_14623_header").className += " active"; document.getElementById("tab_99401_phpTab_14623_content").className += " active"; }) document.getElementById("tab_65936_xmlTab_70689_header").addEventListener("click", function () {document.getElementById("tab_65936_xmlTab_70689_header").className += " active"; document.getElementById("tab_65936_xmlTab_70689_content").className += " active"; document.getElementById("tab_29415_jsonTab_87535_header").className = "headerContent"; document.getElementById("tab_29415_jsonTab_87535_content").className = "tabContent"; }) document.getElementById("tab_29415_jsonTab_87535_header").addEventListener("click", function () {document.getElementById("tab_65936_xmlTab_70689_header").className = "headerContent"; document.getElementById("tab_65936_xmlTab_70689_content").className = "tabContent"; document.getElementById("tab_29415_jsonTab_87535_header").className += " active"; document.getElementById("tab_29415_jsonTab_87535_content").className += " active"; }) document.getElementById("tab_57921_generalTab_59531_header").addEventListener("click", function () {document.getElementById("tab_57921_generalTab_59531_header").className += " active"; document.getElementById("tab_57921_generalTab_59531_content").className += " active"; document.getElementById("tab_61635_phpTab_98929_header").className = "headerContent"; document.getElementById("tab_61635_phpTab_98929_content").className = "tabContent"; }) document.getElementById("tab_61635_phpTab_98929_header").addEventListener("click", function () {document.getElementById("tab_57921_generalTab_59531_header").className = "headerContent"; document.getElementById("tab_57921_generalTab_59531_content").className = "tabContent"; document.getElementById("tab_61635_phpTab_98929_header").className += " active"; document.getElementById("tab_61635_phpTab_98929_content").className += " active"; }) document.getElementById("tab_95083_xmlTab_30899_header").addEventListener("click", function () {document.getElementById("tab_95083_xmlTab_30899_header").className += " active"; document.getElementById("tab_95083_xmlTab_30899_content").className += " active"; document.getElementById("tab_31376_jsonTab_26601_header").className = "headerContent"; document.getElementById("tab_31376_jsonTab_26601_content").className = "tabContent"; }) document.getElementById("tab_31376_jsonTab_26601_header").addEventListener("click", function () {document.getElementById("tab_95083_xmlTab_30899_header").className = "headerContent"; document.getElementById("tab_95083_xmlTab_30899_content").className = "tabContent"; document.getElementById("tab_31376_jsonTab_26601_header").className += " active"; document.getElementById("tab_31376_jsonTab_26601_content").className += " active"; }) document.getElementById("tab_31512_generalTab_89655_header").addEventListener("click", function () {document.getElementById("tab_31512_generalTab_89655_header").className += " active"; document.getElementById("tab_31512_generalTab_89655_content").className += " active"; document.getElementById("tab_71529_phpTab_98733_header").className = "headerContent"; document.getElementById("tab_71529_phpTab_98733_content").className = "tabContent"; }) document.getElementById("tab_71529_phpTab_98733_header").addEventListener("click", function () {document.getElementById("tab_31512_generalTab_89655_header").className = "headerContent"; document.getElementById("tab_31512_generalTab_89655_content").className = "tabContent"; document.getElementById("tab_71529_phpTab_98733_header").className += " active"; document.getElementById("tab_71529_phpTab_98733_content").className += " active"; }) document.getElementById("tab_79759_xmlTab_21377_header").addEventListener("click", function () {document.getElementById("tab_79759_xmlTab_21377_header").className += " active"; document.getElementById("tab_79759_xmlTab_21377_content").className += " active"; document.getElementById("tab_48121_jsonTab_44964_header").className = "headerContent"; document.getElementById("tab_48121_jsonTab_44964_content").className = "tabContent"; }) document.getElementById("tab_48121_jsonTab_44964_header").addEventListener("click", function () {document.getElementById("tab_79759_xmlTab_21377_header").className = "headerContent"; document.getElementById("tab_79759_xmlTab_21377_content").className = "tabContent"; document.getElementById("tab_48121_jsonTab_44964_header").className += " active"; document.getElementById("tab_48121_jsonTab_44964_content").className += " active"; }) document.getElementById("tab_26524_generalTab_16562_header").addEventListener("click", function () {document.getElementById("tab_26524_generalTab_16562_header").className += " active"; document.getElementById("tab_26524_generalTab_16562_content").className += " active"; document.getElementById("tab_21287_phpTab_56422_header").className = "headerContent"; document.getElementById("tab_21287_phpTab_56422_content").className = "tabContent"; }) document.getElementById("tab_21287_phpTab_56422_header").addEventListener("click", function () {document.getElementById("tab_26524_generalTab_16562_header").className = "headerContent"; document.getElementById("tab_26524_generalTab_16562_content").className = "tabContent"; document.getElementById("tab_21287_phpTab_56422_header").className += " active"; document.getElementById("tab_21287_phpTab_56422_content").className += " active"; }) document.getElementById("tab_93461_xmlTab_99879_header").addEventListener("click", function () {document.getElementById("tab_93461_xmlTab_99879_header").className += " active"; document.getElementById("tab_93461_xmlTab_99879_content").className += " active"; document.getElementById("tab_41895_jsonTab_41673_header").className = "headerContent"; document.getElementById("tab_41895_jsonTab_41673_content").className = "tabContent"; }) document.getElementById("tab_41895_jsonTab_41673_header").addEventListener("click", function () {document.getElementById("tab_93461_xmlTab_99879_header").className = "headerContent"; document.getElementById("tab_93461_xmlTab_99879_content").className = "tabContent"; document.getElementById("tab_41895_jsonTab_41673_header").className += " active"; document.getElementById("tab_41895_jsonTab_41673_content").className += " active"; }) document.getElementById("tab_84547_generalTab_20673_header").addEventListener("click", function () {document.getElementById("tab_84547_generalTab_20673_header").className += " active"; document.getElementById("tab_84547_generalTab_20673_content").className += " active"; document.getElementById("tab_49593_phpTab_11250_header").className = "headerContent"; document.getElementById("tab_49593_phpTab_11250_content").className = "tabContent"; }) document.getElementById("tab_49593_phpTab_11250_header").addEventListener("click", function () {document.getElementById("tab_84547_generalTab_20673_header").className = "headerContent"; document.getElementById("tab_84547_generalTab_20673_content").className = "tabContent"; document.getElementById("tab_49593_phpTab_11250_header").className += " active"; document.getElementById("tab_49593_phpTab_11250_content").className += " active"; }) document.getElementById("tab_97112_xmlTab_94646_header").addEventListener("click", function () {document.getElementById("tab_97112_xmlTab_94646_header").className += " active"; document.getElementById("tab_97112_xmlTab_94646_content").className += " active"; document.getElementById("tab_35036_jsonTab_73398_header").className = "headerContent"; document.getElementById("tab_35036_jsonTab_73398_content").className = "tabContent"; }) document.getElementById("tab_35036_jsonTab_73398_header").addEventListener("click", function () {document.getElementById("tab_97112_xmlTab_94646_header").className = "headerContent"; document.getElementById("tab_97112_xmlTab_94646_content").className = "tabContent"; document.getElementById("tab_35036_jsonTab_73398_header").className += " active"; document.getElementById("tab_35036_jsonTab_73398_content").className += " active"; }) document.getElementById("tab_80535_generalTab_40386_header").addEventListener("click", function () {document.getElementById("tab_80535_generalTab_40386_header").className += " active"; document.getElementById("tab_80535_generalTab_40386_content").className += " active"; document.getElementById("tab_37373_phpTab_76165_header").className = "headerContent"; document.getElementById("tab_37373_phpTab_76165_content").className = "tabContent"; }) document.getElementById("tab_37373_phpTab_76165_header").addEventListener("click", function () {document.getElementById("tab_80535_generalTab_40386_header").className = "headerContent"; document.getElementById("tab_80535_generalTab_40386_content").className = "tabContent"; document.getElementById("tab_37373_phpTab_76165_header").className += " active"; document.getElementById("tab_37373_phpTab_76165_content").className += " active"; }) document.getElementById("tab_24232_xmlTab_36682_header").addEventListener("click", function () {document.getElementById("tab_24232_xmlTab_36682_header").className += " active"; document.getElementById("tab_24232_xmlTab_36682_content").className += " active"; document.getElementById("tab_47835_jsonTab_72125_header").className = "headerContent"; document.getElementById("tab_47835_jsonTab_72125_content").className = "tabContent"; }) document.getElementById("tab_47835_jsonTab_72125_header").addEventListener("click", function () {document.getElementById("tab_24232_xmlTab_36682_header").className = "headerContent"; document.getElementById("tab_24232_xmlTab_36682_content").className = "tabContent"; document.getElementById("tab_47835_jsonTab_72125_header").className += " active"; document.getElementById("tab_47835_jsonTab_72125_content").className += " active"; }) document.getElementById("tab_43344_generalTab_52285_header").addEventListener("click", function () {document.getElementById("tab_43344_generalTab_52285_header").className += " active"; document.getElementById("tab_43344_generalTab_52285_content").className += " active"; document.getElementById("tab_29205_phpTab_31198_header").className = "headerContent"; document.getElementById("tab_29205_phpTab_31198_content").className = "tabContent"; }) document.getElementById("tab_29205_phpTab_31198_header").addEventListener("click", function () {document.getElementById("tab_43344_generalTab_52285_header").className = "headerContent"; document.getElementById("tab_43344_generalTab_52285_content").className = "tabContent"; document.getElementById("tab_29205_phpTab_31198_header").className += " active"; document.getElementById("tab_29205_phpTab_31198_content").className += " active"; }) document.getElementById("tab_35856_xmlTab_68827_header").addEventListener("click", function () {document.getElementById("tab_35856_xmlTab_68827_header").className += " active"; document.getElementById("tab_35856_xmlTab_68827_content").className += " active"; document.getElementById("tab_73444_jsonTab_10916_header").className = "headerContent"; document.getElementById("tab_73444_jsonTab_10916_content").className = "tabContent"; }) document.getElementById("tab_73444_jsonTab_10916_header").addEventListener("click", function () {document.getElementById("tab_35856_xmlTab_68827_header").className = "headerContent"; document.getElementById("tab_35856_xmlTab_68827_content").className = "tabContent"; document.getElementById("tab_73444_jsonTab_10916_header").className += " active"; document.getElementById("tab_73444_jsonTab_10916_content").className += " active"; }) document.getElementById("tab_90362_generalTab_16546_header").addEventListener("click", function () {document.getElementById("tab_90362_generalTab_16546_header").className += " active"; document.getElementById("tab_90362_generalTab_16546_content").className += " active"; document.getElementById("tab_54645_phpTab_54325_header").className = "headerContent"; document.getElementById("tab_54645_phpTab_54325_content").className = "tabContent"; }) document.getElementById("tab_54645_phpTab_54325_header").addEventListener("click", function () {document.getElementById("tab_90362_generalTab_16546_header").className = "headerContent"; document.getElementById("tab_90362_generalTab_16546_content").className = "tabContent"; document.getElementById("tab_54645_phpTab_54325_header").className += " active"; document.getElementById("tab_54645_phpTab_54325_content").className += " active"; }) document.getElementById("tab_17933_xmlTab_74133_header").addEventListener("click", function () {document.getElementById("tab_17933_xmlTab_74133_header").className += " active"; document.getElementById("tab_17933_xmlTab_74133_content").className += " active"; document.getElementById("tab_51062_jsonTab_34911_header").className = "headerContent"; document.getElementById("tab_51062_jsonTab_34911_content").className = "tabContent"; }) document.getElementById("tab_51062_jsonTab_34911_header").addEventListener("click", function () {document.getElementById("tab_17933_xmlTab_74133_header").className = "headerContent"; document.getElementById("tab_17933_xmlTab_74133_content").className = "tabContent"; document.getElementById("tab_51062_jsonTab_34911_header").className += " active"; document.getElementById("tab_51062_jsonTab_34911_content").className += " active"; }) document.getElementById("tab_76787_generalTab_84287_header").addEventListener("click", function () {document.getElementById("tab_76787_generalTab_84287_header").className += " active"; document.getElementById("tab_76787_generalTab_84287_content").className += " active"; document.getElementById("tab_93184_phpTab_10325_header").className = "headerContent"; document.getElementById("tab_93184_phpTab_10325_content").className = "tabContent"; }) document.getElementById("tab_93184_phpTab_10325_header").addEventListener("click", function () {document.getElementById("tab_76787_generalTab_84287_header").className = "headerContent"; document.getElementById("tab_76787_generalTab_84287_content").className = "tabContent"; document.getElementById("tab_93184_phpTab_10325_header").className += " active"; document.getElementById("tab_93184_phpTab_10325_content").className += " active"; }) document.getElementById("tab_69011_xmlTab_25166_header").addEventListener("click", function () {document.getElementById("tab_69011_xmlTab_25166_header").className += " active"; document.getElementById("tab_69011_xmlTab_25166_content").className += " active"; document.getElementById("tab_61361_jsonTab_91411_header").className = "headerContent"; document.getElementById("tab_61361_jsonTab_91411_content").className = "tabContent"; }) document.getElementById("tab_61361_jsonTab_91411_header").addEventListener("click", function () {document.getElementById("tab_69011_xmlTab_25166_header").className = "headerContent"; document.getElementById("tab_69011_xmlTab_25166_content").className = "tabContent"; document.getElementById("tab_61361_jsonTab_91411_header").className += " active"; document.getElementById("tab_61361_jsonTab_91411_content").className += " active"; }) document.getElementById("tab_34386_generalTab_62055_header").addEventListener("click", function () {document.getElementById("tab_34386_generalTab_62055_header").className += " active"; document.getElementById("tab_34386_generalTab_62055_content").className += " active"; document.getElementById("tab_45068_phpTab_40790_header").className = "headerContent"; document.getElementById("tab_45068_phpTab_40790_content").className = "tabContent"; }) document.getElementById("tab_45068_phpTab_40790_header").addEventListener("click", function () {document.getElementById("tab_34386_generalTab_62055_header").className = "headerContent"; document.getElementById("tab_34386_generalTab_62055_content").className = "tabContent"; document.getElementById("tab_45068_phpTab_40790_header").className += " active"; document.getElementById("tab_45068_phpTab_40790_content").className += " active"; }) document.getElementById("tab_90336_xmlTab_53817_header").addEventListener("click", function () {document.getElementById("tab_90336_xmlTab_53817_header").className += " active"; document.getElementById("tab_90336_xmlTab_53817_content").className += " active"; document.getElementById("tab_45629_jsonTab_97991_header").className = "headerContent"; document.getElementById("tab_45629_jsonTab_97991_content").className = "tabContent"; }) document.getElementById("tab_45629_jsonTab_97991_header").addEventListener("click", function () {document.getElementById("tab_90336_xmlTab_53817_header").className = "headerContent"; document.getElementById("tab_90336_xmlTab_53817_content").className = "tabContent"; document.getElementById("tab_45629_jsonTab_97991_header").className += " active"; document.getElementById("tab_45629_jsonTab_97991_content").className += " active"; }) document.getElementById("tab_40282_generalTab_86761_header").addEventListener("click", function () {document.getElementById("tab_40282_generalTab_86761_header").className += " active"; document.getElementById("tab_40282_generalTab_86761_content").className += " active"; document.getElementById("tab_74772_phpTab_60149_header").className = "headerContent"; document.getElementById("tab_74772_phpTab_60149_content").className = "tabContent"; }) document.getElementById("tab_74772_phpTab_60149_header").addEventListener("click", function () {document.getElementById("tab_40282_generalTab_86761_header").className = "headerContent"; document.getElementById("tab_40282_generalTab_86761_content").className = "tabContent"; document.getElementById("tab_74772_phpTab_60149_header").className += " active"; document.getElementById("tab_74772_phpTab_60149_content").className += " active"; }) document.getElementById("tab_91952_xmlTab_72167_header").addEventListener("click", function () {document.getElementById("tab_91952_xmlTab_72167_header").className += " active"; document.getElementById("tab_91952_xmlTab_72167_content").className += " active"; document.getElementById("tab_17316_jsonTab_76583_header").className = "headerContent"; document.getElementById("tab_17316_jsonTab_76583_content").className = "tabContent"; }) document.getElementById("tab_17316_jsonTab_76583_header").addEventListener("click", function () {document.getElementById("tab_91952_xmlTab_72167_header").className = "headerContent"; document.getElementById("tab_91952_xmlTab_72167_content").className = "tabContent"; document.getElementById("tab_17316_jsonTab_76583_header").className += " active"; document.getElementById("tab_17316_jsonTab_76583_content").className += " active"; }) document.getElementById("tab_39865_generalTab_19116_header").addEventListener("click", function () {document.getElementById("tab_39865_generalTab_19116_header").className += " active"; document.getElementById("tab_39865_generalTab_19116_content").className += " active"; document.getElementById("tab_13229_phpTab_95413_header").className = "headerContent"; document.getElementById("tab_13229_phpTab_95413_content").className = "tabContent"; }) document.getElementById("tab_13229_phpTab_95413_header").addEventListener("click", function () {document.getElementById("tab_39865_generalTab_19116_header").className = "headerContent"; document.getElementById("tab_39865_generalTab_19116_content").className = "tabContent"; document.getElementById("tab_13229_phpTab_95413_header").className += " active"; document.getElementById("tab_13229_phpTab_95413_content").className += " active"; }) document.getElementById("tab_99517_xmlTab_36505_header").addEventListener("click", function () {document.getElementById("tab_99517_xmlTab_36505_header").className += " active"; document.getElementById("tab_99517_xmlTab_36505_content").className += " active"; document.getElementById("tab_85123_jsonTab_65452_header").className = "headerContent"; document.getElementById("tab_85123_jsonTab_65452_content").className = "tabContent"; }) document.getElementById("tab_85123_jsonTab_65452_header").addEventListener("click", function () {document.getElementById("tab_99517_xmlTab_36505_header").className = "headerContent"; document.getElementById("tab_99517_xmlTab_36505_content").className = "tabContent"; document.getElementById("tab_85123_jsonTab_65452_header").className += " active"; document.getElementById("tab_85123_jsonTab_65452_content").className += " active"; }) document.getElementById("tab_69921_generalTab_14569_header").addEventListener("click", function () {document.getElementById("tab_69921_generalTab_14569_header").className += " active"; document.getElementById("tab_69921_generalTab_14569_content").className += " active"; document.getElementById("tab_58157_phpTab_61859_header").className = "headerContent"; document.getElementById("tab_58157_phpTab_61859_content").className = "tabContent"; }) document.getElementById("tab_58157_phpTab_61859_header").addEventListener("click", function () {document.getElementById("tab_69921_generalTab_14569_header").className = "headerContent"; document.getElementById("tab_69921_generalTab_14569_content").className = "tabContent"; document.getElementById("tab_58157_phpTab_61859_header").className += " active"; document.getElementById("tab_58157_phpTab_61859_content").className += " active"; }) document.getElementById("tab_80249_xmlTab_42388_header").addEventListener("click", function () {document.getElementById("tab_80249_xmlTab_42388_header").className += " active"; document.getElementById("tab_80249_xmlTab_42388_content").className += " active"; document.getElementById("tab_20287_jsonTab_39613_header").className = "headerContent"; document.getElementById("tab_20287_jsonTab_39613_content").className = "tabContent"; }) document.getElementById("tab_20287_jsonTab_39613_header").addEventListener("click", function () {document.getElementById("tab_80249_xmlTab_42388_header").className = "headerContent"; document.getElementById("tab_80249_xmlTab_42388_content").className = "tabContent"; document.getElementById("tab_20287_jsonTab_39613_header").className += " active"; document.getElementById("tab_20287_jsonTab_39613_content").className += " active"; }) document.getElementById("tab_79265_generalTab_29344_header").addEventListener("click", function () {document.getElementById("tab_79265_generalTab_29344_header").className += " active"; document.getElementById("tab_79265_generalTab_29344_content").className += " active"; document.getElementById("tab_70543_phpTab_23308_header").className = "headerContent"; document.getElementById("tab_70543_phpTab_23308_content").className = "tabContent"; }) document.getElementById("tab_70543_phpTab_23308_header").addEventListener("click", function () {document.getElementById("tab_79265_generalTab_29344_header").className = "headerContent"; document.getElementById("tab_79265_generalTab_29344_content").className = "tabContent"; document.getElementById("tab_70543_phpTab_23308_header").className += " active"; document.getElementById("tab_70543_phpTab_23308_content").className += " active"; }) document.getElementById("tab_96571_xmlTab_14086_header").addEventListener("click", function () {document.getElementById("tab_96571_xmlTab_14086_header").className += " active"; document.getElementById("tab_96571_xmlTab_14086_content").className += " active"; document.getElementById("tab_72125_jsonTab_39983_header").className = "headerContent"; document.getElementById("tab_72125_jsonTab_39983_content").className = "tabContent"; }) document.getElementById("tab_72125_jsonTab_39983_header").addEventListener("click", function () {document.getElementById("tab_96571_xmlTab_14086_header").className = "headerContent"; document.getElementById("tab_96571_xmlTab_14086_content").className = "tabContent"; document.getElementById("tab_72125_jsonTab_39983_header").className += " active"; document.getElementById("tab_72125_jsonTab_39983_content").className += " active"; }) document.getElementById("tab_64321_generalTab_77470_header").addEventListener("click", function () {document.getElementById("tab_64321_generalTab_77470_header").className += " active"; document.getElementById("tab_64321_generalTab_77470_content").className += " active"; document.getElementById("tab_31410_phpTab_45244_header").className = "headerContent"; document.getElementById("tab_31410_phpTab_45244_content").className = "tabContent"; }) document.getElementById("tab_31410_phpTab_45244_header").addEventListener("click", function () {document.getElementById("tab_64321_generalTab_77470_header").className = "headerContent"; document.getElementById("tab_64321_generalTab_77470_content").className = "tabContent"; document.getElementById("tab_31410_phpTab_45244_header").className += " active"; document.getElementById("tab_31410_phpTab_45244_content").className += " active"; }) document.getElementById("tab_71331_xmlTab_59888_header").addEventListener("click", function () {document.getElementById("tab_71331_xmlTab_59888_header").className += " active"; document.getElementById("tab_71331_xmlTab_59888_content").className += " active"; document.getElementById("tab_18726_jsonTab_68895_header").className = "headerContent"; document.getElementById("tab_18726_jsonTab_68895_content").className = "tabContent"; }) document.getElementById("tab_18726_jsonTab_68895_header").addEventListener("click", function () {document.getElementById("tab_71331_xmlTab_59888_header").className = "headerContent"; document.getElementById("tab_71331_xmlTab_59888_content").className = "tabContent"; document.getElementById("tab_18726_jsonTab_68895_header").className += " active"; document.getElementById("tab_18726_jsonTab_68895_content").className += " active"; }) document.getElementById("tab_26493_generalTab_89770_header").addEventListener("click", function () {document.getElementById("tab_26493_generalTab_89770_header").className += " active"; document.getElementById("tab_26493_generalTab_89770_content").className += " active"; document.getElementById("tab_78309_phpTab_89000_header").className = "headerContent"; document.getElementById("tab_78309_phpTab_89000_content").className = "tabContent"; }) document.getElementById("tab_78309_phpTab_89000_header").addEventListener("click", function () {document.getElementById("tab_26493_generalTab_89770_header").className = "headerContent"; document.getElementById("tab_26493_generalTab_89770_content").className = "tabContent"; document.getElementById("tab_78309_phpTab_89000_header").className += " active"; document.getElementById("tab_78309_phpTab_89000_content").className += " active"; }) document.getElementById("tab_71621_xmlTab_91222_header").addEventListener("click", function () {document.getElementById("tab_71621_xmlTab_91222_header").className += " active"; document.getElementById("tab_71621_xmlTab_91222_content").className += " active"; document.getElementById("tab_25859_jsonTab_53587_header").className = "headerContent"; document.getElementById("tab_25859_jsonTab_53587_content").className = "tabContent"; }) document.getElementById("tab_25859_jsonTab_53587_header").addEventListener("click", function () {document.getElementById("tab_71621_xmlTab_91222_header").className = "headerContent"; document.getElementById("tab_71621_xmlTab_91222_content").className = "tabContent"; document.getElementById("tab_25859_jsonTab_53587_header").className += " active"; document.getElementById("tab_25859_jsonTab_53587_content").className += " active"; }) document.getElementById("tab_15635_generalTab_25417_header").addEventListener("click", function () {document.getElementById("tab_15635_generalTab_25417_header").className += " active"; document.getElementById("tab_15635_generalTab_25417_content").className += " active"; document.getElementById("tab_94593_phpTab_90360_header").className = "headerContent"; document.getElementById("tab_94593_phpTab_90360_content").className = "tabContent"; }) document.getElementById("tab_94593_phpTab_90360_header").addEventListener("click", function () {document.getElementById("tab_15635_generalTab_25417_header").className = "headerContent"; document.getElementById("tab_15635_generalTab_25417_content").className = "tabContent"; document.getElementById("tab_94593_phpTab_90360_header").className += " active"; document.getElementById("tab_94593_phpTab_90360_content").className += " active"; }) document.getElementById("tab_44379_xmlTab_61329_header").addEventListener("click", function () {document.getElementById("tab_44379_xmlTab_61329_header").className += " active"; document.getElementById("tab_44379_xmlTab_61329_content").className += " active"; document.getElementById("tab_57918_jsonTab_18178_header").className = "headerContent"; document.getElementById("tab_57918_jsonTab_18178_content").className = "tabContent"; }) document.getElementById("tab_57918_jsonTab_18178_header").addEventListener("click", function () {document.getElementById("tab_44379_xmlTab_61329_header").className = "headerContent"; document.getElementById("tab_44379_xmlTab_61329_content").className = "tabContent"; document.getElementById("tab_57918_jsonTab_18178_header").className += " active"; document.getElementById("tab_57918_jsonTab_18178_content").className += " active"; }) document.getElementById("tab_53430_generalTab_46119_header").addEventListener("click", function () {document.getElementById("tab_53430_generalTab_46119_header").className += " active"; document.getElementById("tab_53430_generalTab_46119_content").className += " active"; document.getElementById("tab_49705_phpTab_82363_header").className = "headerContent"; document.getElementById("tab_49705_phpTab_82363_content").className = "tabContent"; }) document.getElementById("tab_49705_phpTab_82363_header").addEventListener("click", function () {document.getElementById("tab_53430_generalTab_46119_header").className = "headerContent"; document.getElementById("tab_53430_generalTab_46119_content").className = "tabContent"; document.getElementById("tab_49705_phpTab_82363_header").className += " active"; document.getElementById("tab_49705_phpTab_82363_content").className += " active"; }) document.getElementById("tab_92716_xmlTab_65869_header").addEventListener("click", function () {document.getElementById("tab_92716_xmlTab_65869_header").className += " active"; document.getElementById("tab_92716_xmlTab_65869_content").className += " active"; document.getElementById("tab_53219_jsonTab_58320_header").className = "headerContent"; document.getElementById("tab_53219_jsonTab_58320_content").className = "tabContent"; }) document.getElementById("tab_53219_jsonTab_58320_header").addEventListener("click", function () {document.getElementById("tab_92716_xmlTab_65869_header").className = "headerContent"; document.getElementById("tab_92716_xmlTab_65869_content").className = "tabContent"; document.getElementById("tab_53219_jsonTab_58320_header").className += " active"; document.getElementById("tab_53219_jsonTab_58320_content").className += " active"; }) document.getElementById("tab_17564_generalTab_84496_header").addEventListener("click", function () {document.getElementById("tab_17564_generalTab_84496_header").className += " active"; document.getElementById("tab_17564_generalTab_84496_content").className += " active"; document.getElementById("tab_92946_phpTab_88322_header").className = "headerContent"; document.getElementById("tab_92946_phpTab_88322_content").className = "tabContent"; }) document.getElementById("tab_92946_phpTab_88322_header").addEventListener("click", function () {document.getElementById("tab_17564_generalTab_84496_header").className = "headerContent"; document.getElementById("tab_17564_generalTab_84496_content").className = "tabContent"; document.getElementById("tab_92946_phpTab_88322_header").className += " active"; document.getElementById("tab_92946_phpTab_88322_content").className += " active"; }) document.getElementById("tab_49853_xmlTab_24278_header").addEventListener("click", function () {document.getElementById("tab_49853_xmlTab_24278_header").className += " active"; document.getElementById("tab_49853_xmlTab_24278_content").className += " active"; document.getElementById("tab_81047_jsonTab_27293_header").className = "headerContent"; document.getElementById("tab_81047_jsonTab_27293_content").className = "tabContent"; }) document.getElementById("tab_81047_jsonTab_27293_header").addEventListener("click", function () {document.getElementById("tab_49853_xmlTab_24278_header").className = "headerContent"; document.getElementById("tab_49853_xmlTab_24278_content").className = "tabContent"; document.getElementById("tab_81047_jsonTab_27293_header").className += " active"; document.getElementById("tab_81047_jsonTab_27293_content").className += " active"; }) document.getElementById("tab_14171_generalTab_94554_header").addEventListener("click", function () {document.getElementById("tab_14171_generalTab_94554_header").className += " active"; document.getElementById("tab_14171_generalTab_94554_content").className += " active"; document.getElementById("tab_86910_phpTab_26845_header").className = "headerContent"; document.getElementById("tab_86910_phpTab_26845_content").className = "tabContent"; }) document.getElementById("tab_86910_phpTab_26845_header").addEventListener("click", function () {document.getElementById("tab_14171_generalTab_94554_header").className = "headerContent"; document.getElementById("tab_14171_generalTab_94554_content").className = "tabContent"; document.getElementById("tab_86910_phpTab_26845_header").className += " active"; document.getElementById("tab_86910_phpTab_26845_content").className += " active"; }) document.getElementById("tab_77075_xmlTab_29244_header").addEventListener("click", function () {document.getElementById("tab_77075_xmlTab_29244_header").className += " active"; document.getElementById("tab_77075_xmlTab_29244_content").className += " active"; document.getElementById("tab_70883_jsonTab_71124_header").className = "headerContent"; document.getElementById("tab_70883_jsonTab_71124_content").className = "tabContent"; }) document.getElementById("tab_70883_jsonTab_71124_header").addEventListener("click", function () {document.getElementById("tab_77075_xmlTab_29244_header").className = "headerContent"; document.getElementById("tab_77075_xmlTab_29244_content").className = "tabContent"; document.getElementById("tab_70883_jsonTab_71124_header").className += " active"; document.getElementById("tab_70883_jsonTab_71124_content").className += " active"; }) document.getElementById("tab_20138_generalTab_77424_header").addEventListener("click", function () {document.getElementById("tab_20138_generalTab_77424_header").className += " active"; document.getElementById("tab_20138_generalTab_77424_content").className += " active"; document.getElementById("tab_50743_phpTab_78912_header").className = "headerContent"; document.getElementById("tab_50743_phpTab_78912_content").className = "tabContent"; }) document.getElementById("tab_50743_phpTab_78912_header").addEventListener("click", function () {document.getElementById("tab_20138_generalTab_77424_header").className = "headerContent"; document.getElementById("tab_20138_generalTab_77424_content").className = "tabContent"; document.getElementById("tab_50743_phpTab_78912_header").className += " active"; document.getElementById("tab_50743_phpTab_78912_content").className += " active"; }) document.getElementById("tab_49341_xmlTab_53379_header").addEventListener("click", function () {document.getElementById("tab_49341_xmlTab_53379_header").className += " active"; document.getElementById("tab_49341_xmlTab_53379_content").className += " active"; document.getElementById("tab_80817_jsonTab_56374_header").className = "headerContent"; document.getElementById("tab_80817_jsonTab_56374_content").className = "tabContent"; }) document.getElementById("tab_80817_jsonTab_56374_header").addEventListener("click", function () {document.getElementById("tab_49341_xmlTab_53379_header").className = "headerContent"; document.getElementById("tab_49341_xmlTab_53379_content").className = "tabContent"; document.getElementById("tab_80817_jsonTab_56374_header").className += " active"; document.getElementById("tab_80817_jsonTab_56374_content").className += " active"; }) document.getElementById("tab_62994_generalTab_34140_header").addEventListener("click", function () {document.getElementById("tab_62994_generalTab_34140_header").className += " active"; document.getElementById("tab_62994_generalTab_34140_content").className += " active"; document.getElementById("tab_98196_phpTab_98818_header").className = "headerContent"; document.getElementById("tab_98196_phpTab_98818_content").className = "tabContent"; }) document.getElementById("tab_98196_phpTab_98818_header").addEventListener("click", function () {document.getElementById("tab_62994_generalTab_34140_header").className = "headerContent"; document.getElementById("tab_62994_generalTab_34140_content").className = "tabContent"; document.getElementById("tab_98196_phpTab_98818_header").className += " active"; document.getElementById("tab_98196_phpTab_98818_content").className += " active"; }) document.getElementById("tab_86855_xmlTab_39223_header").addEventListener("click", function () {document.getElementById("tab_86855_xmlTab_39223_header").className += " active"; document.getElementById("tab_86855_xmlTab_39223_content").className += " active"; document.getElementById("tab_26181_jsonTab_90941_header").className = "headerContent"; document.getElementById("tab_26181_jsonTab_90941_content").className = "tabContent"; }) document.getElementById("tab_26181_jsonTab_90941_header").addEventListener("click", function () {document.getElementById("tab_86855_xmlTab_39223_header").className = "headerContent"; document.getElementById("tab_86855_xmlTab_39223_content").className = "tabContent"; document.getElementById("tab_26181_jsonTab_90941_header").className += " active"; document.getElementById("tab_26181_jsonTab_90941_content").className += " active"; }) document.getElementById("tab_11362_generalTab_24281_header").addEventListener("click", function () {document.getElementById("tab_11362_generalTab_24281_header").className += " active"; document.getElementById("tab_11362_generalTab_24281_content").className += " active"; document.getElementById("tab_46535_phpTab_13356_header").className = "headerContent"; document.getElementById("tab_46535_phpTab_13356_content").className = "tabContent"; }) document.getElementById("tab_46535_phpTab_13356_header").addEventListener("click", function () {document.getElementById("tab_11362_generalTab_24281_header").className = "headerContent"; document.getElementById("tab_11362_generalTab_24281_content").className = "tabContent"; document.getElementById("tab_46535_phpTab_13356_header").className += " active"; document.getElementById("tab_46535_phpTab_13356_content").className += " active"; }) document.getElementById("tab_58013_xmlTab_16583_header").addEventListener("click", function () {document.getElementById("tab_58013_xmlTab_16583_header").className += " active"; document.getElementById("tab_58013_xmlTab_16583_content").className += " active"; document.getElementById("tab_70519_jsonTab_51049_header").className = "headerContent"; document.getElementById("tab_70519_jsonTab_51049_content").className = "tabContent"; }) document.getElementById("tab_70519_jsonTab_51049_header").addEventListener("click", function () {document.getElementById("tab_58013_xmlTab_16583_header").className = "headerContent"; document.getElementById("tab_58013_xmlTab_16583_content").className = "tabContent"; document.getElementById("tab_70519_jsonTab_51049_header").className += " active"; document.getElementById("tab_70519_jsonTab_51049_content").className += " active"; }) document.getElementById("tab_63802_generalTab_49446_header").addEventListener("click", function () {document.getElementById("tab_63802_generalTab_49446_header").className += " active"; document.getElementById("tab_63802_generalTab_49446_content").className += " active"; document.getElementById("tab_43465_phpTab_47318_header").className = "headerContent"; document.getElementById("tab_43465_phpTab_47318_content").className = "tabContent"; }) document.getElementById("tab_43465_phpTab_47318_header").addEventListener("click", function () {document.getElementById("tab_63802_generalTab_49446_header").className = "headerContent"; document.getElementById("tab_63802_generalTab_49446_content").className = "tabContent"; document.getElementById("tab_43465_phpTab_47318_header").className += " active"; document.getElementById("tab_43465_phpTab_47318_content").className += " active"; }) document.getElementById("tab_54687_xmlTab_69928_header").addEventListener("click", function () {document.getElementById("tab_54687_xmlTab_69928_header").className += " active"; document.getElementById("tab_54687_xmlTab_69928_content").className += " active"; document.getElementById("tab_85200_jsonTab_64225_header").className = "headerContent"; document.getElementById("tab_85200_jsonTab_64225_content").className = "tabContent"; }) document.getElementById("tab_85200_jsonTab_64225_header").addEventListener("click", function () {document.getElementById("tab_54687_xmlTab_69928_header").className = "headerContent"; document.getElementById("tab_54687_xmlTab_69928_content").className = "tabContent"; document.getElementById("tab_85200_jsonTab_64225_header").className += " active"; document.getElementById("tab_85200_jsonTab_64225_content").className += " active"; }) document.getElementById("tab_84546_generalTab_75248_header").addEventListener("click", function () {document.getElementById("tab_84546_generalTab_75248_header").className += " active"; document.getElementById("tab_84546_generalTab_75248_content").className += " active"; document.getElementById("tab_91091_phpTab_37998_header").className = "headerContent"; document.getElementById("tab_91091_phpTab_37998_content").className = "tabContent"; }) document.getElementById("tab_91091_phpTab_37998_header").addEventListener("click", function () {document.getElementById("tab_84546_generalTab_75248_header").className = "headerContent"; document.getElementById("tab_84546_generalTab_75248_content").className = "tabContent"; document.getElementById("tab_91091_phpTab_37998_header").className += " active"; document.getElementById("tab_91091_phpTab_37998_content").className += " active"; }) document.getElementById("tab_67433_xmlTab_84567_header").addEventListener("click", function () {document.getElementById("tab_67433_xmlTab_84567_header").className += " active"; document.getElementById("tab_67433_xmlTab_84567_content").className += " active"; document.getElementById("tab_75244_jsonTab_32474_header").className = "headerContent"; document.getElementById("tab_75244_jsonTab_32474_content").className = "tabContent"; }) document.getElementById("tab_75244_jsonTab_32474_header").addEventListener("click", function () {document.getElementById("tab_67433_xmlTab_84567_header").className = "headerContent"; document.getElementById("tab_67433_xmlTab_84567_content").className = "tabContent"; document.getElementById("tab_75244_jsonTab_32474_header").className += " active"; document.getElementById("tab_75244_jsonTab_32474_content").className += " active"; }) document.getElementById("tab_26360_generalTab_37883_header").addEventListener("click", function () {document.getElementById("tab_26360_generalTab_37883_header").className += " active"; document.getElementById("tab_26360_generalTab_37883_content").className += " active"; document.getElementById("tab_42438_phpTab_24818_header").className = "headerContent"; document.getElementById("tab_42438_phpTab_24818_content").className = "tabContent"; }) document.getElementById("tab_42438_phpTab_24818_header").addEventListener("click", function () {document.getElementById("tab_26360_generalTab_37883_header").className = "headerContent"; document.getElementById("tab_26360_generalTab_37883_content").className = "tabContent"; document.getElementById("tab_42438_phpTab_24818_header").className += " active"; document.getElementById("tab_42438_phpTab_24818_content").className += " active"; }) document.getElementById("tab_33987_xmlTab_70731_header").addEventListener("click", function () {document.getElementById("tab_33987_xmlTab_70731_header").className += " active"; document.getElementById("tab_33987_xmlTab_70731_content").className += " active"; document.getElementById("tab_75242_jsonTab_25809_header").className = "headerContent"; document.getElementById("tab_75242_jsonTab_25809_content").className = "tabContent"; }) document.getElementById("tab_75242_jsonTab_25809_header").addEventListener("click", function () {document.getElementById("tab_33987_xmlTab_70731_header").className = "headerContent"; document.getElementById("tab_33987_xmlTab_70731_content").className = "tabContent"; document.getElementById("tab_75242_jsonTab_25809_header").className += " active"; document.getElementById("tab_75242_jsonTab_25809_content").className += " active"; }) </script ></div> <div class="Files"> </div> <div class="ArticleInfo"> <span itemscope itemprop="image" itemtype="https://schema.org/ImageObject"> <meta itemprop="url" content="/scripts/file.php?view=Y&file=2a2f2096ece5375232b72bead5de4c81"> <meta itemprop="width" content="300px"> <meta itemprop="height" content="200px"> </span> <div class="ArticleUpdated" title="Jan 05, 2024, 04:56 AM"> <span class="ArticleInfoLabel">Updated:</span> <span class="ArticleInfoValue"><time datetime="2024-01-05" itemprop="dateModified">Jan 05 (10 months ago)</time></span> </div> <time datetime="2012-06-27" itemprop="datePublished"></time> </div> </div> <div class="col-md-3"> <!-- search_box --> <div class="margin-bottom" itemscope itemtype="https://schema.org/WebSite"> <meta itemprop="url" content="./" /> <form action="search" method="get" itemprop="potentialAction" itemscope itemtype="https://schema.org/SearchAction"> <div class="input-group"> <meta itemprop="target" content="search?q={q}"/> <input aria-label="Search text" title="Search text" placeholder="Search text" itemprop="query-input" type="text" name="q" value="" class="form-control SearchText" required> <input type="hidden" name="pid" value="2821"> <input type="hidden" name="type" value="search"> <input type="hidden" name="upid" value=""> <span class="input-group-btn"> <input class="btn btn-default btn-searchbox" type="submit" value="Search"> </span> </div> </form> </div> <!-- right_other_articles --> <div class="panel panel-default"> <div class="panel-heading"><h4>Other Articles</h4></div> <ul class="panel-body list-group"> <li class="list-group-item item-A"><a href="//support.liveagent.com/061754-How-to-make-REST-calls-in-PHP" class="article-link article-link-2827" title="How to make REST calls in PHP"> <span class="TitleValue">How to make REST calls in PHP</span> </a></li> <li class="list-group-item item-A"><a href="//support.liveagent.com/174246-Using-REST-API-without-mod_rewrite" class="article-link article-link-2915" title="Using REST API without mod_rewrite"> <span class="TitleValue">Using REST API without mod_rewrite</span> </a></li> </ul> </div> </div> </div> </div> </div> <script type="text/javascript"> var searchId = document.location.hash.replace('#', ''); var headTag = document.getElementsByTagName("head").item(0); var scriptTag = document.createElement("script"); scriptTag.setAttribute("type", "text/javascript"); scriptTag.setAttribute("src", "/track.php?id=2821&searchId="+searchId); headTag.appendChild(scriptTag); </script> <footer> <div id="multiwidget" class="multiwidget"> <span onclick="openMultiwidget();">×</span> <ul> <li id="elementForm" class="form" onclick="FcontactFormTrigger();"> <font>Contact form</font> <img src="https://www.liveagent.com/app/themes/liveagent/assets/images/contact/form.svg" /> </li> <li id="elementChat" class="chat" onclick="chatButton.onClick();"> <font>Live chat</font> <img src="https://www.dropbox.com/scl/fi/6o76udnhmkj67sc2c5a0s/livechat.png?rlkey=dwqzgwlo161dss06dg2dpttx0&raw=1" /> </li> <li id="elementAI" class="ai" onclick=""> <font>Chatbot</font> <img src="https://www.liveagent.com/app/themes/liveagent/assets/images/contact/chatbot.svg" /> </li> </ul> <div id="service_status">loading status...</div> </div> <div id="mainButton" class="main_button" onclick="openMultiwidget();"> <span>Contact Us</span> <img src="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQkFnGM_CtOsOzloGOge47HQ7-U4gnyhrryn2iA7dmf0A&s" /> </div> <div class="footer-links"> <div class="container"> <div class="row"> <div class="col-md-3 col-sm-6"> <div class="product-desc"> <h5><img alt="LiveAgent logo" style="max-width:15rem" src="https://www.liveagent.com/wp/urlslab-download/c628015cb7f265c7943a6d568ca8ddac/logo_liveagent_light.svg" /><br></h5> <p>LiveAgent is an integrated <a href="https://www.liveagent.com">customer support software</a>, <a href="https://www.liveagent.com/tour/ticket-processing-distribution/">ticketing system</a>, <a href="https://www.liveagent.com/tour/live-chat-software/">live chat</a>, <a href="https://www.liveagent.com/features/facebook/">social helpdesk</a> and <a href="https://www.liveagent.com/features/call-center/">voice helpdesk</a>. You name it, it's there. Based in cloud and accessible from everywhere, with SSL safety.</p> </div> </div> <div class="col-md-3 col-sm-6"> <div class="product-links"> <h5>LiveAgent</h5> <ul> <li><a href="https://www.liveagent.com/pricing/" title="Subscription plans from $19/month. Downlodable licences(one-time-fee) from $99. 14-day free trial. 30-day money back guarantee.">Pricing</a></li> <li><a href="https://www.liveagent.com/testimonials/" title="Web-based multichannel help desk software which integrates all channels(Email, Voice, Chat, Facebook and Twitter) into 1 interface. 14-day free trial">Testimonials</a></li> <li><a href="https://www.liveagent.com/use-cases/" title="Use Cases">Use Cases</a></li> <li><a href="https://www.liveagent.com/integrations-and-plugins/" title="Maximize the value of your existing help desk and extend customer satisfaction with LiveAgent's range of integrations, plugins and apps.">Integrations and Plugins</a></li> <li><a href="https://www.liveagent.com/trial/" title="Live Agent Free Trial">Free Trial</a></li> </ul> </div> </div> <div class="col-md-3 col-sm-6"><!-- right_popular_list --> <div class="popular-links"> <h5>Most Popular Articles</h5> <ul> <li><a href="//support.liveagent.com/061754-How-to-make-REST-calls-in-PHP" class="article-link article-link-2827" title="How to make REST calls in PHP">How to make REST calls in PHP</a></li> <li><a href="//support.liveagent.com/761558-Enable-External-Forwarding-in-Microsoft-365" class="article-link article-link-12765" title="Enable External Forwarding in Microsoft 365">Enable External Forwarding in Microsoft 365</a></li> <li><a href="//support.liveagent.com/840770-Complete-API-reference" class="article-link article-link-2821" title="Complete API reference">Complete API reference</a></li> <li><a href="//support.liveagent.com/172666-Facebook-application-setup-and-Facebook-page-integration-for-standalone-installations" class="article-link article-link-1283" title="Facebook application setup and Facebook page integration for standalone installations">Facebook application setup and Facebook page integration for standalone installations</a></li> <li><a href="//support.liveagent.com/458758-Email-accounts-configuration-introduction" class="article-link article-link-1092" title="Email accounts configuration introduction">Email accounts configuration introduction</a></li> <li><a href="//support.liveagent.com/704852-How-to-submit-Facebook-application-for-review" class="article-link article-link-5225" title="How to submit Facebook application for review">How to submit Facebook application for review</a></li> <li><a href="//support.liveagent.com/846792-Microphone-permissions-for-browser-calls" class="article-link article-link-5280" title="Microphone permissions for browser calls">Microphone permissions for browser calls</a></li> <li><a href="//support.liveagent.com/851456-Facebook-integration-error---the-user-is-enrolled-in-a-blocking-logged-in-checkpoint" class="article-link article-link-12577" title="Facebook integration error - the user is enrolled in a blocking, logged-in checkpoint">Facebook integration error - the user is enrolled in a blocking, logged-in checkpoint</a></li> <li><a href="//support.liveagent.com/373207-Creating-chat-buttons" class="article-link article-link-1101" title="Creating chat buttons">Creating chat buttons</a></li> <li><a href="//support.liveagent.com/018505-LiveAgent-Domain-parking-guide" class="article-link article-link-3872" title="LiveAgent Domain parking guide">LiveAgent Domain parking guide</a></li> </ul> </div> </div> <div class="col-md-3 col-sm-6"> <div class="product-desc socials"> <h5>Socials</h5> <a href="https://www.instagram.com/liveagent/" target="_blank" title="LiveAgent's Instagram"> <svg width="24" height="24" viewBox="0 0 24 24" version="1.1" id="svg4" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs8"></defs><path d="m 8.16759,12 c 0,-2.11701 1.71577,-3.83364 3.83291,-3.83364 2.1171,0 3.8338,1.71663 3.8338,3.83364 0,2.117 -1.7167,3.8336 -3.8338,3.8336 C 9.88336,15.8336 8.16759,14.117 8.16759,12 Z m -2.07248,0 c 0,3.2614 2.64382,5.9051 5.90539,5.9051 3.2615,0 5.9053,-2.6437 5.9053,-5.9051 0,-3.2614 -2.6438,-5.90511 -5.9053,-5.90511 C 8.73893,6.09489 6.09511,8.7386 6.09511,12 Z M 16.7595,5.86075 c -3e-4,0.76215 0.6174,1.38024 1.3795,1.38055 0.7622,3e-4 1.3803,-0.6173 1.3806,-1.37945 C 19.5199,5.0997 18.9023,4.4816 18.1401,4.4813 h -5e-4 c -0.7618,3.5e-4 -1.3794,0.61766 -1.3801,1.37945 z M 7.35427,21.3607 C 6.23303,21.3097 5.62359,21.1229 5.21859,20.9651 4.68166,20.7561 4.29856,20.5071 3.89576,20.1049 3.49297,19.7027 3.24364,19.32 3.03553,18.7831 2.87765,18.3783 2.69088,17.7687 2.63991,16.6475 2.58416,15.4353 2.57303,15.0711 2.57303,12.0001 2.57303,8.92904 2.58508,8.56592 2.63991,7.35271 2.69098,6.23151 2.87912,5.62311 3.03553,5.21712 3.24456,4.6802 3.49352,4.29712 3.89576,3.89434 4.298,3.49156 4.68074,3.24224 5.21859,3.03414 5.62341,2.87627 6.23303,2.68951 7.35427,2.63854 8.56651,2.58279 8.93067,2.57166 12.0005,2.57166 c 3.0698,0 3.4343,0.01205 4.6475,0.06688 1.1213,0.05106 1.7297,0.2392 2.1357,0.3956 0.5369,0.2081 0.92,0.45798 1.3228,0.8602 0.4028,0.40222 0.6512,0.78586 0.8603,1.32278 0.1578,0.4048 0.3446,1.01439 0.3956,2.13559 0.0557,1.21321 0.0669,1.57633 0.0669,4.64739 0,3.071 -0.0112,3.4342 -0.0669,4.6474 -0.0511,1.1212 -0.2388,1.7306 -0.3956,2.1356 -0.2091,0.5369 -0.458,0.92 -0.8603,1.3218 -0.4022,0.4019 -0.7859,0.6512 -1.3228,0.8602 -0.4048,0.1579 -1.0144,0.3447 -2.1357,0.3956 -1.2122,0.0558 -1.5764,0.0669 -4.6475,0.0669 -3.07121,0 -3.43435,-0.0111 -4.64623,-0.0669 z M 7.25905,0.569644 C 6.03476,0.625396 5.19817,0.819516 4.46757,1.103796 3.71093,1.397368 3.0704,1.79122 2.43033,2.43025 1.79026,3.06928 1.397404,3.7108 1.10382,4.46741 0.819529,5.19844 0.625401,6.03454 0.5696468,7.25878 0.5129725,8.48496 0.5,8.87697 0.5,12 c 0,3.123 0.0129725,3.515 0.0696468,4.7412 0.0557542,1.2244 0.2498822,2.0604 0.5341732,2.7914 0.293584,0.7561 0.68653,1.3984 1.32651,2.0371 0.63998,0.6388 1.2806,1.0321 2.03724,1.3265 0.73198,0.2843 1.56719,0.4784 2.79148,0.5342 1.22687,0.0557 1.61825,0.0696 4.74145,0.0696 3.1231,0 3.5151,-0.013 4.7414,-0.0696 1.2244,-0.0558 2.0604,-0.2499 2.7915,-0.5342 0.7561,-0.2944 1.3971,-0.6874 2.0372,-1.3265 0.6401,-0.639 1.0321,-1.281 1.3265,-2.0371 0.2843,-0.731 0.4793,-1.5671 0.5342,-2.7914 C 23.487,15.5141 23.5,15.123 23.5,12 23.5,8.87697 23.487,8.48496 23.4313,7.25878 23.3755,6.03444 23.1814,5.19798 22.8971,4.46741 22.6027,3.71126 22.2096,3.0703 21.5706,2.43025 20.9315,1.79021 20.2895,1.397368 19.5343,1.103796 18.8023,0.819516 17.9662,0.624476 16.7428,0.569644 15.5166,0.513892 15.1245,0.5 12.0014,0.5 8.87822,0.5 8.48592,0.512972 7.25905,0.569644 Z" id="path2"></path></svg></a> <a href="https://www.facebook.com/LiveAgent/" target="_blank" title="LiveAgent's Facebook"> <svg width="24" height="24" viewBox="0 0 24 24" version="1.1" id="svg4" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs8"></defs><path fill-rule="evenodd" clip-rule="evenodd" d="m 12,0.56965 c 6.352,0 11.5,5.14805 11.5,11.5 0,5.741 -4.2047,10.4982 -9.7031,11.3607 v -8.0365 h 2.6796 l 0.5098,-3.3242 H 13.7969 V 9.9134 c 0,-0.90967 0.4447,-1.79688 1.8732,-1.79688 h 1.451 V 5.28645 c 0,0 -1.1568,-0.19741 -2.3378,-0.22209 -0.0788,-0.00165 -0.1576,-0.00252 -0.2362,-0.00252 -2.628,0 -4.34398,1.59248 -4.34398,4.47422 v 2.53359 H 7.2832 v 3.3242 h 2.91992 v 8.0365 C 4.70469,22.56785 0.5,17.81065 0.5,12.06965 c 0,-6.35195 5.14805,-11.5 11.5,-11.5 z" id="path2"></path></svg> </a> <a href="https://twitter.com/LiveAgent" target="_blank" title="LiveAgent's Twitter"> <svg width="24" height="24" viewBox="0 0 24 24" version="1.1" id="svg4" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><defs id="defs8"></defs><path d="m 21.543,7.1325504 c 0.0146,0.21035 0.0146,0.4207 0.0146,0.63299 C 21.5576,14.234 16.6045,21.6941 7.54759,21.6941 V 21.6903 C 4.87215,21.6941 2.25229,20.9322 0,19.4956 c 0.389031,0.0466 0.780012,0.0698 1.17197,0.0708 2.21718,0.0019 4.37099,-0.7377 6.11529,-2.0996 -2.107,-0.0397 -3.95466,-1.4056 -4.60012,-3.3995 0.73809,0.1415 1.4986,0.1124 2.22304,-0.0843 -2.29714,-0.4615 -3.94979,-2.46802 -3.94979,-4.7983296 0,-0.02133 0,-0.04169 0,-0.06204 0.68446,0.37901 1.45082,0.58936 2.23473,0.61263 -2.16355,-1.43755 -2.830464,-4.29907 -1.52394,-6.536334 2.49993,3.058304 6.18842,4.917514 10.14792,5.114294 -0.3968,-1.70024 0.1453,-3.48191 1.4245,-4.67712 1.9832,-1.853395 5.1023,-1.758399 6.9665,0.21229 1.1028,-0.21616 2.1597,-0.618444 3.1269,-1.188423 -0.3676,1.133173 -1.1369,2.095733 -2.1645,2.707393 0.9759,-0.11438 1.9295,-0.37417 2.8275,-0.77063 -0.6611,0.98486 -1.4937,1.84274 -2.457,2.53582 z" id="path2"></path></svg> </a> <a href="https://www.linkedin.com/company/liveagent/" target="_blank" title="LiveAgent's LinkedIn"> <svg width="24" height="24" viewBox="0 0 24 24" version="1.1" id="svg13" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_150_287)" id="g6" transform="translate(0,1.78825)"><path d="m 22.8259,19.1278 c 0.0995,-5e-4 0.1948,-0.0402 0.2652,-0.1105 0.0704,-0.0703 0.1101,-0.1656 0.1105,-0.265 5e-4,-0.0073 5e-4,-0.0146 0,-0.0218 0,-0.2816 -0.1677,-0.4191 -0.5191,-0.4191 h -0.5636 v 1.4743 h 0.2122 v -0.6428 h 0.2608 l 0.0051,0.0075 0.405,0.6353 h 0.2265 L 22.794,19.1345 Z m -0.2516,-0.1475 h -0.2432 v -0.4987 h 0.312 c 0.161,0 0.3438,0.0259 0.3438,0.2371 0,0.2423 -0.1845,0.2616 -0.4109,0.2616" id="path2"></path><path d="m 17.2905,17.2796 h -3.0059 v -4.7063 c 0,-1.1214 -0.0201,-2.5664 -1.5642,-2.5664 -1.5658,0 -1.8057,1.2229 -1.8057,2.4852 v 4.7867 H 7.90802 V 7.60221 h 2.88678 v 1.32262 h 0.0377 C 11.1218,8.43075 11.5398,8.0244 12.042,7.7491 c 0.5022,-0.27529 1.0697,-0.4092 1.6421,-0.38745 3.047,0 3.6064,2.00321 3.6064,4.60985 z M 4.51551,6.27958 C 4.17032,6.27958 3.83288,6.17729 3.54587,5.98563 3.25885,5.79397 3.03515,5.52156 2.90305,5.20285 2.77095,4.88413 2.73639,4.53343 2.80373,4.19509 2.87107,3.85674 3.0373,3.54595 3.28139,3.30202 3.52547,3.05808 3.83646,2.89196 4.17502,2.82466 4.51358,2.75736 4.8645,2.7919 5.18342,2.92392 5.50233,3.05593 5.77492,3.27949 5.96669,3.56633 6.15847,3.85316 6.26083,4.19039 6.26083,4.53537 6.25841,4.99707 6.07387,5.43919 5.74726,5.76574 5.42065,6.0923 4.97835,6.27694 4.51635,6.27958 Z M 6.01845,17.2796 H 3.00839 V 7.60221 H 6.01845 Z M 18.79,9.0166e-4 H 1.4979 C 1.10595,-0.00158547 0.728827,0.15051 0.448391,0.424178 0.167955,0.697847 0.00683761,1.071 0,1.46266 V 18.8126 c 0.00661812,0.3919 0.167612,0.7654 0.448048,1.0394 0.280435,0.2739 0.657682,0.4263 1.049852,0.4241 H 18.79 c 0.3924,0.0031 0.7702,-0.1483 1.0515,-0.4217 0.2813,-0.2733 0.4435,-0.6464 0.4515,-1.0384 V 1.46182 C 20.2859,1.06936 20.124,0.695569 19.8426,0.421805 19.5611,0.148041 19.1828,-0.003537 18.79,6.26786e-5 Z M 22.6036,17.6577 c -0.3659,0.0034 -0.7155,0.1515 -0.9724,0.4119 -0.2569,0.2603 -0.4002,0.6118 -0.3984,0.9775 0.0017,0.3656 0.1482,0.7157 0.4076,0.9737 0.2593,0.2579 0.6103,0.4027 0.9762,0.4027 0.3659,0 0.7169,-0.1448 0.9762,-0.4027 0.2593,-0.258 0.4059,-0.6081 0.4076,-0.9737 0.0017,-0.3657 -0.1415,-0.7172 -0.3984,-0.9775 -0.2569,-0.2604 -0.6066,-0.4085 -0.9724,-0.4119 z m 0,2.6066 h -0.021 c -0.2392,0 -0.473,-0.0706 -0.6721,-0.203 -0.1991,-0.1324 -0.3546,-0.3207 -0.447,-0.5411 -0.0925,-0.2205 -0.1176,-0.4633 -0.0724,-0.698 0.0452,-0.2347 0.1588,-0.4508 0.3265,-0.6212 0.1677,-0.1704 0.3821,-0.2875 0.6162,-0.3365 0.234,-0.049 0.4774,-0.0279 0.6995,0.0608 0.222,0.0888 0.4129,0.2411 0.5487,0.4379 0.1357,0.1967 0.2102,0.4292 0.2142,0.6682 v 0.0193 c 0.005,0.314 -0.1141,0.6173 -0.3314,0.8442 -0.2172,0.2268 -0.5152,0.359 -0.8294,0.3678 h -0.0318" id="path4"></path></g><defs id="defs11"><clipPath id="clip0_150_287"><rect width="24" height="20.4235" fill="#ffffff" id="rect8" x="0" y="0"></rect></clipPath></defs></svg> </a> <a href="https://www.youtube.com/channel/UCSG5TrYcDozs6jkLf66taBg" target="_blank" title="LiveAgent's YouTube"> <svg width="24" height="24" viewBox="0 0 24 23.999999" version="1.1" id="svg11" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_150_290)" id="g4" transform="matrix(0.92307692,0,0,0.92307692,4e-8,3.5764618)"><path fill-rule="evenodd" clip-rule="evenodd" d="m 24.5829,1.3971 c 0.4038,0.40469 0.6947,0.90839 0.8436,1.46088 0.8588,3.46468 0.6604,8.94162 0.0167,12.53502 -0.149,0.5525 -0.4398,1.0562 -0.8436,1.4609 -0.4038,0.4047 -0.9063,0.6962 -1.4576,0.8455 -2.0177,0.5516 -10.1385,0.5516 -10.1385,0.5516 0,0 -8.12083,0 -10.13853,-0.5516 C 2.31374,17.5501 1.81119,17.2586 1.40742,16.8539 1.00366,16.4492 0.71278,15.9455 0.563792,15.393 -0.303319,11.9434 -0.063196,6.46807 0.547117,2.8747 0.696105,2.3222 0.986982,1.8185 1.39075,1.41381 1.79451,1.00912 2.29706,0.717583 2.8483,0.568254 4.866,0.0167133 12.9868,0 12.9868,0 c 0,0 8.1209,0 10.1386,0.551541 0.5512,0.149329 1.0537,0.44087 1.4575,0.845559 z m -7.444,7.72842 -6.7368,3.91088 V 5.2146 Z" id="path2"></path></g><defs id="defs9"><clipPath id="clip0_150_290"><rect width="26" height="18.250999" fill="#ffffff" id="rect6" x="0" y="0"></rect></clipPath></defs></svg> </a> <a href="https://wa.me/17862041375" target="_blank" title="LiveAgent's WhatsApp"> <svg xmlns="http://www.w3.org/2000/svg" width="23" height="27" xmlns:v="https://vecta.io/nano"><path d="M19.555 4.985a11.31 11.31 0 0 0-8.06-3.342C5.211 1.643.098 6.756.098 13.04a11.41 11.41 0 0 0 1.52 5.699L0 24.643l6.043-1.586c1.663.909 3.537 1.386 5.447 1.386h.005C17.774 24.443 23 19.329 23 13.045c0-3.044-1.294-5.904-3.445-8.06h0zm-8.06 17.538c-1.704 0-3.373-.457-4.826-1.319l-.344-.205-3.583.939.955-3.496-.226-.359a9.44 9.44 0 0 1-1.448-5.042A9.49 9.49 0 0 1 11.5 3.568a9.39 9.39 0 0 1 6.695 2.777c1.787 1.792 2.885 4.169 2.88 6.7 0 5.226-4.359 9.477-9.58 9.477h0zm5.196-7.095c-.282-.144-1.684-.832-1.946-.924-.262-.098-.452-.144-.642.144s-.734.924-.904 1.119c-.164.19-.334.216-.616.072-1.674-.837-2.772-1.494-3.876-3.388-.293-.503.293-.467.837-1.556.092-.19.046-.354-.026-.498s-.642-1.545-.878-2.115c-.231-.554-.467-.477-.642-.488-.164-.01-.354-.01-.544-.01s-.498.072-.76.354c-.262.287-.996.975-.996 2.377s1.022 2.757 1.16 2.947c.144.19 2.007 3.065 4.867 4.302 1.807.78 2.516.847 3.419.714.549-.082 1.684-.688 1.92-1.355s.236-1.237.164-1.355c-.067-.128-.257-.2-.539-.339z"></path></svg> </a> </div> </div> </div> <div id="copyright"><a target="_blank" href="https://www.liveagent.com" title="Helpdesk software by LiveAgent" style="text-decoration:none">Helpdesk software by <object style="vertical-align:top;"><svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 -9 16 16" enable-background="new 0 -9 16 16" xml:space="preserve"><g><path d="M2.445-0.419c0-0.487,0.248-1.564,1.167-1.564c0.772,0,1.158,0.506,1.158,1.519c0,1.093-0.386,1.64-1.158,1.64 C2.833,1.174,2.445,0.644,2.445-0.419z M8.414,4.338C7.496,5.432,6.44,6.669,5.083,6.667c0.513-0.71,0.872-1.568,1.141-2.455 c-3.305-0.524-5.765-2.51-5.765-4.881c0-1.152,0.813-3.455,3.462-3.455c2.167,0,3.718,1.729,3.718,3.697 c0,1.506-0.705,2.045-1.106,2.045c-0.467,0-0.7-0.336-0.7-1.008v-3.458H4.831v0.309C4.534-2.82,4.128-2.96,3.612-2.96 c-1.921,0-2.235,1.927-2.235,2.541c0,0.826,0.431,2.571,2.235,2.571c0.587,0,1.066-0.201,1.438-0.602 c0.306,0.688,0.8,1.03,1.483,1.03c0.849,0,2.069-0.714,2.069-3.007c0-3.368-3.049-4.702-4.082-4.702 c5.584-1.76,10.939,1.016,10.939,4.459C15.459,2,12.344,4.181,8.414,4.338z"/></g></svg></object><b> LiveAgent</b></a><span class="floatRight"> 漏 2004-2024 Quality Unit, LLC. All rights reserved.</span></div> <div class="footer-container"> <div class="container"> <div class="AppBrandProductWidget" style="display:inline-block; vertical-align:middle; line-height:16px; height:16px; white-space:nowrap;"><a class="AppBrandProductLink" target="_blank" href="https://www.ladesk.com/help-desk-software/?utm_source=textlink&utm_medium=link&utm_campaign=" title="Help desk software by LiveAgent" style="line-height:16px; vertical-align:middle; font-family:Arial,Verdana,san-serif; font-size:11px; font-weight:normal; text-decoration:none; color:inherit"><span class="AppBrandProductLabel">Help desk software by</span> <object style="display:inline-block; opacity:0.7; line-height:16px; width:16px; height:16px; vertical-align:top;"><svg version="1.1" id="Layer_1" xmlns="https://www.w3.org/2000/svg" xmlns:xlink="https://www.w3.org/1999/xlink" x="0px" y="0px" width="16px" height="16px" viewBox="0 -9 16 16" enable-background="new 0 -9 16 16" xml:space="preserve"><g><path d="M2.445-0.419c0-0.487,0.248-1.564,1.167-1.564c0.772,0,1.158,0.506,1.158,1.519c0,1.093-0.386,1.64-1.158,1.64 C2.833,1.174,2.445,0.644,2.445-0.419z M8.414,4.338C7.496,5.432,6.44,6.669,5.083,6.667c0.513-0.71,0.872-1.568,1.141-2.455 c-3.305-0.524-5.765-2.51-5.765-4.881c0-1.152,0.813-3.455,3.462-3.455c2.167,0,3.718,1.729,3.718,3.697 c0,1.506-0.705,2.045-1.106,2.045c-0.467,0-0.7-0.336-0.7-1.008v-3.458H4.831v0.309C4.534-2.82,4.128-2.96,3.612-2.96 c-1.921,0-2.235,1.927-2.235,2.541c0,0.826,0.431,2.571,2.235,2.571c0.587,0,1.066-0.201,1.438-0.602 c0.306,0.688,0.8,1.03,1.483,1.03c0.849,0,2.069-0.714,2.069-3.007c0-3.368-3.049-4.702-4.082-4.702 c5.584-1.76,10.939,1.016,10.939,4.459C15.459,2,12.344,4.181,8.414,4.338z"/></g></svg></object><b class='AppBrandProductName'>LiveAgent</b></a> </div> </div> </div> </footer> <a href="#top" id="scroll-top"><span class="glyphicon glyphicon-chevron-up"></span></a> <script src="/themes/kb/montana/js/fixedmenu.js?v=5.51.5.26"></script> <div id="multiwidget_contact"> <span id="contact_close" onclick="FcontactFormTrigger();">×</span> <!-- Start of LiveAgent integration script: Contact form: Tech LA - Multiwidget - LA KB (EN) --> <script type="text/javascript"> (function(d, src, c) { var t=d.scripts[d.scripts.length - 1],s=d.createElement('script');s.id='la_x2s6df8d';s.defer=true;s.src=src;s.onload=s.onreadystatechange=function(){var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, 'https://support.qualityunit.com/scripts/track.js', function(e){ LiveAgent.createForm('tzekkc52', e); }); </script> <!-- End of LiveAgent integration script --> </div> <!-- FlowHunt Chatbot integration script --> <script type="text/javascript" id="fh-chatbot-script"> function loadChatBot( { chatbotId, workspaceId } ) { (function(d, src, c) { var t=d.scripts[d.scripts.length - 1],s=d.createElement('script');s.async=true;s.src=src;s.onload=s.onreadystatechange=function(){var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, 'https://app.flowhunt.io/fh-chat-widget.js?v=1.0.19', function(e){ const chatbotManager = FHChatbot.initChatbot({ showChatButton: false, // important to not show chat button on page load chatbotId: chatbotId, workspaceId: workspaceId, welcomeMessage: 'Hi, I\'m LiveAgent support Bot. How can I help you?', inputPlaceholder: 'Ask me any question...', suggestedUserMessages: [], urlSuffix: '?utm_medium=chatbot&utm_source=flowhunt', maxWindowWidth: '800px', }); document.getElementById('elementAI').addEventListener('click', () => { chatbotManager.openChat(); }); }); } loadChatBot({ chatbotId: 'ee7cb389-4f00-441f-a287-07a43f72f1e3', workspaceId: '4d1adbc8-edfa-48c1-b93a-a8096d28f5e7' }); </script> <!-- End of chatbot integration script --> <!-- Start of contact form trigger --> <script type="text/javascript"> var contactFormTrigger = 0; function FcontactFormTrigger() { if(contactFormTrigger === 0) { document.getElementById("multiwidget_contact").style.bottom = "0"; contactFormTrigger++; } else { document.getElementById("multiwidget_contact").style.bottom = "-101%"; contactFormTrigger--; } } </script> <!-- End of contact form trigger --> <!-- Start of LiveAgent integration script: Chat button: LA - Customer portal --> <script type="text/javascript"> var chatButton; (function(d, src, c) { var t=d.scripts[d.scripts.length - 1],s=d.createElement('script');s.id='la_x2s6df8d';s.defer=true;s.src=src;s.onload=s.onreadystatechange=function(){var rs=this.readyState;if(rs&&(rs!='complete')&&(rs!='loaded')){return;}c(this);};t.parentElement.insertBefore(s,t.nextSibling);})(document, 'https://support.qualityunit.com/scripts/track.js', function(e){ chatButton = LiveAgent.createButton('82dc6d83', e); }); </script> <!-- End of LiveAgent integration script --> <!-- Start of event handling script --> <script> var openTrigger = 0; function openMultiwidget() { if (openTrigger === 0) { document.getElementById("multiwidget").style.bottom = "110px"; document.getElementById("multiwidget").style.opacity = "1"; document.getElementById("mainButton").style.background = "linear-gradient(90deg,#ffbd39 0,#ffbd39 100%)"; openTrigger++; } else { document.getElementById("multiwidget").style.bottom = "-350px"; document.getElementById("multiwidget").style.opacity = "0"; document.getElementById("mainButton").style.background = "linear-gradient(90deg,#ffbd39 0,#fa9531 100%)"; openTrigger--; } } const elementForm = document.getElementById("elementForm"); const elementChat = document.getElementById("elementChat"); const elementAI = document.getElementById("elementAI"); elementForm.addEventListener("click", openMultiwidget); elementChat.addEventListener("click", openMultiwidget); elementAI.addEventListener("click", openMultiwidget); </script> <!-- End of event handling script --> <!-- Start of service status script --> <script type="text/javascript"> var result; var statusClass = 'status-okay'; var quStatusWidget = { statusJsonUrl: "https://status.liveagent.com/status.json", async fetchJson() { try { const data = await fetch(this.statusJsonUrl); return await data.json(); } catch (error) { console.log(error); } }, async getStatus() { let status = await this.fetchJson(); return status; } }; let serviceStatus = quStatusWidget.getStatus().then(function(result) { displayStatusIndicator(result); }); function displayStatusIndicator(serviceStatus) { if (serviceStatus.outages.length > 0) { statusClass = 'status-outage'; } else if (serviceStatus.degradations.length > 0) { statusClass = 'status-degradation'; } displayResult(); } function displayResult() { if(statusClass === 'status-okay') { document.getElementById("service_status").innerHTML = "<div class='okay pulse-button'><img src='https://www.dropbox.com/scl/fi/1xx0s6ftrqkea1vv8enif/okay.png?rlkey=s9ffrdrdqpjyov5snau231b66&raw=1' /><font class='status-title'>Service status: Running</font><br><font class='status-link'><a href='https://status.liveagent.com/' target='_blank'>Check our status page</a></font></div>"; } else if(statusClass === 'status-outage') { document.getElementById("service_status").innerHTML = "<div class='outage pulse-button'><img src='https://www.dropbox.com/scl/fi/ptnej5emarpugugc9l53e/outage.png?rlkey=jthvrdp2d00riklzdy7jd0nby&raw=1' /><font class='status-title'>Service status: Outage</font><br><font class='status-link'><a href='https://status.liveagent.com/' target='_blank'>Check our status page</a></font></div>"; } else if(statusClass === 'status-degradation') { document.getElementById("service_status").innerHTML = "<div class='degradation pulse-button'><img src='https://www.dropbox.com/scl/fi/d4ql1ew2wlotn27jd06d0/degradation.png?rlkey=mbf53aoyapmx5phnwcjejxk8i&raw=1' /><font class='status-title'>Service status: Degradation</font><br><font class='status-link'><a href='https://status.liveagent.com/' target='_blank'>Check our status page</a></font></div>"; } else if(statusClass === 'status-announcement') { document.getElementById("service_status").innerHTML = "<div class='degradation pulse-button'><img src='https://www.dropbox.com/scl/fi/d4ql1ew2wlotn27jd06d0/degradation.png?rlkey=mbf53aoyapmx5phnwcjejxk8i&raw=1' /><font class='status-title'>announcement_title</font><br><font class='status-link'><a href='https://status.liveagent.com/' target='_blank'>Day Date Month - DC</a></font></div>"; } } </script> <!-- End of service status script --> <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-56486-1', 'auto', {'allowLinker': true}); ga('require', 'linker'); ga('linker:autoLink', ['qualityunit.com', 'ladesk.com', 'postaffiliatepro.com', 'unitminer.com', 'postaffiliatenetwork.com', 'swreg.org']); ga('send', 'pageview'); </script> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-132128640-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag() { dataLayer.push(arguments) } gtag("js", new Date); gtag("config", "UA-132128640-1", { 'linker': { 'domains': ['liveagent.com', 'liveagent.fr', 'liveagent.de', 'liveagent.hu', 'liveagent.com.br', 'liveagent.sk', 'liveagent.es', 'live-agent.cn', 'live-agent.nl', 'live-agent.it', 'live-agent.pl', 'live-agent.ru', 'live-agent.cz', 'liveagent.vn', 'liveagent.no', 'liveagent.dk', 'liveagent.gr', 'liveagent.ro', 'liveagent.bg', 'liveagent.se', 'liveagent.jp', 'liveagent.fi', 'liveagent.ae', 'liveagent.ph', 'liveagent.si', 'liveagent.lv', 'liveagent.lt', 'liveagent.hr', 'liveagent.ee', 'ladesk.com'] } }); </script> <script type="text/javascript"> var _paq = window._paq || []; _paq.push(['enableLinkTracking']); _paq.push(['enableHeartBeatTimer', 30]); _paq.push(['trackPageView']); _paq.push(['enableCrossDomainLinking']); window.onerror = function (msg, url, lineNo, columnNo, error) { var stackT = ""; if (typeof(error) != 'undefined' && typeof(error.stack) != 'undefined') { stackT = error.stack.replace(/\n/g, ' ').substring(0, 1000); } _paq.push(['trackEvent', 'error', 'js', msg + "::" + url + "::" + lineNo + "::" + stackT]); }; (function() { _paq.push(['setSiteId', 'LA-web']); var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.async=true; g.defer=true; g.src='//analytics.qualityunit.com/i.js'; s.parentNode.insertBefore(g,s); })(); </script> <a id="3941168314300481931" href="https://www.liveagent.com/live-chat-software/"></a> <script type="text/javascript"> function enableCopy(selector = "pre", childSelector = "code", btnText = "Copy to clipboard", btnTextSuccess = "Copied", activeClass = "copyButton") { document.querySelectorAll(`${selector}:not(.${activeClass})`).forEach(node => { // create a "copy" button let copyBtn = document.createElement("button"); copyBtn.innerText = btnText; // activeClass acts as flag so we don't add another copy button by mistake copyBtn.classList.add(activeClass); node.before(copyBtn); copyBtn.addEventListener("click", async () => { // copy to clipboard if (navigator.clipboard) { let text = node.innerText.replace(/\u00A0/g, ' '); await navigator.clipboard.writeText(text); } // change text of button after copying copyBtn.innerText = btnTextSuccess; // change text back to normal after ### ms setTimeout(() => copyBtn.innerText = btnText, 2000); }) }) } enableCopy(); </script> <script type="text/javascript"> var quStatusWidget = { statusJsonUrl: "https://status.liveagent.com/status.json", async fetchJson() { try { const data = await fetch(this.statusJsonUrl); return await data.json(); } catch (error) { console.log(error); } }, async getStatus() { let status = await this.fetchJson(); return status; }, async display() { let status = await this.getStatus(); console.log(status); if (status.outages.length > 0) { this.createWidget(status.outages[0], true); } else if (status.degradations.length > 0) { this.createWidget(status.degradations[0]); } }, createWidget(incident, isOutage = false) { let widgetDiv = document.createElement('div'); widgetDiv.style.cssText = 'width: 600px; height: 200px; background-color: rgb(255, 56, 35); position: absolute; bottom: 50px; left: 50px; border-radius: 15px; color:white; display: flex;'; widgetDiv.id = 'quStatusWidget'; widgetDiv.innerHTML = '<div style= "width: 100px; height: 50%; color: white; margin: 50px 0px 0px 25px;"><svg preserveAspectRatio="none" width="100%" viewBox="0 0 24 24" height="100%"><g><path d="M15.73,3H8.27L3,8.27v7.46L8.27,21h7.46L21,15.73V8.27L15.73,3z M19,14.9L14.9,19H9.1L5,14.9V9.1L9.1,5h5.8L19,9.1V14.9z" fill="white"></path><rect y="7" x="11" width="2" height="6" fill="white"></rect><rect y="15" x="11" width="2" height="2" fill="white"></rect></g></svg></div><div style="height:100%; margin: 40px 0px 0px 25px"><h2>' + incident.title + '</h2><p style="font-size: 1.1em">We are experiencing issues, see our status page for <a href="https://status.liveagent.com/">more info</a></p></div>'; document.body.appendChild(widgetDiv); } }; var statusPageArticles = document.querySelectorAll('a[title*="services status page" i]') if (statusPageArticles.length > 0) { statusPageArticles[0].id = 'statusPageArticle'; statusPageArticles[0].href = 'https://status.liveagent.com/'; let serviceStatus = quStatusWidget.getStatus().then(function(result) {setStatusPageBackground(result);}); function setStatusPageBackground(serviceStatus) { let statusClass = 'status-okay'; let statusTitle = ''; if (serviceStatus.outages.length > 0) { statusClass = 'status-outage'; statusTitle = serviceStatus.outages[0].title; } else if (serviceStatus.degradations.length > 0) { statusClass = 'status-degradation'; statusTitle = serviceStatus.degradations[0].title; } statusPageArticles[0].classList.add(statusClass); if (statusTitle !== '') { statusPageArticles[0].title = statusPageArticles[0].children[0].innerText = statusTitle; statusPageArticles[0].children[2].innerText = 'We are experiencing issues, click here to see our status page for more info'; } } } </script> <script type="text/javascript"> document.querySelectorAll('.article-content a:not(.cboxElement)').forEach((link) => { if (link.getAttribute('href').indexOf('#') !== 0) { link.target = '_blank'; } }); </script> </body> </html>