Custom API voice AI integration

What your agent can do with Custom API

What you'll need to connect Custom API

Connect with an API key. In Telenow, open Integrations → Custom API and provide:

• API token / key — Optional. Reference it in your requests as {auth.auth_token}.
• Base URL — Optional. Reference it in your requests as {connection.base_url}.
• Capabilities and requests — Map each capability your templates need to a request against your API.
• Contact list URL — A GET returning your contacts, for use as a campaign source. Give the plain URL with NO query string and NO placeholders — paging is added for you using the two parameter names below. Must be https and publicly reachable. Leave blank if you are not dialling from this API.
• Path to the list — Where the array of contacts sits in the response, dotted (`data.customers`). Leave BLANK if the response is the array itself.
• Identifier field — The field that identifies each contact. A record's POSITION is not its identity — insert one contact and every later position shifts — so this is what dedupe and write-back address.
• Path to each contact's fields — Leave BLANK if the fields sit directly on each record. Set it only if they are nested (Airtable-style `fields`).
• Page size — How many records to ask for per page. Capped at 500.
• Call results URL — A POST that receives one batch of finished calls, for use as an agent destination. The body is {"calls": [ ... ]}, each entry the fields you map, flat. Give the full https URL. Leave blank if you are not writing results here.
• Page-size parameter — What your API calls the page size — limit, per_page, count, page_size.
• Page-number parameter — What your API calls the page number — page, offset, skip.

Frequently asked questions