راهنما
معرفی سرویس کاوه نگار
ساخت حساب کاربری
اطالاعات بیشتر
کد ارسال و دریافت پیامک
همکاری
#C
نصب
نمونه
PHP
نصب
نمونه
Java
gradle
maven
sbt
leiningen
نمونه
Delphi
نصب
Curl
نمونه
Node
نصب
نمونه
Python
نصب
نمونه
go
نمونه
Ruby
نصب
Laravel
نیاز ها
نصب
Laravel 5
Laravel 4
نمونه
yii2
نصب
کانفیگ
کاربرد

راهنما

معرفی سرویس کاوه نگار

کاوه نگار یک وب سرویس ارسال و دریافت پیامک و تماس صوتی است که به راحتی میتوانید از آن استفاده نمایید.

ساخت حساب کاربری

اگر در وب سرویس کاوه نگار عضو نیستید میتوانید از لینک عضویت ثبت نام و اکانت آزمایشی برای تست API دریافت نمایید.

مستندات

برای مشاهده اطلاعات کامل مستندات وب سرویس پیامک به صفحه مستندات وب سرویس مراجعه نمایید.

اطالاعات بیشتر

برای مطالعه بیشتر به صفحه معرفی وب سرویس اس ام اس کاوه نگار مراجعه نمایید .

کد ارسال و دریافت پیامک

کیت توسعه نرم‌افزار یا SDK ، مجموعه ای از توابع و کتابخانه‌های کامپایل شده‌ای است که برای آسان کردن برنامه‌نویسی در اختیار توسعه دهندگان قرار می‌ گیرد.

شرکت کاوه نگار بعد از انتشار وب سرویس اس ام اس REST و SOAP اقدام به تولید SDK برای زبان های برنامه نویسی محبوب نمود تا گسترش دهندگان نرم افزار بتوانند به راحتی با افزودن یک کتابخانه به پروژه خود از سرویس کاوه نگار در هر پروژه ها استفاده نمایند.

نکته: کد ارسال پیامک کاوه نگار بر مبنای وب سرویس پیامک REST می باشد، بنابراین در صورت تمایل به دریافت جزئیات بیشتر می توانید به مستندات وب سرویس Rest مراجعه نمائید. توابع موجود در SDK شامل ارسال پیامک سریع ، ارسال پیامک گروهی ، دریافت وضعیت پیامک های ارسال ،ارسال کد اعتبارسنجی پیامک و تماس تلفنی، واکشی پیامک های دریافتی و گزارشات مربوط به میزان ارسال و دریافت پیامک می باشد . نکته : در صورتی که در اجرای هر کدام از متدها مشکلی وجود داشته باشد

Exception ارسال می شود ، که شما می توانید با استفاده از آن خطا موجود را شناسایی کنید.

ApiException : به این معنی است که ارتباط با وب سرویس امکان پذیر بوده و خطایی از آن دریافت کرده است ( لیست خطاها به همراه توضیحات )

HttpException : به این معنی است که مشکلی در برقراری ارتباط با سرویس کاوه نگار وجود دارد

برای ارائه مشکلات و یا پیشنهادات خود در رابطه با SDK می توانید از طریق ایمیل support@kavenegar.com آن را به ما منتقل کنید و یا از طریق یک Push Request در کانال گیت هاب ما را مطلع نمائید .

در صورتی که در گیت هاب حساب کاربری دارید خوشحال میشویم کاوه نگار را دنبال نمائید.

همکاری

اگر در استفاده از کیت های سرویس کاوه نگار مشکلی یا پیشنهادی داشتید ما را با یک Pull Request یا ارسال ایمیل به support@kavenegar.com خوشحال کنید.

http://kavenegar.com

Edit on GitHub

#C

برای استفاده از SDK کاوه نگار در زبان های دات نت کافی است فایل DLL دانلود شده را به بخش Refrence های پروژه اضافه نمایید.

نصب

برای نصب کافیست مراحل زیر را طی کنید

روش اول :

nuget را از اینجادانلود و نصب نمایید
ازمنوی Tools قسمت Library Package Manager گزینه Package Manager Console را انتخاب نمایید
از Package Manager Console باز شده دستور Install-Package Kavenegar را تایپ نمایید و سپس اینتر را بزنید
اکنون پکیج Kavenegar.dll به References های پروزه اضافه شده که از بخش Solution explorer پوشه References قابل مشاهده میباشد

