kavenegar-node

Kavenegar RESTful API Document

If you need to future information about API document Please visit RESTful Document

Installation

First of all, You need to make an account on Kavenegar from Here

After that you just need to pick API-KEY up from My Account section. You can download the Node SDK Here or just pull it. Anyway there is good tutorial about Pull request

For installing Kavenegar use this command via npm

npm install kavenegar

If you don't have npm you can easily install it from npm website

Usage

Well, There is examples to Send SMS by node below.

Simple Send:

var Kavenegar = require('kavenegar');
var api = Kavenegar.KavenegarApi({
    apikey: 'your apikey here'
});
api.Send({
        message: "خدمات پیام کوتاه کاوه نگار",
        sender: "10004346",
        receptor: "09123456789,09367891011"
    },
    function(response, status) {
        console.log(response);
        console.log(status);
    });
/*
sample output
{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": 
    [
        {
            "messageid":8792343,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09123456789",
            "date":1356619709,
            "cost":120
        },
        {
            "messageid":8792344,
            "message":"خدمات پیام کوتاه کاوه نگار",
            "status":1,
            "statustext":"در صف ارسال",
            "sender":"10004346",
            "receptor":"09367891011",
            "date":1356619709,
            "cost":120
        }
    ]
}
*/

Verify Lookup:

var Kavenegar = require('kavenegar');
var api = Kavenegar.KavenegarApi({
    apikey: 'your apikey here'
});
api.VerifyLookup({
    receptor: "09361234567",
    token: "852596",
    template: "registerverify"
}, function(response, status) {
    console.log(response);
    console.log(status);
});
/*
sample output
{
    "return":
    {
        "status":200,
        "message":"تایید شد"
    },
    "entries": {
            "messageid":8792343,
			"message": "ممنون از ثبت نام شما کد تایید عضویت  : 852596",
            "status":5,
            "statustext":"ارسال به مخابرات",
            "sender":"10004346",
            "receptor":"09361234567",
            "date":1356619709,
            "cost":120
   }    
    
}
*/

Send Array:

var Kavenegar = require('kavenegar');
var api = Kavenegar.KavenegarApi({
    apikey: 'your-apikey'
});
api.SendArray(
{
        message: '["کاوه نگار", "وب سرویس کاوه نگار"]',
        sender: '["10008445","10008445"]',
        receptor: '["09123456789","09123456781"]'
}
,
    function(response, status) {
        console.log(response);
        console.log(status);
});

Contribution

Bug fixes, docs, and enhancements welcome! Please let us know [email protected]