Download the PHP package ghasedak/php without Composer

Ghasedak PHP SDK

Easy-to-use SDK for implementing Ghasedak SMS API in your PHP projects.
Explore the docs »

Web Service Documents · REST API . Report Bug · Request Feature

مستندات فارسی

## Table of Contents * [Install](#install) * [Usage](#usage) * [Parameters](#parameters) * [Example](#example) * [One-Time Passwords (OTP)](#one-time-passwords-otp) * [Parameters](#parameters-1) * [Example](#example-1) * [Licence](#license) ## Install The easiest way to install is by using [Composer](https://getcomposer.org/): Composer is a dependency manager for PHP which allows you to declare the libraries your project depends on, and it will manage (install/update) them for you. If you are not familiar with Composer, you can read its documentations and download it via [getcomposer.org](https://getcomposer.org/). Alternatively you can download Ghasedak SDK from [here](https://github.com/ghasedakapi/ghasedak-php/archive/master.zip) and extract it in your project and follow the rest of the instructions below. Also there is an `Example` folder inside the package which you can use to understand the procedure. ## usage To use the API, you need an API key. To get that you should have a [Ghasedak](https://ghasedak.me) account. Register and get your API key. Then require the file autoload.php to get all classes and dependencies loaded. Create an instance from Ghasedak class with your API key: Don't forget to change `your_api_key` with the key you have got from your Ghasedak account. Send a sms: ## Parameters | Parameter | Required | Description | Type | Example | | --- | --- | --- | --- | --- | | message | Yes | Text to be sent | string | Hello, World! | | receptor | Yes | The number of the recipient(s) of the message (seperated by comma `,`). | string | 09111111111 | | linenumber | No | The number of the sender of the message, which, if not specified, will be selected from your dedicated lines with a higher priority.**** | string | 5000222 | | senddate | No | The exact date and time of sending the message based on Unix time, if not specified, the message will be sent instantly. | string | 1508144471 | | checkid | No | It is used to set a unique number for each SMS, and after sending the SMS, all the information of the sent message can be received with the `status` method. | string | 2071 | ## Example Here is a sample code for sending SMS. Please note that you must specify `linenumber` if you don't have a dedicated line. ## One-Time Passwords (OTP) The One-Time-Password (OTP) Interface is used to perform a mobile authentication or to implement Two-Factor-Authentication (2FA). You can pass up to 10 `param` to `Verify` method; ## Parameters | Parameter | Required | Description | Type | Example | | --- | --- | --- | --- | --- | | receptor | Yes | The number of the recipient of the message. | string | 09111111111 | | type | Yes | Set `1` to send text message and `2` to send voice message. | int | Hello, World! | | template | Yes | The title of the template you created in your panel. | string | my-template | | checkid | No | It is used to set a unique number for each SMS, and after sending the SMS, all the information of the sent message can be received with the `status` method. | string | 2071 | | param1 | Yes | The values you enter (You must enter at least one parameter). | string | abcdef | | param2 | No | The values you enter. | string | abcdef | | param3 | No | The values you enter. | string | abcdef | | param4 | No | The values you enter. | string | abcdef | | param5 | No | The values you enter. | string | abcdef | | param6 | No | The values you enter. | string | abcdef | | param7 | No | The values you enter. | string | abcdef | | param8 | No | The values you enter. | string | abcdef | | param9 | No | The values you enter. | string | abcdef | | param10 | No | The values you enter. | string | abcdef | ## Example :) ## License Freely distributable under the terms of the [MIT](https://opensource.org/licenses/MIT) license.

فهرست مطالب

• نصب
• استفاده
• پارامترها
• نمونه کد
• رمز عبور یک‌بار مصرف
• پارامترها
• نمونه کد
• مجوز

نصب

ساده‌ترین راه برای نصب این پکیج استفاده از Composer است:

Composer سامانه‌ای برای مدیریت بسته‌های زبان PHP است که به شما امکان مدیریت (نصب / به روزرسانی) پکیج‌های نوشته شده در این زبان را می‌دهد. اگر با کامپوزر آشنایی ندارید، می‌توانید از طریق سایت getcomposer.org مستندات آن را مطالعه و اقدام به بارگیری و نصب آن کنید.

در صورت عدم تمایل به استفاده از کامپوزر، می‌توانید پکیج Ghasedak PHP را از اینجا دانلود کرده و محتویات فایل زیپ را درون پروژه‌ی خود استفاده کنید. همچنین پوشه‌ای با نام Example درون پکیج وجود دارد که می‌توانید از آن برای یادگیری استفاده‌ی صحیح از پکیج استفاده کنید.

نحوه استفاده

برای استفاده از این پکیج می‌بایست API key داشته باشید. جهت دریافت ابتدا در سایت قاصدک ثبت‌نام کنید و از پنل کاربری‌تان API key دریافت کنید.

سپس باید فایل autoload را به پروژه‌ی خود اضافه کنید:

یک instance از کلاس Ghasedak با API key خود بسازید:

به خاطر داشته باشید که your_api_key را با کلید دریافتی از حساب قاصدک خود جایگزین کنید.

پیامک دلخواه‌تان را ارسال کنید:

پارامترها

نمونه کد

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

رمز عبور یکبار مصرف (OTP)

رمز عبور یک‌بار مصرف برای اعتبارسنجی از طریق تلفن همراه و یا برای ورود دو مرحله‌ای (2FA) استفاده می‌شود.

با استفاده از متد Verify می‌توانید تا سقف 10 param را ارسال کنید:

پارامترها

نمونه کد

مجوز

این پکیج تحت مجوز MIT منتشر شده است.