WAwavix
10DLC

Register a 10DLC Campaign

Changed on

Registers a 10DLC Campaign under the 10DLC Brand identified by brand_id. The Brand must have a verified identity status.

post/v3/10dlc/brands/{brand_id}/campaigns

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/10dlc/brands/{brand_id}/campaigns
  • Auth
    HTTP bearer

Path parameters

brand_idstring required
Example:BM20QP9

The unique ID of the 10DLC Brand.

Request body

affiliate_marketingboolean required

Indicates whether the Campaign is used for affiliate marketing.

age_gatedboolean required

Indicates whether the Campaign messages contain age-gated content.

auto_renewalboolean required

Indicates whether the Campaign is automatically renewed at the end of each billing period.

direct_lendingboolean required

Indicates whether the Campaign messages contain direct lending content.

embedded_linksboolean required

Indicates whether the Campaign messages contain embedded links.

embedded_phonesboolean nullable

Indicates whether the Campaign messages contain embedded phone numbers.

embedded_link_samplestring nullable

Sample of an embedded link used in Campaign messages.

descriptionstring required

Description of the Campaign and its messaging purpose.

optin_workflowstring required

Description of the workflow through which subscribers opt in to the Campaign.

helpboolean required

Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword such as HELP or INFO.

help_keywordsstring required

Comma-separated list of help keywords. Keywords are case-insensitive.

help_messagestring required

Acknowledgement sent when a subscriber texts a help keyword.

optinboolean required

Indicates whether the Campaign requires subscribers to opt in before receiving messages.

optin_keywordsstring required

Comma-separated list of opt-in keywords. Keywords are case-insensitive.

optin_messagestring required

Acknowledgement sent when a subscriber texts an opt-in keyword.

optoutboolean required

Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword such as STOP or QUIT.

optout_keywordsstring required

Comma-separated list of opt-out keywords. Keywords are case-insensitive.

optout_messagestring required

Acknowledgement sent when a subscriber texts an opt-out keyword.

namestring required

Display name of the Campaign.

sample1string required

Sample message demonstrating the content sent through the Campaign.

sample2string nullable

Sample message demonstrating the content sent through the Campaign.

sample3string nullable

Sample message demonstrating the content sent through the Campaign.

sample4string nullable

Sample message demonstrating the content sent through the Campaign.

sample5string nullable

Sample message demonstrating the content sent through the Campaign.

mockboolean required

Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.

usecasestring required

Registered use case for the Campaign, such as 2FA or MARKETING.

privacy_policystring

URL of the Campaign privacy policy.

terms_conditionsstring required

URL of the Campaign terms and conditions.

Example request

{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "description": "Our campaign aims to …",
  "direct_lending": false,
  "embedded_link_sample": "https://site.com/verify",
  "embedded_links": false,
  "embedded_phones": false,
  "help": true,
  "help_keywords": "help",
  "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
  "mock": false,
  "name": "My first campaign",
  "optin": true,
  "optin_keywords": "begin,start",
  "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
  "optin_workflow": "Our SMS ...",
  "optout": true,
  "optout_keywords": "stop,quit,unsubscribe",
  "optout_message": "You are now opted out and will receive no further messages",
  "privacy_policy": "https://site.com/privacy-policy",
  "sample1": "Your verification code is XXXXXX",
  "sample2": "XXXX is your verification code",
  "sample3": "Your code is XXXXXX, valid for 10 minutes",
  "sample4": "Use code XXXXXX to confirm your login",
  "sample5": "XXXXXX is your one-time passcode",
  "terms_conditions": "https://site.com/terms-and-conditions",
  "usecase": "2FA"
}

Response

Returns the registered 10DLC Campaign.

affiliate_marketingboolean required

Indicates whether the Campaign is used for affiliate marketing.

age_gatedboolean required

Indicates whether the Campaign messages contain age-gated content.

auto_renewalboolean required

Indicates whether the Campaign should be automatically renewed.

last_bill_datestring nullable required

Date and time the Campaign was last billed in ISO 8601 format. null if the Campaign has never been billed.

next_bill_datestring nullable required

Date and time the Campaign will be billed next in ISO 8601 format. null if the next billing date is not scheduled.

