Struct CampaignsResource 

pub struct CampaignsResource { /* private fields */ }

Outbound campaigns — /api/v2/outbound/campaigns.

Implementations

impl CampaignsResource

pub async fn list(&self) -> Result<Vec<OutboundCampaign>, ManagerError>

List the outbound campaigns.

pub async fn create( &self, body: CreateCampaignRequest, ) -> Result<OutboundCampaignItemResponse, ManagerError>

Create a campaign.

pub async fn get( &self, id: &str, ) -> Result<OutboundCampaignItemResponse, ManagerError>

Get a campaign by id.

pub async fn update( &self, id: &str, body: UpdateCampaignRequest, ) -> Result<OutboundCampaignItemResponse, ManagerError>

Update a campaign.

pub async fn delete(&self, id: &str) -> Result<(), ManagerError>

Delete a campaign.

pub async fn attempts( &self, id: &str, number: Option<&str>, ) -> Result<PaginatedAttemptResponse, ManagerError>

List the dial attempts for a campaign, optionally filtered by phone number.

pub async fn hopper( &self, id: &str, ) -> Result<CampaignHopperResponse, ManagerError>

Get the hopper (queued leads) of a campaign.

pub async fn leads( &self, id: &str, ) -> Result<PaginatedLeadResponse, ManagerError>

List the leads of a campaign.

pub async fn processed_leads( &self, id: &str, ) -> Result<PaginatedLeadResponse, ManagerError>

List the processed leads of a campaign.

pub async fn get_list( &self, id: &str, ) -> Result<LeadListItemResponse, ManagerError>

Get the lead list assigned to a campaign.

pub async fn set_list( &self, id: &str, body: SetCampaignListRequest, ) -> Result<CampaignItemResponse, ManagerError>

Set the lead list of a campaign.

pub async fn unset_list( &self, id: &str, ) -> Result<CampaignItemResponse, ManagerError>

Unset (detach) the lead list of a campaign.

pub async fn set_list_by_id( &self, id: &str, list_id: &str, ) -> Result<CampaignItemResponse, ManagerError>

Set the lead list of a campaign by list id.

pub async fn logout_all_agents( &self, id: &str, ) -> Result<DefaultV2MessageResponse, ManagerError>

Log out all agents currently assigned to a campaign.

pub async fn statistics( &self, id: &str, from: Option<i32>, to: Option<i32>, ) -> Result<CampaignStatisticsResponse, ManagerError>

Get the statistics of a campaign, optionally bounded by a from/to time range.

pub async fn status( &self, id: &str, ) -> Result<CampaignRealtimeStatusResponse, ManagerError>

Get the realtime status of a campaign.