روش دوم :

بصورت دستی * از اینجا SDK را دانلود نمایید

روش استفاده :

از قسمت Solution explorer روی References راست کلیک کرده سپس از منوی ضاهر شده روی Add Reference کلیک کرده سپس Kavenegar.dll انتخاب نمایید

SDK دانلود

دانلود نمونه کد

نمونه

ارسال پیامک در سی شارپ :


try
{
var sender = "10006703323323";
var receptor = "{Your Phone Number}";
var message = "وب سرویس تخصصی کاوه نگار ";
var api = new Kavenegar.KavenegarApi("{Your API Key}");
api.Send(sender, receptor, message);
catch (Kavenegar.Exceptions.ApiException ex) 
{
    // در صورتی که خروجی وب سرویس 200 نباشد این خطارخ می دهد.
    Console.Write("Message : " + ex.Message);
}
catch (Kavenegar.Exceptions.HttpException ex) 
{
    // در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
    Console.Write("Message : " + ex.Message);

}

PHP

برای استفاده از SDK کاوه نگار در زبان PHP کافیست فایل فشرده که حاوی کدهای ارسال و دریافت پیامک می باشد را دانلود و از حالت فشرده خارج نموده و در کنار کدهای خود قرار دهید. ضمنا Include SDK کاوه نگار را در قسمتی که میخواهید توابع را فراخوانی کنید فراموش نشود

شما به عنوان برنامه نویس و توسعه دهنده وظیفه قرار دادن کد مناسب با سیستم خود را در این کلاس دارید

برای مثال شما مایل هستید بعد از ایجاد خطا, متن و اطلاعات پشته خطا در فایلی ذخیره و سپس پیام مناسب به کلاینت نمایش داده شود.

نصب

از راه های زیر استفاده کنید :

composer require kavenegar/php

یا فایل را اظافه کنید ‌:


"kavenegar/php": "*"

دستور زیر را بزنید تا نصب شود :


composer update

نمونه


require  '/vendor/autoload.php';
$sender = "10006703323323";
$receptor = "09010346953";
$message = "وب سرویس تخصصی کاوه نگار ";
$api = new \Kavenegar\KavenegarApi("ِYour API Key");
$api->Send($sender,$receptor,$message);
catch(\Kavenegar\Exceptions\ApiException $e){
    // در صورتی که خروجی وب سرویس 200 نباشد این خطا رخ می دهد
    echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
    // در زمانی که مشکلی در برقرای ارتباط با وب سرویس وجود داشته باشد این خطا رخ می دهد
    echo $e->errorMessage();
}

Java

نصب

بسته به آنچه که استفاده میکنید :

gradle

مرحله اول

ابتدا مخزن jitpck را به پروژه خود اظافه میکنید

allprojects {
        repositories {
            ...
            maven { url 'https://jitpack.io' }
        }
    }

مرحله دوم

سپس dependency ها را اظافه میکنید

dependencies {
        compile 'com.github.User:Repo:Tag'
    }

maven

مرحله اول

ابتدا مخزن jitpck را به پروژه خود اظافه میکنید


<repositories>
        <repository>
            <id>jitpack.io</id>
            <url>https://jitpack.io</url>
        </repository>
    </repositories>

مرحله دوم

سپس dependency ها را اظافه میکنید

<dependency>
        <groupId>com.github.User</groupId>
        <artifactId>Repo</artifactId>
        <version>Tag</version>
    </dependency>

sbt

مرحله اول

ابتدا مخزن jitpck را به پروژه خود اظافه میکنید

    resolvers += "jitpack" at "https://jitpack.io"

مرحله دوم

سپس dependency ها را اظافه میکنید


    libraryDependencies += "com.github.User" % "Repo" % "Tag"

leiningen

مرحله اول

ابتدا مخزن jitpck را به پروژه خود اظافه میکنید

    :repositories [["jitpack" "https://jitpack.io"]]

    }

مرحله دوم

سپس dependency ها را اظافه میکنید


    :dependencies [[com.github.User/Repo "Tag"]]

نمونه

مثالی از ارسال اس ام اس از طریق java :


