setSoftphoneItemLabel() for Lightning Experience

Sets the label for the softphone component item in the utility bar. Returns true if the function is successfully executed, and false when there is a failure. This method is available in API version 38.0 or later.

The softphone label in the utility bar.

Screen shot of softphone in utility bar.

NameTypeDescription
labelstringThe string you want to use for the softphone label in the utility bar.
callbackfunctionJavaScript method executed when the API method call is completed.
");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"96ZND-LJLSH-JXHC9-F8GQP-6WCGS";var o=document.currentScript||document.getElementsByTagName("script")[0],i=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!i)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),o.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="3be5qrixij72u2ronafq-f-3a57c73e1-clientnsv4-s.akamaihd.net",o="false"=="true"?2:1,i={"ak.v":"41","ak.cp":"1836958","ak.ai":parseInt("1224868",10),"ak.ol":"0","ak.cr":8,"ak.ipv":4,"ak.proto":"h2","ak.rid":"1d91c62","ak.r":42223,"ak.a2":n,"ak.m":"dsca","ak.n":"essl","ak.cport":60083,"ak.gh":"23.66.124.170","ak.quicv":"","ak.tlsv":"tls1.3","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"","ak.t":"1781426187","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==hcz/bCDUnITOCUaWJ3z6XLMGQFrPKCf53/kMVg7aGvQv1nBHluqB2pe2YtHHxsBjXFoaoBqFYTIFOLvQcmdD6K+lgav3EnYYRhRHy4lAm/syWapvOANRX0RoZa3MRYljkx/56IzI7XurK1JzSZZLJzGW+X5eAp3Wmzm0CTKLkgOOO6uqbFrKXIiFRRKft+EGTzzWlpRYeSLGHwWmjka7kHKhQ5TCFuoZj66IO4Vz8WvKZmdrs4kC+MUsuqa+ZiFG67ELLVjD53J5lEgpfs9Nl3ET0bu9MsLzAUdqXS4JXOrJR1kjbQt37yVdcTHgKn9WLNZkwep2RqvWQlpjh+7UEbXhomWqUOwiwhbtBBnKq8YiWtL7K95yWZVY/0oBBMxbWXFXU6bIemQ5oOwJ8mGYXc3cC3CgDi+XtSDiiJTnrb0=","ak.pv":"87","ak.dpoabenc":"","ak.tf":o};if(""!==t)i["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))i["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(i)},rv:function(){var e=["ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:i,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window); ">

This method is asynchronous. The response is returned in an object passed to a callback method. The response object contains the following fields.

NameTypeDescription
successbooleanReturns true if the API method call was invoked successfully, false otherwise.
returnValueobjectThis API method doesn’t return this object. The returnValue is always null.
errorsarrayIf the API call was successful, this variable is null. If the API call failed, this variable returns an array of error messages.