Add Contacts to Campaign

HTPS Method

POST

URI

https://<server>/adminapi/campaign/{id}/contacts

Example URI

https://uccx-server/adminapi/campaign/200/contacts

Accept

Application/XML, Application/JSON

Content Type

Application/XML, Application/JSON

HTPS Success Code

200, 202

HTPS Failure Codes

400, 401, 403, 404, 405, 500

Error Codes

—

Input XML Example 1

<?xml version="1.0" encoding="UTF-8"?>
<campaignContacts xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="campaignContacts.xsd">
    <campaign name="Campaign1">
        <refURL>https://uccx-server/adminapi/campaign/200</refURL>
    </campaign>
    <allowDuplicateContacts>true</allowDuplicateContacts>
    <csvdata>
Account Number, First Name, Last Name ,Phone1, Phone2, Phone3, Dial Time
ABCD1234, John , Doe, 1401111, 1402222, 1403333, 12:35
ABCD1235, Jane , Smith, 1504444, 1505555, 1506666, 12:35
    </csvdata>
</campaignContacts>
Note

Dial Time field is applicable only for UCCX Agent Direct Preview campaigns.

Success Response

<?xml version="1.0" encoding="UTF-8"?>
<campaignContacts>
    <campaign name="Campaign1">
        <refURL>https://uccx-server/adminapi/campaign/200</refURL>
    </campaign>
    <csvdata/>
</campaignContacts>

Input XML Example 2


<campaignContacts>
    <campaign name=“campaign1”>
        <refURL>https://uccx-server/adminapi/campaign/200</refURL>
    </campaign>
    	
    <allowDuplicateContacts>true</allowDuplicateContacts>
        <csvFileData>
            <csvFileRef>43_contacts.csv</csvFileRef>
            <importType>AUTO</importType>
            <contactHeaders>
                <header1>Account Number</header1>
                <header2>First Name</header2>
                <header3>Last Name</header3>
                <header4>Phone1</header4>
                <header5>Phone2</header5>
                <header6>Phone3</header6>
                <header7>Dial Time</header7>
            </contactHeaders>
        </csvFileData>
</campaignContacts>

Response Headers

The header "Location" contains the URL for the import status API, which can be executed by client to get the status of import.

Example: http://<UCCX FQDN>/adminapi/campaign/<campId>/contacts/status

Attention
Do not upload the outbound dialing list using the Load Balancer.