try {
     KavenegarApi  api= new KavenegarApi("Your API Key");
      SendResult Result = api.Send("SenderLine", "Your Receptor", "وب سرویس تخصصی کاوه نگار ");
}
catch (HttpException ex)
{ // در صورتی که خروجی وب سرویس 200 نباشد این خطارخ می دهد.
  System.out.print("HttpException  : " + ex.getMessage());
}
catch (ApiException ex)
{ // در صورتی که خروجی وب سرویس 200 نباشد این خطارخ می دهد.
   System.out.print("ApiException : " + ex.getMessage());
}

Delphi

با توجه آنکه Parser ساختار Json در دلفی نسخه 2011 به بالا وجود دارد استفاده از SDK در نسخه های 2011 و بالاتر توصیه میشود در صورتی که شما از نسخه های پایین تر استفاده می کنید توصیه میشود از راهنمای SOAP استفاده نمایید.

ارسال پیامک در دلفی

برای استفاده از SDK کاوه نگار در زبان دلفی ، کافی است که فایل مورد نظر را را دانلود کرده و به بخش کتابخانه های پروژه اضافه کنید.

توجه : این نسخه از SDK برای دلفی 2011 و بالاتر مناسب می باشد , در صورتی که شما از نسخه های پائین تر استفاده می کنید لطفا به صفحهراهنمای SOAP مراجعه نمائید تا نسخه مناسب با دلفی 6 و 7 را دریافت کنید.

نصب

از لینک روبرو Delphi SDk را دریافت کنید D‌elphi SDK

Curl

خب میتونید از طریق دستور زیر توسط curl پیام خود را ارسال کنید :

نمونه


curl -XPOST http://api.kavenegar.com/v1/{API-KEY}/sms/send.json \
    --data-urlencode "receptor={Your Phone Number}"  \
    --data-urlencode "sender=10004346"  \
    --data-urlencode "message=  وب سرویس تخصصی کاوه نگار  "  \

Node

نصب

برای نصب کافی است که Nodejs SDK کاوه نگار را از طریق npm نصب کنید به صورت زیر :

npm install kavenegar

اگر npm را در سیستم خود نصب ندارید به راحتی ان را از طریق سایت روبرو نصب کنید . سایت npm

نمونه

دو نمونه از ارسال اسم از طریق nodejs را میتوانید در زیر مشاهده کنید


var Kavenegar = require('kavenegar');
var api = Kavenegar.KavenegarApi({
    apikey: ''
});
api.Send({
        message: "وب سرویس تخصصی کاوه نگار  ",
        sender: "10004346",
        receptor: "{Your API Key}"
    },
    function(response, status) {
        console.log(response);
        console.log(status);
    });
