API Document

1. Signup an Account

Signup an Account then verify your email address. Please take note that you will not be able to use API with unverified account.

2. Generate an API Key and Secret

You need an API Key and Secret to start using the API. You can create one by logging in to your Account then go to Modules > Credentials.

1. Send SMS

Endpoint:
https://juansms.com/api/sms/send_sms
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"sender":"MySender",
"mobile":"09171234567",
"message":"your message"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
sender required. Registered sender of your account. Sender should be active on your account.
mobile required. Mobile number of the recipient. PH subscribers: Smart, Sun, Globe only.
message required. The message or content you wanted to send to subscriber. Should not be blank.
API Response:
{
"status":"success",
"message":"Message was successfully sent!",
"id":"M0000002870-001"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id System generated message id Unique message id

2. Send Pin

Endpoint:
https://juansms.com/api/sms/send_pin
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"sender":"MySender",
"mobile":"09171234567",
"template":"myOtp"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
sender required. Registered sender of your account. Sender should be active on your account.
mobile required. Mobile number of the recipient. PH subscribers: Smart, Sun, Globe only.
template optional. Registered template of your account. Default template will apply if none supplied. Template should be active on your account.
API Response:
{
"status":"success",
"message":"You have successfully generated a PIN.",
"id":"P0000002871-001",
"refcode":"123456"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id Pin reference id Unique reference id
refcode System generated reference code. This will be use to verify the PIN sent to subscriber. 6 digit code

3. Verify Pin

Endpoint:
https://juansms.com/api/sms/verify_pin
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"pincode":"567890",
"refcode":"123456"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
pincode required. Pin code sent to subscriber. 6 digit pin code and not expired.
refcode required. Reference code response from Send Pin method. 6 digit reference code should exist and valid.
API Response:
{
"status":"success",
"message":"You have successfully verified the PIN.",
"id":"P0000002871-001"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id Pin reference id Unique reference id

4. Get Inbox

Endpoint:
https://juansms.com/api/sms/get_inbox
Method:
GET,POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
page optional. The page number of the list of messages. Should be numeric.
limit optional. The number of messages to show per page. Should be numeric.
API Response:
{"count":2,
"list":[{
"id":"M0000029222-001",
"mobile":"09171234567",
"ac":"22566767",
"parts":1,
"message":"SMS JUAN test message 456",
"created_at":"12-16-2021 15:09:34",
"updated_at":"12-16-2021 15:09:34"
},
{
"id":"M0000029221-001",
"mobile":"09171234567",
"ac":"22566767",
"parts":1,
"message":"SMS JUAN test message 123",
"created_at":"12-16-2021 14:30:04",
"updated_at":"12-16-2021 14:30:04"
}] }
Response Parameters:
Name Description Possible Values
id System generated message id Unique message id
mobile Mobile number of subscriber who sent a message to access code 09171234567 or the sender of the message
ac Access code as to where the subscriber sent a message to 22566767 or access code assign to your account
message The actual message that subscriber sent. Text message from subscribers.
parts The number of message parts. 160 max chars per part or 153 chars per part if more than 160 chars.. 1 to 10

5. Get Outbox

Endpoint:
https://juansms.com/api/sms/get_outbox
Method:
GET,POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
page optional. The page number of the list of messages. Should be numeric.
limit optional. The number of messages to show per page. Should be numeric.
API Response:
{"count":2,
"list":[{
"id":"M0000029222-001",
"mobile":"09171234567",
"sender":"22566767",
"parts":1,
"message":"SMS JUAN test message 456",
"created_at":"12-16-2021 15:09:34",
"updated_at":"12-16-2021 15:09:34"
},
{
"id":"M0000029221-001",
"mobile":"09171234567",
"sender":"22566767",
"parts":1,
"message":"SMS JUAN test message 123",
"created_at":"12-16-2021 14:30:04",
"updated_at":"12-16-2021 14:30:04"
}] }
Response Parameters:
Name Description Possible Values
id System generated message id Unique message id
mobile Mobile number of subscriber who received the message 09171234567 or the sender of the message
sender Sender or access code of the message sent to subscribers 22566767 or access code assign to your account
message The actual message that was sent to subscriber. Text message from subscribers.
parts The number of message parts. 160 max chars per part or 153 chars per part if more than 160 chars. 1 to 10

6. Send Viber Broadcast

Endpoint:
https://juansms.com/api/viber/send_bcast
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"account":"VA0123456789",
"message":"This is a viber broadcast"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
account required. Account Id on your registered Viber accounts. Viber Account should be active.
message required. The message or content you wanted to send to subscriber. Should not be blank.
API Response:
{
"status":"success",
"message":"Message was successfully sent!",
"id":"VM0000002870-001"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id System generated message id Unique message id

7. Send Viber Reply

Endpoint:
https://juansms.com/api/viber/send_reply
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"account":"VA0123456789",
"recipient":"5W5obGyzCCVx+uS3123E2A==",
"message":"This is a viber reply"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
account required. Account Id on your registered Viber accounts. Viber account should be active.
recipient required. Viber Id on your registered Viber users. Viber user should be active.
message required. The message or content you wanted to send to subscriber. Should not be blank.
API Response:
{
"status":"success",
"message":"Message was successfully sent!",
"id":"VM0000002870-001"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id System generated message id Unique message id

8. Send Facebook Broadcast

Endpoint:
https://juansms.com/api/facebook/send_bcast
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"account":"FA0123456789",
"message":"This is a facebook broadcast"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
account required. Account Id on your registered Facebook accounts. Facebook Account should be active.
message required. The message or content you wanted to send to subscriber. Should not be blank.
API Response:
{
"status":"success",
"message":"Message was successfully sent!",
"id":"FM0000002870-001"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id System generated message id Unique message id

9. Send Facebook Reply

Endpoint:
https://juansms.com/api/facebook/send_reply
Method:
POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
"account":"FA0123456789",
"recipient":"343474780784412311",
"message":"This is a facebook reply"
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
account required. Account Id on your registered Facebook accounts. Facebook account should be active.
recipient required. Facebook Id on your registered Facebook users. Facebook user should be active.
message required. The message or content you wanted to send to subscriber. Should not be blank.
API Response:
{
"status":"success",
"message":"Message was successfully sent!",
"id":"FM0000002870-001"
}
Response Parameters:
Name Description Possible Values
status Transaction result success or failed transactions.
message Successful or failed reason For successful, Message was successfully sent! then for failed, Invalid Account, etc..
id System generated message id Unique message id

10. Get Account Info

Endpoint:
https://juansms.com/api/account/get_info
Method:
GET,POST
Sample Submit Data:
{
"key":"defcxHvxCje5WE9g",
"secret":"defcxHvxCje5WE9gSF3xkEJNF24NcMLyFym7T9Kr7uM3GQ1238B",
}
Submit Parameters:
Name Description Validation
key required. Generated API key from Credentials. API key should be active on your account.
secret required. Generated API secret from Credentials. API secret should be active on your account.
API Response:
{
"id": "A0000000001",
"email": "paulgonzaga@me.com",
"fullname": "Paul Gonzaga",
"status": "Active",
"credits": "984",
"ac": "22566767",
"created": "2018-04-01 00:48:28",
"updated": "2022-04-12 09:37:59"
}
Response Parameters:
Name Description Possible Values
id System generated account id Unique account id
email Registered account email youremail@domain.com
fullname Registered account fullname Fullname of registered account
status Status of account Active or Inactive
credits Total credits of account Integer, whole number
ac Access code assigned for the account 22566767 or other dedicated access code
created Access code assigned for the account Y-m-d H:i:s in PHP format
updated Date and time when account was updated. Y-m-d H:i:s in PHP format

1. Inbox

Description:
To set this up, please go to Settings > Webhook or go to the link below.
https://juansms.com/settings/webhook
Method:
GET, POST
Sample Data:
{
"type":"incoming",
"id":"M0000029221-001",
"mobile":"09171234567",
"ac":"22566767",
"parts":"1",
"message":"SMS JUAN test message"
}
Parameters:
Name Description Possible Values
type Type of webhook data to receive incoming or status
id System generated message id Unique message id
mobile Mobile number of subscriber who sent a message to access code 09171234567 or the sender of the message
ac Access code as to where the subscriber sent a message to 22566767 or access code assign to your account
message The actual message that subscriber sent. Text message from subscribers.
parts The number of message parts. 160 max chars per part or 153 chars per part if more than 160 chars.. 1 to 10
2025 © JuanSMS. ALL Rights Reserved. Powered by Coders Technology Solutions
  • We accept Western Union
  • We accept American Express
  • We accept MasterCard
  • We accept PayPal
  • We accept Visa