http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


PHP Restful API

If you are going to build your own applications and your requirement is Freesms.Pk , BrandedSMS , Masked SMS and You need a super fast response and better grip in your application then our php Rest API is very advance and good.

Our Docs are such friendly that a normal user can also integrate API with out having deep Developer knowledge. Our Rest api is best choice for international SMS.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/plain

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
to * Recepient Mobile Number (Required).
from * Your company Name/Brand Name like "xyz" Displayed of Recepient mobile (Required).
type type=unicode FOR unicode SMS (OPTIONAL).
date dd-mm-YYYY Example:25-02-2014 (OPTIONAL)
time hh:mm:ss Example:21:30:55 (OPTIONAL)
message * The Message For Recepient (Required).

Return Response and their Meanings

Return Values
OK {message_id} - e.g 798149e144b88bbe5255
-1 Your request is incomplete and missing some mandatory parameters.
-2 Invalid Recipient Number.
-3 Sender ID cant Be Greater Than 11 Characters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-5 Message Length Cant Be exceeded Than 612 Characters.
-6 Balance Error.
-7 SMS Rejected Due to spam Filters.
-8 Too many Recepients are Supplied
-9 Unknow error (contact with Department).
-10 Service Down.
-11 Invalid Date For Schedule.

Note: You can Explod Successfull Result by delemeter Collan ( : ) . First Param for outPut and second to trace Delivery.

Successfull Output Response

OK : 798149e144b88bbe5255

Scheduled SMS For Future Reservation?

Below simple HTTP GET / POST METHOD example is given. Please Click on it to check api interferace
https://freesms.pk/plain?api_token= xxxx&api_secret=xxxx&to=92xxxxxxxxxx&from=Brand&date=21-05-2019&time=21:30:50&message=this+is+plain+api

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


JSON Output API

Welcome to the REST API. Below, you will find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Documents.

