Index - JALPI - Your Mass Communication App

API Endpoint

http://jalpi.com/api/Message/Send

Every API request is made to a method on top of this base URL.

Required POST Parameters:

 username             : Your Jalpi Account User Name
 password             : Your Jalpi Account Password
 contenttype          : Message Type eg:- “text” or “image” or “audio” or “video”
 senderid             : SenderID approved by Jalpi
 audiance.numbers     : Recipient Number(s)
                    OR
 audiance.channels    : ChannelId with Comma seprate
                    OR
 audiance.groups      : GroupId with Comma seprate

Extra POST Parameters:

 content         : Actual Jalpi Message to be sent (pass if contenttype = “text”)
 url             : select Image / Audio / Video file ( Pass if required)
 alternatemsg    : Actual Text Message To be sent ( Pass if required)
 scheduledatetime: (MM/DD/YYYY HH:MM:SS) ( Pass if required)
 isscheduled     : “true” if want to schedule message and “false” if not schedule ( Pass if required)
 sms_non_jalpi   : “true” if sent message to  non jalpi user and “false” if not send to non jalpi user ( Pass if required)
 fallbacksmstime : If jalpi message not delivered within fallbacksmstime time then send text message using alternate text. Ex:- (5)seconds ( Pass if required)

HTTP API to Submit Message

Type 1 : API to send Normal Message

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 2 : API to send Image

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
contenttype: "image",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
urlimage: "Please Upload Image"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
contenttype: "image",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
urlimage: "Please Upload Image"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 3 : API to send Audio

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
contenttype: "audio",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
urlaudio: "Select Audio file To be Send"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
contenttype: "audio",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
urlaudio: "Select Audio file To be Send"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 4 : API to send Video

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
contenttype: "video",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
urlvideo: "Please Upload Video"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
contenttype: "video",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
urlvideo: "Please Upload Video"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 5 : API to send Message to Jalpi User and Non Jalpi

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
sms_non_jalpi: "true" ,
alternatemsg: "Hi there, I am Test msg Text"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
sms_non_jalpi: "true",
alternatemsg: "Hi there, I am Test msg Text"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 6 : API to send SCHEDULED Message to Jalpi users

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
scheduledatetime : "05/03/2016 09:45:00 AM (MM/dd/yyyy HH:MM:SS AM/PM)",
isscheduled: "true"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
scheduledatetime : "05/03/2016 09:45:00 AM",
isscheduled: "true"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 7 : API to send SCHEDULED Message to NON Jalpi users

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
alternatemsg: "Hi there, I am Test msg Text",
scheduledatetime : "05/03/2016 09:45:00 AM (MM/dd/yyyy HH:MM:SS AM/PM)",
isscheduled: "true",
sms_non_jalpi: "true"
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
alternatemsg: "Hi there, I am Test msg Text",
scheduledatetime : "05/03/2016 09:45:00 AM",
isscheduled: "true",
sms_non_jalpi: "true"
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 8 : API to send Message & FALLBACK Message TO Jalpi user in case of NON Delivery on Jalpi App within specified time

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
alternatemsg: "Hi there, I am Test msg Text" ,
fallbacksmstime: 10("Second")
});

Demo using Ajax

var model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.numbers: "919999999999,919898989898,919797979797",
senderid: "JalpiMsg",
alternatemsg: "Hi there, I am Test msg Text",
fallbacksmstime: 10("Second")
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Type 9 : API to send Message/Image/Audio/Video to Jalpi User in Channel and Group

pass parameters in json model

http://jalpi.com/api/Message/Send
json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.channels: 48a2ea41-a8a2-499a-a58f-701030e80f54
senderid: JalpiMsg,
isscheduled: true,
scheduledatetime: 05/02/2016 09:45:00 AM,
audiance.numbers: 919722978105,
audiance.groups:  7e4bb69d-d71b-4d4b-b4de-d7e451bb1932,
alternatemsg: "Hi there, I am Test msg",
});

Demo using Ajax

json model = JSON.stringify({
username: "JalpiTest",
password: "JalpiTest",
content: "Hi there, I am Test msg",
contenttype: "text",
audiance.channels: 48a2ea41-a8a2-499a-a58f-701030e80f54,
audiance.numbers: 919722978105,
audiance.groups:  7e4bb69d-d71b-4d4b-b4de-d7e451bb1932,
senderid: JalpiMsg,
isscheduled: true,
scheduledatetime: 05/02/2016 09:45:00 AM,
alternatemsg: "Hi there, I am Test msg",
});
$.ajax({
url: '/Api/Message/Send',
data: model,
type: 'POST',
contentType: 'application/json; charset=utf-8'
});

Response Received after HTTP API call

Response Text -> ResponseCode : ResponseMessage

Response Code

Response Message

error 404

Enter Required Parameter

error 404

Please Enter at least one audiance

error 404

Enter Alternate Text

error 401

User Not Valid

error 204

Enter MobileNo

error 204

Enter Channel

error 204

Enter Group

error 500

Error Occurred

error 500

Enter Valid Time

error 500

Please Enter Valid Channel

error 500

Please Enter Valid Group

error 406

SenderId not approved

error 406

Please Configure SMS Account Detail

error 404

Upload Image File

error 404

Upload Audio File

error 404

Upload Video File

success 200

Message Sent Successfully