> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# ICUK API

> Work on your clients' ICUK services: broadband lines, hosted VoIP, domains, web hosting and email, phone and leased lines, with the approvals you set

An agent with this tool works on the services you resell from ICUK. It answers a broadband ticket from the line itself, checks whether a user's phone is online or needs provisioning again, warns before a client's domain expires with auto-renew off, and looks after mailboxes and websites, with the approvals you set.

> [!NOTE]
>
> Automatically enabled when you configure ICUK permissions in your agent workflow. No manual toggle needed.

## What It Does

* Find the client's ICUK records from the [Organization Mapping](https://docs.neoagent.io/integrations/icuk/overview.md#your-clients-records-are-mapped-automatically)
* Broadband: read a line's status, sessions, sign-ins and usage, run TalkTalk and Openreach line tests and resets, and change its settings and IP addresses
* Hosted VoIP: read which phones are online, their sign-in and provisioning logs, users, voicemail, numbers, call routing and call records, and change them
* Domains: read each domain's expiry date, auto-renew, nameservers and DNS, list the domains that expire in the next month, and change DNS
* Web hosting and email: read and change hosting accounts, FTP, databases, PHP, cron jobs, mailboxes, forwarders, auto-responders, DKIM and the spam filter
* Phone lines (WLR): run a line test, raise and follow Openreach faults, and manage orders; leased lines: read status, uptime, speed tests and faults
* Your account: ICUK customers and contacts, tariffs and prices, SMS credits, invoices, and ICUK's service status

The agent calls ICUK through the [Vendor API](https://docs.neoagent.io/agents/tools/vendor-api.md) tool, with `icuk` as the vendor id. [Sandbox](https://docs.neoagent.io/agents/tools/built-in/sandbox.md) scripts can call it too, under the same permissions.

## Permission Groups

| Group | What it covers |
| - | - |
| **Broadband Lines** | Each line's record, contact, status, sessions, sign-ins, RADIUS logs, sync profile, speed tests, usage and notices |
| **Line Tests** | TalkTalk and Openreach (KBD) line tests and their results |
| **Line Resets** | Port, DLM and session resets, ending a session, an SNR reset, their results and SNR logs |
| **Line Settings** | Care level, quota action, speed limit, stability, interleaving, SNR profile and ban |
| **IP Addresses** | Static, routed and IPv6 addresses and reverse DNS |
| **Orders** | Broadband orders and their history; new line, migration and cease orders |
| **RIPE Contacts** | The RIPE person contacts for routed IP blocks |
| **Domains** | Domains, their expiry, auto-renew, nameservers and contacts, and DNS |
| **VoIP Accounts** | Hosted VoIP accounts, their settings and sign-in logs |
| **VoIP Phones** | Phones, whether each is online, their provisioning and sign-in logs, and locations |
| **VoIP Users & Voicemail** | Users, follow-me, voicemail boxes and address books |
| **VoIP Numbers & Call Routing** | Numbers, call flows, menus, ring groups, opening hours, holidays, audio, conferences and number ports |
| **VoIP Call Records** | Inbound and outbound call records and monthly summaries. Read only |
| **Web Hosting** | Hosting accounts and their FTP users, databases, PHP, .NET, cron jobs, protected folders, DNS and SSL certificates |
| **Email & Spam Filter** | Mailboxes, forwarders, group addresses, auto-responders, the catch-all, DKIM and the spam filter |
| **Phone Lines (WLR)** | Openreach line checks, line tests, fault reports, appointments, numbers and orders |
| **Leased Lines** | Leased line orders, status, uptime, speed tests, faults, notices, reverse DNS and quotes |
| **SMS** | SMS credits, warnings, sender names, and sending an SMS |
| **Customers** | Your ICUK customers and contacts |
| **Tariffs & Prices** | Your tariffs and markups, and ICUK's prices for broadband, VoIP, domains, phone lines and mailboxes |
| **Invoices** | The invoices ICUK sends you. Read only |
| **Availability & Notices** | Addresses, availability, network notices, fax lists, domain availability, public WHOIS and ICUK's service status. Read only |

## Access Profiles

> [accordion] Read Only
>
> Every group Read Only, and Invoices off.

> [accordion] Helpdesk
>
> Line Tests run on their own. Line Resets, Line Settings, Broadband Lines, IP Addresses, VoIP Phones, VoIP Users & Voicemail, VoIP Numbers & Call Routing, Domains, Web Hosting and Email & Spam Filter can change, each change after a technician approves it. Every other group is Read Only, and Invoices off.

> [accordion] IT Admin
>
> Broadband, VoIP phones, users and numbers, Domains, Web Hosting, Email & Spam Filter, Leased Lines and RIPE Contacts change on their own. Orders, Tariffs & Prices, VoIP Accounts, Phone Lines (WLR), SMS and Customers ask a technician first. Invoices are Read Only.

> [accordion] Full Automation
>
> Every change runs on its own, except the ones that always ask.

These always ask a technician: deleting or ceasing a core record (a line's account, a cease order, a domain, a VoIP account or number, a hosting account and its databases, a customer, the spam filter); anything that changes where a client's web, mail, calls, voicemail or invitations go, or sends out (DNS, a mail forwarder, the catch-all, a group address recipient, call forwarding, a ring group's members and alert email, a follow-me, voicemail sent to email, meeting invitations, an auto-responder, an SMS); anything that weakens a client's mail protection (the spam filter's settings, its allow and block entries, releasing queued mail, deleting or deactivating a DKIM key); adding, changing or enabling a cron job; and any change that sets a password, a PIN or a transfer code.

Neo does not send a domain's transfer code, an invoice's PDF, or the old password changes that put the password in the web address. It hides every password, PIN and transfer code in what it reads.

## On a ticket

On a ticket, every call names one of the records mapped to the ticket's company: a broadband line, a VoIP account, a hosting account, a domain, a leased line or an ICUK customer. The lists of every client's records, orders, faults, SMS and phone-line calls, and your own prices, tariffs and invoices are not sent. Availability, public WHOIS, number ranges and ICUK's service status carry no client's data and stay open. With no ticket company (a chat, or a scheduled agent with no ticket), the agent reads every client's records.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.