INinfobip
platform
numbers
number-registration
campaigns

Create Toll Free Campaign

Creates a toll free campaign within the Infobip platform.

post/number-registration/1/campaigns/toll-free

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

idstring uuid

The identifier for the campaign.

referenceIdstring

Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.

applicationIdstring

CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.

entityIdstring

CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.

namestring required

The name of the campaign.

createdDatestring date-time

The date and time when the campaign was created.

lastModifiedDatestring date-time

The date and time when the campaign was last modified.

stage'DRAFT' | 'SUBMITTED_FOR_REVIEW' | 'IN_REVIEW' | 'UPDATE_REQUESTED_BY_INTERNAL_REVIEWER' | 'APPROVED_BY_INTERNAL_REVIEWER' | 'SUBMITTED' | 'REJECTED_EXTERNALLY' | 'REGISTERED' | 'REJECTED' | 'ON_HOLD' | 'DEREGISTERED' | 'REGISTERED_PENDING_UPDATE' | 'REGISTERED_PENDING_DEREGISTRATION' | 'ARCHIVED' | 'BLOCKED' | 'SUSPENDED' | 'APPEALED' | 'IN_MIGRATION' | 'PAUSED'
type'TOLL_FREE_UNIFIED_NUMBER'
privacyPolicyUrlstring

Public URL to the privacy policy that outlines how user data is collected, stored, and used.

termsAndConditionsUrlstring

URL where the terms and conditions of the campaign are located.

messageVolume'TEN' | 'HUNDRED' | 'THOUSAND' | 'TEN_THOUSAND' | 'HUNDRED_THOUSAND' | 'TWO_HUNDRED_FIFTY_THOUSAND' | 'FIVE_HUNDRED_THOUSAND' | 'SEVEN_HUNDRED_FIFTY_THOUSAND' | 'ONE_MILLION' | 'FIVE_MILLION' | 'TEN_MILLION_PLUS' required
numbersstring[]

US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.

numberKeysstring[]

The numberKey(s) of the numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.

useCase'TWO_FA' | 'APP_NOTIFICATIONS' | 'APPOINTMENTS' | 'AUCTIONS' | 'AUTO_DEALERSHIP_SERVICES' | 'BANKING' | 'BILLING' | 'BOOKING_CONFIRMATIONS' | 'BUSINESS_UPDATES' | 'COVID_19_ALERTS' | 'CAREER_TRAINING' | 'CHATBOT' | 'CONVERSATIONAL_ALERTS' | 'COURIER_SERVICES_DELIVERIES' | 'EDUCATIONAL' | 'EMERGENCY_ALERTS' | 'EMPLOYEE_ALERTS_NOTIFICATIONS' | 'EVENTS_PLANNING' | 'FINANCIAL_SERVICES' | 'FRAUD_ALERTS' | 'FUNDRAISING' | 'GENERAL_MARKETING' | 'HR_STAFFING' | 'HEALTHCARE' | 'HOUSING_COMMUNITY_UPDATES' | 'INSURANCE_SERVICES' | 'JOB_ALERTS' | 'LEGAL_SERVICES' | 'MIXED' | 'MOTIVATIONAL_REMINDERS' | 'NOTARY_NOTIFICATIONS' | 'NOTIFICATIONS' | 'ORDER_NOTIFICATIONS' | 'POLITICAL' | 'PUBLIC_WORKS' | 'REAL_ESTATE_SERVICES' | 'RECEIPT_NOTIFICATIONS' | 'RELIGIOUS_SERVICES' | 'REPAIR_DIAGNOSTICS_ALERTS' | 'REWARDS_PROGRAM' | 'SURVEYS' | 'SYSTEM_ALERTS' | 'WAITLIST_ALERTS' | 'WEBINAR_REMINDERS' | 'WORKSHOP_ALERTS' required

Campaign use case.

programSummarystring required

A brief description of the purpose of the campaign.

exampleMessagestring required

The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.

optInImageURLsstring[] required

List of URLs linking to screenshots that show how end-users opt in to receive messages.

additionalInformationstring

Free-form field for any extra details relevant to the campaign—such as custom use cases or compliance clarification.

countryCodestring

The country where the brand is located.

supportPhonestring required

The business phone number to contact about brand compliance issues.

supportEmailstring required

The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character.

businessContactFirstNamestring required

First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.

businessContactLastNamestring required

Last name of the primary contact person for the brand or business entity.

legalNamestring required

The legal name of the brand.

businessDBAstring

'Doing Business As' name if different from the legal business name.

businessNamestring

The customer defined name of brand or business entity.

businessWebsitestring required

The website for the brand or business entity.

customerCareEmailstring email

The email address the user may contact to get customer care. Must be a well formed email address that does not include a '=' character.

taxIdstring

The tax identifier for the brand. Not required for sole proprietor brands.

taxIdIssuingCountrystring

The country where tax identifier is issued. If not specified, the value from countryCode will be used.

legalEntityType'PRIVATE_COMPANY' | 'PUBLIC_COMPANY' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' required

Legal entity type of the business.

businessRegistrationType'EIN' | 'CBN' | 'NEQ' | 'PROVINCIAL_NUMBER' | 'CRN' | 'VAT' | 'ACN' | 'ABN' | 'BRN' | 'SIREN' | 'SIRET' | 'NZBN' | 'UST_IDNR' | 'CIF' | 'NIF' | 'CNPJ' | 'UID' | 'OTHER'

Type of tax identification number provided. Value depend on selected taxId issuing country. For US it can be only EIN. Not required for sole proprietor brands.

campaignVerifyTokenstring

Campaign Verify token for POLITICAL campaigns.

priorityIdstring uuid

Priority information used in latest campaign review.

