Capability Library · Pack detail

five9 v1.0.0

Five9 VCC Agent and Supervisor REST APIs: read agent info, active calls, contacts and supervisor queue statistics, update contacts, place an external call, and dispose a call.

Review state: draft· Not in the distributable release manifest

Release identity

SHA-256 of the pack file bytes: ae70bedc002c0595e1aa7d81387ad744076a4cf2611e2b7199d61098ad95f8ca

Not in the distributable release manifest. The binary carries a digest-bound manifest of the distributable library; a pack whose bytes differ from its manifest entry — endpoint, tier, allowlist, or credential edited, with provider, version, and review block preserved — fails the digest check, loses distributability, and renders MODIFIED rather than as the shipped reviewed artifact. Review state and artifact status are different facts: the first is a documentation-review declaration, the second is the identity of the exact bytes.

Capabilities (7)

five9.agent.info.read v1.0.0R0

Action
read
Endpoint
GET https://five9-vcc.invalid/appsvcs/rs/svc/agents/AGENT_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
pii

Read one agent's information (agent-context path /appsvcs/rs/svc/agents/{agentId}, as exercised by the retrieved starter kit): the agent's profile and state, which are personal data. AGENT_ID is a placeholder the deployment binds to a concrete agent before enabling, and the host is a reserved placeholder to substitute with the customer's data-center API host before enabling.

five9.calls.read v1.0.0R0

Action
read
Endpoint
GET https://five9-vcc.invalid/appsvcs/rs/svc/agents/AGENT_ID/interactions/calls
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
pii

List the calls an agent can currently work (agent-context path .../interactions/calls, as exercised by the retrieved starter kit): a collection read of live interaction records carrying customer numbers and campaign ids, registered at the pii class. AGENT_ID is a placeholder the deployment binds before enabling, and the host is a reserved placeholder to substitute before enabling.

five9.contacts.read v1.0.0R0

Action
read
Endpoint
GET https://five9-vcc.invalid/appsvcs/rs/svc/orgs/ORG_ID/contacts/CONTACT_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
pii

Read one contact record by id (agent-context path /orgs/{orgId}/contacts/{contactId}, as exercised by the retrieved starter kit): contact records are customer personal data. ORG_ID and CONTACT_ID are placeholders the deployment binds before enabling, and the host is a reserved placeholder to substitute before enabling.

five9.contacts.update v1.0.0R2

Action
update
Endpoint
PUT https://five9-vcc.invalid/appsvcs/rs/svc/orgs/ORG_ID/contacts/CONTACT_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
pii

Update one contact record (agent-context PUT /orgs/{orgId}/contacts/{contactId}, as exercised by the retrieved starter kit). The request body carries the contact's fields unrestricted — this registration does not restrict which field values a request may write, so a caller may overwrite any writable field on the record; the effect is bounded by the session user's permissions, not by this pack. ORG_ID and CONTACT_ID are placeholders the deployment binds before enabling, and the host is a reserved placeholder to substitute before enabling.

five9.supervisor.ewt.read v1.0.0R0

Action
read
Endpoint
GET https://five9-vcc.invalid/supsvcs/rs/svc/orgs/ORG_ID/ewt/group/SKILL_GROUP_ID/MEDIA_TYPE_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
internal

Read expected wait time for a skill group on the supervisor-context path (/supsvcs/rs/svc/...), registered at the internal class: an aggregate queue statistic, not customer data. This capability exercises the supervisor side of the Agent/Supervisor split; it grants nothing on the separate SOAP admin or statistics surfaces. ORG_ID, SKILL_GROUP_ID and MEDIA_TYPE_ID are placeholders the deployment binds before enabling, and the host is a reserved placeholder to substitute before enabling.

five9.calls.make_external v1.0.0R3

Actions
create, send
Endpoint
POST https://five9-vcc.invalid/appsvcs/rs/svc/agents/AGENT_ID/interactions/make_external_call
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
pii

