Get Script Selectors

This API allows you to get all the available script selectors. You can get the script selectors based on the MRD type (mrdType). The "mrdType" can be voice, digitalchannel, or all. If you do not specify any "mrdType", the all option is considered.

URI:

https://<FQDN>/finesse/api/ScriptSelectors?mrdType=<parameter>

Example URI:

https://finesse1.xyz.com/finesse/api/ScriptSelectors?mrdType=all

Security Constraints:

Administrators, agents, and supervisors can use this API.

HTTP Method:

GET

Content Type:

—

Input/Output Format:

XML

HTTP Request:

—

HTTP Response:

200: Success

401: Unauthorized

404: Not Found

500: Internal Server Error

Example HTTP Response:

mrdType is all

Code Snippet
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ScriptSelectors>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>CVP_VRU_RC1.7000200000</Name>
    <DialedNumber>7000200000</DialedNumber>
    <Description>SIP, Direct, CVPCS20A Dialed Number</Description>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>CVP_VRU_RC1.7000202001</Name>
    <DialedNumber>7000202001</DialedNumber>
  </ScriptSelector>
  ...
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>MR_PIM1_Voice.PersonalCallback</Name>
    <DialedNumber>PersonalCallback</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5000</MrdID>
    <Name>MR_PIM1_Voice.mark_test_dn</Name>
    <DialedNumber>mark_test_dn</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5000</MrdID>
    <Name>mrsim.mark_test_dn</Name>
    <DialedNumber>mark_test_dn</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5003</MrdID>
    <Name>MR_PIM1_Voice.uq_script_dn</Name>
    <DialedNumber>uq_script_dn</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5003</MrdID>
    <Name>mrsim.uq_script_dn</Name>
    <DialedNumber>uq_script_dn</DialedNumber>
  </ScriptSelector>
</ScriptSelectors>

mrdType is voice

Code Snippet
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ScriptSelectors>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>CVP_VRU_RC1.7000200000</Name>
    <DialedNumber>7000200000</DialedNumber>
    <Description>SIP, Direct, CVPCS20A Dialed Number</Description>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>CVP_VRU_RC1.7000202001</Name>
    <DialedNumber>7000202001</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>CVP_VRU_RC1.7000202002</Name>
    <DialedNumber>7000202002</DialedNumber>
  </ScriptSelector>
  ...
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>UCM_RC.218022</Name>
    <DialedNumber>218022</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>1</MrdID>
    <Name>MR_PIM1_Voice.PersonalCallback</Name>
    <DialedNumber>PersonalCallback</DialedNumber>
  </ScriptSelector>
</ScriptSelectors>

mrdType is digitalChannels

Code Snippet
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ScriptSelectors>
  <ScriptSelector>
    <MrdID>5000</MrdID>
    <Name>MR_PIM1_Voice.mark_test_dn</Name>
    <DialedNumber>mark_test_dn</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5000</MrdID>
    <Name>mrsim.mark_test_dn</Name>
    <DialedNumber>mark_test_dn</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5003</MrdID>
    <Name>MR_PIM1_Voice.uq_script_dn</Name>
    <DialedNumber>uq_script_dn</DialedNumber>
  </ScriptSelector>
  <ScriptSelector>
    <MrdID>5003</MrdID>
    <Name>mrsim.uq_script_dn</Name>
    <DialedNumber>uq_script_dn</DialedNumber>
  </ScriptSelector>
</ScriptSelectors>

Example Failure Response:
Code Snippet
Copy
<ApiErrors>
   <ApiError>
      <ErrorType>Unauthorized</ErrorType>
      <ErrorMessage>Not authorized to access this
resource.</ErrorMessage>
   </ApiError>
</ApiErrors>
Field Details

Field

Description

MrdID

A unique media routing domain (MRD) ID to map with digital routing media channels.

Name

The name of the media channel configured in Unified CCE.

DialedNumber

Dialed numbers, also called as script selectors, are the strings or numbers submitted with Task Routing task requests through Customer Collaboration Platform. Each dialed number is associated with a call type, and determines which routing script the Unified CCE uses to route the request to an agent.

Description

Additional information about the dialed number.