Scribd
Upload
9 views4 pages

AddCampaignDataV2 (1 0)

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
9 views4 pages

AddCampaignDataV2 (1 0)

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

Sample Responses in JSON 3

Sample Responses in XML 3

CloudAgent API documentation 1


Add Campaign Data V2

Overview

Add Campaign data v2 API is used to Add data to any Outbound Campaign(Dialer). Create an
Outbound campaign in your CloudAgent account, and use this API to add data/records for the
same. One can also add data into the dialer by uploading an Excel sheet manually. However
using this API, the same can be automated.This API may be used to trigger as and when you get
leads into your CRM application.

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/CloudAgent/CloudAge
ntAPI/addCamapaignDataV2?

Method GET

Parameters api_key*

campaign_name* (Respective campaign name where data is to be added)

PhoneNumber* (data/leads that is to be inserted in Campaign)

checkDuplicate=true (avoids adding duplicate numbers to the Campaign)

action=start (Starts the campaign simultaneous to adding data)

Name

Note:

CloudAgent API documentation 2


● Parameters with ‘*’ are considered to be mandatory parameters.
● User can check if there are any duplicate values by passing parameter
checkDuplicate=true.
● User can auto start the campaign simultaneously while adding the data by passing the
parameter action=start.
● Along with "PhoneNumber", other headers/parameters can also be added into dialer as
per the mapping file given in desired Outbound Campaign. Ex: Name, Email, City, Service,
OrderNumber, etc..

Sample request

https://api1.cloudagent.in/cloudAgentRestAPI/index.php/CloudAgent/CloudAgentAPI/addCamap
aignDataV2?api_key=KK11XXXXXXXXXXXXXXXXX&campaign_name=XXXXXXXX&format=js
on&PhoneNumber=040XXXXXX&Name=Prxxxxx&action=start&checkDuplicate=true

Sample Responses in json


Success​​response {​​"status":​​"SUCCESS",​​"message":​​"SuccessFully​​Updated"}

Invalid or empty {​"status":​​"FAIL",​​"message":​​"phone number should be numeric


PhoneNumber and must be between 3 to 16 digits and allows prefix +"}

Invalid​​api_key {"status":​​"FAIL",​​"message":​​"api_key should not be empty"}

Invalid​​Campaign​​name {"status":​​"FAIL",​​"message":​​"campaign_name should not be


empty"}

checkDuplicate {"status":​​"SUCCESS",​​"message":​​"Number​​Already​​Exist"}

action {"status":​​"SUCCESS",​​"message":​​"SuccessFully​​Updated,​
Progressive was​​started"}

Sample Responses in xml


Success​​response <status>SUCCESS</status>​​<message>SuccessFully​​
Updated</message>

Invalid or empty <status>FAIL</status>​​<message>phone number should be numeric


PhoneNumber and must be between 3 to 16 digits and allows prefix +</message>

CloudAgent API documentation 3


Invalid​​api_key <status>FAIL</status><message>api_key should not be
empty</message>

Invalid​​Campaign​​name <status>FAIL</status><message>campaign_name should not be


empty</message>

checkDuplicate <status>SUCCESS</status>​​<message>Number​​Already​​
Exist</message>

action <status>SUCCESS</status><message>SuccessFully​
Updated,Progressive was​​started</message>

CloudAgent API documentation 4

You might also like