RELAY RESTCampaign Registry

Retrieve a Campaign

View as Markdown

Retrieves the details of a campaign.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the campaign.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the campaign.
namestring or null
A name for the campaign.
statestring or null
The current state of the campaign.
sms_use_casestring or null
An SMS Use Case category for the campaign (2FA, ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY, CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT, HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED, MARKETING, MIXED, POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PROXY, PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE, TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
sub_use_caseslist of strings or null

A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING, PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA, ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT).

campaign_verify_tokenstring or null

Campaign Verify token. Required if sms use case is POLITICAL_SECTION_527.

descriptionstring or null
A description for the campaign. Please use at least 40 characters.
sample1string or null

Sample message template/content. At least two samples are required and up to five can be provided. Please use at least 20 characters.

sample2string or null
Sample 2.
sample3string or null
Sample 3.
sample4string or null
Sample 4.
sample5string or null
Sample 5.
dynamic_templatesstring or null
If your messaging content will be modified in any way beyond what you shared in your templates, please describe the nature of how the content will change.
message_flowstring or null

Please describe the call to action/message flow your intended recipients will experience.

opt_in_messagestring or null
Please share the message subscribers receive when they opt in.
opt_out_messagestring or null
Please share the message subscribers receive when they opt out.
help_messagestring or null
Please share the message subscribers receive when they request help.
opt_in_keywordsstring or nullDefaults to START
Opt in keywords that subscribers can use.
opt_out_keywordsstring or nullDefaults to STOP
Opt out keywords that subscribers can use.
help_keywordsstring or nullDefaults to HELP
Help keywords that subscribers can use.
number_pooling_requiredboolean or null
Will 50 or more numbers be used with this single campaign? If so, please enter true.
number_pooling_per_campaignstring or null
If you will be using number pooling, please provide an explanation as to why it is needed.
direct_lendingboolean or null
Will this campaign include content related to direct lending or other loan agreements?
embedded_phoneboolean or null

Are you using an embedded phone number (except the required HELP information contact phone number)?

age_gated_contentboolean or null
Will this campaign include any age gated content as defined by carrier and CTA guidelines?
lead_generationboolean or null
Is there any intent of this campaign to generate leads?
csp_campaign_referencestring or null

If you are your own Campaign Service Provider, what is the approved Campaign ID? (Mandatory for CSPs, otherwise please omit)

status_callback_urlstring or null

Optional: Specify a URL to receive webhook notifications when your campaign’s state changes. See the 10DLC status callback docs for the webhook payload.

created_atdatetime or null
Timestamp when the campaign was created.
updated_atdatetime or null
Timestamp when the campaign was last updated.

Errors