ads

GET /v1/ads/connections/{connection_id}/call-numbers/available

Local numbers the customer could buy, each at its measured price (za-160).

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the ads.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/ads/connections/{connection_id}/call-numbers/available \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.view. A read at the voice vendor (costs nothing): up to ten local voice numbers, each with the customer's first-month and monthly price in USD micros (the vendor's own cost_information plus the platform margin). Only countries whose call rates were measured are offered (callCountryNotOffered).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—
country (query)stringNo—
area_code (query)stringNo—

Response

NameTypeRequiredWhat it is
numbersAdsCallNumberOffer[]Yes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429