Class: Telnyx::Resources::Messaging10dlc::Campaign

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/messaging_10dlc/campaign.rb,
lib/telnyx/resources/messaging_10dlc/campaign/osr.rb,
lib/telnyx/resources/messaging_10dlc/campaign/usecase.rb

Overview

Campaign operations

Defined Under Namespace

Classes: Osr, Usecase

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Campaign

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Campaign.

Parameters:



250
251
252
253
254
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 250

def initialize(client:)
  @client = client
  @usecase = Telnyx::Resources::Messaging10dlc::Campaign::Usecase.new(client: client)
  @osr = Telnyx::Resources::Messaging10dlc::Campaign::Osr.new(client: client)
end

Instance Attribute Details

#osr ⇒ Telnyx::Resources::Messaging10dlc::Campaign::Osr (readonly)

Campaign operations

Returns:



14
15
16
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 14

def osr
  @osr
end

#usecase ⇒ Telnyx::Resources::Messaging10dlc::Campaign::Usecase (readonly)

Campaign operations

Returns:



10
11
12
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 10

def usecase
  @usecase
end

Instance Method Details

#accept_sharing(campaign_id, request_options: {}) ⇒ Hash{Symbol=>Object}

Manually accept a campaign shared with Telnyx

Parameters:

  • campaign_id (String) —

    TCR’s ID for the campaign to import

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (Hash{Symbol=>Object})

See Also:



128
129
130
131
132
133
134
135
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 128

def accept_sharing(campaign_id, params = {})
  @client.request(
    method: :post,
    path: ["10dlc/campaign/acceptSharing/%1$s", campaign_id],
    model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
    options: params[:request_options]
  )
end

#deactivate(campaign_id, request_options: {}) ⇒ Telnyx::Models::Messaging10dlc::CampaignDeactivateResponse

Terminate a campaign. Note that once deactivated, a campaign cannot be restored.

Parameters:

  • campaign_id (String) —

    Unique identifier of the campaign.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



148
149
150
151
152
153
154
155
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 148

def deactivate(campaign_id, params = {})
  @client.request(
    method: :delete,
    path: ["10dlc/campaign/%1$s", campaign_id],
    model: Telnyx::Models::Messaging10dlc::CampaignDeactivateResponse,
    options: params[:request_options]
  )
end

#get_mno_metadata(campaign_id, request_options: {}) ⇒ Telnyx::Models::Messaging10dlc::CampaignGetMnoMetadataResponse

Get the campaign metadata for each MNO it was submitted to.

Parameters:

  • campaign_id (String) —

    ID of the campaign in question

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



168
169
170
171
172
173
174
175
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 168

def get_mno_metadata(campaign_id, params = {})
  @client.request(
    method: :get,
    path: ["10dlc/campaign/%1$s/mnoMetadata", campaign_id],
    model: Telnyx::Models::Messaging10dlc::CampaignGetMnoMetadataResponse,
    options: params[:request_options]
  )
end

#get_operation_status(campaign_id, request_options: {}) ⇒ Hash{Symbol=>Object}

Retrieve campaign’s operation status at MNO level.

Parameters:

  • campaign_id (String) —

    Unique identifier of the campaign.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (Hash{Symbol=>Object})

See Also:



188
189
190
191
192
193
194
195
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 188

def get_operation_status(campaign_id, params = {})
  @client.request(
    method: :get,
    path: ["10dlc/campaign/%1$s/operationStatus", campaign_id],
    model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
    options: params[:request_options]
  )
end

#get_sharing_status(campaign_id, request_options: {}) ⇒ Telnyx::Models::Messaging10dlc::CampaignGetSharingStatusResponse

Get Sharing Status

Parameters:

  • campaign_id (String) —

    ID of the campaign in question

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



208
209
210
211
212
213
214
215
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 208

def get_sharing_status(campaign_id, params = {})
  @client.request(
    method: :get,
    path: ["10dlc/campaign/%1$s/sharing", campaign_id],
    model: Telnyx::Models::Messaging10dlc::CampaignGetSharingStatusResponse,
    options: params[:request_options]
  )
end

#list(brand_id:, page: nil, records_per_page: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::PerPagePaginationV2<Telnyx::Models::Messaging10dlc::CampaignListResponse>

Some parameter documentations has been truncated, see Models::Messaging10dlc::CampaignListParams for more details.

