Build on the NUACOM phone system

V1, deprecated soon

V1 is the original NUACOM API, served from https://api.api-nuacom.com/v1/… by a separate code base. It is kept only for integrations that already use it: it still receives security fixes, it receives no new features, and it will be retired.

Sunset plan#

• V1 is frozen: no new endpoints and no new fields are added.
• The sunset date will be announced in advance on this page and in the V1 reference. Until then V1 keeps working unchanged.
• New integrations must not be built against V1.

Migrating to V2#

• Authentication is the same on both: the Authorization: Bearer header with an API key (see the Authentication guide), so you can move one call at a time.
• The base URL changes from https://api.api-nuacom.com/v1 to https://api.api-nuacom.com/v2.
• Not every V1 capability has a V2 counterpart. Start from the API reference group that matches the V1 resource; the group guides describe the order of calls the NUACOM portal itself uses.
• V2 reports failures with HTTP status codes (401, 403, 422) rather than the 200 + error object V1 often returns, so error handling usually needs a small rewrite.

The V1 reference stays available at /v1 until the sunset date.

Open the V1 reference →

V2, current

V2 is the current, stable NUACOM API and the one to build new integrations against. It covers the whole product: account and users, extensions, numbers and call routing, IVR, call logs and recordings, SMS, contacts, billing and more.

• Base URL: https://api.api-nuacom.com/v2
• Reference: /v2/ref, generated from the deployed code, so it always matches what is running. Use the search box (Ctrl+K / ⌘K) to jump to an endpoint.
• Authentication: the Authorization: Bearer header, see the Authentication guide.

Stability#

• Existing endpoints, parameters and response fields are not removed or renamed within V2. New optional fields and endpoints can appear at any time: read responses by key and ignore keys you do not know.
• Dates are returned as Y-m-d H:i:s by default; accounts can opt into ISO 8601 output. Send X-Timezone with an IANA timezone name on endpoints that take date filters, otherwise the user's profile timezone is used.
• Rate limit: 3000 requests per minute per token; above that the API answers 429 with a Retry-After header.

Endpoints under /v3/…#

Some resources are served from a /v3/… path. These are not a separate API: the same token works on both, one integration mixes /v2/… and /v3/… calls freely, and every one of them is listed in this reference alongside the /v2/… endpoints. Copy the path from the reference as it is shown there.

A handful of resources — contacts, call tags, call notes, users, queues and number blocking — have an endpoint on both paths. They are not duplicates: each operation in the reference says what it does and, where a close counterpart exists on the other path, how the two differ. The stability rules above apply to the /v3/… endpoints too, except that validation rules there are stricter and may be tightened further between releases.

Open the V2 reference →