Survey API

Survey API is used to create CX KPI Survey. This API will be used to trigger the associated call type.

The Survey API is applicable for the following deployments only:

  • Unified CCE 2000 Agents.

  • PCCE 2000 Agents and

  • PCCE LabOnly

https://<server>/unifiedconfig/survey

Operations

  • get: Uses the HTTP GET method to retrieve the details from the database.

    https://<server>/unifiedconfig/survey/id

  • delete: Uses the HTTP DELETE method to delete the survey details.

  • put: Uses the HTTP PUT method to update or modify the details in the survey.

  • post: Uses the HTTP POST method to create the survey.

Parameters

  • name: It is the name of the survey.

  • description: Additional information about the survey.

  • department name: A reference of the department Department API, including the refURL and name.

  • application: The field must start with alphanumeric. Allowed characters are period (.), underscore (_), and alphanumeric. The maximum length is 32. Application Name is not mandatory. If not provided, application name from ICR_Globals (defaultSurveyAppName) will be used.

  • questionType: Specifies the type of questions. Allowed Strings (in case sensitive) are CSAT, CES, and NPS.

  • call Type: The order in which the question is prompted. The allowed values are 1, 2 and 3.

Example Create Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<survey>
    <name>CreditCard Survey</name>
    <description>Survey from credit card customers</description>
    <department>
        <refURL>/unifiedconfig/config/department/5000</refURL>
        <name>Department1</name>
    </department>
    <applicationName>default_survey_app</applicationName>
    <questions>
        <question>
            <questionType>NPS</type>
            <sequence>2</sequence>
        </question>  
        <question>
            <questionType>CSAT</type>
            <sequence>1</sequence>
        </question>
    </questions>
    <callTypes>
        <callType>
            <refURL>/unifiedconfig/config/calltype/1</refURL>
            <name>BuiltIn</name>
        </callType>
    </callTypes>   
</survey>

Example Get Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<results>
<pageInfo>
<firstPage>https://10.77.63.188/unifiedconfig/config/survey?sort=name%20asc&resultsPerPage=25</firstPage>
<lastPage>https://10.77.63.188/unifiedconfig/config/survey?sort=name%20asc&startIndex=0&resultsPerPage=25</lastPage>
<resultsPerPage>25</resultsPerPage>
<sortTerm>name asc</sortTerm>
<startIndex>0</startIndex>
<totalResults>2</totalResults>
</pageInfo>
<permissionInfo>
<canCreate>true</canCreate>
<canUpdate>true</canUpdate>
<canDelete>true</canDelete>
<role>Administrator</role>
<departmentAdmin>false</departmentAdmin>
</permissionInfo>
<surveys>
<survey>
<department>
<refURL>/unifiedconfig/config/department/5000</refURL>
<name>Department1</name>
</department>
<refURL>/unifiedconfig/config/survey/5016</refURL>
<changeStamp>0</changeStamp>
<application>DefaultSurveyApp</application>
<callTypes>
<callType>
<refURL>/unifiedconfig/config/calltype/1</refURL>
<name>BuiltIn</name>
</callType>
</callTypes>
<description>Survey from credit card customers</description>
<name>Survey121</name>
<questions>
<question>
<questionType>NPS</questionType>
<sequence>1</sequence>
</question>
</questions>
</survey>
</surveys>
</results>