https://github.com/icerockdev/sms-service
Sms sending service for kotlin - part of BOKO libs
https://github.com/icerockdev/sms-service
backend kotlin kotlin-jvm sms sms4b twilio
Last synced: 4 months ago
JSON representation
Sms sending service for kotlin - part of BOKO libs
- Host: GitHub
- URL: https://github.com/icerockdev/sms-service
- Owner: icerockdev
- License: apache-2.0
- Created: 2020-02-10T07:30:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T10:26:46.000Z (almost 3 years ago)
- Last Synced: 2025-05-07T05:04:01.887Z (7 months ago)
- Topics: backend, kotlin, kotlin-jvm, sms, sms4b, twilio
- Language: Kotlin
- Homepage:
- Size: 154 KB
- Stars: 5
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sms service
## Installation
````kotlin
// Append repository
repositories {
mavenCentral()
}
// Append dependency
implementation("com.icerockdev.service:sms-service:1.2.0")
````
## Library usage
### Twilio
````kotlin
private val scope = CoroutineScope(Dispatchers.IO + SupervisorJob())
private val smsService = SmsService(
scope,
TwilioDriver(
TwilioConfig(
accountSID = "sid",
authToken = "token",
phone = ""
)
)
)
````
### Sms4b
````kotlin
private val scope = CoroutineScope(Dispatchers.IO + SupervisorJob())
private val smsService = SmsService(
scope,
Sms4bDriver(
Sms4bConfig(
login = "login",
password = "pass",
source = ""
)
)
)
````
### Sending
````kotlin
runBlocking {
smsService
.sendAsync("", "TEST MESSAGE")
.await()
}
````
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2020 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.