Professional Documents
Culture Documents
Smart Ping
Features of service:
Control Panel: Web Based
Integration : Https URL Base Campaign Management
Reports: Real Time Web-based & API based
Key Features
Benefits
3
How it Works
OBD Types
A) Transactional B) Promotional
OBD interfaces
GUI: Graphical user interface where user login to system with valid login
credentials and operate OBD interface .
A) Voice File approval process: User will upload voice file through GUI
portal. Videocon team will validate voice content and voice quality. in case
voice content or quality is not appropriate Executive will reject the file else
approve it. this process is GUI based Only.
B) Campaign Creation: User have GUI and API option for campaign create.
User need to upload calling data in txt format and select calling voice to
create a campaign through GUI.
C) Campaign Report: User can view real time Campaign status on GUI and
Web API
4
GUI Portal
User login on above URL with valid login credential to access OBD service
Dash Board
5
1.Campaign Creation by API call using Post method
API URL : https://obdapi.vispl.in/
API: https://obdapi.vispl.in/Service1.asmx?op=Campaign_Creation
API Response:
<Campaign_CreationResponse xmlns="http://tempuri.org/">
<Campaign_CreationResult>
<ERR_CODE>string</ERR_CODE>
<ERR_DESC>string</ERR_DESC>
<CAMPG_ID>string</CAMPG_ID>
</Campaign_CreationResult>
</Campaign_CreationResponse>
6
A.0 Campaign Creation for Normal OBD for Single
Number:
API: https://obdapi.vispl.in/Service1.asmx?op=SINGLE_CALL
API Response:
<Campaign_CreationResponse xmlns="http://tempuri.org/">
<Campaign_CreationResult>
<ERR_CODE>string</ERR_CODE>
<ERR_DESC>string</ERR_DESC>
<CAMPG_ID>string</CAMPG_ID>
</Campaign_CreationResult>
</Campaign_CreationResponse>
API: https://obdapi.vispl.in/Service1.asmx?op=Campaign_CreationDTMF
7
OBD_TYPE OBD_TYPE Value should be DTMF String Required
Transaction Customer Application
TransitionId Numeric value Optional
Number Primary Key
API Response:
<Campaign_CreationResponse xmlns="http://tempuri.org/">
<Campaign_CreationResult>
<ERR_CODE>string</ERR_CODE>
<ERR_DESC>string</ERR_DESC>
<CAMPG_ID>string</CAMPG_ID>
</Campaign_CreationResult>
</Campaign_CreationResponse>
Limitation : You can pass only 500000 numbers maximum in a Single API Call, limit can
be increased as per requirement.
A) Campaign Summery
API: https://obdapi.vispl.in/Service1.asmx?op=Campaign_Summary
API Response:
<Campaign_prop>
<CampaignID>1187</CampaignID>
8
<CampaignCode>CMP01187</CampaignCode>
<CampaignName>1187</CampaignName>
<CampaignScheduleTime>1/20/2017 6:06:42 PM</CampaignScheduleTime>
<Status>CLOSE</Status>
<ScheduleType>CURRENT</ScheduleType>
<VALID_DN>2</VALID_DN>
<INVALID_DN>0</INVALID_DN>
<PROJECTED_AMOUNT>0.2000000029802320</PROJECTED_AMOUNT>
<CONSUMED_AMOUNT>0.20</CONSUMED_AMOUNT>
<OPENING_BALANCE>97.10</OPENING_BALANCE>
<CLOSING_BALANCE>96.90</CLOSING_BALANCE>
<Transation_ID>321</Transation_ID></Campaign_prop>
API: https://obdapi.vispl.in/Service1.asmx?op=Campaign_Call_Details
Required
Name Parameter Description Type
Value
Username Assigned to the
Username UserName Username Required
account
Password Assigned to the
Password Password Password Required
account
Pk of campaign as return on
Campaign ID campaignid Numeric value Required
campaign creation
API Response:
<arrayofcampaign_prop>
<Campaign_prop>
<CampaignID>1187</CampaignID>
<MSISDN>09961597414</MSISDN>
<CLI>1725148496</CLI>
<FLAG>T</FLAG>
<STATUS>Answered</STATUS>
<STARTTIME>1/20/2017 6:09:32 PM</STARTTIME>
<ENDTIME>1/20/2017 6:09:48 PM</ENDTIME>
<DURATION>16</DURATION>
<Transation_ID>321</Transation_ID>
<DTMF>DTMF</DTMF>
<ID>49467296</ID>
</Campaign_prop></arrayofcampaign_prop>
9
2.Campaign Creation by API call Using Get method:
Campaign creation for Normal OBD:
https://obdapi.vispl.in/Service1.asmx/Campaign_Creation?UserName=demoxx&Password=de
moxxx&VoiceId=1422&TransitionId=1&CampaignData=1234567890,1123456789,XXXXX
XXXXX
https://obdapi.vispl.in/Service1.asmx/SINGLE_CALL?UserName=custxxx&Password=xxx&
VoiceId=86&OBD_TYPE= SINGLE_VOICE &DN=96530xxx
https://obdapi.vispl.in/Service1.asmx/Campaign_CreationDTMF?UserName=demoxx&Passw
ord=demoxxx&VoiceId=1422&OBD_TYPE=DTMF&TransitionId=1&CampaignData=12345
67890,1123456789,XXXXXXXXXX
https://obdapi.vispl.in/Service1.asmx/SINGLE_CALL?UserName=custxxx&Password=xxxxx
&VoiceId=86&OBD_TYPE=DTMF&DN=96530xxx
Campaign Summary:
https://obdapi.vispl.in/Service1.asmx/Campaign_Summary?UserName=demoxx&Password=d
emoxx&campaignid=3574
https://obdapi.vispl.in/Service1.asmx/Campaign_Call_Details?campaignid=3574&UserName=
demoxx&Password=demoxx
https://www.vispl.in/WEB_API/VoxUpload/api/Values/upload
API Response:
https://www.vispl.in/WEB_API/VoxUpload/api/Values/CheckStatus
API Response:
11
Sample Code for Voice Upload in JAVA:
try {
reqEntity.addPart("username",username);
reqEntity.addPart("password",password);
reqEntity.addPart("PlanType",PlanType);
reqEntity.addPart("FileName",FileName);
reqEntity.addPart("uploadedFile", uploadedFile);
httppost.setEntity(reqEntity);
System.out.println("Requesting : " + httppost.getRequestLine());
ResponseHandler<String> responseHandler = new BasicResponseHandler();
String responseBody = httpclient.execute(httppost, responseHandler);
System.out.println("responseBody : " + responseBody);
https://www.vispl.in/WEB_API/VoxUpload/api/Values/CheckBalanceAPI
Username
Username username Assigned to the Username Required
account
Password Assigned
Password password Password Required
to the account
childusername childusername Chilid Userid Child userid Required
12
API Response:
13