Scribd
Upload
21 views

AddCampaignBulkDataV2 Revised

Uploaded by

vamsi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
21 views

AddCampaignBulkDataV2 Revised

Uploaded by

vamsi
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 4

Table of Content

Overview 2

Prerequisite 2

Sample request 2

Responses in JSON 3

CloudAgent API documentation 1


Add Campaign Bulk DataV2

Overview

Add Campaign Bulk DataV2 API is used to Add data in Bulk to any Outbound Campaign(Dialer).
Data(numbers/leads) consist of map(Headers) sequence listing PhoneNumber, Name,
Priority,ExpiryDate while adding to the dialer.

This API has no rate limit. We store the requests in queue(after rate limit per minute exceeded for
user) and add data to the outbound campaign later

Prerequisite

To access this API we need to pass the following parameters.

API https://api1.cloudagent.in/cloudAgentRestAPI/index.php/AddCampaignBulkDat
aV2/addBulkData/format/json

Method POST

Parameters apiKey* (Available in Cloudagent Admin login)

userName* (CloudAgent user name)

campaignName* (CloudAgent Campaign Name )

bulkData* (Data to be inserted)

Note:

● Maximum count of data to be added is 500 per request.


● Maximum of 5 Requests allowed per minute, After that requests are stored in the queue.
● Following is the format to save bulk numbers (2 sample numbers) with names.
{"map":["PhoneNumber","Name","Priority"],"data":[["865XXXXXXX","Name1",1],["789XXXXXX
X","Anxxxxx",2]]}

CloudAgent API documentation 2


Sample request
curl --location --request POST
'https:/api1.cloudagent.in/cloudAgentRestAPI/index.php/AddCampaignBulkDataV2/addBulkData/f
ormat/json' --form 'apiKey="xxxxxxxxxxxxxxxxxxxxxxxxx"' --form 'campaignName="xxxxxxxx"'
--form
'bulkData="{\"map\":[\"PhoneNumber\",\"Id\",\"Name\"],\"data\":[[\"xxxxx\",\"10\",\"agxxt\"],[\"xxxx\",\"1
2\",\"kuxxx\"]]}"' --form 'userName="xxxxxxxx"' --form 'checkDuplicate="true"'

Responses in json
Success response {
"status": "success",
"message": {
"success": "SuccessFully Inserted 2 Records",
"fail": null
}
}

If userName is empty {"status":"error","message":"userName should not be empty"}

If apiKey is empty {"status":"error","message":"apiKey should not be empty"}

If campaignName is
{"status":"error","message":”campaignName should not be empty"}
empty

If invalid userName or {"status":"error","message":”Invalid userName or apiKey"}


apiKey is passed

If invalid campaign Name


{"status":"error","message":”Invalid Campaign Name"}
is passed

If max record limit in a {"status":"error","message":”The max data to be uploaded is 500


exist request exceeds records only."}

If Rate Limit Exceeds and {"status":"success","message":”too many Requests and request is


process queued added to queue"}

If invalid bulkData is
{"status":"error","message":”Please provide valid data"}
passed

CloudAgent API documentation 3


CloudAgent API documentation 4

You might also like