Get Campaign


HTTPS Method	GET
URI	https://<server>/adminapi/campaign/{id}
Example URI	https://uccx-server/adminapi/campaign/200
Accept	Application/XML, Application/JSON
HTTPS Success Code	200
HTTPS Failure Codes	401, 404, 405
Error Codes	—

Success Response

<?xml version="1.0" encoding="UTF-8"?>
<campaign>
    <self>https://uccx-server/adminapi/campaign/200</self>
    <campaignId>200</campaignId>
    <campaignName>OBPreview</campaignName>
    <enabled>false</enabled>
    <description>This is Outbound Preview campaign</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>AGENT</campaignType>
    <dialerType>DIRECT_PREVIEW</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obPreview>
            <maxDialAttempts>3</maxDialAttempts>
            <cacheSize>20</cacheSize>
            <ansMachineRetry>false</ansMachineRetry>
            <callbackTimeLimit>15</callbackTimeLimit>
            <missedCallbackAction>NEXT_DAY</missedCallbackAction>
            <assignedCSQs>
                <csq name="1">
                    <refURL>https://uccx-server/adminapi/csq/1</refURL>
                </csq>
            </assignedCSQs>
        </obPreview>
    </typeSpecificInfo>
</campaign>

If a campaign is associated with a supervisor, the sample response would be as below:

<?xml version="1.0" encoding="UTF-8"?>
<campaign>
    <self></self>
    <campaignId>200</campaignId>
    <campaignName>OBPreview</campaignName>
    <enabled>false</enabled>
    <description>This is Outbound Preview campaign</description>
    <startTime>08:00</startTime>
    <endTime>21:00</endTime>
    <timeZone>India Standard Time</timeZone>
    <campaignType>AGENT</campaignType>
    <dialerType>DIRECT_PREVIEW</dialerType>
    <pendingContacts>0</pendingContacts>
    <typeSpecificInfo>
        <obPreview>
            <maxDialAttempts>3</maxDialAttempts>
            <cacheSize>20</cacheSize>
            <ansMachineRetry>false</ansMachineRetry>
            <callbackTimeLimit>15</callbackTimeLimit>
            <missedCallbackAction>NEXT_DAY</missedCallbackAction>
            <assignedCSQs>
                <csq name="1">
                    <refURL>https://uccx-server/adminapi/csq/1</refURL>
                </csq>
            </assignedCSQs>
        </obPreview>
    </typeSpecificInfo>
    <associatedSupervisors>
        <supervisor name="OBAgent101">
            <refURL>https://uccx-server/adminapi/csq/1</refURL>
        </supervisor>
    </associatedSupervisors>
</campaign>