|
| 1 | +# SMSTenDLCCampaign |
| 2 | + |
| 3 | +## Properties |
| 4 | +Name | Type | Description | Notes |
| 5 | +------------ | ------------- | ------------- | ------------- |
| 6 | +**campaign_id** | **str** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. | |
| 7 | +**csp_id** | **str** | Alphanumeric identifier of the CSP associated with this campaign. | |
| 8 | +**brand_id** | **str** | Alphanumeric identifier of the brand associated with this campaign. | |
| 9 | +**usecase** | **str** | Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. | |
| 10 | +**sub_usecases** | **[str]** | Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases | |
| 11 | +**description** | **str** | Summary description of this campaign. | |
| 12 | +**mock** | **bool** | Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. | |
| 13 | +**account_id** | **str, none_type** | ID of the account that created this Queue. | [optional] |
| 14 | +**reseller_id** | **str, none_type** | Alphanumeric identifier of the reseller that you want to associate with this campaign. | [optional] |
| 15 | +**status** | **str** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. | [optional] |
| 16 | +**create_date** | **datetime** | Unix timestamp when campaign was created. | [optional] |
| 17 | +**auto_renewal** | **bool** | Campaign subscription auto-renewal status. | [optional] |
| 18 | +**billed_date** | **datetime, none_type** | Campaign recent billed date. | [optional] |
| 19 | +**embedded_link** | **bool** | Does message generated by the campaign include URL link in SMS? | [optional] if omitted the server will use the default value of False |
| 20 | +**embedded_phone** | **bool** | Does message generated by the campaign include phone number in SMS? | [optional] if omitted the server will use the default value of False |
| 21 | +**affiliate_marketing** | **bool** | Does message content controlled by affiliate marketing other than the brand? | [optional] |
| 22 | +**number_pool** | **bool** | Does campaign utilize pool of phone nubers? | [optional] if omitted the server will use the default value of False |
| 23 | +**age_gated** | **bool** | Age gated content in campaign. | [optional] |
| 24 | +**direct_lending** | **bool** | | [optional] |
| 25 | +**subscriber_optin** | **bool** | Does campaign require subscriber to opt-in before SMS is sent to subscriber? | [optional] if omitted the server will use the default value of False |
| 26 | +**subscriber_optout** | **bool** | Does campaign support subscriber opt-out keyword(s)? | [optional] if omitted the server will use the default value of False |
| 27 | +**subscriber_help** | **bool** | Does campaign responds to help keyword(s)? | [optional] if omitted the server will use the default value of False |
| 28 | +**sample1** | **str** | Message sample. Some campaign tiers require 1 or more message samples. | [optional] |
| 29 | +**sample2** | **str, none_type** | Message sample. Some campaign tiers require 2 or more message samples. | [optional] |
| 30 | +**sample3** | **str, none_type** | Message sample. Some campaign tiers require 3 or more message samples. | [optional] |
| 31 | +**sample4** | **str, none_type** | Message sample. Some campaign tiers require 4 or more message samples. | [optional] |
| 32 | +**sample5** | **str, none_type** | Message sample. Some campaign tiers require 5 or more message samples. | [optional] |
| 33 | +**message_flow** | **str, none_type** | Message flow description. | [optional] |
| 34 | +**help_message** | **str, none_type** | Help message of the campaign. | [optional] |
| 35 | +**reference_id** | **str, none_type** | Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. | [optional] |
| 36 | +**next_renewal_or_expiration_date** | **date, none_type** | When the campaign would be due for its next renew/bill date. | [optional] |
| 37 | + |
| 38 | +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
| 39 | + |
| 40 | + |
0 commit comments