Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Commit

Permalink
Removing spaces between keywords and adding a note
Browse files Browse the repository at this point in the history
  • Loading branch information
@nirmitpatel
nirmitpatel committed Nov 8, 2022
1 parent 6010fd3 commit 79a7422
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions site/docs/messaging/campaign-management/csp/campaign-api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,11 @@ HTTP/1.1 429 Too Many Requests
| `Sample5` | No (Required for some usecases) | Message sample. Some campaign tiers require 5 message samples. Min length 20. Max length 1024 |
| `MessageFlow` | Yes | Message flow description. Min length 40. Max length 2048 |
| `HelpMessage` | Yes | Help message of the campaign. Min length 20. Max length 320 |
| `HelpKeywords` | No | Help keywords of the campaign. Max length 320. TCR will default the value to HELP |
| `HelpKeywords` | No | Help keywords of the campaign. Max length 320. TCR will default the value to HELP. Multiple keywords are comma separated without space. |
| `OptinMessage` | No | Opt-In message of the campaign. Min length 20. Max length 320 |
| `OptinKeywords` | No | Opt-In keywords of the campaign. Max length 320. |
| `OptinKeywords` | No | Opt-In keywords of the campaign. Max length 320. Multiple keywords are comma separated without space. |
| `OptoutMessage` | Yes | Opt-Out message of the campaign. Min length 20. Max length 320 |
| `OptoutKeywords` | No | Opt-Out keywords of the campaign. Max length 320. TCR will default the value to STOP |
| `OptoutKeywords` | No | Opt-Out keywords of the campaign. Max length 320. TCR will default the value to STOP. Multiple keywords are comma separated without space. |
| `AffiliateMarketing` | No | Is affiliate marketing being used (or was used in the creation of the campaign)? Default false |
| `ReferenceId` | No | Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. Max length 50 |
| `AutoRenewal` | Yes | Campaign subscription auto-renewal status. Default true |
Expand Down Expand Up @@ -148,9 +148,9 @@ Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
</Campaign>
```
Expand Down Expand Up @@ -186,9 +186,9 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
<MnoMetadataList>
<MnoMetadata>
Expand Down Expand Up @@ -278,11 +278,11 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
| `SubscriberHelp` | No | No | Have you implemented a response to the HELP keyword informing customers of how they can contact the message sender? Default false |
| `AffiliateMarketing` | No | No | Is affiliate marketing being used (or was used in the creation of the campaign)? Default false |
| `ReferenceId` | No | No | Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. Max length 50 |
| `HelpKeywords` | No | Yes | Help keywords of the campaign. Max length 320. TCR will default the value to HELP |
| `HelpKeywords` | No | Yes | Help keywords of the campaign. Max length 320. TCR will default the value to HELP. Multiple keywords are comma separated without space. |
| `OptinMessage` | No | Yes | Opt-In message of the campaign. Min length 20. Max length 320 |
| `OptinKeywords` | No | Yes | Opt-In keywords of the campaign. Max length 320. |
| `OptinKeywords` | No | Yes | Opt-In keywords of the campaign. Max length 320. Multiple keywords are comma separated without space. |
| `OptoutMessage` | Yes | Yes | Opt-Out message of the campaign. Min length 20. Max length 320 |
| `OptoutKeywords` | No | Yes | Opt-Out keywords of the campaign. Max length 320. TCR will default the value to STOP |
| `OptoutKeywords` | No | Yes | Opt-Out keywords of the campaign. Max length 320. TCR will default the value to STOP. Multiple keywords are comma separated without space. |

### Examples

Expand Down Expand Up @@ -333,9 +333,9 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
</Campaign>
</CampaignResponse>
Expand Down Expand Up @@ -413,9 +413,9 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
<MnoMetadataList>
<MnoMetadata>
Expand Down Expand Up @@ -534,9 +534,9 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
<MnoStatusList>
<MnoStatus>
Expand Down Expand Up @@ -668,9 +668,9 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
<MnoStatusList>
<MnoStatus>
Expand Down Expand Up @@ -711,9 +711,9 @@ Location: https://dashboard.bandwidth.com/api/accounts/{accountId}/campaignManag
<MessageFlow>This is a sample Message Flow of my campaign.</MessageFlow>
<HelpKeywords>HELP</HelpKeywords>
<HelpMessage>This is a sample Help Message of my campaign.</HelpMessage>
<OptinKeywords>START, YES</OptinKeywords>
<OptinKeywords>START,YES</OptinKeywords>
<OptinMessage>This is a sample Opt-In Message of my campaign.</OptinMessage>
<OptoutKeywords>STOP, NO</OptoutKeywords>
<OptoutKeywords>STOP,NO</OptoutKeywords>
<OptoutMessage>This is a sample Opt-Out Message of my campaign.</OptoutMessage>
<MnoStatusList>
<MnoStatus>
Expand Down

0 comments on commit 79a7422

Please sign in to comment.