Retrieve a list of campaigns associated with a supplied ‘brandId`.

Parameters:

  • brand_id (String) —

    Filter results by brand id.

  • page (Integer) —

    The 1-indexed page number to get. The default value is ‘1`.

  • records_per_page (Integer) —

    The amount of records per page, limited to between 1 and 500 inclusive. The defa

  • sort (Symbol, Telnyx::Models::Messaging10dlc::CampaignListParams::Sort) —

    Specifies the sort order for results. If not given, results are sorted by create

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 104

def list(params)
  parsed, options = Telnyx::Messaging10dlc::CampaignListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "10dlc/campaign",
    query: query.transform_keys(brand_id: "brandId", records_per_page: "recordsPerPage"),
    page: Telnyx::Internal::PerPagePaginationV2,
    model: Telnyx::Models::Messaging10dlc::CampaignListResponse,
    options: options
  )
end

#retrieve(campaign_id, request_options: {}) ⇒ Telnyx::Models::Messaging10dlc::TelnyxCampaignCsp

Retrieve campaign details by ‘campaignId`.

Parameters:

  • campaign_id (String) —

    Unique identifier of the campaign.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



27
28
29
30
31
32
33
34
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 27

def retrieve(campaign_id, params = {})
  @client.request(
    method: :get,
    path: ["10dlc/campaign/%1$s", campaign_id],
    model: Telnyx::Messaging10dlc::TelnyxCampaignCsp,
    options: params[:request_options]
  )
end

#submit_appeal(campaign_id, appeal_reason:, request_options: {}) ⇒ Telnyx::Models::Messaging10dlc::CampaignSubmitAppealResponse

Some parameter documentations has been truncated, see Models::Messaging10dlc::CampaignSubmitAppealParams for more details.

Submits an appeal for rejected native campaigns in TELNYX_FAILED or MNO_REJECTED status. The appeal is recorded for manual compliance team review and the campaign status is reset to TCR_ACCEPTED. Note: Appeal forwarding is handled manually to allow proper review before incurring upstream charges.

Parameters:

  • campaign_id (String) —

    The Telnyx campaign identifier

  • appeal_reason (String) —

    Detailed explanation of why the campaign should be reconsidered and what changes

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 236

def submit_appeal(campaign_id, params)
  parsed, options = Telnyx::Messaging10dlc::CampaignSubmitAppealParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["10dlc/campaign/%1$s/appeal", campaign_id],
    body: parsed,
    model: Telnyx::Models::Messaging10dlc::CampaignSubmitAppealResponse,
    options: options
  )
end

#update(campaign_id, auto_renewal: nil, help_message: nil, message_flow: nil, reseller_id: nil, sample1: nil, sample2: nil, sample3: nil, sample4: nil, sample5: nil, webhook_failover_url: nil, webhook_url: nil, request_options: {}) ⇒ Telnyx::Models::Messaging10dlc::TelnyxCampaignCsp

Some parameter documentations has been truncated, see Models::Messaging10dlc::CampaignUpdateParams for more details.

Update a campaign’s properties by ‘campaignId`. **Please note:** only sample messages are editable.

Parameters:

  • campaign_id (String) —

    Unique identifier of the campaign.

  • auto_renewal (Boolean) —

    Help message of the campaign.

  • help_message (String) —

    Help message of the campaign.

  • message_flow (String) —

    Message flow description.

  • reseller_id (String) —

    Alphanumeric identifier of the reseller that you want to associate with this cam

  • sample1 (String) —

    Message sample. Some campaign tiers require 1 or more message samples.

  • sample2 (String) —

    Message sample. Some campaign tiers require 2 or more message samples.

  • sample3 (String) —

    Message sample. Some campaign tiers require 3 or more message samples.

  • sample4 (String) —

    Message sample. Some campaign tiers require 4 or more message samples.

  • sample5 (String) —

    Message sample. Some campaign tiers require 5 or more message samples.

  • webhook_failover_url (String) —

    Webhook failover to which campaign status updates are sent.

  • webhook_url (String) —

    Webhook to which campaign status updates are sent.

  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/telnyx/resources/messaging_10dlc/campaign.rb', line 73

def update(campaign_id, params = {})
  parsed, options = Telnyx::Messaging10dlc::CampaignUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["10dlc/campaign/%1$s", campaign_id],
    body: parsed,
    model: Telnyx::Messaging10dlc::TelnyxCampaignCsp,
    options: options
  )
end