smsru 0.5.0

Typed Rust client for the SMS.RU HTTP 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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

# smsru

Typed Rust client for the SMS.RU HTTP API.

Supported methods:
- `sms/send`
- `sms/cost`
- `sms/status`
- `callcheck/add`
- `callcheck/status`
- `auth/check`
- `my/balance`
- `my/free`
- `my/limit`
- `my/senders`
- `stoplist/add`
- `stoplist/del`
- `stoplist/get`
- `callback/add`
- `callback/del`
- `callback/get`

The client is async and expects a Tokio runtime.

## MSRV

Minimum supported Rust version: **1.85** (edition 2024).

## Quickstart

```rust,no_run
use smsru::{Auth, MessageText, RawPhoneNumber, SendOptions, SendSms, SmsRuClient};

# async fn run() -> Result<(), smsru::SmsRuError> {
let client = SmsRuClient::new(Auth::api_id("...")?);
let request = SendSms::to_many(
    vec![RawPhoneNumber::new("+79255070602")?],
    MessageText::new("hello world")?,
    SendOptions::default(),
)?;
let response = client.send_sms(request).await?;
println!("status: {:?} code: {:?}", response.status, response.status_code);
# Ok(())
# }
```

## Authentication

- API key: `Auth::api_id("...")?`
- Login + password: `Auth::login_password("login", "password")?`

## Request shapes

- One message to many recipients:
  - `SendSms::to_many(Vec<RawPhoneNumber>, MessageText, SendOptions)`
- Per-recipient messages:
  - `SendSms::per_recipient(BTreeMap<RawPhoneNumber, MessageText>, SendOptions)`
- Check message cost:
  - `CheckCost::to_many(Vec<RawPhoneNumber>, MessageText, CheckCostOptions)`
  - `CheckCost::per_recipient(BTreeMap<RawPhoneNumber, MessageText>, CheckCostOptions)`
- Check status:
  - `CheckStatus::new(Vec<SmsId>)`
  - `CheckStatus::one(SmsId)`
- Stoplist:
  - `AddStoplistEntry::new(RawPhoneNumber, StoplistText)`
  - `RemoveStoplistEntry::new(RawPhoneNumber)`
- Callback handlers:
  - `AddCallback::new(CallbackUrl)`
  - `RemoveCallback::new(CallbackUrl)`

## Account and utility methods

No-arg client methods (auth + `json=1`):
- `check_auth()`
- `get_balance()`
- `get_free_usage()`
- `get_limit_usage()`
- `get_senders()`
- `get_stoplist()`
- `get_callbacks()`

Input-based client methods:
- `send_sms(...)`
- `check_cost(...)`
- `check_status(...)`
- `start_call_auth(...)`
- `check_call_auth_status(...)`
- `add_stoplist_entry(...)`
- `remove_stoplist_entry(...)`
- `add_callback(...)`
- `remove_callback(...)`

## Strong types

- `RawPhoneNumber`: non-empty, no normalization.
- `PhoneNumber::parse(...)`: optional E.164 normalization path.
- `StoplistText`: non-empty note for stoplist entries.
- `CallbackUrl`: absolute `http://` or `https://` URL.

## Client configuration

Use `SmsRuClient::builder(auth)` to configure `timeout`, `user_agent`, and endpoints.

Per-endpoint overrides:
- `send_endpoint(...)`
- `cost_endpoint(...)`
- `status_endpoint(...)`
- `callcheck_add_endpoint(...)`
- `callcheck_status_endpoint(...)`
- `auth_check_endpoint(...)`
- `my_balance_endpoint(...)`
- `my_free_endpoint(...)`
- `my_limit_endpoint(...)`
- `my_senders_endpoint(...)`
- `stoplist_add_endpoint(...)`
- `stoplist_del_endpoint(...)`
- `stoplist_get_endpoint(...)`
- `callback_add_endpoint(...)`
- `callback_del_endpoint(...)`
- `callback_get_endpoint(...)`

`endpoint(...)` sets all method endpoints at once.

## JSON-only transport

The client always sends `json=1` and only supports JSON responses.
When a request type exposes `JsonMode`, `JsonMode::Plain` is rejected by the client.

## Status codes

Responses preserve SMS.RU status codes via `StatusCode`.
Known codes are mapped through `StatusCode::known_kind()`; unknown codes are preserved.