Skip to content

Spire-Recovery-Solutions/IDTExpress.NET

Repository files navigation

# IDT Express .NET SDK

IDT Express Logo

NuGet

📱 About

The IDT Express .NET SDK simplifies interaction with IDT's VoIP services, making it easy to integrate communication features into your .NET applications.

🚀 Features

  • 🌍 Fetch country coverage and regions
  • 📞 Manage DID groups and browse available numbers
  • 📊 Create and manage orders
  • 🔢 Retrieve and delete numbers
  • 🔒 Secure API communication
  • ⚡ Efficient JSON serialization via System.Text.Json

📦 Installation

Install the IDT Express SDK via NuGet:

dotnet add package IDTExpress.NET

Or via the NuGet Package Manager Console:

Install-Package IDTExpress.NET

🏗 Quick Start

using IDTExpress.NET;

// Initialize API client
string apiKey = "YOUR_API_KEY";
string apiSecret = "YOUR_API_SECRET";
string baseUrl = "https://sandbox-api.idtexpress.com/v1/";

// For production use:
// string baseUrl = "https://api.idtexpress.com/v1/";

var client = new IdtExpressApiClient(apiKey, apiSecret, baseUrl);
// Fetch country coverage
var countries = await client.GetCountryCoverageAsync();

// Fetch regions for a specific country
var regions = await client.GetRegionsAsync("your-country-code");

// Get available DID groups
var didGroups = await client.GetDidGroupsAsync("your-country-code", regionCode: "your-region-code", tollFree: false);

// Browse available numbers for a specific DID group
var numbers = await client.BrowseAvailableNumbersAsync("DID_GROUP_ID");

// Create an order
var createOrderRequest = new CreateOrderRequest
{
    OrderItems = new List<OrderItem>
    {
        new OrderItem
        {
            DidGroupId = did-group-id,
            Quantity = 1
        }
    }
};
var order = await client.CreateOrderAsync(createOrderRequest);

// Fetch order details
var orderDetails = await client.GetOrderAsync(order.Order.Id);

// Get numbers
var numbers = await client.GetNumbersAsync();

// Delete a number
await client.DeleteNumberAsync("NUMBER_TO_DELETE");

📘 Documentation

For detailed documentation, please visit our GitHub Wiki.

📊 Supported .NET Versions

  • .NET 8.0+

🛠 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

📄 License

This project is licensed under the GPL-3.0 license.

🤝 Support

If you encounter any issues or have questions, please open an issue on our GitHub repository

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages