Sign in

v1

latestSwagger 2.02026-07-17101735.8 KB
TollFreeVerification - CampaignBrief

Get a Campaign Brief by id.

get/tollfreeVerification/countries/{countryCode}/campaignBriefs/{campaignBriefId}

Path parameters

countryCodestring required

Country Code Id. Must be a valid country code

campaignBriefIdstring uuid required

Campaign Brief Id. Must be a valid GUID

Query parameters

api-versionstring required

Version of API to invoke

Response

Success

idstring uuid required

Campaign Brief Id.

status'submitted' | 'approved' | 'updateRequested' | 'draft' | 'cancelled' | 'denied'

Campaign Brief status e.g. 'submitted', 'approved', etc

submissionDatestring date-time

Date and time when the Campaign Brief was submitted.

statusUpdatedDatestring date-time

Last date and time when the Campaign Brief status was updated.

countryCodestring

Country code of the Campaign Brief

phoneNumbersstring[]

List of numbers provisioned for the Campaign e.g. 18881234567

estimatedMonthlyVolume'V10' | 'V100' | 'V1000' | 'V10000' | 'V100000' | 'V250000' | 'V500000' | 'V750000' | 'V1000000' | 'V5000000' | 'V10000000OrMore'

Estimated total messages per month.

additionalInformationstring

Campaign opt in additional information - image URLs or opt in description.

multipleNumbersJustificationstring
dbastring

Doing Business As (DBA). Must be filled if the company name used to contact customers differs from the legal entity name.

privacyPolicyUrlstring

URL to the privacy policy for the campaign.

termsAndConditionsUrlstring

URL to the terms and conditions for the campaign.

All 10 operations