Initiate an outbound external call from the agent's session (agent-context POST .../interactions/make_external_call, as exercised by the retrieved starter kit): the effect rings a telephone number supplied in the request body and opens a live voice interaction with an end recipient, which cannot be un-rung once placed. The capability is registered as create and send at the R3 floor — send is one of the IRREVERSIBLE ACTIONS (delete, send, pay, deploy, approve, share and transfer), and an irreversible action cannot be taken without a person. The request body carries the destination number and campaign id unrestricted, so the vendor verb being a POST-create does not lower the effect; the dialed number is personal data. AGENT_ID is a placeholder the deployment binds before enabling, and the host is a reserved placeholder to substitute before enabling.

five9.calls.dispose v1.0.0R3

Actions
delete, update
Endpoint
PUT https://five9-vcc.invalid/appsvcs/rs/svc/agents/AGENT_ID/interactions/calls/CALL_ID/dispose
Connector
http
Custody
customer_vault
Credential ref
secret-ref-five9-vcc-session-cookie
Data class
pii

Dispose a call (agent-context PUT .../interactions/calls/{callId}/dispose, as exercised by the retrieved starter kit, whose own method comment reads 'dispose Finishes a call and sets a disposition'): the operation writes the call's disposition — a durable update to the interaction record — and, per that sample, finishes the call. Whether disposal terminates an active call in every documented state is NOT verified: the full Agent and Supervisor REST API developer guide is gated and was not retrievable at review time, so this pack does not claim every dispose call is a hangup — but on the states where it does end an in-progress customer call, that effect cannot be undone. The registration therefore declares both delete (the possible termination) and update (the disposition write) and sits at the R3 floor; delete is one of the IRREVERSIBLE ACTIONS (delete, send, pay, deploy, approve, share and transfer). AGENT_ID and CALL_ID are placeholders the deployment binds before enabling, and the host is a reserved placeholder to substitute before enabling.

Credential reference

The pack names a reference, never a secret. Installing a pack registers capabilities and makes them governable; registration is not connectivity. The credential is created at the provider and held in the client's own secret manager under the reference the pack names, and deployment testing is still required to show the credential path works and cannot be bypassed.

Reference
secret-ref-five9-vcc-session-cookie
Custody
customer_vault
Injection
header (Cookie)

A Five9 VCC session cookie for a dedicated agent-or-supervisor user, held in the client's own secret manager. The retrieved Five9 developer-program starter kit authenticates REST calls with the logged-in browser session (fetch with credentials: 'include'), and no token-based scheme for this API was verified at review time — the full Agent and Supervisor REST API developer guide is gated, so whether HTTP Basic with VCC credentials or an API token is supported for server-side callers is an open review item before enabling. TOKEN ISSUANCE IS EXTERNAL: an external deployment process performs the VCC login for the dedicated user, captures the session cookie, and stores it; the stored material must be the complete Cookie header value exactly as the session issued it. The executor injects the stored value verbatim and performs no login itself. Expiry and revocation: the retrieved material establishes only that VCC sessions expire and that logout ends a session. Whether a password change or user disablement invalidates an already-issued live session is NOT established by any source retrieved at review time — the full developer guide is gated and Five9's developer documentation sites were unreachable — so this pack makes no such guarantee: the custody job must refresh the reference before expiry, an expired session fails closed, and on suspected exposure the deployment must terminate the session itself rather than rely on account-side changes. Obtaining the gated Agent and Supervisor REST API developer guide's session, expiry and revocation terms is an open review item before enabling. Least privilege: the session acts with the full permissions of the logged-in VCC user, so use a dedicated service user with only the agent or supervisor permissions these capabilities need, and nothing more. Executor hygiene: the value must live only in executor memory for the lifetime of a call, must never be written to logs, traces or diagnostics, and must not appear in crash dumps; a deployment that cannot meet that bar must not enable the pack.

Resources

  • five9-vcc-agents (api, pii): https://five9-vcc.invalid/appsvcs/rs/svc/agents
  • five9-vcc-contacts (api, pii): https://five9-vcc.invalid/appsvcs/rs/svc/orgs/ORG_ID/contacts
  • five9-vcc-supervisor (api, internal): https://five9-vcc.invalid/supsvcs/rs/svc

Pack notes and exclusions

