TFN (Toll Free Numbers) Registration API
The Vonage TFN (Toll Free Numbers) Registration API allows you to manage Toll Free Number registrations in the US & Canada.
For more information, visit the Vonage Developer Portal.
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
The content creator, not an ISV or reseller
500Ericsson LMParent company or organization full name.
500101 Crawfords Corner RdStreet number and name.
500HolmdelCity name
500CAState or province. For the United States, use 2-character codes, e.g., ‘CA’ for California.
1021012Zip Code or postal code. For the United States, use a 5-digit ZIP code
USTwo-letter country code following the ISO 3166-2 standard
500https://www.vonage.comProvide a publicly available website link for the company/organization. Must be a valid URL.
500JohnFirst name of business contact.
500SmithLast name of business contact.
500john.smith@vonage.comEmail address must match the company, organization or brand (DBA) name if entered.
50012125551212Phone number of business contact. Must be a valid phone number in E.164 format without the + prefix.
500Vonage Holdings CorpIf applicable, the Brand name ‘Doing Business As (DBA)’.
500https://www.vonage.com/legal/messaging-service-supplementary-terms/Provide Terms link for the company/organization. Must be a valid URL.
500https://www.vonage.com/legal/privacy-policy/Provide a Privacy Policy link for the company/organization. Must be a valid URL.
PRIVATE_PROFITLegal classification for the company/organization.
SOLE_PROPRIETORPRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENTEINEIN- For the US, a Federal Tax ID or Employee Identification Number (EIN) is required.
- For Canada, the Canada Business Number (CBN) is required.
- Sole Proprietorship may apply without an EIN/CBN, but there will be additional checks to validate that the provided information is accurate.
- For other country-specific registration, select the relevant option or Other.
EINCBNCRNNEQPROVINCIAL_NUMBERVATACNABNBRNSIRENSIRETNZBNUST-IDNRCIFNIFCNPJUIDOTHER50012-3456789- For the US, provide the Employee Identification Number (EIN) for the company/organization.
- For Canada, provide the Canada Business Number (CBN) for the company/organization.
- For Sole Proprietorship, you may leave this field blank.
- For country-specific registration types, provide the relevant Tax ID number.
2USRelevant issuing country. Two-letter ISO-2 country code.
10,000Estimated monthly message volume.
101001,00010,000100,000250,000500,000750,0001,000,0005,000,00010,000,000+ISV/Reseller initiating the registration on behalf of the customer.
Note: This is only required for ISV and resellers.
500Reseller ABCIf you are an ISV/Reseller, enter the name of your business.
500john.doe@resellerabc.comVonage will only communicate with this email address for ISV/Reseller submissions. Must be a valid email.
List all toll-free phone numbers to be registered. Add up to 5 TFNs.
111118001234567Must be a valid purchased TFN in E.164 international format without the + prefix. Should always start with prefix 1800, 1888, 1877, 1866, 1855, 1844, or 1833.
149Two numbers are for two sales regions, one number per region to manage and track the business (East and West)This field is required when multiple numbers are included in the registration. Provide a clear reason for each number to get multiple numbers verified for messaging services.
Describes the use case.
PoliticalUse case category that represents your business industry; choose “Mixed” if marketing and alerts.
2FAApp NotificationsAppointmentsAuctionsAuto / Dealership ServicesBankingBillingBooking ConfirmationsBusiness UpdatesCOVID-19 AlertsCareer TrainingChatbotConversational / AlertsCourier Services & DeliveriesEducationalEmergency AlertsEmployee Alerts / NotificationsEvents & PlanningFinancial ServicesFraud AlertsFundraisingGeneral MarketingHR / StaffingHealthcareHousing Community UpdatesInsurance ServicesJob AlertsLegal ServicesMixedMotivational RemindersNotary NotificationsNotificationsOrder NotificationsPoliticalPublic WorksReal Estate ServicesReceipt NotificationsReligious ServicesRepair and Diagnostics AlertsRewards ProgramSurveysSystem AlertsWaitlist AlertsWebinar RemindersWorkshop Alerts500This Toll-Free Number will be used to deliver opt-in SMS communications, such as one-time passwords (OTPs), alerts, and notifications, to end users who have provided explicit consent.Describe the business reason for the selected use case, and enter any other important information about this request.
500cv|1.0|mno|tfree|9957c339-d46f-49b7-a399-2e6d5ebac66d|GQ3NMEjED8xSlaAgRNote: This field is required only when the use_case category is set to "Political".
If you do not have a token, visit Campaign Verify at https://www.campaignverify.org/ to get started. A valid token follows a specific, pipe-delimited format, comprised of six fields: cv|1.0|mno|tfree|UUID|SecretString
- cv: A constant prefix indicating a Campaign Verify token.
- 1.0: The token version number (currently 1.0).
- mno: The Service ID for Toll-Free numbers (for 10DLC, this would be tcr).
- tfree: The Channel ID for Toll-Free.
- UUID: A unique identifier specific to your verified committee/brand.
- SecretString: A unique, 32-bit URL-safe random string.
1000[Candidate/Org Name]: You’re invited to a community meeting on [Date] at [Location]. RSVP here: [URL]. Message frequency varies. Reply STOP to end.Provide an example of a message to be sent, up to 1000 characters.
Select 'true' if your messages include content that is legally restricted to certain age groups over 21 years of age (e.g., alcohol, gambling, adult content).
On your website:
- Provide the end user's birth date (MM/DD/YYYY) to receive promotional/alert messages.
- On the bottom, add instructions that "If a user is too young to purchase, then place a hold on sending messages until age appropriate."
On end user's mobile device:
- Double Opt-In age gate text message flow includes a Birthdate entry field End user receives opt-in message from an online/mobile site. Example: [Brand Name]: Welcome! Reply with your "birthdate" (MM/DD/YYYY) to successfully sign-up for promotional/alerts messages from _____ (content provider name). Reply STOP to cancel. End user sends message in this format - MM/DD/YYYY - If user replies with age of 21+ then add to opt-in list and send opt-in confirmation message. Example: [Brand Name]: Welcome! Msg frequency varies. Msg & data rates may apply. For support, reply HELP for STOP to cancel.
OtherSelect consent method collected from the message recipient.
Online (website, Mobile app/browser)Text-to-joinPoint of saleOther494Paper-based opt-in form: End-customer consent may be obtained via a paper form. The form requires the end user to enter their mobile phone number and affirmatively select a consent checkbox stating “I agree to receive text messages.” The signed and completed form constitutes valid opt-in documentation.Note: This field is required only when the workflow is set to "Other".
Describe the opt-in process where consent is collected from the message recipient.
- Provide a shared link or publicly accessible link to a screenshot
- Do not add any additional content, i.e. "here's a list"
Provide one or more opt-in keywords that trigger an auto-response message to the recipient.
160[Vonage]: Welcome! You've signed up for alert messages. Msg freq varies. Msg&data rates may apply. Reply HELP for info, STOP to opt-out.The opt-in message responds to the recipient with your brand name, welcome, use case category and helpful hints.
Note: SMS response message is limited to 160 characters for compliance purposes.
160[Vonage]: Thanks for contacting us. Please visit https://www.vonage.com/support or email support@api.vonage.comThe HELP keyword confirmation message sent to a user should contain your Brand name and two (2) contact methods, such as a toll-free number, email address or a link to a customer support page.
Note: SMS response message is limited to 160 characters for compliance purposes.
350This is test additional information.Provide any additional information.
The submission status of the registration.
SUBMITTEDDRAFTExemplo Solicitação
{
"business": {
"name": "Ericsson LM",
"address": {
"street": "101 Crawfords Corner Rd",
"city": "Holmdel",
"state": "CA",
"postal_code": "21012",
"country": "US"
},
"company_website": "https://www.vonage.com",
"contact": {
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@vonage.com",
"phone": "12125551212"
},
"dba": "Vonage Holdings Corp",
"terms_and_conditions_url": "https://www.vonage.com/legal/messaging-service-supplementary-terms/",
"privacy_policy_url": "https://www.vonage.com/legal/privacy-policy/",
"entity_type": "PRIVATE_PROFIT",
"tax_id_type": "EIN",
"tax_id": "12-3456789",
"tax_id_issuing_country": "US"
},
"estimated_monthly_volume": "10,000",
"isv_reseller": {
"name": "Reseller ABC",
"contact_email": "john.doe@resellerabc.com"
},
"requested_numbers": [
{
"number": "18001234567",
"business_reason": "Two numbers are for two sales regions, one number per region to manage and track the business (East and West)"
}
],
"use_case": {
"category": "Political",
"description": "This Toll-Free Number will be used to deliver opt-in SMS communications, such as one-time passwords (OTPs), alerts, and notifications, to end users who have provided explicit consent.",
"campaign_verify_auth_token": "cv|1.0|mno|tfree|9957c339-d46f-49b7-a399-2e6d5ebac66d|GQ3NMEjED8xSlaAgR"
},
"message_content": {
"content": "[Candidate/Org Name]: You’re invited to a community meeting on [Date] at [Location]. RSVP here: [URL]. Message frequency varies. Reply STOP to end.",
"age_gated": false
},
"opt_in": {
"workflow": "Other",
"workflow_description": "Paper-based opt-in form: End-customer consent may be obtained via a paper form. The form requires the end user to enter their mobile phone number and affirmatively select a consent checkbox stating “I agree to receive text messages.” The signed and completed form constitutes valid opt-in documentation.",
"images": [
{
"url": "https://drive.google.com/file/d/screenshot1/view"
},
{
"url": "https://drive.google.com/file/d/screenshot2/view"
}
],
"keywords": [
"JOIN",
"START",
"YES"
],
"confirmation_message": "[Vonage]: Welcome! You've signed up for alert messages. Msg freq varies. Msg&data rates may apply. Reply HELP for info, STOP to opt-out.",
"help_message": "[Vonage]: Thanks for contacting us. Please visit https://www.vonage.com/support or email support@api.vonage.com"
},
"additional_information": "This is test additional information.",
"status": "SUBMITTED"
}Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
3fa85f64-5717-4562-b3fc-2c963f66afa6Unique identifier of a registration
The content creator, not an ISV or reseller
500Ericsson LMParent company or organization full name.
500101 Crawfords Corner RdStreet number and name.
500HolmdelCity name
500CAState or province. For the United States, use 2-character codes, e.g., ‘CA’ for California.
1021012Zip Code or postal code. For the United States, use a 5-digit ZIP code
USTwo-letter country code following the ISO 3166-2 standard
500https://www.vonage.comProvide a publicly available website link for the company/organization. Must be a valid URL.
500JohnFirst name of business contact.
500SmithLast name of business contact.
500john.smith@vonage.comEmail address must match the company, organization or brand (DBA) name if entered.
50012125551212Phone number of business contact. Must be a valid phone number in E.164 format without the + prefix.
500Vonage Holdings CorpIf applicable, the Brand name ‘Doing Business As (DBA)’.
500https://www.vonage.com/legal/messaging-service-supplementary-terms/Provide Terms link for the company/organization. Must be a valid URL.
500https://www.vonage.com/legal/privacy-policy/Provide a Privacy Policy link for the company/organization. Must be a valid URL.
PRIVATE_PROFITLegal classification for the company/organization.
SOLE_PROPRIETORPRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENTEINEIN- For the US, a Federal Tax ID or Employee Identification Number (EIN) is required.
- For Canada, the Canada Business Number (CBN) is required.
- Sole Proprietorship may apply without an EIN/CBN, but there will be additional checks to validate that the provided information is accurate.
- For other country-specific registration, select the relevant option or Other.
EINCBNCRNNEQPROVINCIAL_NUMBERVATACNABNBRNSIRENSIRETNZBNUST-IDNRCIFNIFCNPJUIDOTHER50012-3456789- For the US, provide the Employee Identification Number (EIN) for the company/organization.
- For Canada, provide the Canada Business Number (CBN) for the company/organization.
- For Sole Proprietorship, you may leave this field blank.
- For country-specific registration types, provide the relevant Tax ID number.
2USRelevant issuing country. Two-letter ISO-2 country code.
ISV/Reseller initiating the registration on behalf of the customer.
Note: This is only required for ISV and resellers.
500Reseller ABCIf you are an ISV/Reseller, enter the name of your business.
500john.doe@resellerabc.comVonage will only communicate with this email address for ISV/Reseller submissions. Must be a valid email.
10,000Estimated monthly message volume.
101001,00010,000100,000250,000500,000750,0001,000,0005,000,00010,000,000+TFN number details
111118001234567Must be a valid purchased TFN in E.164 international format without the + prefix. Should always start with prefix 1800, 1888, 1877, 1866, 1855, 1844, or 1833.
The verification status of the tfn.
UPDATES_REQUIREDPENDING_REVIEWCARRIERS_REVIEWREGISTEREDREJECTEDDRAFTBLOCKEDDisallowedContent - GamblingReason the number is rejected for tfn registration
149Two numbers are for two sales regions, one number per region to manage and track the business (East and West)This field is required when multiple numbers are included in the registration. Provide a clear reason for each number to get multiple numbers verified for messaging services.
Describes the use case.
PoliticalUse case category that represents your business industry; choose “Mixed” if marketing and alerts.
2FAApp NotificationsAppointmentsAuctionsAuto / Dealership ServicesBankingBillingBooking ConfirmationsBusiness UpdatesCOVID-19 AlertsCareer TrainingChatbotConversational / AlertsCourier Services & DeliveriesEducationalEmergency AlertsEmployee Alerts / NotificationsEvents & PlanningFinancial ServicesFraud AlertsFundraisingGeneral MarketingHR / StaffingHealthcareHousing Community UpdatesInsurance ServicesJob AlertsLegal ServicesMixedMotivational RemindersNotary NotificationsNotificationsOrder NotificationsPoliticalPublic WorksReal Estate ServicesReceipt NotificationsReligious ServicesRepair and Diagnostics AlertsRewards ProgramSurveysSystem AlertsWaitlist AlertsWebinar RemindersWorkshop Alerts500This Toll-Free Number will be used to deliver opt-in SMS communications, such as one-time passwords (OTPs), alerts, and notifications, to end users who have provided explicit consent.Describe the business reason for the selected use case, and enter any other important information about this request.
500cv|1.0|mno|tfree|9957c339-d46f-49b7-a399-2e6d5ebac66d|GQ3NMEjED8xSlaAgRNote: This field is required only when the use_case category is set to "Political".
If you do not have a token, visit Campaign Verify at https://www.campaignverify.org/ to get started. A valid token follows a specific, pipe-delimited format, comprised of six fields: cv|1.0|mno|tfree|UUID|SecretString
- cv: A constant prefix indicating a Campaign Verify token.
- 1.0: The token version number (currently 1.0).
- mno: The Service ID for Toll-Free numbers (for 10DLC, this would be tcr).
- tfree: The Channel ID for Toll-Free.
- UUID: A unique identifier specific to your verified committee/brand.
- SecretString: A unique, 32-bit URL-safe random string.
The expiration date of the Campaign Verify token. This field is applicable only to Political use cases. New tokens typically remain valid for 2 years from the date of issue.
1000[Candidate/Org Name]: You’re invited to a community meeting on [Date] at [Location]. RSVP here: [URL]. Message frequency varies. Reply STOP to end.Provide an example of a message to be sent, up to 1000 characters.
Select 'true' if your messages include content that is legally restricted to certain age groups over 21 years of age (e.g., alcohol, gambling, adult content).
On your website:
- Provide the end user's birth date (MM/DD/YYYY) to receive promotional/alert messages.
- On the bottom, add instructions that "If a user is too young to purchase, then place a hold on sending messages until age appropriate."
On end user's mobile device:
- Double Opt-In age gate text message flow includes a Birthdate entry field End user receives opt-in message from an online/mobile site. Example: [Brand Name]: Welcome! Reply with your "birthdate" (MM/DD/YYYY) to successfully sign-up for promotional/alerts messages from _____ (content provider name). Reply STOP to cancel. End user sends message in this format - MM/DD/YYYY - If user replies with age of 21+ then add to opt-in list and send opt-in confirmation message. Example: [Brand Name]: Welcome! Msg frequency varies. Msg & data rates may apply. For support, reply HELP for STOP to cancel.
OtherSelect consent method collected from the message recipient.
Online (website, Mobile app/browser)Text-to-joinPoint of saleOther494Paper-based opt-in form: End-customer consent may be obtained via a paper form. The form requires the end user to enter their mobile phone number and affirmatively select a consent checkbox stating “I agree to receive text messages.” The signed and completed form constitutes valid opt-in documentation.Note: This field is required only when the workflow is set to "Other".
Describe the opt-in process where consent is collected from the message recipient.
- Provide a shared link or publicly accessible link to a screenshot
- Do not add any additional content, i.e. "here's a list"
Provide one or more opt-in keywords that trigger an auto-response message to the recipient.
160[Vonage]: Welcome! You've signed up for alert messages. Msg freq varies. Msg&data rates may apply. Reply HELP for info, STOP to opt-out.The opt-in message responds to the recipient with your brand name, welcome, use case category and helpful hints.
Note: SMS response message is limited to 160 characters for compliance purposes.
160[Vonage]: Thanks for contacting us. Please visit https://www.vonage.com/support or email support@api.vonage.comThe HELP keyword confirmation message sent to a user should contain your Brand name and two (2) contact methods, such as a toll-free number, email address or a link to a customer support page.
Note: SMS response message is limited to 160 characters for compliance purposes.
350This is test additional information.Provide any additional information.
The submission status of the registration.
SUBMITTEDDRAFTThe date and time of creation.
The date and time of last update.
The date and time of submission.
Exemplo Resposta
application/hal+jsonAutenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
The content creator, not an ISV or reseller
500Ericsson LMParent company or organization full name.
500101 Crawfords Corner RdStreet number and name.
500HolmdelCity name
500CAState or province. For the United States, use 2-character codes, e.g., ‘CA’ for California.
1021012Zip Code or postal code. For the United States, use a 5-digit ZIP code
USTwo-letter country code following the ISO 3166-2 standard
500https://www.vonage.comProvide a publicly available website link for the company/organization. Must be a valid URL.
500JohnFirst name of business contact.
500SmithLast name of business contact.
500john.smith@vonage.comEmail address must match the company, organization or brand (DBA) name if entered.
50012125551212Phone number of business contact. Must be a valid phone number in E.164 format without the + prefix.
500Vonage Holdings CorpIf applicable, the Brand name ‘Doing Business As (DBA)’.
500https://www.vonage.com/legal/messaging-service-supplementary-terms/Provide Terms link for the company/organization. Must be a valid URL.
500https://www.vonage.com/legal/privacy-policy/Provide a Privacy Policy link for the company/organization. Must be a valid URL.
PRIVATE_PROFITLegal classification for the company/organization.
SOLE_PROPRIETORPRIVATE_PROFITPUBLIC_PROFITNON_PROFITGOVERNMENTEINEIN- For the US, a Federal Tax ID or Employee Identification Number (EIN) is required.
- For Canada, the Canada Business Number (CBN) is required.
- Sole Proprietorship may apply without an EIN/CBN, but there will be additional checks to validate that the provided information is accurate.
- For other country-specific registration, select the relevant option or Other.
EINCBNCRNNEQPROVINCIAL_NUMBERVATACNABNBRNSIRENSIRETNZBNUST-IDNRCIFNIFCNPJUIDOTHER50012-3456789- For the US, provide the Employee Identification Number (EIN) for the company/organization.
- For Canada, provide the Canada Business Number (CBN) for the company/organization.
- For Sole Proprietorship, you may leave this field blank.
- For country-specific registration types, provide the relevant Tax ID number.
2USRelevant issuing country. Two-letter ISO-2 country code.
ISV/Reseller initiating the registration on behalf of the customer.
Note: This is only required for ISV and resellers.
500Reseller ABCIf you are an ISV/Reseller, enter the name of your business.
500john.doe@resellerabc.comVonage will only communicate with this email address for ISV/Reseller submissions. Must be a valid email.
10,000Estimated monthly message volume.
101001,00010,000100,000250,000500,000750,0001,000,0005,000,00010,000,000+List all toll-free phone numbers to be registered. Add up to 5 TFNs.
111118001234567Must be a valid purchased TFN in E.164 international format without the + prefix. Should always start with prefix 1800, 1888, 1877, 1866, 1855, 1844, or 1833.
149Two numbers are for two sales regions, one number per region to manage and track the business (East and West)This field is required when multiple numbers are included in the registration. Provide a clear reason for each number to get multiple numbers verified for messaging services.
Describes the use case.
PoliticalUse case category that represents your business industry; choose “Mixed” if marketing and alerts.
2FAApp NotificationsAppointmentsAuctionsAuto / Dealership ServicesBankingBillingBooking ConfirmationsBusiness UpdatesCOVID-19 AlertsCareer TrainingChatbotConversational / AlertsCourier Services & DeliveriesEducationalEmergency AlertsEmployee Alerts / NotificationsEvents & PlanningFinancial ServicesFraud AlertsFundraisingGeneral MarketingHR / StaffingHealthcareHousing Community UpdatesInsurance ServicesJob AlertsLegal ServicesMixedMotivational RemindersNotary NotificationsNotificationsOrder NotificationsPoliticalPublic WorksReal Estate ServicesReceipt NotificationsReligious ServicesRepair and Diagnostics AlertsRewards ProgramSurveysSystem AlertsWaitlist AlertsWebinar RemindersWorkshop Alerts500This Toll-Free Number will be used to deliver opt-in SMS communications, such as one-time passwords (OTPs), alerts, and notifications, to end users who have provided explicit consent.Describe the business reason for the selected use case, and enter any other important information about this request.
500cv|1.0|mno|tfree|9957c339-d46f-49b7-a399-2e6d5ebac66d|GQ3NMEjED8xSlaAgRNote: This field is required only when the use_case category is set to "Political".
If you do not have a token, visit Campaign Verify at https://www.campaignverify.org/ to get started. A valid token follows a specific, pipe-delimited format, comprised of six fields: cv|1.0|mno|tfree|UUID|SecretString
- cv: A constant prefix indicating a Campaign Verify token.
- 1.0: The token version number (currently 1.0).
- mno: The Service ID for Toll-Free numbers (for 10DLC, this would be tcr).
- tfree: The Channel ID for Toll-Free.
- UUID: A unique identifier specific to your verified committee/brand.
- SecretString: A unique, 32-bit URL-safe random string.
1000[Candidate/Org Name]: You’re invited to a community meeting on [Date] at [Location]. RSVP here: [URL]. Message frequency varies. Reply STOP to end.Provide an example of a message to be sent, up to 1000 characters.
Select 'true' if your messages include content that is legally restricted to certain age groups over 21 years of age (e.g., alcohol, gambling, adult content).
On your website:
- Provide the end user's birth date (MM/DD/YYYY) to receive promotional/alert messages.
- On the bottom, add instructions that "If a user is too young to purchase, then place a hold on sending messages until age appropriate."
On end user's mobile device:
- Double Opt-In age gate text message flow includes a Birthdate entry field End user receives opt-in message from an online/mobile site. Example: [Brand Name]: Welcome! Reply with your "birthdate" (MM/DD/YYYY) to successfully sign-up for promotional/alerts messages from _____ (content provider name). Reply STOP to cancel. End user sends message in this format - MM/DD/YYYY - If user replies with age of 21+ then add to opt-in list and send opt-in confirmation message. Example: [Brand Name]: Welcome! Msg frequency varies. Msg & data rates may apply. For support, reply HELP for STOP to cancel.
OtherSelect consent method collected from the message recipient.
Online (website, Mobile app/browser)Text-to-joinPoint of saleOther494Paper-based opt-in form: End-customer consent may be obtained via a paper form. The form requires the end user to enter their mobile phone number and affirmatively select a consent checkbox stating “I agree to receive text messages.” The signed and completed form constitutes valid opt-in documentation.Note: This field is required only when the workflow is set to "Other".
Describe the opt-in process where consent is collected from the message recipient.
- Provide a shared link or publicly accessible link to a screenshot
- Do not add any additional content, i.e. "here's a list"
Provide one or more opt-in keywords that trigger an auto-response message to the recipient.
160[Vonage]: Welcome! You've signed up for alert messages. Msg freq varies. Msg&data rates may apply. Reply HELP for info, STOP to opt-out.The opt-in message responds to the recipient with your brand name, welcome, use case category and helpful hints.
Note: SMS response message is limited to 160 characters for compliance purposes.
160[Vonage]: Thanks for contacting us. Please visit https://www.vonage.com/support or email support@api.vonage.comThe HELP keyword confirmation message sent to a user should contain your Brand name and two (2) contact methods, such as a toll-free number, email address or a link to a customer support page.
Note: SMS response message is limited to 160 characters for compliance purposes.
350This is test additional information.Provide any additional information.
Set to SUBMITTED to submit DRAFT registration. If omitted, the previous status is maintained.
SUBMITTEDExemplo Solicitação
{
"business": {
"name": "Ericsson LM",
"address": {
"street": "101 Crawfords Corner Rd",
"city": "Holmdel",
"state": "CA",
"postal_code": "21012",
"country": "US"
},
"company_website": "https://www.vonage.com",
"contact": {
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@vonage.com",
"phone": "12125551212"
},
"dba": "Vonage Holdings Corp",
"terms_and_conditions_url": "https://www.vonage.com/legal/messaging-service-supplementary-terms/",
"privacy_policy_url": "https://www.vonage.com/legal/privacy-policy/",
"entity_type": "PRIVATE_PROFIT",
"tax_id_type": "EIN",
"tax_id": "12-3456789",
"tax_id_issuing_country": "US"
},
"isv_reseller": {
"name": "Reseller ABC",
"contact_email": "john.doe@resellerabc.com"
},
"estimated_monthly_volume": "10,000",
"requested_numbers": [
{
"number": "18001234567",
"business_reason": "Two numbers are for two sales regions, one number per region to manage and track the business (East and West)"
}
],
"use_case": {
"category": "Political",
"description": "This Toll-Free Number will be used to deliver opt-in SMS communications, such as one-time passwords (OTPs), alerts, and notifications, to end users who have provided explicit consent.",
"campaign_verify_auth_token": "cv|1.0|mno|tfree|9957c339-d46f-49b7-a399-2e6d5ebac66d|GQ3NMEjED8xSlaAgR"
},
"message_content": {
"content": "[Candidate/Org Name]: You’re invited to a community meeting on [Date] at [Location]. RSVP here: [URL]. Message frequency varies. Reply STOP to end.",
"age_gated": false
},
"opt_in": {
"workflow": "Other",
"workflow_description": "Paper-based opt-in form: End-customer consent may be obtained via a paper form. The form requires the end user to enter their mobile phone number and affirmatively select a consent checkbox stating “I agree to receive text messages.” The signed and completed form constitutes valid opt-in documentation.",
"images": [
{
"url": "https://drive.google.com/file/d/screenshot1/view"
},
{
"url": "https://drive.google.com/file/d/screenshot2/view"
}
],
"keywords": [
"JOIN",
"START",
"YES"
],
"confirmation_message": "[Vonage]: Welcome! You've signed up for alert messages. Msg freq varies. Msg&data rates may apply. Reply HELP for info, STOP to opt-out.",
"help_message": "[Vonage]: Thanks for contacting us. Please visit https://www.vonage.com/support or email support@api.vonage.com"
},
"additional_information": "This is test additional information.",
"status": "SUBMITTED"
}Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
3fa85f64-5717-4562-b3fc-2c963f66afa6Unique identifier of a registration
The verification status of the tfn.
UPDATES_REQUIREDPENDING_REVIEWCARRIERS_REVIEWREGISTEREDREJECTEDDRAFTBLOCKEDThe provided use case description is insufficient. Please provide more details.Reason for the given status of TFN. The reason will be empty for statuses like REGISTERED or PENDING_REVIEW.
The date and time of creation.
10https://example:com/resource?page_size=10&cursor=19284743Exemplo Resposta
application/hal+jsonOperações disponíveis
Autenticação
| Chave | Descrição | Onde | Exemplo |
|---|---|---|---|
| Authorization | Chave e segredo da API codificados em Base64, separados por dois pontos. | Headers | Basic <base64> |
Consulta Parâmetros
19284743Cursor for pagination
10Number of results per page
Filter by number status
UPDATES_REQUIREDPENDING_REVIEWCARRIERS_REVIEWREGISTEREDREJECTEDDRAFTBLOCKED111118001234567Filter by specific toll-free number
3fa85f64-5717-4562-b3fc-2c963f66afa6Filter by specific registration ID
500Ericsson LMFuzzy search by business name
111118001234567Must be a valid purchased TFN in E.164 international format without the + prefix. Should always start with prefix 1800, 1888, 1877, 1866, 1855, 1844, or 1833.
The verification status of the tfn.
UPDATES_REQUIREDPENDING_REVIEWCARRIERS_REVIEWREGISTEREDREJECTEDDRAFTBLOCKED500Ericsson LMParent company or organization full name.
3fa85f64-5717-4562-b3fc-2c963f66afa6Unique identifier of a registration
The date and time of submission.
Date when the current status tfn was updated
10https://example:com/resource?page_size=10&cursor=19284743https://example:com/resource?page_size=10&cursor=19284743https://example:com/resource?page_size=10&cursor=19284743https://example:com/resource?page_size=10Exemplo Resposta
{
"_embedded": {
"numbers": [
{
"number": "18001234567",
"status": "UPDATES_REQUIRED",
"business_name": "Ericsson LM",
"registration_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"submission_date": "2019-08-24T14:15:22Z",
"status_change_date": "2019-08-24T14:15:22Z"
}
]
},
"page_size": 10,
"_links": {
"self": "https://example:com/resource?page_size=10&cursor=19284743",
"next": "https://example:com/resource?page_size=10&cursor=19284743",
"prev": "https://example:com/resource?page_size=10&cursor=19284743",
"first": "https://example:com/resource?page_size=10"
}
}