https://github.com/developerzelentsov/smshubapi
SmsHubAPI Swift Library
https://github.com/developerzelentsov/smshubapi
ios sms-api sms-client sms-hub sms-messages smshub smshub-api swift
Last synced: 3 months ago
JSON representation
SmsHubAPI Swift Library
- Host: GitHub
- URL: https://github.com/developerzelentsov/smshubapi
- Owner: DeveloperZelentsov
- License: mit
- Created: 2023-03-20T21:54:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-06T11:05:13.000Z (over 2 years ago)
- Last Synced: 2024-11-14T14:44:35.192Z (about 1 year ago)
- Topics: ios, sms-api, sms-client, sms-hub, sms-messages, smshub, smshub-api, swift
- Language: Swift
- Homepage:
- Size: 60.5 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SmsHubAPI Swift Library #
SmsHubAPI is a Swift library that provides an easy-to-use interface for interacting with the SmsHub API. With this library, you can access various [SmsHub services](https://smshub.org/en/main), such as getting your account balance, purchasing a phone number, setting and retrieving the status of an activation, and more.
[](https://www.buymeacoffee.com/zelentsov)
## Features ##
* Swift concurrency support with async/await
* Simple, protocol-based API
* Lightweight and modular
## Requirements ##
* iOS 15.0+
* Swift 5.6+
## Installation ##
Add the library to your project using Swift Package Manager:
1. Open your project in Xcode.
2. Go to File > Swift Packages > Add Package Dependency.
3. Enter the repository URL `https://github.com/DeveloperZelentsov/SMSHubAPI` for the SmsHubAPI library and click Next.
4. Choose the latest available version and click Next.
5. Select the target where you want to use SmsHubAPI and click Finish.
## Usage ##
First, import the **_SmsHubAPI_** library in your Swift file:
```swift
import SmsHubAPI
```
To start using the library, create an instance of **_SmsHubAPI_** with your API key:
```swift
let smsHubAPI = SmsHubAPI(apiKey: "your_api_key_here")
```
Now, you can call the methods provided by the **_SmsHubAPI_** protocol:
### Get Account Balance ###
```swift
do {
let balance = try await smsHubAPI.getBalance()
print("Account balance: \(balance)")
} catch {
print("Error: \(error)")
}
```
### Purchase Phone Number ###
```swift
let getNumber = GetNumberRequest(service: .nextdoor, country: .usa)
do {
let (id, phone) = try await smsHubAPI.purchasePhoneNumber(by: getNumber)
print("Purchased phone number: \(phone) with ID: \(id)")
} catch {
print("Error: \(error)")
}
```
### Wait for Code ###
The `waitForCode` method can be used to conveniently retrieve the SMS verification code for an activation. This method will repeatedly check the activation status until the code is received or the specified number of attempts is exhausted.
```swift
do {
let activationId = 12345
let code = try await smsHubAPI.waitForCode(id: activationId, attempts: 20, setStatusAfterCompletion: true)
print("Received code: \(code)")
} catch {
print("Error: \(error)")
}
```
### Set Activation Status ###
```swift
do {
let response = try await smsHubAPI.setStatus(id: activationId, status: .smsSent)
print("Status set response: \(response)")
} catch {
print("Error: \(error)")
}
```
### Get Activation Status ###
```swift
do {
let (status, code) = try await smsHubAPI.getStatus(id: activationId)
print("Activation status: \(status)")
if let code = code {
print("Activation code: \(code)")
}
} catch {
print("Error: \(error)")
}
```
For more information on the available methods and their parameters, refer to the **_ISmsHubAPI_** protocol and the library's source code.
## License ##
This project is released under the MIT License.