API Setup New - VeloConnect

API Setup

Send Single SMS to URL: https://api.fortis-te.com/api/SendSMS To send single text to multiple numbers using a single submission use below link https://api.fortis-te.com/api/SendSMSMulti

1.1 PARAMETERS

Parameter Name	Required	Description	Example
api_id	Yes	Your API ID Sent in Email	API43404236
api_password	Yes	Your SPI Password Sent in Email	password@123
sms_type	Yes	SMS Type Promotional / Transactional	P for Promotional T for Transactional
encoding	Yes	SMS Encoding Text, Unicode etc.	for Text for Unicode FS for Flash Message UFS for Unicode Flash Message
sender_id	Yes	Your Sender ID	Your Registered Sender ID
phonenumber	Yes	Recipient Phone Number	Phone Number Should No Contain + Sign Phone Number Format is Country Code + Phone Number Example: 919622333345 In case of bulk submit , separate each number with a comma like 911234567890,63344455678,971543213066
templateid	Optional	Required If You Want to Send Existing Template. Check Template ID in Customer Panel	Template ID from Customer Panel Example: 10
textmessage	Conditional	If Template ID is provided text message is not required	Text of SMS Message to Send
V1	Optional	Variable 1 To Replace in Template	Any Data for Variable 1 You Want to Replace
V2	Optional	Variable 2 To Replace in Template	Any Data for Variable 2 You Want to Replace
V3	Optional	Variable 3 To Replace in Template	Any Data for Variable 3 You Want to Replace
V4	Optional	Variable 4 To Replace in Template	Any Data for Variable 4 You Want to Replace
V5	Optional	Variable 5 To Replace in Template	Any Data for Variable 5 You Want to Replace
ValidityPeriodInSeconds	Optional	Message validity period (Expiry time)	Default is 2 days, you can set it manually int value as second like 60 for 1 min.
uid	Optional	Message reference variable, this value will return as it is in quick response and delivery	xyz
callback_url	Optional	The CallBack-URL where you wanna delivery report. We will post the json data of delivery.	https://xyz.com/
pe_id	Optional	DLT parameter	xyz
template_id	Conditional	DLT parameter (if given pe_id then this field is required )	xyz

Note: uid and callback_url parameters is not supported with SendSMSMulti API. Only for SendSMS API.

1.2 CALLING THE API

1.2.1 Method-1: Using Get Request

Example: https://api.fortis-te.com/api/SendSMS? api_id=API4623444906&api_password=password@123&sms_type=P&encoding=T&sender_id=AS MSC&phonenumber=91999020323&textmessage=test&uid=xyz&callback_url=https://xyz.com/

1.2.2 Method-2: Using POST Request

1.2.3 : Response Format for Both GET AND POST

Response Details.

message_id System Generated Message ID

status S = Submitted F = Failed to Submit

remarks Description of the status

uid Reference Value as given

1.2.4 : CallBack URL Response Details

message_id Message ID of the request

PhoneNumber Phone Number to which message was sent

SMSMessage Text of the SMS message

MessageType Message Encoding

MessageLength Length of Message

MessageParts No of Message parts

ClientCost Amount Deducted from account

DLRStatus Delivery Status Can Be One Of the following

Pending

Delivered

Undeliverable

Acknowledged

Expired

Accepted

Rejected

Unknown

Failed

DND

SMSID Carrier Generated SMS ID

ErrorCode Error Code If Any

ErrorDescription Error Description If Any

SentDateUTC SMS Sent Date Time in UTC (Universal Time Coordinate)

Remarks Remarks for the Request

uid Reference parameter as you submit with sms

1.3 QUERY DELIVERY REPORT / MESSAGE STATUS

URL: https://api.fortis-te.com/api/GetDeliveryStatus

1.3.1 Parameters

Parameter Name Required Description Example

message_id Conditional Message ID You Received at The Time of Submit (Not Required if your are using uid parameter) 4134

uid Conditional Reference value as you sent and received at the time of submit message Xyz

api_id Yes Your API ID API1234

api_password Yes Your API password 1234xyz