direct_lendingboolean required

Indicates whether the Campaign messages contain direct lending content.

embedded_linksboolean required

Indicates whether the Campaign messages contain embedded links.

embedded_phonesboolean required

Indicates whether the Campaign messages contain embedded phone numbers.

embedded_link_samplestring nullable required

Sample of an embedded link used in Campaign messages.

brand_idstring required

Unique identifier of the Brand that owns the Campaign.

campaign_idstring required

Unique identifier of the Campaign assigned by the registry.

descriptionstring nullable required

Description of the Campaign and its messaging purpose.

optin_workflowstring nullable required

Description of the workflow through which subscribers opt in to the Campaign.

feedbackstring nullable required

Feedback from the registry explaining the current status.

helpboolean required

Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).

help_keywordsstring required

Comma-separated list of help keywords. Keywords are case-insensitive.

help_messagestring nullable required

Help message sent upon receiving a help keyword.

optinboolean required

Indicates whether the Campaign requires subscriber opt-in.

optin_keywordsstring required

Comma-separated list of opt-in keywords. Keywords are case-insensitive.

optin_messagestring nullable required

Opt-in message sent upon receiving an opt-in keyword.

optoutboolean required

Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).

optout_keywordsstring required

Comma-separated list of opt-out keywords. Keywords are case-insensitive.

optout_messagestring nullable required

Opt-out message sent upon receiving an opt-out keyword.

namestring required

Display name of the Campaign.

created_atstring required

Timestamp when the Campaign was created, in ISO 8601 format.

sample1string nullable required

Sample message demonstrating the content sent through the Campaign.

sample2string nullable required

Sample message demonstrating the content sent through the Campaign.

sample3string nullable required

Sample message demonstrating the content sent through the Campaign.

sample4string nullable required

Sample message demonstrating the content sent through the Campaign.

sample5string nullable required

Sample message demonstrating the content sent through the Campaign.

updated_atstring required

Timestamp when the Campaign was last updated, in ISO 8601 format.

mockboolean required

Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.

usecasestring required

Registered use case for the Campaign, such as 2FA or MARKETING.

monthly_feestring required

Recurring monthly fee charged for the Campaign, as a decimal string.

privacy_policystring nullable required

Privacy policy URL.

terms_conditionsstring nullable required

Terms and conditions URL.

statusstring required

Current registration status of the Campaign, such as APPROVED or PENDING.

phone_numbersstring[] required

Phone numbers assigned to the Campaign, in E.164 format.

Example response

{
  "affiliate_marketing": false,
  "age_gated": false,
  "auto_renewal": false,
  "brand_id": "BM20QP9",
  "campaign_id": "CKLCK95",
  "created_at": "2024-08-14T11:57:41",
  "description": "Our campaign aims to …",
  "direct_lending": false,
  "embedded_link_sample": null,
  "embedded_links": false,
  "embedded_phones": false,
  "feedback": null,
  "help": true,
  "help_keywords": "help",
  "help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
  "last_bill_date": "2024-08-14T11:57:42",
  "mock": false,
  "monthly_fee": "10.0",
  "name": "My first campaign",
  "next_bill_date": "2024-11-14T00:00:00",
  "optin": true,
  "optin_keywords": "begin,start",
  "optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
  "optin_workflow": "Our SMS ...",
  "optout": true,
  "optout_keywords": "stop,quit,unsubscribe",
  "optout_message": "You are now opted out and will receive no further messages",
  "privacy_policy": "https://site.com/privacy-policy",
  "sample1": "Your verification code is XXXXXX",
  "sample2": "XXXX is your verification code",
  "sample3": null,
  "sample4": null,
  "sample5": null,
  "status": "APPROVED",
  "terms_conditions": "https://site.com/terms-and-conditions",
  "updated_at": "2024-08-14T11:57:47",
  "usecase": "2FA",
  "phone_numbers": [
    "14358684439",
    "13193337776",
    "12673296046"
  ]
}

Changes

  • 6a89c962481cRevision changes
    • breaking

      added the pattern ^B[A-Z0-9]{6}$ to the path request parameter brand_id

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 33be77905120Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API