/*

نمونه دوم :


var Kavenegar = require('kavenegar');
var api = Kavenegar.KavenegarApi({
    apikey: '{Your API Key}'
});
api.VerifyLookup({
    receptor: "{Your Phone Number} ",
    token: "852596",
    template: "registerverify"
}, function(response, status) {
    console.log(response);
    console.log(status);
});

Python

نصب

نمونه

نمونه ارسال پیامک از طریق پایتون :

#!/usr/bin/env python
from kavenegar import *
try:
    import json
except ImportError:
    import simplejson as json

try:
    api = KavenegarAPI('{Your APIKey}')
    params = {
        'sender': '10004346',
        'receptor': '{Your Phone Number}',
        'message': 'Kaveh specialized Web service '
    }   
    response = api.sms_send(params)
    print str(response)
except APIException,e: 
    print str(e)
except HTTPException,e: 
    print str(e)

go

با استفاده از دستور زیر نصب کنید ‌:

go get github.com/negah/kavenegar

نمونه

نمونه ارسال اس ام اس از طریق GO :

package main

import (
  "github.com/negah/kavenegar"
  "log"
  "fmt"
)

func main(){
  // Setup new Client
  // kavenegar.SMS(api_key, sender)
  // sender is your dedicate phone_number in kavenagar. if you dont have one, left it blank but pass ""
  sms := kavenegar.NewSMS("api_key","{Your APi Key}")

  // Send sms
  status, err := sms.Send("{Your Phone Number} ", "سلام من به تو یار قدیمی ")

  if err != nil {
    log.Printf("Response status code: %d", status)
    log.Fatal(err)
  } else {
    fmt.Printf("SMS sent successfully.")
  }
}

Ruby

نصب

این خط را به فایل gem اپلیکشن خود اظافه کنید :

gem 'kave'

سپس دستور زیر را اجرا کنید :

$ bundle install

یا آن را به طور کلی از طریق gem نصب کنید ‌:

$ gem install kave

و initfile را در دایرکتوری کانفیگ خود بسازیذ (kave.rb):

Kave.configure do |config|
  config.wsdl ='http://api.kavenegar.com/soap/v1.asmx?WSDL'
  config.sender  = 'number'

خب یک مثال ارسال اس ام اس از طریق روبی

 request=Kave::SendRequestSimple.new({

    message: 'سلام عزیز :)',
    mobile: 'Your Phone Number ',
    #optional
    unixdate: by default 0 ,
    msgmode: by default 1
})

res=request.call
render :text=>{status_message_only_farsi: res.statusmessage,status_code: res.status}

Laravel

نیاز ها

Laravel 4 or 5.

نصب

از این راه نصب کنید : :

composer require kavenegar/laravel

Laravel 5

به آرایه providers در config/app.php در مسیر Kavenegar\Laravel\ServiceProvider کد های زیر را اظافه کنید ‌::

'providers' => [
  ...
  Kavenegar\Laravel\ServiceProvider::class,
],

کد زیر را به آرایه aliases اظافه کنید ::

'aliases' => [
  ...
  'Kavenegar' => Kavenegar\Laravel\Facade::class,
],

در اخر فایل کانفیگ را با دستور php artisan vendor:publishpublish کنید . آن را در مسیر ربرو پیدا خواهید کرد ‌: config/kavenegar.php.

Laravel 4

به آرایه providers در config/app.php در مسیر Kavenegar\Laravel\ServiceProvider کد های زیر را اظافه کنید ‌::

'providers' => [
  ...
  'Kavenegar\Laravel\ServiceProvider',
],

کد زیر را به آرایه aliases اظافه کنید ::

'aliases' => [
  ...
  'Kavenegar' => Kavenegar\Laravel\Facade',
],

در اخر فایل کانفیگ را با دستور php artisan vendor:publishpublish کنید . آن را در مسیر روبرو پیدا خواهید کرد ‌: config/kavenegar.php.

نمونه

نمونه ارسال اس ام اس از طریق laravel :


use Kavenegar as api;
try{
    $sender = "10004346";
    $message = "Kaveh specialized Web service ";
    $receptor = array("{Your Phone Number}");
    $result = api->Send($sender,$receptor,$message);
    if($result){
        foreach($result as $r){
            echo "messageid = $r->messageid";
            echo "message = $r->message";
            echo "status = $r->status";
            echo "statustext = $r->statustext";
            echo "sender = $r->sender";
            echo "receptor = $r->receptor";
            echo "date = $r->date";
            echo "cost = $r->cost";
        }       
    }
}
catch(\Kavenegar\Exceptions\ApiException $e){
    //In case that error throw 200 
    echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
//in case that there is any problem to connect to webservie  this error thow
    echo $e->errorMessage();
}

yii2

نصب

از روش های زیر نصب کنید :

composer require kavenegar/yii2

یا کد زیر را اظافه کنید‌:‌

"kavenegar/yii2": "*"

ودستور زیر اجرا کنید تا افزونه را از **composer** نصب کنید:

$ composer update

Configuration

کد های زیر را کانفیگ خود اظافه کنید ‌:

return [
    'components' => [
        'Kavenegar' => [
            'class' => 'Kavenegar\Yii2\Kavenegar',
            'apikey' => '{Your API Key}',
        ],
    ],
];

Usage

نمونه ارسال اسم ام اس از طریق yii2 :

try{
    $api = Yii::$app->Kavenegar->KavenegarApi();
    $sender = "10004346";
    $message = "Kaveh specialized Web service ";
    $receptor = array("{Your Phone Number} ");
    $result = $api->Send($sender,$receptor,$message);
    if($result){
        foreach($result as $r){
            echo "messageid = $r->messageid";
            echo "message = $r->message";
            echo "status = $r->status";
            echo "statustext = $r->statustext";
            echo "sender = $r->sender";
            echo "receptor = $r->receptor";
            echo "date = $r->date";
            echo "cost = $r->cost";
        }       
    }
}
catch(\Kavenegar\Exceptions\ApiException $e){
//In case that error throw 200 
    echo $e->errorMessage();
}
catch(\Kavenegar\Exceptions\HttpException $e){
//in case that there is any problem to connect to webservie  this error thow
    echo $e->errorMessage();
}