our-sms v1.0.2
need a simple, easy and fast implementaion for sending SMS around the world...? then this is service is for you
Documentation
First thing you need to sign up in the oursms.app site
You will find your own credentials.
userIdandsecretKeyon the account settings tap
install our-sms package by typing in the console :
npm install our-smsSample Usage
- requiring the packge into you Node js file
const client = require("our-sms")( <YOUR OWN USER ID GOES HERE> , <YOUR OWN SECRET KEY GOES HERE>);- sending SMS implementation
client.messages.create({
to: <PHONE NUMBER GOES HERE>,
body: <YOUR OWN TEXT GOES HERE>,
},(err) => {
if (err)
// do something
});props
| Name | Type | Default | Description | Status |
|---|---|---|---|---|
| body | String | the text message that you need to send it to the end user | Required | |
| to | String | The phone number that you need to send the message to. NOTE : the number should be in the following format '9647811111111' | Required | |
| userId | String | you own user id in the website. NOTE : the user id is without the zeros and characters on the left side (i.e. if your userId is SP-0107 then you should type 107 as the userId) | Required | |
| secretKey | String | your own secret key you can find it next to the user id in the website | Required |
IMPORTANT NOTES TO BE CONSIDERED
The secretKey will be changed if you change your own account password so reconsider changing the password if you are already connected your own app with the API
The meassages may take 5-25 sec to be delivered. Providers may have issus and take more time to be delivered
You could be black listed from sending messages to specific numbers if you send multible messages to the same number at colse period of time. NOTE : it's recommened for waite at leas a minute before resending the message to the same phone nymber