DRAFT — verification limits a reviewer must weigh. Five9's Agent and Supervisor REST API developer guide is gated behind the Five9 Developer Program and could not be fetched at review time, and Five9's developer documentation sites (developer.five9.com, apidocs.five9.com) were unreachable from the review environment. This pack was scaffolded from what was actually retrieved: Five9's official developer-program starter-kit repository (whose own README disclaims being an officially supported Five9 resource), its sample agent_VCC_boilerplate.html, and Five9's publicly hosted CRM SDK documentation. At the 2026-09-21 re-review, developer.five9.com remained unreachable and the vendor-hosted VCC Agent and Supervisor REST API reference guide PDF redirected to a login-gated documentation portal, so the guide's session, expiry, revocation and per-state dispose semantics remain unverified; the starter-kit README's disclaimer that the repository is not an official or supported Five9 resource was retrieved and stands. Every endpoint path registered here is one the boilerplate exercises. THE ADMIN vs SUPERVISOR SPLIT, STATED HONESTLY: Five9 exposes at least three distinct API surfaces. (1) The administrative surface — users, campaigns, calling lists, skills, dispositions — is the Configuration Web Services API, a SOAP/WSDL service on a separate host pattern (api.<region>.five9.com / api.five9.com /wsadmin/...) with its own admin credentials; this pack registers NOTHING on it. (2) The statistics surface is a second SOAP service (Statistics Web Services); this pack registers nothing on it either. (3) The Agent and Supervisor REST API — session-scoped, for real-time call control and supervision — is what this pack covers: agent-context paths under /appsvcs/rs/svc and supervisor-context paths under /supsvcs/rs/svc. Do not read any capability here as governing Five9 administration; domain administration is a different registration requiring its own review. HOST SUBSTITUTION: the REST API host and port are not fixed — the session metadata endpoint (https://app.five9.com/appsvcs/rs/svc/auth/metadata, called with the logged-in session) returns the data center's API host and port (metadata.dataCenters[].apiUrls[]), and the client builds https://<host>:<port> from them. The endpoint host 'five9-vcc.invalid' is a reserved non-production placeholder (an RFC 2606 reserved TLD): substitute the customer's data-center API host before enabling, in every endpoint, in the resource locators and in every egress allowlist entry — the allowlist matches exactly, so all three must be substituted together, and substitution is a required deployment step. If the data-center API port is not 443, the deployment must also review the port: the egress allowlist entry here is the authority only. AUTHENTICATION: the retrieved boilerplate calls the REST API with browser session credentials (fetch credentials: 'include') from an already-logged-in Five9 VCC session — the retrieved material does not document a token-based scheme for this API, and the pack's credential note registers the session cookie honestly as a vault-held, externally-refreshed value rather than pretending a bearer scheme was verified; whether the gated developer guide documents HTTP Basic or token auth for server-side callers is an open review item. Tiering rationale: calls.make_external places a live outbound call to an end recipient and is registered as create and send at the R3 floor — send is one of the IRREVERSIBLE ACTIONS (delete, send, pay, deploy, approve, share and transfer). calls.dispose finishes a call and sets its disposition per the retrieved starter-kit wording; whether disposal terminates an active call in every documented state is unverified against the gated guide — this pack treats it as hanging up a live customer interaction. The action floor for update is R2, but ending an in-progress customer call cannot be undone, so this pack registers it at R3 on effect. Documented exclusions — this pack does not register: the Configuration Web Services API and Statistics Web Services (separate SOAP admin and reporting surfaces, excluded outright); call-recording views and recording downloads (POST /supsvcs/rs/svc/supervisors/{id}/agents/{id}/recording_views — bulk access to recorded customer conversations); contact record deletion and DNC (do-not-call) list mutations; campaign start/stop and list loading (admin operations driving mass outbound dialing); supervisor monitoring, whisper and barge-in on live calls; and the WebSocket event channels — each is a different registration requiring its own review, and none is approximated here.

Review record

Draft review record dated 2026-09-21 · Reviewer: aaes-eng (an opaque id that resolves internally to the responsible reviewer)

A pack review is not a vendor or examiner attestation. A retrieval date says when a source page was read; it does not by itself establish what the page said then. No pack is vendor-endorsed, and none has been connectivity-tested against a live vendor tenant.