All requests must be submitted to the base URL. We provides you with an option of a response as a JSON object, or an XML string - you have to choose required response by selecting the appropriate base URL for your request.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/json

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
to * Recepient Mobile Numbers (Required).
from * Your company Name/Brand Name like "xyz" Displayed of Recepient mobile (Required).
type type=unicode FOR unicode SMS (OPTIONAL).
date dd-mm-YYYY Example:25-02-2014 (OPTIONAL)
time hh:mm:ss Example:21:30:55 (OPTIONAL)
message * The Message For Recepient (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-2 Invalid Recipient Number.
-3 Sender ID cant Be Greater Than 11 Characters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-5 Message Length Cant Be exceeded Than 612 Characters.
-6 Balance Error.
-7 SMS Rejected Due to spam Filters.
-8 Too many Recepients are Supplied
-9 Unknow error (contact with Department).
-10 Service Down.
-11 Invalid Date For Schedule.

Successfull Output Response

{"status":1,"type":"text","totalprice":3,"totalgsm":3,"remaincredit":11999991,"messages":[{"status":"OK","messageid":"ddc282453ce3ca74af1f0","gsm":"923001234567"},{"status":"OK","messageid":"78f7e373efffcc9e781f1","gsm":"923331234567"},{"status":"OK","messageid":"928bea94253a7d01ec012","gsm":"923211234567"}]}

Scheduled SMS For Future Reservation?

Below simple HTTP GET / POST METHOD example is given. Please Click on it to check api interferace
https://freesms.pk/json?api_token= xxxx&api_secret=xxxx&to=92xxxxxxxxxx,92xxxxxxxxxx,92xxxxxxxxxx&from=Brand&date=21-05-2019&time=21:30:50&message=this+is+json+api

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


XML API

It is designed to work 24/7. Manages network link failures, service provider failures, and tolerates server reboots. Extremely Easy integration with your existing IT Systems

GREAT PERFORMANCE - provides the highest availability, performance, and security to run most demanding SMS applications. No hardware or software to buy - integration with your system can be easily done by us.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/xml

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
to * Recepient Mobile Numbers (Required).
from * Your company Name/Brand Name like "xyz" Displayed of Recepient mobile (Required).
type type=unicode FOR unicode SMS (OPTIONAL).
date dd-mm-YYYY Example:25-02-2014 (OPTIONAL)
time hh:mm:ss Example:21:30:55 (OPTIONAL)
message * The Message For Recepient (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-2 Invalid Recipient Number.
-3 Sender ID cant Be Greater Than 11 Characters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-5 Message Length Cant Be exceeded Than 612 Characters.
-6 Balance Error.
-7 SMS Rejected Due to spam Filters.
-8 Too many Recepients are Supplied
-9 Unknow error (contact with Department).
-10 Service Down.
-11 Invalid Date For Schedule.

Scheduled SMS For Future Reservation?

Below simple HTTP GET / POST METHOD example is given. Please Click on it to check api interferace
https://freesms.pk/xml?api_token= xxxx&api_secret=xxxx&to=92xxxxxxxxxx&from=Brand&date=21-05-2019&time=21:30:50&message=this+is+json+api

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Personalized SMS Output API

Welcome to the REST API. Below, you will find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Documents.

All requests must be submitted to the base URL. We provides you with an option of a response as a JSON object, or an XML string - you have to choose required response by selecting the appropriate base URL for your request.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/personalized

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
to * Recepient Mobile Numbers (Required).
from * Your company Name/Brand Name like "xyz" Displayed of Recepient mobile (Required).
type type=unicode FOR unicode SMS (OPTIONAL).
date dd-mm-YYYY Example:25-02-2014 (OPTIONAL)
time hh:mm:ss Example:21:30:55 (OPTIONAL)
data * details in json format (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-2 Invalid Recipient Number.
-3 Sender ID cant Be Greater Than 11 Characters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-6 Balance Error.
-7 SMS Rejected Due to spam Filters.
-8 Too many Recepients are Supplied
-9 Unknow error (contact with Department).
-10 Service Down.
-11 Invalid Date For Schedule.

Successfull Output Response

{"status":1,"type":"success","totalgsm":2,"remaincredit":11999987,"cost":"2 SMS","messages":[{"message":"testing","gsm":"03341234567","messageid":"65a2c324e4d906ca4c1e1"},{"message":"testing","gsm":"03341234568","messageid":"304bdb4c09cc3c3c1a4d1"}]}

Scheduled SMS For Future Reservation?

Below simple HTTP GET / POST METHOD example is given. Please Click on it to check api interferace
https://freesms.pk/personalized?api_token= xxxx&api_secret=xxxx&to=92xxxxxxxxxx,92xxxxxxxxxx,92xxxxxxxxxx&from=Brand&date=21-05-2019&time=21:30:50&data=[{"to":"03341234567","from":"example","message":"testing"},{"to":"03341234568","from":"example","message":"testing"}]

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Voice SMS Output API

Welcome to the REST API. Below, you will find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Documents.

All requests must be submitted to the base URL. We provides you with an option of a response as a JSON object, or an XML string - you have to choose required response by selecting the appropriate base URL for your request.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/voice-sms

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
to * Recepient Mobile Numbers (Required).
from * Your company Name/Brand Name like "xyz" Displayed of Recepient mobile (Required).
voice_id * Id of approved voice sms (Required).
date dd-mm-YYYY Example:25-02-2014 (OPTIONAL)
time hh:mm:ss Example:21:30:55 (OPTIONAL)

Return Response and their Meanings

Return Values
-1 Your request is incomplete and missing some mandatory parameters.
-2 Invalid Recipient Number.
-3 Sender ID cant Be Greater Than 11 Characters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-6 Balance Error.
-7 SMS Rejected Due to spam Filters.
-8 Too many Recepients are Supplied
-9 Unknow error (contact with Department).
-10 Service Down.
-11 Invalid Date For Schedule.
-14 Either this voice message is invalid or not approved yet.
-15 You donot have permission to send voice message.

Scheduled SMS For Future Reservation?

Below simple HTTP GET / POST METHOD example is given. Please Click on it to check api interferace
https://freesms.pk/voice-sms?api_token= xxxx&api_secret=xxxx&to=92xxxxxxxxxx,92xxxxxxxxxx,92xxxxxxxxxx&from=Brand&date=21-05-2019&time=21:30:50&voice_id=1

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Balance Inquiry API

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/balance-inquiry

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Delivery Inquiry API

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/delivery

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
messageid * Message ID (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-2 Incorrect messageId.

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Voice Request Output API

Welcome to the REST API. Below, you will find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Documents.

All requests must be submitted to the base URL. We provides you with an option of a response as a JSON object, or an XML string - you have to choose required response by selecting the appropriate base URL for your request.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/voice-request

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
title * Title of voice (Required).
file * Voice SMS file (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-17 Allowed upload file of maximum 10MB size.
-18 Invalid file. File type must be wav, mp3.
-12 File Upload Error.
-27 You dont have enough credit to create voice message.

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Voice Status Output API

Welcome to the REST API. Below, you will find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Documents.

All requests must be submitted to the base URL. We provides you with an option of a response as a JSON object, or an XML string - you have to choose required response by selecting the appropriate base URL for your request.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/voice-status

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
voice_id * Id of voice sms (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-4 The token and secret you supplied is either invalid or disabled or blocked.
-15 You donot have permission to send voice message.
-16 Invalid voice ID.

http / Php / json / xml / C# / .NET / java
Delivery Reports / Pre-built Libraries / Readymade SMS Sending Script


Network Lookup Output API

Welcome to the REST API. Below, you will find a full listing of all the available endpoints. As we add more endpoints, they will be automatically documented here and available through the Documents.

All requests must be submitted to the base URL. We provides you with an option of a response as a JSON object, or an XML string - you have to choose required response by selecting the appropriate base URL for your request.

All requests are submitted through the HTTP GET / POST Method

Base Url

https://freesms.pk/network-lookup

Please Note: All Required Fields are compulsory! Your Request Can Not move Forward without Required Fields

Information About Parameters

Parameters
api_token * Your API token (Required).
api_secret * Your API Secret (Required).
phone_number * Phone number (Required).

Return Response and their Meanings

Return Values
1 {details}
-1 Your request is incomplete and missing some mandatory parameters.
-2 Invalid Phone Number.
-4 The token and secret you supplied is either invalid or disabled or blocked.

Test Our Gateway Now!

The website is dedicated for business sms only. Illegal sms, fake sms, anonymous sms and any kind of harassment through our website is strictly prohibited. We monitor and keep records of each sms 24/7. If our team fond any member indulged in any illegal activity so our team have rights to terminate his/her account immediately and permanently. For further please check our Terms and Condition and Agreement of Privacy policy Also check our Reversal/refund policy