The combined Phone API surface for the Web-Phone umbrella, aggregated from the sub-projects
listed in PROJECTS_DOCS.md. Each sub-project marks its public surface
with @PhoneAPI docstring tags and exports a PHONE_API.md manifest; this page collects those
exposed symbols and the documents that describe them. Copied reference pages live under
projects/<Project>/. Each project lists the symbols it exposes, then a table of documents —
click a document for its full reference page.
Provisioning settings reference — Reference for every runtime phone.Settings.* value applied during phone provisioning.
Exposed: phone.SaveToStorage, phone.LoadFromStorage, phone.IndexStorage.GetBuddyById
| Document | Description |
|---|---|
| phone.SaveToStorage() | Save data to window.localStorage under key. |
| phone.LoadFromStorage() | Read the raw string stored at key. |
| phone.IndexStorage.GetBuddyById() | Fetch a single MyBuddies record by its id. |
Exposed: InitPhoneAPI, phone.Dial, phone.EndCall, phone.Answer, phone.Decline, phone.Hold, phone.Unhold, phone.Mute, phone.Unmute, phone.BlindTransfer, phone.AttendedTransfer, phone.CompleteTransfer, phone.CancelTransfer, phone.SendDtmf, phone.AddBuddy, phone.DeleteBuddy, phone.UpdateBuddy, phone.SaveRecording, phone.GetRecording, phone.PlayRecording, phone.SaveBuddy, phone.AddMessage, phone.SaveMessage, phone.LoadMessage, phone.LoadBuddyMessages, phone.FlagMessage, phone.GetSession, phone.GetActiveSessions, phone.GetSessions, phone.GetBuddySessions, phone.OnSessionChange, phone.OnIncomingCall
| Document | Description |
|---|---|
| InitPhoneAPI() | Initializes the PhoneAPI by attaching all public call-control, buddy-management, and recording methods to the global window.phone object. |
| phone.Dial() | Dials a call to the given param. Works with or without await. |
| phone.EndCall() | Ends a call. Works with or without await. |
| phone.Answer() | Answers an incoming call. Works with or without await. |
| phone.Decline() | Decline a call. |
| phone.Hold() | Places a call on hold. |
| phone.Unhold() | Takes a call off hold. |
| phone.Mute() | Mutes a call. |
| phone.Unmute() | Unmutes a call. |
| phone.BlindTransfer() | Immediately transfers a call to the given destination. |
| phone.AttendedTransfer() | Initiates a consultative (attended) transfer: places the current call on hold and dials the destination. |
| phone.CompleteTransfer() | Completes a pending attended transfer, connecting the original caller to the destination. |
| phone.CancelTransfer() | Cancels a pending attended transfer and restores the original call. |
| phone.SendDtmf() | Send DTMF to a session. |
| phone.AddBuddy() | Adds a new buddy to the PhoneAPI buddy list and persists it. |
| phone.DeleteBuddy() | Deletes a buddy from the PhoneAPI buddy list and triggers related callbacks. |
| phone.UpdateBuddy() | Updates an existing buddy and refreshes the UI after a short delay. |
| phone.SaveRecording() | Saves a call recording to persistent storage. |
| phone.GetRecording() | Retrieves a previously saved recording by its ID. |
| phone.PlayRecording() | Plays a saved recording by object or ID, handling DOM and cleanup. |
| phone.SaveBuddy() | Save a buddy to the storage. |
| phone.AddMessage() | Add a message to the message stream. |
| phone.SaveMessage() | Save a message to the message stream. |
| phone.LoadMessage() | Load a message from the message stream. |
| phone.LoadBuddyMessages() | Load the messages for a buddy. |
| phone.FlagMessage() | Flag a message. |
| phone.GetSession() | Gets a session by id. |
| phone.GetActiveSessions() | Returns all active sessions across every buddy. |
| phone.GetSessions() | Returns all sessions across every buddy. |
| phone.GetBuddySessions() | Returns the sessions belonging to a buddy. |
| phone.OnSessionChange() | Registers a callback for session state changes. |
| phone.OnIncomingCall callback slot | Assignable callback slot the host app sets to receive incoming-call details. |
Last updated: 2026-07-07.