Objective
Static promo numbers(toll-free or local) can be automatically generated via Invoca API.Applies To
Invoca API > Network Integration > Promo NumbersProcedure
It can be more beneficial to leverage the Invoca API to create multiple promo numbers for a given campaign automatically than manually creating them individually on the platform.1. Use the POST method and the endpoint URL. There are two different endpoints for POST methods:
- If you want to specify the ID for a promo number, use the endpoint, "/promo_numbers_by_id".
- If you are okay with the auto-created ID for a promo number, use the endpoint, "/promo_numbers.json".
- The promo number ID will be found here:
NOTE: for POST requests, ensure to include an oAuth token as a param("oauth_token") in the endpoint.
2. Include the promo number data properties in the request body in JSON format. Please note the required properties, media_type, and description, should be included.
- When creating a local number, include the key, "local_center" with the value corresponding to your desired location information. Add one of the following:
- zipcode
- city
- state
- NOTE: City & State required together
With a zipcode:
with City and State:
- If no local information is specified, a toll-free number will be generated.
3. To apply marketing data to the number, include the "custom_data" property with pairs of marketing data fields(API name) and their respective values.
* Request
* Result on the platform
5. If all configurations are in place and the request is successfully sent, the response will contain information about the generated number.
Additional Information
For bulk promotional number creation, you may require developer resources to build an application capable of sending multiple requests, as the API is designed for one request and one response.