Import API

Use the Import API to import customer contact information for an outbound campaign.

You can import up to 10,000 records in one create request.


Note


You can queue up to 30 requests at a time. If you have 30 requests in queue and submit another request, the response is HTTP 503 Service Unavailable with the boundary error condition "Request processing queue is at capacity."

If you receive this error, wait a few seconds and then retry the request.


URL

https://<server>/unifiedconfig/config/campaign/<id>/import

Note


You must specify the ID for a campaign that was created using the Outbound Campaign API. If you specify the ID for a campaign created using the Outbound Option Campaign tool, the request returns CceDBDataNotFoundException.


Operations

Parameters

Response Parameters for get:

Parameters for create:

Search and Sort

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters Sort parameters
  • accountNumber
  • firstName
  • lastName
  • accountNumber (default)
  • firstName
  • lastName

See Search and Sort.

Example Get Response

<importContact>
    <refURL>/unifiedconfig/config/campaign/5000/import/1</refURL>
    <accountNumber>4019</accountNumber>
    <callsMade>1</callsMade>
    <callStatus>pending</callStatus>
    <callResultOverall>0</callResultOverall>
    <firstName>Mir</firstName>
    <lastName>Ali</lastName>
    <importDate>2016-03-28T01:09:40</importDate>
    <phone01>        
        <callResult>0</callResult>
        <dstObserved>true</dstObserved>
        <gmtOffset>720</gmtOffset>
        <number>9789360001</number>
    </phone01>
    <phone02>      
        <callResult>0</callResult>
        <dstObserved>true</dstObserved>
        <gmtOffset>720</gmtOffset>
        <number>9789360002</number>
    </phone02>
    <phone03>...</phone03>
    <phone04>...</phone04>
    <phone05>...</phone05>
    <phone06>...</phone06>
    <phone07>...</phone07>
    <phone08>...</phone08>
    <phone09>...</phone09>
    <phone10>
        <callResult>0</callResult>
        <dstObserved>true</dstObserved>
        <gmtOffset>330</gmtOffset>
        <number>9789360010</number>
    </phone10>
</importContact>

Example Create Request

<import>
    <fileContent>
        <![CDATA[
        AccountNumber,FirstName,LastName,Phone01,Phone02,TimeZoneBias,DstObserved
        6782,Henry,Martin,2225554444,2225556262,720,false
        3456,Michele,Smith,2225559999,2225551234,540,true
        4569,Walker,Evans,2225552000,2225557890,-600,true
        ]]> 
    </fileContent>
    <delimiter>,</delimiter>
</import>