Skip to content

raychat/sms-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sms Gateways

Using this Node.js REST-ful API you'll be able to send SMS using multiple services.

List of sms panels that currently supported :

Number website
1 https://sms.ir
2 http://melipayamak.com
3 https://kavenegar.com/

Add your web service:

Add your web service info to ./gateways/gateways.json

"YourWebserviceName" : {
	    	"name": "YourWebserviceName",
	      	"localName" : "نام وب سرویس شما",
	        "developer": "@yourGithubId",
	        "website": "http://domain.com",
	        "logo": "/logos/YourWebserviceName.png",
	        "country": "IR",
	        "AuthType" : 1 
    	} 

Some web services only requires token to authorize and some of them requires username and password, you can specify Auth type using this numbers:

Number Type
1 Token
2 User Pass
3 Other

You can check this types in your client and ask user to register token or username & password.

After that

Add YourWebserviceName.js to './gateways' - its name must be that name what you added to gateways.json file:

And use ./gateways/sample js for writing your codes.

How to use?

  1. Clone this project
git clone https://github.com/raychat/sms-service.git
  1. Go to project directory
  2. Install dependencies
npm install
  1. Then
node index.js 
  • Send SMS

POST /sendSms

Field Type * Description
auth string or object required your auth data(depends on your web service it can be an object or a string)
message string required message
sender string required sender number
receptor string required receptor number
gateway string required web service name
  • Get account information

POST /getInfo

Field Type * Description
auth string or object required your auth data(depends on your web service it can be an object or a string)
gateway string required web service name

About

Sms gateways that supported in Raychat

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published