kavenegar / kavenegar-elixir

A Elixir library for communicating with the Kavenegar REST API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

#Elixir SDK

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. Here You can download the Elixir SDK Here or just pull it. Anyway there is good tutorial about Pull request

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
  1. Add kavenegar to your list of dependencies in mix.exs:

    def deps do [{:kavenegar, "~> 0.0.1"}] end

  2. Ensure kavenegar is started before your application:

    def application do [applications: [:kavenegar]] end

Usage

Well, There is an example to Send SMS by Elixir.

Kavenegar.send %{receptor: "+989123456789", message: "this is a sample text"}

will return:

%{"entries" => [%{"cost" => 130, "date" => 1466091791,
     "message" => "this is a sample text", "messageid" => 999999999,
     "receptor" => "+989123456789", "sender" => "10001000010000", "status" => 1,
     "statustext" => "در صف ارسال"}],
  "return" => %{"message" => "تایید شد", "status" => 200}}

#Contribution Bug fixes, docs, and enhancements welcome! Please let us know support@kavenegar.com


راهنمای فارسی

راهنما

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

مستندات

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

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

برای مشاهده ویژگی های وب سرویس پیامک کاوه نگار به صفحه وب سرویسمراجعه نمائید.

ایجاد حساب کاربری

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

support@kavenegar.com

About

A Elixir library for communicating with the Kavenegar REST API