1.3.2 Calling Delivery Report API Using, Method-1 Get Request

Example: https://api.fortis-te.com/api/GetDeliveryStatus?api_id=API123&api_password=123xyz&message_id=2323&uid=xyz

1.3.3 Calling Delivery Report API Using, Method-2 Post Request

1.3.4 Response Format for Both GET AND POST

1.3.5 Response Details

message_id	Message ID of the request
PhoneNumber	Phone Number to which message was sent
SMSMessage	Text of the SMS message
MessageType	Message Encoding
MessageLength	Length of Message
MessageParts	No of Message parts

ClientCost Amount Deducted from account

DLRStatus

Delivery Status Can Be One Of the following

Pending
Delivered
Undeliverable
Acknowledged
Expired
Accepted
Rejected
Unknown
Failed
DND

SMSID Carrier Generated SMS ID

ErrorCode	Error Code If Any
ErrorDescription	Error Description If Any
SentDateUTC	SMS Sent Date Time in UTC (Universal Time Coordinate)
Remarks	Remarks for the Request
uid	Reference parameter as you submit with sms

Post Request JSON Format

							
					

{
"api_id": yourapiid,
"api_password": yourapipassword,
"sms_type": T,
"encoding": T,
"sender_id": ASMSC,
"phonenumber": 919990123312,
"templateid": null,
"textmessage":test message,
"V1": null,
"V2": null,
"V3": null,
"V4": null,
"V5": null,
"ValidityPeriodInSeconds": 60,
"uid":"xyz",
"callback_url":"https://xyz.com/",
"pe_id":NULL,
"template_id":NULL
}
				
			
		

							
					{

“message_id”: 4125,

“status”: “S”,

“remarks”: “Message Submitted Successfully” ,

“uid”: “xyz”

}

Post Request JSON Format

				
					{
  “message_id”: 32,

  “PhoneNumber”: “9713254”,

   “SMSMessage”: “Test Message”,

  “MessageType”: “Default”,

  “MessageLength”: 159,

  “MessageParts”: 1,

  “ClientCost”: 1,

  “DLRStatus”: “Delivered”,

  “SMSID”: “9cbd20a1-0cd8-420e-b384-5767b7df7a87”,

  “ErrorCode”: 0,

  “ErrorDescription”: “000”,

  “SentDateUTC”: “2017-05-05T10:16:39.523”,

  “Remarks”: “OK” ,

“uid” : “xyz”
}

							
					{
“api_id” : “API123”,

“api_password” : “123”

   ” message_id “: 32423,

“uid” : “xyz”
}

							
					{
  “message_id”: 32,

  “PhoneNumber”: “9713254”,

   “SMSMessage”: “Test Message”,

  “MessageType”: “Default”,

  “MessageLength”: 159,

  “MessageParts”: 1,

  “ClientCost”: 1,

  “DLRStatus”: “Delivered”,

  “SMSID”: “9cbd20a1-0cd8-420e-b384-5767b7df7a87”,

  “ErrorCode”: 0,

  “ErrorDescription”: “000”,

  “SentDateUTC”: “2017-05-05T10:16:39.523”,

  “Remarks”: “OK” ,

“uid” : “xyz”
}

2.1 ADD NUMBER TO CONTACT LIST THROUGH API

2.1.1 Parameters List

Parameter Name Required		Description	Example
api_id	Yes	Your API ID Received in the email or you can get it from your customer panel	API0896731286
api_password	Yes	Your API Password Received in the email or can change API password from customer panel	password@123
contact_list_id	Yes	Create Contact List in Customer Panel and Get the ID from There See Image Below for Detailed Explanation	1
contact_name	Yes	Name of the person you want to save	John
contact_number	Yes	Contact Number of the person you want to save	919990785632

2.1.2 How to Get Contact List ID

Step 1. Login in your Customer Panel At http://my.ASMSC.com

Step 2. Go to Contact List in The Left Side Menu Bar

Step 3. Click on Add New Contact List Button & Create a new Contact List

Step 4. Enter Contact List Name and Click Create New Contact List

