Direct Endpoints for Notify.lk SMS Actions
Send SMS
Use this endpoint directly to send SMS to a contact number.
Request
URL : https://app.notify.lk/api/v1/send
Type: GET or POST
Parameters
| Key | Required | Value |
|---|---|---|
user_id |
YES | User ID from your settings page. |
api_key |
YES | API key from your settings page. |
sender_id |
YES | Your approved Sender ID. Use “NotifyDEMO” for testing. This one is case sensitive. |
to |
YES | The number of the recipient. Should be in the format of 9471XXXXXXX. |
message |
YES | The message. Max: 621 chars. |
contact_fname |
NO | (Optional) First name of the contact. Will be used while saving the contact. |
contact_lname |
NO | (Optional) Last name of the contact. Will be used while saving the contact. |
contact_email |
NO | (Optional) Email of the contact. Will be used while saving the contact. |
contact_address |
NO | (Optional) Local address of the contact. Will be used while saving the contact. |
contact_group |
NO | (Optional) Contact Group Id, if you need to assign the saving contact to a group. |
type |
NO | (Optional) Provide this with unicode, to enable unicode. |
Response
You will get a JSON response in a success or a failure attempt.
{
"status": "success",
"data": "Sent"
}
Example Call
https://app.notify.lk/api/v1/send?user_id=[USER_ID]&api_key=[API_KEY]&sender_id=NotifyDEMO&to=[TO]&message=Test
Replace [API_KEY] and [USER_ID] with your account information and [TO] with the phone number you need to receive the SMS to. And then visit the URL with your browser.
You can find your account’s API information here .
[!IMPORTANT]
Please avoid sending OTP content with our DEMO sender name. If you want to test OTP please get you own Sender ID approved first and start. Otherwise there’s a risk of getting your account suspended.Also, even after getting your own name please use your app website or brand name in the SMS content as well to continue successful delivery. Eg:
Please use the code 111111 to verify your ABC account.
Account Status
You can use this API endpoint to retrieve account status and the account balance.
Request
URL : https://app.notify.lk/api/v1/status
Type: GET
Parameters
| Key | Required | Value |
|---|---|---|
user_id |
YES | User ID from your settings page. |
api_key |
YES | API key from your settings page. |
Response
You will get a JSON response in a success attempt.
{
"status": "success",
"data": {
"active": true,
"acc_balance": 3500.00
}
}
Example Call
https://app.notify.lk/api/v1/status?user_id=[USER_ID]&api_key=[API_KEY]
Replace [API_KEY] and [USER_ID] with your account information. And then visit the URL with your browser.
You can find your account’s API information here .