Struct Client 

pub struct Client { /* private fields */ }

Zipwhip API Client Requires a Zipwhip session key to be used

Implementations

impl Client

pub fn with_key<K: Into<String>>(session_key: K) -> Self

Create a new Zipwhip client with a session key.

pub async fn add_webhook<U: Into<String>>( &self, event: WebhookEvent, url: U, ) -> Result<usize, ZipwhipError>

Register a new webhook for event events.

Returns the id of the new webhook

pub async fn list_webhooks(&self) -> Result<Vec<Webhook>, ZipwhipError>

Returns a list of webhooks configured for this session_key.

pub async fn remove_webhook(&self, id: usize) -> Result<(), ZipwhipError>

Delete a webhook (id) for this session_key

pub async fn logout(self) -> Result<(), ZipwhipError>

Invalidate the session_key

pub async fn login<U: Into<String>, P: Into<String>>( username: U, password: P, ) -> Result<Self, ZipwhipError>

Generate a session key on auth

pub fn set_key<K: Into<String>>(&mut self, session_key: K)

Override the current session_key

pub async fn send_sms<T: Into<String>, B: Into<String>>( &self, to: T, body: B, ) -> Result<usize, ZipwhipError>

Send an SMS message to a single recipient.

• to: A phone number to send your SMS too
• body: Message body Returns the message_id of the newly send message

pub async fn group_sms<T: Into<String>, B: Into<String>>( &self, to: Vec<T>, body: B, ) -> Result<usize, ZipwhipError>

Send a group SMS message

• to: A vector of phone numbers to send a group message too
• body: Message body

pub async fn bulk_sms<T: Into<String>, B: Into<String> + Clone>( &self, to: Vec<T>, body: B, ) -> Vec<Result<usize, ZipwhipError>>

Send a group SMS message

• to: A vector of phone numbers to send an individual message to each recipient.
• body: Message body

pub async fn group_mms<T: Into<String>, B: Into<String>>( &self, to: Vec<T>, body: B, ) -> Result<usize, ZipwhipError>

Send a group MMS message

• to: A vector of phone numbers to send a group message too
• body: Message body

pub async fn bulk_mms<T: Into<String>, B: Into<String> + Clone>( &self, to: Vec<T>, body: B, ) -> Vec<Result<usize, ZipwhipError>>

Send a group MMS message

• to: A vector of phone numbers to send an individual message to each recipient.
• body: Message body

pub async fn send_mms<T: Into<String>, B: Into<String>>( &self, to: T, body: B, ) -> Result<usize, ZipwhipError>

Send an MMS message

• to: A vector of phone numbers to send a group message too
• body: Message body

pub async fn send_file<T: Into<String>>( &self, to: T, file: Vec<u8>, ) -> Result<usize, ZipwhipError>

Send an MMS message with an attachment

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Client

fn default() -> Self

Returns the “default value” for a type.