Expand description
Official Rust SDK for the Unimatrix HTTP API.
UniClient provides typed access to SMS messages and OTP verification.
Credentials can be supplied explicitly or loaded from UNIMTX_ACCESS_KEY_ID
and UNIMTX_ACCESS_KEY_SECRET with UniClient::from_env.
Structs§
- Message
Service - Asynchronous SMS message operations.
- OtpService
- Asynchronous one-time passcode operations.
- Send
Message Data - Data returned after sending one or more messages.
- Send
Message Request - Parameters accepted by
sms.message.send. - Send
OtpRequest - Parameters accepted by
otp.send. - UniClient
- Asynchronous client for the Unimatrix HTTP API.
- UniClient
Builder - Builder for
UniClient. - UniMessage
- Per-recipient message details returned by the API.
- UniResponse
- A successful Unimatrix API response.
- Verify
OtpData - Data returned after verifying an OTP.
- Verify
OtpRequest - Parameters accepted by
otp.verify.
Enums§
- OtpChannel
- Channel used to deliver a one-time passcode.
- Recipients
- One phone number or a list of phone numbers.
- UniError
- Errors produced while configuring the client or calling the API.
Constants§
- DEFAULT_
ENDPOINT - Default base URL for Unimatrix API requests.
- DEFAULT_
SIGNING_ ALGORITHM - Signing algorithm used for authenticated requests.
- USER_
AGENT - User agent sent with API requests.
- VERSION
- Version of this SDK package.
Type Aliases§
- Result
- Result type returned by the SDK.