Step 5 : Once Created You Will Find Contact List ID in the Grid Below

Yellow Color Highlighted Is Your Contact List ID

2.1.3 CALLING CONTACT LIST API USING METHOD 1 (GET REQUEST)

Example:

https://api.fortis-te.com/api/AddContact?api_id=API3434144906&api_password=passwor d&contact_list_id=1&contact_name=Test&contact_number=919990206824

2.1.4 CALLING CONTACT LIST API USING METHOD 2 (POST REQUEST)

URL: https://api.fortis-te.com/api/AddContact

2.1.5 RESPONSE FORMAT FOR BOTH GET AND POST

2.1.6 RESPONSE DETAILS

contact_id	System generated id of your contact save it for future deletion of this contact via api.
status	S = Contact Created Successfully F = Failed to create contact
remarks	Description of the status

2.2 DELETING NUMBER FROM CONTACT LIST USING API

2.2.1 Parameters List

Parameter Name	Required	Description	Example
api_id	Yes	Your API ID Received in the email or you can get it from your customer panel	API0896731286
api_password	Yes	Your API Password Received in the email or can change API password from customer panel	password@123
contact_id	Yes	Contact ID You Have Get While Creating the contact from api	123

2.2.2 Calling Delete Contact Using API, Method 1, Get Request

Example:

https://api.fortis-te.com/api/DeleteContact?api_id=API4das62144906&api_password=pas sword&contact_id=4

2.2.3 Calling Delete Contact Using API, Method 2, POST Request

URL: https://api.fortis-te.com/api/DeleteContact

2.2.4 Response Format for Both GET AND POST

2.2.5 Response Details

contact_id	Value Will Always Be Zero
status	S = Contact Deleted Successfully F = Failed to delete contact
remarks	Description of the status

Post Request JSON Format

				
					{

  “api_id”: yourapiid,

  “api_password”: yourapipassword,

  “contact_list_id”: 1,

  “contact_name”: Test,

  “contact_number”: 91999020238,
  
}

							
					{

  “contact_id”: 4,

  “status”: “S”,

  “remarks”: “Contact Created Sucessfully”

}

Post Request JSON Format

				
					{

  “api_id”: yourapiid,

  “api_password”: yourapipassword,

  “contact_id “: 1,

}

							
					{

  “contact_id”: 0,

  “status”: “S”,

  “remarks”: “Contact Created Successfully”

}

This API helps you to verify user phone number using OTP (One Time Password).

3.1 SENDING VERIFICATION SMS

3.1.1 Calling the ASMSC Verify API using Get Request Example:

https://api.fortis-te.com/api/Verfiy?api_id=API651344002&api_password=password&bran d=aSMSC_name&phonenumber=91340206824&sender_id=S MS ALA

3.1.2 Calling the ASMSC Verify API using POST Request

URL: https://api.fortis-te.com/api/Verify

3.1.3 Response Format for Both GET AND POST

3.1.4 Response Details

verfication_id	System generated id of your verification request save it to check the verification status
status	S = Verification SMS Sent Successfully F = Failed to send verification SMS
remarks	Description of the status

3.2 CHECKING VERIFICATION STATUS

3.2.1 Checking the verification Status Using Get Request.

Example: http://YOUR_API_URL/api/VerifyS tatus?verfication_id=2&verfication_code=4022

3.2.2 Checking the verification Status Using Get Request.

URL: https://api.fortis-te.com/api/VerifyStatus

3.2.3 Response Format for Both GET AND POST

3.2.4 Response Details

verfication_id	Verification ID You Sent in the Request
status	V = Verification Successfully F = Verification Failed
remarks	Description of the status

Post Request JSON Format

				
					{

  “api_id”: yourapiid,

  “api_password”: yourapipassword,

  “brand”: ASMSC_Name,

  “phonenumber”: 91999664445,

  “sender_id”: ASMSC,

}

							
					{

  “verfication_id”: 4,

  “status”: “S”,

  “remarks”: “Verification Code Sent Successfully”

}

