zipwhip-rs 0.6.0

A fast, asynchronous, and safe wrapper around the Zipwhip API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

<div align="center">
 <p><h1>zipwhip-rs</h1> </p>
  <p><strong>Fast, asynchronous, and safe wrapper around the <a href="https://developers.zipwhip.com/">Zipwhip API</strong></p>
<p>

[![GitHub Actions](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fajmwagar%2Fzipwhip-rs%2Fbadge&label=build&logo=none)](https://actions-badge.atrox.dev/ajmwagar/zipwhip-rs/goto)
[![crates.io](https://meritbadge.herokuapp.com/zipwhip-rs)](https://crates.io/crates/zipwhip-rs)
[![Documentation](https://docs.rs/zipwhip-rs/badge.svg)](https://docs.rs/zipwhip-rs)
[![Download](https://img.shields.io/crates/d/zipwhip-rs.svg)](https://crates.io/crates/zipwhip-rs)
[![Version](https://img.shields.io/badge/rustc-1.40+-lightgray.svg)](https://blog.rust-lang.org/2019/12/19/Rust-1.40.0.html)
[![License](https://img.shields.io/crates/l/zipwhip-rs.svg)](./LICENSE)

  </p>

  <h3>
    <a href="https://zipwhip.com">Website</a>
    <span> | </span>
    <a href="https://github.com/ajmwagar/zipwhip-rs/tree/master/examples">Examples</a>
  </h3>
</div>
<br>

## Features

- Asynchronous SMS/MMS Client
- Low-Latency, High Throughput [chatbots](https://github.com/ajmwagar/zipwhip-rs/tree/master/examples/chatbot)
- Bulk SMS/MMS functions
- Webhook managment
- Runtime Agnostic (using `std::future::Future`) (`tokio` is only used to run unit tests)

## Send an SMS

```rust
#[tokio::main] // or `async-std`
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  // Create API Client
  let zw_client = zipwhip_rs::Client::with_key("<zipwhip session key>");
  // Send SMS
  zw_client.send_sms("+12064517010", "Hello, Zipwhip-rs!").await?;
  
  Ok(())
}
```

## Running tests
`ZIPWHIP_SESSION_KEY=<key> ZIPWHIP_TEST_NUMBER=<phone_number> cargo test`