Method: questionpro.cx.importTransaction
This API call is used to upload the information of customers and can also send SMS and
Email to customers.
Attributes
|
Name
|
Value
|
Required
|
|
apiKey
|
This is an encrypted alphanumeric string to authenticate your credentials.
|
✔
|
|
surveyID
|
This is the survey id for which contacts are to be imported.
|
✔
|
|
sendEmail
|
This is used to specify if email is to be sent to the imported contacts or not.
|
✕
|
|
sendSMS
|
This is used to specify if sms is to be sent to the imported contacts or not. If
true, then mobile no. needs to be specified.
Note: To send sms, you need to have sufficient sms credit in your account.
|
✕
|
|
firstName
|
This is the first name of the contact which is to be imported.
|
✕
|
|
lastName
|
This is the last name of the contact which is to be imported.
|
✕
|
|
mobile
|
This is the mobile number of the contact which is to be imported.
|
✕
|
|
segmentCode
|
This is the segment code for which contacts are to be imported.
|
✕
|
|
transactionDate
|
This is the date on which transaction was done by the contact(mm/dd/yyyy).
|
✕
|
|
email
|
This is the email address of the contact which is to be imported
|
✔
|
|
field1
|
This is the Custom1 variable of the contact which is to be imported.
Note: Similary, we can have field2,field3,...field20, except field5, for
importing Custom2,Custom3,...Custom20 variables.
|
✕
|
|
productName
|
This is the product name of the contact which is to be imported. If the
specified product do not exist, new product will be created.
|
✕
|
|
productGroup
|
This is the product group name of the contact which is to be imported. If the
specified product group do not exist, new product group will be created.
Note: To have a product group, product is mandatory.
|
✕
|
|
invitationTemplateID
|
This is the id of the customized created email template, if any.
Note: The value for Default email template is -1.
|
✕
|
|
status
|
Following are the status of response generated, after importing the
contacts via this API.
- emailStatus - If email attribute value is true, it specifies status of
the sent email.
- ImportStatus - This is the status of the API
- ImportCount - This is the count of the contacts that have been imported
successfully.
- smsStatus - If sms attribute value is true, it specifies status of the
sent sms.
|
|
NOTE:
*All the parameter names are Case Sensitive.
*One API call cannot exceed 500 contacts.
URL
http://www.questionpro.com/a/questionpro.cx.importTransaction?apiKey={API-KEY}
Sample Request
POST
https://www.questionpro.com/a/api/questionpro.cx.importTransaction?apiKey=4dbedabb-631f-4d68-b40a-e5cd47d610ce
HTTP/1.1
Accept: application/json
{
"surveyID": 6069695,
"sendEmail": "true",
"sendSMS": "false",
"contacts": [
{
"firstName": "John",
"lastName": "Johnson",
"mobile": "+12066688987",
"segmentCode": "SANFRAN",
"transactionDate": "11/30/2016",
"email": "[email protected]",
"productName": "Laptop",
"productGroup": "Lenovo"
}
],
"invitationTemplateID": 423382
}
Sample Response
{
"response": {
"emailStatus": "Successful: Initiated email send process.",
"ImportStatus": "Successful: Contact imported.",
"ImportCount": 1
},
"status": {
"method": "questionpro.cx.importTransaction",
"apiKey": "4dbedabb-631f-4d68-b40a-e5cd47d610ce",
"serverUTC": 1522768600787,
"id": 200,
"message": "OK",
"url": "/a/api/questionpro.cx.importTransaction"
}
}
URL
http://www.questionpro.com/a/questionpro.cx.importTransaction?apiKey={API-KEY}
Sample Request
public JSONObject processTransactions() throws Exception {
String path = getAPIURL();
DefaultHttpClient httpclient = new DefaultHttpClient();
HttpPost httpost = new HttpPost(path);
JSONObject requestJSON = getRequestJSON();
StringEntity se = new StringEntity(data.toString());
httpost.setEntity(se);
httpost.setHeader("Accept", "application/json");
httpost.setHeader("Content-type", "application/json");
ResponseHandler responseHandler = new BasicResponseHandler();
Object resp = httpclient.execute(httpost, responseHandler);
return new JSONObject(resp.toString());
}
public JSONObject getRequestJSON() throws JSONException {
JSONObject requestJSON = new JSONObject();
requestJSON.put("surveyID", 234); // Valid Survey ID - IF not found contacts will
not be processed.
requestJSON.put("sendEmail", true); //Optional field : Default : false ; No Email
will be sent for the contacts.
requestJSON.put("sendSMS", true); //Optional field : Default : false ; No SMS will
be sent for the contacts.
requestJSON.put("contacts", getTransactions());
requestJSON.put("invitationTemplateID", 20);
return requestJSON;
}
public JSONArray getTransactions() throws JSONException{
JSONArray transactions = new JSONArray();
JSONObject transaction = new JSONObject();
transaction.put("email", "[email protected]");
transaction.put("firstName", "John");
transaction.put("lastName", "Johnson");
transaction.put("mobile","+12066688987");
transaction.put("segmentCode","SANFRAN"); // You need a valid segment code
here.
transaction.put("transactionDate","11/30/2016");
transaction.put("productName","Sony Television"); // Valid Product Name , New
product will be added, if the name is not present already.
transaction.put("productGroup","Televisions"); // Valid Product Group , New Group
will be added if the group is not present already.
transactions.put(transaction); // One API call cannot exceed
500 contacts.
return transactions;
}
public String getAPIURL() {
return " http://cx.questionpro.com/a/questionpro.cx.importTransaction?apiKey={API-KEY}"
+ getAccessKey();
}
Sample Response
{
"response": {
"emailStatus": "Successful: Initiated email send process.",
"ImportStatus": "Successful: Contact imported.",
"ImportCount": 1
},
"status": {
"method": "questionpro.cx.importTransaction",
"apiKey": "4dbedabb-631f-4d68-b40a-e5cd47d610ce",
"serverUTC": 1522768600787,
"id": 200,
"message": "OK",
"url": "/a/api/questionpro.cx.importTransaction"
}
}
URL
http://www.questionpro.com/a/questionpro.cx.importTransaction?apiKey={API-KEY}
Sample Request
public function processTransactions() {
$path = $this->getProcessTransactionssUrl();
$data = $this->getRequestJSON();
$json_string = json_encode($data);
$ch = curl_init($path);
$options = array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => array('Content-type: application/json') ,
CURLOPT_POSTFIELDS => $json_string
);
curl_setopt_array( $ch, $options );
$resp = curl_exec($ch);
$json = json_decode($resp, true);
$json_pretty = json_encode($json, JSON_PRETTY_PRINT);
return $json_pretty;
}
public function getRequestJSON(){
$requestJSON = array('surveyID' => 4735113, 'sendEmail' => 'true', 'sendSMS'=> 'true',
'startDate'=> 0, 'contacts'=> $this->getTransactions());
return $requestJSON;
}
public function getTransactions(){
$transactions = array('email' => '[email protected]', 'firstName' => 'John',
'lastName'=> 'Johnson', 'mobile'=> '12066688987', 'segmentCode'=> 'S1',
'transactionDate'=> '11/30/2016', 'productName'=> 'Sony Television', 'productGroup'=>
'Televisions');
return $transactions;
}
Sample Response
{
"response": {
"emailStatus": "Successful: Initiated email send process.",
"ImportStatus": "Successful: Contact imported.",
"ImportCount": 1
},
"status": {
"method": "questionpro.cx.importTransaction",
"apiKey": "4dbedabb-631f-4d68-b40a-e5cd47d610ce",
"serverUTC": 1522768600787,
"id": 200,
"message": "OK",
"url": "/a/api/questionpro.cx.importTransaction"
}
}
Survey Software
Easy to use and accessible for everyone. Design, send and analyze online surveys.
Research Suite
A suite of enterprise-grade research tools for market research professionals.
CX
Experiences change the world. Deliver the best with our CX management software.
Workforce
Create the best employee experience and act on real-time data from end to end.