Post Request JSON Format

				
					{

  “verfication_id“: 2,

  “verfication_code“: 4022,

}

							
					{

  “verfication_id”: 2,

  “status”: “F”,

  “remarks”: “Verification Code is Not Verified”

}

URL: https://api.fortis-te.com/api/SenderIDRequest

Methods Supported : GET & POST

Parameters List

For Get Request:

https://api.fortis-te.com/api/SenderIDRequest?api_id=youapiid&api_password=
yourapipassword&sender_id=yoursenderid&country=yourcountryname&remarks=remarks

status = S (Successful)

status = F (Failed)

For Post JSON

				
					{

“api_id” : “Your API ID”,

“api_password” : “Your API Password”,

“sender_id”: “Desired Sender ID”,

“country” : “Desired Country Name”,

“remarks” : “Remarks Related To Sender ID”

}

Reponse JSON

				
					{

“status”: “S”,

“remarks”: “Sender ID Request Created Sucessfully”

}

URL : https://api.fortis-te.com/api/ GetSenderIDList

Methods Supported : GET & POST

Parameters List:

For Get Request:

https://api.fortis-te.com/api/GetSenderIDList?api_id=youapiid&api_password=yourapipassword

Post Post JSON

				
					{

“api_id” : “Your API ID”,

“api_password” : “Your API Password”,

}

Reponse JSON

				
					[

  {

    “sender_id”: “SMS UPDATE”,

    “country”: “United Arab Emirates”

    },

   {

    “sender_id”: “ASMSC”,

    “country”: “United Arab Emirates”

    }

]

URI: https://api.fortis-te.com/api/CheckBalance

Input Parameters:

Input Parameters	Required
1. api_id	Yes
2. api_password	yes

a) Method-1: Using Get Request

https://api.fortis-te.com/api/CheckBalance?api_id=yourapiid&api_password=yourapipassword

b) Method-2: Using Post Request

Post Request JSON Format

				
					{

“api_id “: your api id,

“api_password”: your api password

}

URL: https://api.fortis-te.com/api/RegisterResellerCustomer

Auth : Basic Auth ( Username as RegistrationUsername, Password as RegistrationPassword)

Note: For RegistrationUsername and RegistrationPassword you can contact to your administrator or support team.

Input Parameters:

Input Parameters	Required	Default Value
Username	Yes	ABC123
Password	yes	12345
CompanyName	Yes	aSMSC
CompanyEmail	Yes	[email protected]
BillingEmail	Yes	[email protected]
Phone	Yes	9197xxxx23
CustomerPlanID	Yes	0
DefaultSMSPrice	Yes	0
CurrencyID	Yes	50
BalanceAmount	Yes	0
TimeZoneID	Yes	1
TemplateLocked	Yes	false
CountryID	Yes	0
SenderID	Yes	TST

a) Method-2: Using Post Request

Response Details:

UserRegistered: 1 for success, 0 for fail

Remarks : Description of the status

Post Request JSON Format

				
					{

“Username”: ”Reseller account username”,

“Password”:  “Reseller account password”,

“CompanyName”:  “Reseller clients company name”,

“CompanyEmail”:  “Reseller clients company name “,

“BillingEmail”:  “Reseller clients billing email”,

“Phone”:  “Reseller clients phone number”,

“CustomerPlanID”:  customers plan id ,

“DefaultSMSPrice: customers default price,

“CurrencyID”: currency id,

“BalanceAmount”: default balance amount,

“TimeZoneID”: time zone ,

“TemplateLocked”: true or false,

“CountryID”: country id of customer,

“SenderID”: sender id

}

URL: https://api.fortis-te.com/api/GetTimeZoneList

Type: POST

Auth : Basic Auth ( Username as RegistrationUsername, Password as RegistrationPassword)

Note: For RegistrationUsername and RegistrationPassword you can contact to your administrator or support team.

Response Details:

							
					[

{

“TimeZoneID” : 1,

“Display” : “(GMT-12:00) International Date Line West”

}

]

URL: https://api.fortis-te.com/api/ReceiveIncoming

Input Parameters :

