Get List of Pending Contacts for Campaign with Specific Call Status

This API allows you to provide a specific call status to list the pending contacts for a campaign that exists in the system. The following call statuses are supported:

  • PENDING

  • CALLBACK

  • RETRY

  • RETRIES_WITH_DELAY

  • MAX_CALLS

  • UNKNOWN

HTPS Method

GET

URI

https://<server>/adminapi/campaign/{id}/contacts?q={callstatus}

Example URI

https://uccx-server/adminapi/campaign/200/contacts?q=CALLBACK

Accept

Application/XML, Application/JSON

HTPS Success Code

200

HTPS Failure Codes

401, 404, 405

Error Codes

—

Success Response

<?xml version="1.0" encoding="UTF-8"?>
<campaignContacts>
    <campaign name="previewCampaign">
				<refURL>https://uccx-server/adminapi/campaign/200</refURL>
    </campaign>
    <csvdata>account number, first name, last name, phone1,
        phone2, phone3, dial time
        , , , 1000, , , 10:45
        , , , 1001, , , 10:45
        , , , 1002, , , 10:45
        , , , 1003, , , 10:45
        , , , 1004, , , 10:45
        </csvdata>
</campaignContacts>
<?xml version="1.0" encoding="UTF-8"?>
<campaignContacts>
    <campaign name="previewCampaign">
        <refURL>https://uccx-server/adminapi/campaign/200</refURL>
    </campaign>
    <csvdata>account number, first name, last name, phone1,
        phone2, phone3, dial time, call result, callback number, call status, call result 01, call result 02, call result 03, last number dialled, calls made to phone 01, calls made to phone 02, calls made to phone 03, retry, num missed call back

        , , , 1000, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0
        , , , 1001, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0
        , , , 1002, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0
        , , , 1003, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0
        , , , 1004, , , 10:45,0, , 5, 0, 0, 0, 0, 0, 0, 0, false, 0
        </csvdata>
</campaignContacts>