SMSFactor.Campaigns (SMSFactor v0.2.0) View Source

Wrappers around Campaigns section of SMSFactor API.

Link to this section Summary

Types

Params for retrieving campaigns history.

Link to this section Types

Link to this type

campaigns_history_params()

View Source

Specs

campaigns_history_params() :: %{required(atom()) => any()}

Params for retrieving campaigns history.

  • start : You can define the start record for pagination. Default 0
  • length : You can define the number of records to retrieve per request. Default 100. Maximum 1000
  • date_start : Add a filter to retrieve campaigns of which send date is after this date. Date format must be as follow: Y-m-d H:i:s
  • date_end : Add a filter to retrieve campaigns of which send date is before this date. Date format must be as follow: Y-m-d H:i:s
  • sms_min : Add a filter to retrieve campaigns that have a minimum amount of SMS
  • sms_max : Add a filter to retrieve campaigns that have a maximum amount of SMS

Link to this section Functions

Link to this function

blacklist_campaign_npai(client, campaign_id)

View Source

Specs

blacklist_campaign_npai(Tesla.Client.t(), integer()) :: Tesla.Env.result()
Link to this function

get_campaign(client, campaign_id)

View Source

Specs

get_campaign(Tesla.Client.t(), integer()) :: Tesla.Env.result()
Link to this function

get_campaign_npais(client, campaign_id)

View Source

Specs

get_campaign_npais(Tesla.Client.t(), integer()) :: Tesla.Env.result()
Link to this function

get_campaign_replies(client, campaign_id)

View Source

Specs

get_campaign_replies(Tesla.Client.t(), integer()) :: Tesla.Env.result()
Link to this function

get_campaign_stops(client, campaign_id)

View Source

Specs

get_campaign_stops(Tesla.Client.t(), integer()) :: Tesla.Env.result()
Link to this function

get_campaigns_history(client, params \\ %{})

View Source

Specs

get_campaigns_history(Tesla.Client.t(), campaigns_history_params()) ::
  Tesla.Env.result()