Input Parameters	Required	Default Value
ChannelNumber	Yes	2222222
MessageText	Yes	Text msg
IncomingNumber	Yes	91xxxxxx1234
Circle	No	xyz
Operator	No	xyz
Time	No	0

Note: All parameters are dynamic , you have to set parameter name in incoming vendor in admin panel and use the same parameters name as you mention for the same.

Method-2: Using Get Request

https://api.fortis-te.com/api/ReceiveIncoming?ChannelNumber=22222&MessageText=test msg&IncomingNumber=9123123211212

Method-2: Using Post Request

URL: https://api.fortis-te.com/api/ReceiveIncoming

For aSMSC V2 :

For aSMSC V3 : Post Form data

Response Details: Success / Bad Request

Auto Post: Receive data in Request Form Body

Content Type: application/json

Received Parameters: IncomingNumber, MessageText, ChannelNumber, Keyword

Post Json data

				
					{

“ChannelNumber“: 2222222,

“MessageText”:  “test” ,

“IncomingNumber”:  12323123123

}

URL: http://YOUR_API_URL/api/SenderIDStatus

Input Parameters:

Input Parameters	Required	Default Value
api_id	Yes	API123
api_password	Yes	123xyz
request_id	Yes	1234

Method-1: Using Get Request

https://api.fortis-te.com/api/SenderIDStatus?api_id=API123&api_password=123&request_id=123

Method-2: Using Post Request

URL: https://api.fortis-te.com/api/SenderIDStatus

Response Details:

Failed:

Success:

Post Json data

				
					{

“api_id“: “API123”,

“api_password”:  “wd123” ,

“request_id”:  123

}

							
					{

“request_id”:123,

“status”: ”F”,

“remarks”: “API Password Is Invalid”

}

							
					{

“request_id”: 123,

“company_name”: ”acdsa”,

“country”: ”india”,

“sender_id”: ”TST”,

“status”: “Approved”,

“created_time”: ”2021-05-20 15:30:49.730”,

“approval_time” : ”2021-05-20 15:30:49.730”,

“request_deleted”: 0

}

URL: https://api.fortis-te.com/api/SendVoiceOTP

Input Parameters:

Input Parameters	Required	Default Value
api_id	Yes	API123
api_password	Yes	123xyz
phonenumber	Yes	1234123123
otp_code	Yes	123

Method-1: Using Get Request

https://api.fortis-te.com/api/SendVoiceOTP?api_id=API123&api_password=123&phonenumber=98123123123&otp_code=123

Method-2: Using Post Request

URL: https://api.fortis-te.com/api/SendVoiceOTP

Response Details:

Post Json data

				
					{

“api_id“: “API123”,

“api_password”:  “wd123” ,

“phonenumber”:  123234234123,

“otp_code” : 123

}

							
					{

“message_id”:123,

“status”: ”S”,

“remarks”: “Submitted Successful”

}

URL: https://api.fortis-te.com/api/VoiceOTPStatus

Input Parameters:

Input Parameters	Required	Default Value
api_id	Yes	API123
api_password	Yes	123xyz
message_id	Yes	123

Method-1: Using Get Request

https://api.fortis-te.com/api/VoiceOTPStatus?api_id=API123&api_password=123&message_id=123

Method-2: Using Post Request

URL: https://api.fortis-te.com/api/VoiceOTPStatus

Response Details:

Post Json data

				
					{

“api_id“: “API123”,

“api_password”:  “wd123” ,

“message_id”:  123


}

							
					{

“PhoneNumber”:123,

“status”: ”Delivered”,

“OTP”: “123”,

“Remarks”:”OK”,

“JobDetailID”:123

}

message_id	System Generated Message ID
status	S = Submitted F = Failed to Submit
remarks	Description of the status
uid	Reference Value as given

Parameter Name	Required	Description	Example
message_id	Conditional	Message ID You Received at The Time of Submit (Not Required if your are using uid parameter)	4134
message_id	Conditional
uid	Conditional	Reference value as you sent and received at the time of submit message	Xyz
api_id	Yes	Your API ID	API1234
api_password	Yes	Your API password	1234xyz