Response

Created

idstring uuid

The identifier for the campaign.

referenceIdstring

Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.

applicationIdstring

CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.

entityIdstring

CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.

namestring required

The name of the campaign.

createdDatestring date-time

The date and time when the campaign was created.

lastModifiedDatestring date-time

The date and time when the campaign was last modified.

stage'DRAFT' | 'SUBMITTED_FOR_REVIEW' | 'IN_REVIEW' | 'UPDATE_REQUESTED_BY_INTERNAL_REVIEWER' | 'APPROVED_BY_INTERNAL_REVIEWER' | 'SUBMITTED' | 'REJECTED_EXTERNALLY' | 'REGISTERED' | 'REJECTED' | 'ON_HOLD' | 'DEREGISTERED' | 'REGISTERED_PENDING_UPDATE' | 'REGISTERED_PENDING_DEREGISTRATION' | 'ARCHIVED' | 'BLOCKED' | 'SUSPENDED' | 'APPEALED' | 'IN_MIGRATION' | 'PAUSED'
type'TOLL_FREE_UNIFIED_NUMBER'
privacyPolicyUrlstring

Public URL to the privacy policy that outlines how user data is collected, stored, and used.

termsAndConditionsUrlstring

URL where the terms and conditions of the campaign are located.

messageVolume'TEN' | 'HUNDRED' | 'THOUSAND' | 'TEN_THOUSAND' | 'HUNDRED_THOUSAND' | 'TWO_HUNDRED_FIFTY_THOUSAND' | 'FIVE_HUNDRED_THOUSAND' | 'SEVEN_HUNDRED_FIFTY_THOUSAND' | 'ONE_MILLION' | 'FIVE_MILLION' | 'TEN_MILLION_PLUS' required
numbersstring[]

US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.

numberKeysstring[]

The numberKey(s) of the numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.

useCase'TWO_FA' | 'APP_NOTIFICATIONS' | 'APPOINTMENTS' | 'AUCTIONS' | 'AUTO_DEALERSHIP_SERVICES' | 'BANKING' | 'BILLING' | 'BOOKING_CONFIRMATIONS' | 'BUSINESS_UPDATES' | 'COVID_19_ALERTS' | 'CAREER_TRAINING' | 'CHATBOT' | 'CONVERSATIONAL_ALERTS' | 'COURIER_SERVICES_DELIVERIES' | 'EDUCATIONAL' | 'EMERGENCY_ALERTS' | 'EMPLOYEE_ALERTS_NOTIFICATIONS' | 'EVENTS_PLANNING' | 'FINANCIAL_SERVICES' | 'FRAUD_ALERTS' | 'FUNDRAISING' | 'GENERAL_MARKETING' | 'HR_STAFFING' | 'HEALTHCARE' | 'HOUSING_COMMUNITY_UPDATES' | 'INSURANCE_SERVICES' | 'JOB_ALERTS' | 'LEGAL_SERVICES' | 'MIXED' | 'MOTIVATIONAL_REMINDERS' | 'NOTARY_NOTIFICATIONS' | 'NOTIFICATIONS' | 'ORDER_NOTIFICATIONS' | 'POLITICAL' | 'PUBLIC_WORKS' | 'REAL_ESTATE_SERVICES' | 'RECEIPT_NOTIFICATIONS' | 'RELIGIOUS_SERVICES' | 'REPAIR_DIAGNOSTICS_ALERTS' | 'REWARDS_PROGRAM' | 'SURVEYS' | 'SYSTEM_ALERTS' | 'WAITLIST_ALERTS' | 'WEBINAR_REMINDERS' | 'WORKSHOP_ALERTS' required

Campaign use case.

programSummarystring required

A brief description of the purpose of the campaign.

exampleMessagestring required

The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.

optInImageURLsstring[] required

List of URLs linking to screenshots that show how end-users opt in to receive messages.

additionalInformationstring

Free-form field for any extra details relevant to the campaign—such as custom use cases or compliance clarification.

countryCodestring

The country where the brand is located.

supportPhonestring required

The business phone number to contact about brand compliance issues.

supportEmailstring required

The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character.

businessContactFirstNamestring required

First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.

businessContactLastNamestring required

Last name of the primary contact person for the brand or business entity.

legalNamestring required

The legal name of the brand.

businessDBAstring

'Doing Business As' name if different from the legal business name.

businessNamestring

The customer defined name of brand or business entity.

businessWebsitestring required

The website for the brand or business entity.

customerCareEmailstring email

The email address the user may contact to get customer care. Must be a well formed email address that does not include a '=' character.

taxIdstring

The tax identifier for the brand. Not required for sole proprietor brands.

taxIdIssuingCountrystring

The country where tax identifier is issued. If not specified, the value from countryCode will be used.

legalEntityType'PRIVATE_COMPANY' | 'PUBLIC_COMPANY' | 'NON_PROFIT' | 'GOVERNMENT' | 'SOLE_PROPRIETOR' required

Legal entity type of the business.

businessRegistrationType'EIN' | 'CBN' | 'NEQ' | 'PROVINCIAL_NUMBER' | 'CRN' | 'VAT' | 'ACN' | 'ABN' | 'BRN' | 'SIREN' | 'SIRET' | 'NZBN' | 'UST_IDNR' | 'CIF' | 'NIF' | 'CNPJ' | 'UID' | 'OTHER'

Type of tax identification number provided. Value depend on selected taxId issuing country. For US it can be only EIN. Not required for sole proprietor brands.

campaignVerifyTokenstring

Campaign Verify token for POLITICAL campaigns.

priorityIdstring uuid

Priority information used in latest campaign review.

Changes

No recorded changes to this operation across all 1 revision of this API.