PortSIP ONE Desktop App
Last updated
Last updated
The PortSIP ONE app is compatible only with PortSIP PBX version 22.0 or higher. It does not support PortSIP PBX version 16.x.
To download the latest version of PortSIP ONE for Windows desktop, visit the PortSIP website. The application is provided as an MSI installer. Simply double-click the downloaded file to start the installation process.
This guide applies to both PortSIP ONE for Windows and PortSIP ONE WebRTC.
The PortSIP ONE app makes logging in effortless by using a QR code. Please follow the below steps to process.
If the SMTP server has been configured in PortSIP PBX by the tenant manager, the PBX will automatically email the account information and QR code to the extension user upon successful extension creation.
As a tenant manager, you can also manually access and manage QR codes by following these steps:
Sign in to the PBX web portal as the tenant manager.
Navigate to Call Manager > Users to list all users.
Select a user by either clicking Edit or double-clicking their name.
The user’s QR code will be displayed. To refresh the QR code, click on it.
Within the Extension tab of a user’s settings, there are two QR code configuration options:
Preferred transport for QR code:
This dropdown menu lets you specify the preferred transport protocol (e.g., TCP, UDP) for the QR code. When scanning the QR code to register with the PBX, the PortSIP ONE app will prioritize this setting.
Generate a QR Code with the network interface below:
Use this option to designate the Outbound Proxy Server for the PortSIP ONE app when scanning the QR code to log in to the PBX.
Important Note: If you modify the PBX IP address or adjust either of the above options, you must refresh the QR code by clicking on it to ensure the updated configuration is applied.
The PortSIP ONE app makes logging in effortless by using a QR code. On the PortSIP ONE login window, click the QR code icon located at the bottom-right corner. Select the QR code option, and then scan the QR code provided by the PBX. The app will log in automatically.
Once you have configured the Microsoft 365 integration and synced Microsoft 365 users with PortSIP PBX users, you can log into the PortSIP ONE app using your Microsoft 365 credentials.
Ensure your tenant has successfully configured the Microsoft 365 integration.
Verify that the users have been properly synced and provisioned to PortSIP PBX.
Launch the PortSIP ONE app: Open the PortSIP ONE app (either the Windows desktop app or WebRTC app).
Enter Connection Information:
In the login window, enter your tenant’s SIP domain and the PBX IP address or hostname/domain.
Click the Next button to proceed.
SSO Authentication via Microsoft 365:
If the Microsoft 365 integration is configured correctly, the PortSIP ONE app will detect your tenant and display the Microsoft 365 logo (as shown in the screenshot below).
Click on the Microsoft 365 logo to initiate the authentication process.
Login to Microsoft 365:
A browser window will automatically open, directing you to the Microsoft 365 portal.
Enter your Microsoft 365 username and password to sign in.
After successfully logging into Microsoft 365, the PortSIP ONE app will automatically log you into the PortSIP PBX.
You can manually input user details in the PortSIP ONE app to log in to the PortSIP PBX. In this example, we assume the following configurations:
The PortSIP PBX and SBC are installed on a server with:
Public IP: 66.175.221.120
Private IP: 192.168.1.72
The PBX web domain uc.portsip.cc resolves to the PBX server’s public IP: 66.175.221.120.
The PBX is configured with the following transport protocols in the SBC:
UDP on port 5060
TLS on port 5061
TCP on port 5063
WSS on port 5065
A tenant has been created with the SIP domain set as test.io.
Based on these configurations, after signing in to the PBX as the system administrator, you will see a page similar to the screenshot below.
At the PortSIP ONE login window, provide the following details:
SIP Domain: Enter the tenant's SIP domain. For this example, the SIP domain is test.io.
Server Address: Enter the PBX server's IP address or web domain:
If logging in from the internet, use the public IP (66.175.221.120).
If logging in from a LAN, use the private IP (192.168.1.72).
Alternatively, you can enter the web domain (uc.portsip.cc) instead of the IP address.
Click Next after entering this information. If the details are correct, the next window will prompt you to enter user credentials.
In the user information window, provide the following:
Username: Enter the username of the extension user. Note that this is not the extension number, but the designated username.
Password: Enter the password for the extension user. This is not the extension password, but the user’s account password.
Click the Sign In button to complete the login process. The PortSIP ONE app will successfully log in to the PortSIP PBX.
Upon signing in, click the Calls tab to navigate to the Calls page. The page is divided into two distinct sections:
Call Log Window: This section displays all incoming, outgoing, and missed calls.
Caller Information Section: This section shows detailed information for the selected caller. The data displayed will update based on the caller you choose.
Click the New Call button. The dial pad will appear.
Enter a valid extension or a phone number.
Click the Call button. The call will be initiated and displayed at the top of the dashboard screen.
Click the New Call button to open the dial pad window.
Next, click the Contacts icon. The dial pad will disappear and be replaced by your contact list.
You can either search for a contact using the search field or scroll through the list.
Once you locate the contact, hover over their name and click the blue phone icon to initiate the call.
Click Contacts in the left menu.
You can filter contacts by Users, Company Contacts, or Personal Contacts.
On the user/contact information page, you can easily place a call by selecting the extension or phone number.
Press the Leave button located at the bottom-right corner to end the current call.
Alternatively, press the End button located at the top-right corner to terminate the active call.
A Blind Transfer occurs when you transfer a call to another person without announcing it first. To perform a blind transfer while on an active call:
Click the Transfer button.
Select Blind Transfer.
From the Contact Panel, select the recipient to whom you wish to transfer the call.
Click the extension. The call will be successfully transferred
You can also transfer the call to a receptionist by the number via the Dial Pad. From the Contact Panel window:
Click the Dial Pad icon.
Enter a valid extension or phone number.
Click the Dial button. The transfer will be completed.
An Attended Transfer occurs when you announce the call to the recipient before transferring it. To perform an attended transfer while on a call:
Click the Transfer button.
Select Attended Transfer.
From the Contact Panel, select the recipient to whom you wish to transfer the call.
Click on that recipient.
Once the party answers, announce the call and click the blinking Transfer Now button. The call will then be transferred.
A Direct-to-Voicemail Transfer is used when you wish to transfer a call directly to another user’s voicemail. To perform a transfer to voicemail while on an active call:
Click the Transfer button.
Select Transfer to Voicemail.
From the Contact Panel, select the recipient to whom you wish to transfer the call to click on it.
The call will be transferred directly to their voicemail.
To park a call to an extension while on an active call:
Click the Transfer button.
Select Park.
From the Contact Panel, select the recipient to whom you wish to park the call and click on their name.
The call will be parked on that extension.
If the user is a member of a park group, they can park a call to the group, allowing group members to retrieve the parked call.
To park a call to the group while on an active call:
Click the Transfer button.
Select Group Park.
The call will be parked to the group if the user is a member of a park group.
Once a call is parked to an extension user or a park group, the extension user or group members will receive a notification. As shown in the screenshot below, the Call HUB icon on the top title bar will start blinking.
Click the HUD icon. The parked call will appear in the list.
Click the Retrieve button to easily retrieve the call.
Call Flip allows you to quickly transfer an active call from PortSIP ONE to another endpoint, such as PortSIP ONE mobile or an IP phone. To perform a Call Flip while on an active call:
Click the Transfer button.
Select Flip.
Your other devices (e.g., PortSIP ONE mobile or IP phone) will ring. Simply answer the call on the other device.
To access your voicemails, click on the Voicemails tab. The page is divided into two sections:
Voicemail Window: This area displays your voicemails, typically organized in chronological order (by date).
Voicemail Details: Located to the right of the voicemail window, this section provides detailed information about each voicemail.
Select the Voicemail Message: In the Voicemail Window, click on the desired message. The message details will appear on the right side of the screen.
Play the Voicemail: Click the Play button to listen to the selected message.
Download the Message: In the Voicemail Details section, click the Download icon button.
Save the File: Choose the desired location on your computer to save the .wav file and confirm the download.
In the Voicemail Window, locate the voicemail message you wish to delete.
Click on the ... (ellipsis) button located at the upper right corner of the message to open the options menu.
From the dropdown menu, select Delete.
Confirm Deletion: A confirmation prompt will appear to verify your intention to delete the selected voicemail.
Click Delete to confirm. The message will be permanently removed from your voicemail section.
To access your contact directory, follow these steps:
Navigate to the Contacts Tab: Click on the Contacts tab located in the main navigation menu.
Understand the Contacts Page Layout:
Contact List Window:
Located on the left side of the page.
Provides access to both your Company Extension Users, Company Contacts List, and Personal Contact.
Allows you to browse, search, and manage your contacts efficiently.
Contact Information Area:
Situated to the right of the Contact List Window.
Displays detailed information about the selected contact.
Updates dynamically based on the contact you choose, showing relevant details and available actions.
Synchronous: The PortSIP ONE app synchronizes your contacts—including extension users, company contacts, and personal contacts—periodically. When you make changes to an extension user or contact, these updates are automatically propagated to all instances of the app. Please note that synchronization is not instantaneous; it may take a short while for the updated information to appear across all devices.
To add a new contact to your directory, follow these steps:
Navigate to the Contacts tab. Click on the New Contact button to open the contact creation window.
Enter Contact Information: In the Add Contact window, fill in the necessary details in the appropriate fields.
If you are a tenant administrator with the necessary permissions to access Company Contacts, you have the option to save a new contact to either Company Contacts or Personal Contacts. This allows you to manage contacts effectively based on their intended usage and accessibility.
Save the Contact: After entering all required information, click the Save button.
Your new contact will now appear in the My Contacts table.
To delete a contact, follow these steps:
Click on the Contacts tab located in the main navigation menu.
Select the Company Contacts or Personal Contact sub-tab to view your contact list.
Select the contact to delete: Locate the contact you wish to remove, and click on the contact to highlight it.
Initiate deletion: Click on the ... (ellipsis) button once the mouse over the contact, or click on the ... (ellipsis) button located at the upper right corner of the contact information.
From the dropdown menu, select Delete.
Confirm deletion
A verification prompt will appear to confirm your intention to delete the contact.
Click Delete to permanently remove the contact.
To efficiently remove multiple contacts at once, follow these steps:
Access the contacts Sub-Tab
Navigate to the Contacts tab in the main navigation menu.
Select either the Company Contacts or Personal Contacts sub-tab, depending on where the contacts you wish to delete are located.
Initiate bulk deletion
Locate the ... (ellipsis) button situated next to the search box within the selected sub-tab.
Click on the Ellipsis button to open additional options.
Select contacts to delete
Delete all contacts:
To remove all contacts within the selected sub-tab, check the Select All checkbox.
Delete all contacts:
To delete specific contacts, individually click on each contact you wish to remove to select them.
Confirm deletion
Click on the Trash icon button to initiate the deletion process.
A verification prompt will appear to confirm your intention to delete the selected contacts.
Click Delete to permanently remove the chosen contacts from your directory.
To quickly access your most frequently used contacts, you can mark them as favorites. Follow these steps to add a contact to your Favorites list:
Click on the Contacts tab located in the main navigation menu.
Select the Users or Company Contacts or Personal Contact sub-tab to view your contact list.
Select the contact: Locate the contact you wish to favor, and click on the contact to highlight it.
Click on the ... (ellipsis) button once the mouse over the contact, or click on the ... (ellipsis) button located at the upper right corner of the contact information.
From the dropdown menu, select Favorites.
Once clicked, a solid yellow star (⭐) will appear next to the contact to confirm that the contact has been successfully added to your Favorites list.
Unfavorite a contact: To remove a contact from your Favorites, follow the same steps. The yellow star will disappear, indicating that the contact is no longer in your favorites.
Both the extension users and contacts can be favored.
PortSIP allows seamless communication within your team through internal extension user chat. If the contact you're messaging isn't an extension user, messages will be sent via SMS, MMS, or a WhatsApp channel, ensuring you're always connected.
To access your team messages, follow these steps:
Navigate to the Messaging Tab: Click on the Messaging tab in the main navigation menu.
Understand the Messaging Interface: The page is divided into two sections:
Messaging List Window: This is where your team messages are displayed. Messages are usually sorted by date and recipient in chronological order.
Message Details Area: On the right, you’ll find the message details section, which updates based on the selected team message. Here, you can view more information about the selected message.
There are three ways to send a new team message:
1. From the contacts menu:
Navigate to the Contacts menu and select the desired extension user.
In the right-hand window, you will see the user's information.
Click the Message Icon (as shown in the below screenshot) to open a chat window and begin composing your message. Note: there have two message icons allow you to send the message.
2. From the messaging menu:
Navigate to the Messaging menu.
On the left side, you will see a list of existing message conversations.
Select an existing conversation to open the chat UI, where you can continue the conversation or start composing a new message.
3. Using the new message button:
Navigate to the Messaging menu and click the New Message button in the upper-right corner.
From the list, select the extension user you wish to message, and click their name to proceed.
Once you’ve entered the chat UI, type your message in the chat window, when you're ready, press Enter on your keyboard to send the message. You can also click the arrow icon to send the message.
Navigate to the Messaging Menu: Go to the Messaging menu within the application.
Create a New Group: Click on the New Group icon. The New Group window will appear.
Name and Customize the Group:
Enter a name for your group chat.
Optionally, add a description for the group to provide more context.
You can also upload a picture for the group by clicking on the Upload Image option.
Add Group Members:
After naming the group, click the Next button to proceed.
From the Extension Users list, select the members you want to add to the group.
Once you've selected all desired members, click Apply to finalize the group creation.
Finish and View the Group: Once the group is created, you will see it listed in the Team Messaging window.
Select the Group: Click on the desired group within the Team Messaging window to open the conversation.
Compose Your Message: Type your message in the chat window field located in the information area.
Send the Message: When you're ready, press Enter on your keyboard to send your message to the group. You can also click the arrow icon to send the message.
