# Phone Integration API TypeScript SDK client for the epilot Phone Integration API: usage with @epilot/sdk, all operations and schemas. - **Base URL:** `https://phone-integration-api.sls.epilot.io` - **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration) ## Usage ```ts import { epilot } from '@epilot/sdk' epilot.authorize(() => '') const { data } = await epilot.phoneIntegration.batchSearchCustomers(...) ``` ### Tree-shakeable import ```ts import { getClient, authorize } from '@epilot/sdk/phone-integration' const phoneIntegrationClient = getClient() authorize(phoneIntegrationClient, () => '') const { data } = await phoneIntegrationClient.batchSearchCustomers(...) ``` ## Operations **phone-integration** - [`batchSearchCustomers`](#batchsearchcustomers) - [`getActiveCall`](#getactivecall) - [`reportActiveCall`](#reportactivecall) - [`clearActiveCall`](#clearactivecall) **manager** - [`getManagerStatus`](#getmanagerstatus) - [`listPhoneAgents`](#listphoneagents) - [`assignPhoneAgent`](#assignphoneagent) - [`removePhoneAgent`](#removephoneagent) - [`getLiveSnapshot`](#getlivesnapshot) - [`listLiveAgents`](#listliveagents) - [`setAgentRouting`](#setagentrouting) - [`previewAgentRouting`](#previewagentrouting) - [`setAgentPresence`](#setagentpresence) - [`listAgentPresences`](#listagentpresences) - [`listQueues`](#listqueues) - [`getQueue`](#getqueue) - [`getCallReport`](#getcallreport) - [`getLiveKpis`](#getlivekpis) - [`getAgentPerformance`](#getagentperformance) - [`listMissedCalls`](#listmissedcalls) - [`requestMissedCallCallback`](#requestmissedcallcallback) - [`getAgentActivity`](#getagentactivity) - [`getQueueSettings`](#getqueuesettings) - [`setQueueSettings`](#setqueuesettings) - [`getCallHandlingSettings`](#getcallhandlingsettings) - [`setCallHandlingSettings`](#setcallhandlingsettings) - [`getQueuePerformance`](#getqueueperformance) - [`listSkills`](#listskills) - [`createSkill`](#createskill) - [`deleteSkill`](#deleteskill) - [`setQueueSkill`](#setqueueskill) - [`removeQueueSkill`](#removequeueskill) **operator** - [`listProviderSetups`](#listprovidersetups) - [`getProviderSetup`](#getprovidersetup) - [`setupProvider`](#setupprovider) **Schemas** - [`ManagerStatus`](#managerstatus) - [`PhoneAgent`](#phoneagent) - [`AssignPhoneAgentRequest`](#assignphoneagentrequest) - [`ProviderSetup`](#providersetup) - [`ProviderSetupSummary`](#providersetupsummary) - [`ProviderSetupRequest`](#providersetuprequest) - [`CustomerBatchSearchResult`](#customerbatchsearchresult) - [`CustomerSearchResult`](#customersearchresult) - [`CustomerIdentifier`](#customeridentifier) - [`CustomerSummary`](#customersummary) - [`ActiveCall`](#activecall) - [`ActiveCallReport`](#activecallreport) - [`AgentState`](#agentstate) - [`AgentPresence`](#agentpresence) - [`AgentPresenceRequest`](#agentpresencerequest) - [`AgentPresenceChange`](#agentpresencechange) - [`Skill`](#skill) - [`QueueRef`](#queueref) - [`PersonRef`](#personref) - [`EligibilityPath`](#eligibilitypath) - [`AgentQueueEligibility`](#agentqueueeligibility) - [`LiveAgent`](#liveagent) - [`LiveAgentCounters`](#liveagentcounters) - [`QueueHealth`](#queuehealth) - [`QueueLive`](#queuelive) - [`LiveSnapshot`](#livesnapshot) - [`QueueRoutingStep`](#queueroutingstep) - [`QueueOverview`](#queueoverview) - [`EligibleAgent`](#eligibleagent) - [`WaitingCall`](#waitingcall) - [`QueueDetail`](#queuedetail) - [`AgentRoutingRequest`](#agentroutingrequest) - [`AgentRouting`](#agentrouting) - [`AgentRoutingPreview`](#agentroutingpreview) - [`CallReport`](#callreport) - [`QueuePerformance`](#queueperformance) - [`QueuePerformanceReport`](#queueperformancereport) - [`SkillCatalogueEntry`](#skillcatalogueentry) - [`SkillCatalogue`](#skillcatalogue) - [`CreateSkillRequest`](#createskillrequest) - [`SkillDeletion`](#skilldeletion) - [`QueueSkillChange`](#queueskillchange) - [`ErrorResponse`](#errorresponse) - [`KpiPeriod`](#kpiperiod) - [`LiveKpis`](#livekpis) - [`AgentPerformance`](#agentperformance) - [`AgentPerformanceReport`](#agentperformancereport) - [`MissedCallCaller`](#missedcallcaller) - [`MissedCallCallback`](#missedcallcallback) - [`MissedCallCallbackRequest`](#missedcallcallbackrequest) - [`MissedCall`](#missedcall) - [`MissedCallList`](#missedcalllist) - [`AgentActivityEvent`](#agentactivityevent) - [`AgentPresenceTotal`](#agentpresencetotal) - [`AgentActivity`](#agentactivity) - [`QueueSettingsUpdate`](#queuesettingsupdate) - [`QueueSettings`](#queuesettings) - [`WrapUpTimes`](#wrapuptimes) - [`CallHandlingSettings`](#callhandlingsettings) ### `batchSearchCustomers` Resolves up to 50 identifiers to epilot customers (Contacts) in one request — for example every number in an agent's call history. `GET /v1/customer:batchSearch` ```ts const { data } = await client.batchSearchCustomers({ id: ['...'], customer_number: ['...'], external_id: ['...'], phone_number: ['...'], email: ['...'], x-trace-id: 'example', }) ```
Response ```json { "results": [ { "identifier": { "type": "id", "value": "+4917012345678" }, "status": "found", "customer": { "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624", "name": "Max Mustermann", "customer_number": "4711" } } ] } ```
--- ### `getActiveCall` Whether the signed-in user is on a phone call right now, and which conversation it is. The answer is about the caller only (the user of the bearer token). `GET /v1/calls/active` ```ts const { data } = await client.getActiveCall() ```
Response ```json { "on_call": true, "conversation_id": "01KW704DAM1PM5SDGKFDY9BNK0", "started_at": "1970-01-01T00:00:00.000Z", "source": "softphone", "expires_at": "1970-01-01T00:00:00.000Z" } ```
--- ### `reportActiveCall` Reports the call the signed-in user is on. Sent by the epilot 360 phone when a call is answered and again every 30 seconds while it lasts: a report is valid for 2 minutes (`expires_at`), so a phone th `PUT /v1/calls/active` ```ts const { data } = await client.reportActiveCall( null, { conversation_id: '01KW704DAM1PM5SDGKFDY9BNK0', started_at: '2026-11-10T10:00:00.000Z' }, ) ```
Response ```json { "on_call": true, "conversation_id": "01KW704DAM1PM5SDGKFDY9BNK0", "started_at": "1970-01-01T00:00:00.000Z", "source": "softphone", "expires_at": "1970-01-01T00:00:00.000Z" } ```
--- ### `clearActiveCall` Clears the signed-in user's reported call, when their part of it ended (hung up, or handed over to another agent). With `conversation_id`, only a report of that conversation is cleared, so a late "cal `DELETE /v1/calls/active` ```ts const { data } = await client.clearActiveCall({ conversation_id: 'example', }) ``` --- ### `getManagerStatus` Whether the caller's organization is ready for phone agents: the telephony provider tenant exists and is configured. The control center shows a "not set up" state when `ready` is false. Requires `phon `GET /v1/manager/status` ```ts const { data } = await client.getManagerStatus() ```
Response ```json { "provider": "babelforce", "ready": true, "reasons": ["provider_tenant_missing"] } ```
--- ### `listPhoneAgents` Organization members who hold the phone (`phone:use`), each joined with the provider user behind them. Requires `phone:manage`. `GET /v1/manager/agents` ```ts const { data } = await client.listPhoneAgents() ```
Response ```json { "results": [ { "user_id": "string", "email": "string", "display_name": "string", "status": "active", "provider_user_id": "string", "provider_roles": ["string"], "assigned_at": "1970-01-01T00:00:00.000Z", "assigned_by": "string" } ] } ```
--- ### `assignPhoneAgent` Gives an organization member the phone. In order: the member is verified with user-api, their pairwise subject for the provider is read from identity-api, the provider user is created (or found) bound `POST /v1/manager/agents` ```ts const { data } = await client.assignPhoneAgent( null, { user_id: 'string' }, ) ```
Response ```json { "user_id": "string", "email": "string", "display_name": "string", "status": "active", "provider_user_id": "string", "provider_roles": ["string"], "assigned_at": "1970-01-01T00:00:00.000Z", "assigned_by": "string" } ```
--- ### `removePhoneAgent` Takes the phone away from a member: the `phone_agent` role is removed first, then the provider user is deactivated (never deleted: call history keeps referring to it). Requires `phone:manage`. `DELETE /v1/manager/agents/{user_id}` ```ts const { data } = await client.removePhoneAgent({ user_id: 'example', }) ``` --- ### `getLiveSnapshot` One snapshot of the organization's live phone state for the control center's Overview: agent presence counters and per-queue health (waiting calls, longest wait, eligible vs available agents). The pro `GET /v1/manager/live` ```ts const { data } = await client.getLiveSnapshot() ```
Response ```json { "captured_at": "1970-01-01T00:00:00.000Z", "agents": { "total": 0, "online": 0, "available": 0, "on_call": 0, "wrap_up": 0, "offline": 0 }, "queues": [ { "id": "string", "name": "string", "waiting": 0, "longest_wait_seconds": 0, "expected_wait_seconds": 0, "eligible": 0, "available": 0, "health": "healthy" } ], "calls_waiting": 0, "longest_wait_seconds": 0, "expected_wait_seconds": 0 } ```
--- ### `listLiveAgents` The organization's phone agents with their live phone status, their skills (as the phone system holds them) and the queues they can take calls from. Agents that are epilot phone agents carry the epilo `GET /v1/manager/agents/live` ```ts const { data } = await client.listLiveAgents() ```
Response ```json { "captured_at": "1970-01-01T00:00:00.000Z", "results": [ { "provider_agent_id": "string", "user_id": "string", "name": "string", "email": "string", "enabled": true, "state": "available", "presence": { "name": "string", "label": "string", "available": true }, "display_status": "string", "skills": ["string"], "queues": [ { "id": "string", "name": "string", "via": ["skill"], "skills": ["string"], "locked": true } ], "current_call": { "started_at": "1970-01-01T00:00:00.000Z", "queue_name": "string" } } ] } ```
--- ### `setAgentRouting` Sets an agent's skills and direct queue membership (full sets, not deltas), in this order: 1. Skills: the agent's skills in the phone system are replaced by `skills` (lowercased, see `Skill`), so t `PUT /v1/manager/agents/{provider_agent_id}/routing` ```ts const { data } = await client.setAgentRouting( { provider_agent_id: 'example', }, { skills: ['string'], queue_ids: ['string'], include_own_steps: false }, ) ```
Response ```json { "provider_agent_id": "string", "skills": ["string"], "queues": [ { "id": "string", "name": "string", "via": ["skill"], "skills": ["string"], "locked": true } ] } ```
--- ### `previewAgentRouting` The routing impact of `setAgentRouting` with the same body, without changing anything: the queues the agent can take calls from now (as the phone system routes today) and after the change, what is add `POST /v1/manager/agents/{provider_agent_id}/routing:preview` ```ts const { data } = await client.previewAgentRouting( { provider_agent_id: 'example', }, { skills: ['string'], queue_ids: ['string'], include_own_steps: false }, ) ```
Response ```json { "provider_agent_id": "string", "before": [ { "id": "string", "name": "string" } ], "after": [ { "id": "string", "name": "string" } ], "added": [ { "id": "string", "name": "string" } ], "removed": [ { "id": "string", "name": "string" } ], "coverage_lost": [ { "id": "string", "name": "string" } ], "locked": [ { "id": "string", "name": "string" } ] } ```
--- ### `setAgentPresence` Puts the agent on one of the phone system's presences (`listAgentPresences`), as the agent could in the phone app. A presence that is not `available` stops queue calls to the agent until it changes ag `PUT /v1/manager/agents/{provider_agent_id}/presence` ```ts const { data } = await client.setAgentPresence( { provider_agent_id: 'example', }, { presence: 'string' }, ) ```
Response ```json { "provider_agent_id": "string", "presence": { "name": "string", "label": "string", "available": true } } ```
--- ### `listAgentPresences` The presences the organization's agents can be on (e.g. Available, Break, Meeting), as the phone system defines them. `available` presences let agents take queue calls. Requires `phone:manage`. `GET /v1/manager/presences` ```ts const { data } = await client.listAgentPresences() ```
Response ```json { "results": [ { "name": "string", "label": "string", "available": true } ] } ```
--- ### `listQueues` The organization's queues with live demand (waiting calls, longest wait), staffing (eligible vs available agents), derived health and who can take their calls: the routing steps in the order the phone `GET /v1/manager/queues` ```ts const { data } = await client.listQueues() ```
Response ```json { "captured_at": "1970-01-01T00:00:00.000Z", "results": [ { "id": "string", "name": "string", "waiting": 0, "longest_wait_seconds": 0, "expected_wait_seconds": 0, "eligible": 0, "available": 0, "health": "healthy", "numbers": ["string"], "routing": [ { "id": "string", "order": 0, "label": "string", "enabled": true, "skills": ["string"], "people": [ { "provider_agent_id": "string", "user_id": "string", "name": "string" } ], "team_members": ["string"], "managed_by_epilot": true } ] } ] } ```
--- ### `getQueue` One queue for the control center's queue drawer: the overview fields plus the agents currently eligible for it (with live status and how they are eligible) and the calls waiting in it. Requires `phone `GET /v1/manager/queues/{queue_id}` ```ts const { data } = await client.getQueue({ queue_id: 'example', }) ```
Response ```json { "id": "string", "name": "string", "waiting": 0, "longest_wait_seconds": 0, "expected_wait_seconds": 0, "eligible": 0, "available": 0, "health": "healthy", "numbers": ["string"], "routing": [ { "id": "string", "order": 0, "label": "string", "enabled": true, "skills": ["string"], "people": [ { "provider_agent_id": "string", "user_id": "string", "name": "string" } ], "team_members": ["string"], "managed_by_epilot": true } ], "captured_at": "1970-01-01T00:00:00.000Z", "eligible_agents": [ { "provider_agent_id": "string", "user_id": "string", "name": "string", "email": "string", "state": "available", "presence": { "name": "string", "label": "string", "available": true }, "via": ["skill"], "skills": ["string"] } ], "waiting_calls": [ { "id": "string", "from_masked": "string", "contact": { "id": "string", "name": "string" }, "waited_seconds": 0, "state": "string" } ] } ```
--- ### `getCallReport` Inbound call outcomes for a period, from the provider's call reporting: how many inbound calls there were, how many an agent handled (bridged) and how many ended without an agent (abandoned or failed) `GET /v1/manager/reporting/calls` ```ts const { data } = await client.getCallReport({ from: 'example', to: 'example', }) ```
Response ```json { "from": "1970-01-01T00:00:00.000Z", "to": "1970-01-01T00:00:00.000Z", "inbound_total": 0, "handled_by_agent": 0, "abandoned_or_failed": 0, "previous_period": { "from": "1970-01-01T00:00:00.000Z", "to": "1970-01-01T00:00:00.000Z", "inbound_total": 0 } } ```
--- ### `getLiveKpis` Service KPIs of the organization's phone team for a period: call counts, abandon rate, waits and handling times, from the provider's metrics or, where it has none, its call reporting. A KPI the provid `GET /v1/manager/live/kpis` ```ts const { data } = await client.getLiveKpis({ period: 'example', from: 'example', to: 'example', }) ```
Response ```json { "captured_at": "1970-01-01T00:00:00.000Z", "period": "today", "calls_total": 0, "answered_total": 0, "abandoned_total": 0, "abandon_rate_percent": 0, "average_wait_seconds": 0, "longest_wait_seconds": 0, "average_talk_seconds": 0, "average_handle_seconds": 0, "average_hold_seconds": 0 } ```
--- ### `getAgentPerformance` Per-agent performance for a period from the provider's call reporting: calls handled and talk, hold, wrap-up and handle times, one row per agent who handled at least one call. Agents that are epilot p `GET /v1/manager/reporting/agents` ```ts const { data } = await client.getAgentPerformance({ from: 'example', to: 'example', }) ```
Response ```json { "from": "1970-01-01T00:00:00.000Z", "to": "1970-01-01T00:00:00.000Z", "results": [ { "provider_agent_id": "string", "user_id": "string", "name": "string", "calls_handled": 0, "outbound_calls": 0, "talk_seconds_total": 0, "talk_seconds_average": 0, "hold_seconds_total": 0, "wrap_up_seconds_average": 0, "handle_seconds_average": 0 } ] } ```
--- ### `listMissedCalls` Callers who did not reach an agent in a period, newest first, one row per caller: an inbound call (grouped by the provider's session, so transfer legs count once) that ended without being bridged to a `GET /v1/manager/missed-calls` ```ts const { data } = await client.listMissedCalls({ from: 'example', to: 'example', }) ```
Response ```json { "from": "1970-01-01T00:00:00.000Z", "to": "1970-01-01T00:00:00.000Z", "results": [ { "call_id": "string", "last_missed_at": "1970-01-01T00:00:00.000Z", "first_missed_at": "1970-01-01T00:00:00.000Z", "attempts": 1, "queue": { "id": "string", "name": "string" }, "longest_wait_seconds": 0, "caller": { "anonymous": true, "number_masked": "string", "contact": { "id": "string", "name": "string" } }, "resolved": true, "can_call_back": true, "callback": { "state": "queued", "requested_at": "1970-01-01T00:00:00.000Z", "requested_by": "string", "queue": { "id": "string", "name": "string" }, "callback_call_id": "string" } } ] } ```
--- ### `requestMissedCallCallback` Asks the phone system to call the caller of a missed call back: the provider queues an outbound callback on a queue (the missed call's queue unless `queue_id` names another), so the next eligible agen `POST /v1/manager/missed-calls/{call_id}/callback` ```ts const { data } = await client.requestMissedCallCallback( { call_id: 'example', }, { queue_id: 'string' }, ) ``` --- ### `getAgentActivity` An agent's activity in a period from the provider's agent logs: presence changes and calls in time order, the time spent on each presence and the number of calls handled. The window is at most 31 days `GET /v1/manager/agents/{provider_agent_id}/activity` ```ts const { data } = await client.getAgentActivity({ provider_agent_id: 'example', from: 'example', to: 'example', }) ```
Response ```json { "provider_agent_id": "string", "from": "1970-01-01T00:00:00.000Z", "to": "1970-01-01T00:00:00.000Z", "events": [ { "at": "1970-01-01T00:00:00.000Z", "kind": "presence", "presence": { "name": "string", "label": "string", "available": true }, "call": { "call_id": "string", "direction": "inbound", "queue_name": "string", "duration_seconds": 0 }, "description": "string" } ], "presence_totals": [ { "presence": { "name": "string", "label": "string", "available": true }, "seconds": 0 } ], "calls_handled": 0 } ```
--- ### `getQueueSettings` A queue's call handling settings as the phone system holds them: how many callers may wait, how long an agent's phone rings, the wrap-up time after a call and how many agents are tried per call. Requi `GET /v1/manager/queues/{queue_id}/settings` ```ts const { data } = await client.getQueueSettings({ queue_id: 'example', }) ```
Response ```json { "queue_id": "string", "name": "string", "max_size": 0, "ring_timeout_seconds": 5, "wrap_up_seconds": 0, "max_dial_count": 1 } ```
--- ### `setQueueSettings` Replaces a queue's call handling settings (all fields, not a delta); the phone system applies them to the next call. The queue's name and routing are not changed. Requires `phone:manage`. `PUT /v1/manager/queues/{queue_id}/settings` ```ts const { data } = await client.setQueueSettings( { queue_id: 'example', }, { max_size: 0, ring_timeout_seconds: 5, wrap_up_seconds: 0, max_dial_count: 1 }, ) ```
Response ```json { "queue_id": "string", "name": "string", "max_size": 0, "ring_timeout_seconds": 5, "wrap_up_seconds": 0, "max_dial_count": 1 } ```
--- ### `getCallHandlingSettings` The organization's call handling settings for all agents: wrap-up rules (including whether agents may call out during wrap-up), wrap-up times after unsuccessful calls, and recording defaults. Requires `GET /v1/manager/settings/call-handling` ```ts const { data } = await client.getCallHandlingSettings() ```
Response ```json { "wrap_up": { "inbound_cancel_allowed": true, "inbound_extend_allowed": true, "inbound_max_extension_seconds": 0, "outbound_enabled": true, "outbound_cancel_allowed": true, "outbound_extend_allowed": true, "outbound_max_extension_seconds": 0, "outbound_calls_allowed": true }, "after_unsuccessful_inbound": { "busy_seconds": 0, "unreachable_seconds": 0, "declined_seconds": 0 }, "after_unsuccessful_outbound": { "busy_seconds": 0, "unreachable_seconds": 0, "declined_seconds": 0 }, "recording": { "always_record_outbound": true, "agents_may_delete": true, "hide_recording_controls": true } } ```
--- ### `setCallHandlingSettings` Replaces the organization's call handling settings (the full object, not a delta). Requires `phone:manage`. `PUT /v1/manager/settings/call-handling` ```ts const { data } = await client.setCallHandlingSettings( null, { wrap_up: { inbound_cancel_allowed: true, inbound_extend_allowed: true, inbound_max_extension_seconds: 0, outbound_enabled: true, outbound_cancel_allowed: true, outbound_extend_allowed: true, outbound_max_extension_seconds: 0, outbound_calls_allowed: true }, after_unsuccessful_inbound: { busy_seconds: 0, unreachable_seconds: 0, declined_seconds: 0 }, after_unsuccessful_outbound: { busy_seconds: 0, unreachable_seconds: 0, declined_seconds: 0 }, recording: { always_record_outbound: true, agents_may_delete: true, hide_recording_controls: true } }, ) ```
Response ```json { "wrap_up": { "inbound_cancel_allowed": true, "inbound_extend_allowed": true, "inbound_max_extension_seconds": 0, "outbound_enabled": true, "outbound_cancel_allowed": true, "outbound_extend_allowed": true, "outbound_max_extension_seconds": 0, "outbound_calls_allowed": true }, "after_unsuccessful_inbound": { "busy_seconds": 0, "unreachable_seconds": 0, "declined_seconds": 0 }, "after_unsuccessful_outbound": { "busy_seconds": 0, "unreachable_seconds": 0, "declined_seconds": 0 }, "recording": { "always_record_outbound": true, "agents_may_delete": true, "hide_recording_controls": true } } ```
--- ### `getQueuePerformance` Inbound call outcomes per queue for a period, derived from the provider's call reporting (the phone system has no per-queue report): every inbound call that started in [from, to) is counted for the qu `GET /v1/manager/reporting/queues` ```ts const { data } = await client.getQueuePerformance({ from: 'example', to: 'example', }) ```
Response ```json { "from": "1970-01-01T00:00:00.000Z", "to": "1970-01-01T00:00:00.000Z", "results": [ { "queue": { "id": "string", "name": "string" }, "inbound_total": 0, "handled_by_agent": 0, "abandoned_or_failed": 0, "abandon_rate_percent": 0, "average_wait_seconds": 0 } ] } ```
--- ### `listSkills` The organization's skill catalogue: the skills epilot keeps for it (created in the control center, `source: epilot`) together with every skill the phone system already uses on an agent or in a queue's `GET /v1/manager/skills` ```ts const { data } = await client.listSkills() ```
Response ```json { "results": [ { "tag": "string", "source": "epilot", "created_at": "1970-01-01T00:00:00.000Z", "created_by": "string" } ] } ```
--- ### `createSkill` Adds a skill to the organization's catalogue (epilot only: nothing is written to the phone system until an agent gets the skill or a queue accepts it). The skill is trimmed, must then be 1 to 100 char `POST /v1/manager/skills` ```ts const { data } = await client.createSkill( null, { tag: 'string' }, ) ```
Response ```json { "tag": "string", "source": "epilot", "created_at": "1970-01-01T00:00:00.000Z", "created_by": "string" } ```
--- ### `deleteSkill` Deletes a skill everywhere (in any letter case, see `Skill`): it is taken from every agent that has it and from every routing step of every queue that accepts it in the phone system, then removed from `DELETE /v1/manager/skills/{tag}` ```ts const { data } = await client.deleteSkill({ tag: 'example', }) ```
Response ```json { "tag": "string", "agents_updated": 0, "queues_updated": 0 } ```
--- ### `setQueueSkill` The queue accepts the skill: every agent with it can take the queue's calls. epilot adds the skill to the queue's FIRST enabled routing step of the organization's own in the phone system (lowest order `PUT /v1/manager/queues/{queue_id}/skills/{tag}` ```ts const { data } = await client.setQueueSkill({ queue_id: 'example', tag: 'example', }) ```
Response ```json { "queue": { "id": "string", "name": "string" }, "tag": "string", "accepted": true, "step": { "id": "string", "label": "string" } } ```
--- ### `removeQueueSkill` The queue no longer accepts the skill: it is removed from every routing step of the queue that lists it (enabled or not). Idempotent. Requires `phone:manage`. `DELETE /v1/manager/queues/{queue_id}/skills/{tag}` ```ts const { data } = await client.removeQueueSkill({ queue_id: 'example', tag: 'example', }) ```
Response ```json { "queue": { "id": "string", "name": "string" }, "tag": "string", "accepted": true, "step": { "id": "string", "label": "string" } } ```
--- ### `listProviderSetups` Every organization that has a telephony provider tenant, for the admin portal's overview: the provider's sub-accounts (one per organization, keyed by the organization id) joined with this service's se `GET /v1/operator/provider-setups` ```ts const { data } = await client.listProviderSetups() ```
Response ```json { "results": [ { "org_id": "string", "provider": "babelforce", "ready": true, "setup_recorded": true, "tenant": { "id": "string", "name": "string", "org_key": "string" }, "sso_identity_client_id": "string", "last_setup_by": "string", "updated_at": "1970-01-01T00:00:00.000Z" } ] } ```
--- ### `getProviderSetup` What has been set up at the telephony provider for this organization. `GET /v1/operator/organizations/{org_id}/provider` ```ts const { data } = await client.getProviderSetup({ org_id: 'example', }) ```
Response ```json { "provider": "babelforce", "org_id": "string", "ready": true, "tenant": { "id": "string", "name": "string", "org_key": "string", "created_at": "1970-01-01T00:00:00.000Z" }, "scim": { "configured": true, "roles_enabled": true }, "sso": { "configured": true, "identity_client_id": "string", "configured_at": "1970-01-01T00:00:00.000Z" }, "last_setup_by": "string" } ```
--- ### `setupProvider` Prepares the telephony provider for an organization, idempotently and in order: the provider tenant (Babelforce sub-account keyed by the organization id), its SCIM configuration with role management o `POST /v1/operator/organizations/{org_id}/provider:setup` ```ts const { data } = await client.setupProvider( { org_id: 'example', }, { account_name: 'string', identity_client_id: 'string', identity_client_secret: 'stringstring' }, ) ```
Response ```json { "provider": "babelforce", "org_id": "string", "ready": true, "tenant": { "id": "string", "name": "string", "org_key": "string", "created_at": "1970-01-01T00:00:00.000Z" }, "scim": { "configured": true, "roles_enabled": true }, "sso": { "configured": true, "identity_client_id": "string", "configured_at": "1970-01-01T00:00:00.000Z" }, "last_setup_by": "string" } ```
--- ## Schemas ### `ManagerStatus` ```ts type ManagerStatus = { provider: "babelforce" ready: boolean reasons: "provider_tenant_missing" | "sso_not_configured" | "scim_not_configured" | "identity_enablement_missing"[] } ``` ### `PhoneAgent` ```ts type PhoneAgent = { user_id: string email: string display_name?: string status: "active" | "pending" | "disabled" | "missing_provider" | "missing_role" provider_user_id?: string provider_roles?: string[] assigned_at?: string // date-time assigned_by?: string } ``` ### `AssignPhoneAgentRequest` ```ts type AssignPhoneAgentRequest = { user_id: string } ``` ### `ProviderSetup` ```ts type ProviderSetup = { provider: "babelforce" org_id: string ready: boolean tenant: { id: string name: string org_key: string created_at?: string // date-time } scim: { configured: boolean roles_enabled: boolean } sso: { configured: boolean identity_client_id?: string configured_at?: string // date-time } last_setup_by?: string } ``` ### `ProviderSetupSummary` One organization's provider setup, as listed in the overview (no live SCIM or SSO reads). ```ts type ProviderSetupSummary = { org_id: string provider: "babelforce" ready: boolean setup_recorded: boolean tenant: { id: string name: string org_key: string } sso_identity_client_id?: string last_setup_by?: string updated_at?: string // date-time } ``` ### `ProviderSetupRequest` ```ts type ProviderSetupRequest = { account_name?: string identity_client_id: string identity_client_secret: string } ``` ### `CustomerBatchSearchResult` ```ts type CustomerBatchSearchResult = { results: Array<{ identifier: { type: { ... } value: { ... } } status: "found" | "not_found" | "ambiguous" | "invalid" | "error" customer?: { id: { ... } name: { ... } customer_number?: { ... } } }> } ``` ### `CustomerSearchResult` ```ts type CustomerSearchResult = { identifier: { type: "id" | "customer_number" | "external_id" | "phone_number" | "email" value: string } status: "found" | "not_found" | "ambiguous" | "invalid" | "error" customer?: { id: string name: string customer_number?: string } } ``` ### `CustomerIdentifier` ```ts type CustomerIdentifier = { type: "id" | "customer_number" | "external_id" | "phone_number" | "email" value: string } ``` ### `CustomerSummary` Present when `status` is `found` ```ts type CustomerSummary = { id: string name: string customer_number?: string } ``` ### `ActiveCall` The phone call a user is on right now. ```ts type ActiveCall = { on_call: boolean conversation_id?: string started_at?: string // date-time source?: "softphone" | "provider" expires_at?: string // date-time } ``` ### `ActiveCallReport` ```ts type ActiveCallReport = { conversation_id: string started_at?: string } ``` ### `AgentState` The agent's live line state as the provider reports it, plus `busy` for anyone who cannot take a queue call for a reason other than a call: on a presence that takes no calls (e.g. Busy, Break), without a presence, or disabled at the provider; `busy` also covers the provider's busy line state. `unkno ```ts type AgentState = "available" | "ringing" | "in_call" | "wrap_up" | "busy" | "declined" | "unreachable" | "selected" | "offline" | "unknown" ``` ### `AgentPresence` The provider presence the agent has selected (e.g. Available, Break, Meeting) ```ts type AgentPresence = { name: string label: string available: boolean } ``` ### `AgentPresenceRequest` ```ts type AgentPresenceRequest = { presence: string } ``` ### `AgentPresenceChange` ```ts type AgentPresenceChange = { provider_agent_id: string presence: { name: string label: string available: boolean } } ``` ### `Skill` A skill as the phone system holds it (Babelforce: an agent tag). epilot's convention for skills is `: