| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
Methods for Brand/Campaign Creation
CreateSMSCustomer
This method will create a new customer (brand) for 10DLC SMS registration.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
customer | SMSCustomer | Customer information |
CreateSMSCampaign
This method will create a new 10DLC SMS Campaign/Use-Case.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
customerId | String | The DID(s) to remove |
description | String | Campaign Description |
displayName | String | Campaign display name |
vertical | String | Industry of campaign type |
messageFlow | String | Opt-in summary |
sampleMsg1 | String | Sample message 1 |
sampleMsg2 | String | Sample message 2 |
subOptIn | boolean | Subscriber Opt-In |
subOptOut | boolean | Subscriber Opt-out |
subHelp | boolean | Subscriber Help |
numPooling | boolean | Number Pooling |
directLending | boolean | Direct Lending |
embeddedLink | boolean | Embedded Link |
embeddedPhone | boolean | Embedded Phone Number |
affMarketing | boolean | Affiliate Marketing |
ageGated | boolean | Age-gated Content |
usecaseId | String | Use case ID |
subUsecaseIds | String | Sub-use case ID |
AssignToSMSCampaign
This method will assign one or more DIDs to a registered 10DLC SMS campaign.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tns | String | The DID(s) to assign |
campaignId | String | The 10DLC SMS campaignID |
Methods for Auditing
GetSMSCustomers
This method will display a list of all registered customers for 10DLC SMS.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
GetSMSCampaigns
This method will display a list of all registered campaigns for 10DLC SMS.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
Methods for Brand/Campaign Removal
RemoveFromSMSCampaign
This method will remove one or more DIDs from a registered 10DLC SMS campaign.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
tns | String | The DID(s) to remove |
DeleteSMSCampaign
This method will remove an existing 10DLC SMS campaign.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
campaignId | String | Campaign ID |
DeleteSMSCustomer
This method will delete an existing customer (brand) for 10DLC SMS registration.
Parameters:
Name | Type | Description |
login | String | Your API username |
secret | String | Your API user password |
customerId | String | Customer ID |