https://github.com/torabi-srh/messageway

برای استفاده از سامانه هوشمند راه‌پیام
https://github.com/torabi-srh/messageway

aspnetcore dotnet gap ivr messageway messaging msgway notification otp sms verification

Last synced: about 2 months ago
JSON representation

برای استفاده از سامانه هوشمند راه‌پیام

• Host: GitHub
• URL: https://github.com/torabi-srh/messageway
• Owner: Torabi-srh
• Created: 2025-12-23T13:12:16.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2025-12-23T14:40:01.000Z (6 months ago)
• Last Synced: 2025-12-25T01:46:02.835Z (6 months ago)
• Topics: aspnetcore, dotnet, gap, ivr, messageway, messaging, msgway, notification, otp, sms, verification
• Language: C#
• Homepage: https://msgway.com/
• Size: 14.6 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# راه پیام (MessageWay)

[![Build](https://github.com/Torabi-srh/MessageWay/actions/workflows/ci.yml/badge.svg)](https://github.com/Torabi-srh/MessageWay/actions/workflows/ci.yml)

[![NuGet](https://img.shields.io/nuget/v/MessageWay.svg)](https://www.nuget.org/packages/MessageWay)

**MessageWay** is a comprehensive messaging solution for .NET, supporting **SMS**, **IVR**, and **Gap** messenger with built-in **OTP** verification.

**Keywords**: messaging, sms, otp, ivr, gap, notification, verification, dotnet, aspnetcore, msgway

## مقدمه

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

- **وب‌سایت:** [https://msgway.com/](https://msgway.com/)

- **گیت‌هاب:** [https://github.com/MessageWay](https://github.com/MessageWay)

## شروع کار

### نصب

بسته را از طریق NuGet نصب کنید:

```bash

dotnet add package MessageWay

```

### نحوه استفاده

#### تزریق وابستگی (پیشنهادی)

سرویس‌های MsgWay را در فایل `Startup.cs` یا `Program.cs` ثبت کنید:

```csharp

using MessageWay;

builder.Services.AddMsgWay(options =>

{

    options.ApiKey = "YOUR_API_KEY";

    options.Language = "fa"; // اختیاری، پیش‌فرض "fa" است

});

```

رابط `IMsgWayClient` را به سرویس‌های خود اضافه کنید:

```csharp

public class MyService

{

    private readonly IMsgWayClient _client;

    public MyService(IMsgWayClient client)

    {

        _client = client;

    }

    public async Task SendOtpAsync(string mobile)

    {

        var request = new SendRequest

        {

            Mobile = mobile,

            Method = SendMethod.Sms,

            TemplateId = 3 // شناسه الگوی OTP شما

        };

        var response = await _client.SendAsync(request);

        

        if (response.Status == "success")

        {

            Console.WriteLine($"پیام ارسال شد! شناسه مرجع: {response.ReferenceId}");

        }

    }

}

```

#### دستی

اگر از تزریق وابستگی (DI) استفاده نمی‌کنید، می‌توانید کلاینت را مستقیماً استفاده کنید:

```csharp

var httpClient = new HttpClient();

var options = new MsgWayOptions { ApiKey = "YOUR_API_KEY" };

var client = new MsgWayClient(httpClient, options);

```

### ویژگی‌ها

- **ارسال پیام (Send Messages)**: پشتیبانی از پیامک (SMS)، تماس صوتی (IVR) و پیام‌رسان گپ.

- **بررسی وضعیت (Check Status)**: استعلام وضعیت پیام‌های ارسال شده.

- **تایید کد یکبار مصرف (Verify OTP)**: پشتیبانی داخلی برای تایید کدهای OTP.

- **دریافت موجودی (Get Balance)**: بررسی موجودی حساب.

- **دریافت الگوها (Get Templates)**: دریافت جزئیات الگوها.

## ساختار

- **MessageWay.Core**: انتزاعات اصلی، رابط‌ها و مدل‌ها.

- **MessageWay**: پیاده‌سازی اصلی و نقطه ورود.

- **MessageWay.Tests**: تست‌های واحد (Unit Tests).