Skip to main content

UCaaS Web Phone

Updated

The UCaaS webphone allows users to quickly move a conversation from text to voice calls and allows users to manual dial their customers. We've created a UCaaS webphone widget that allows you to add webrtc webphone capabilities in your CRM and internal systems.

What does it looks like?

Once the phone is installed into your system there are three modes for the phone.

The first is a full right-side push over to bring in the phone, but not overlap on any of your system.

The second mode is a hover in the bottom right hand corner of the system.

The third mode is a icon in the bottom right hand corner to hide the phone from your workspace until you get an inbound call.

Inbound Call

Once an inbound call comes in the user will be alerted by a temporary pop-up to be able to accept the call.

Phone Feature Breakdown

On the top left are the phone status:

Green indicates you are authenticated to the phone, available for inbound calls and want to place outbound calls if a phone number is clicked or manually dialed.

Checking the red circle button unauthenticated the phone, so that all inbound is directed to the phone number url and outbound calls can not be placed.

Checking the phone icon to red sends all inbound calls to the phone number url, but allows for outbound calls to be placed.

Mute and Pause

Located under the dial pad are two icons. One if for muting live calls with no sound. The other is for placing a call on hold with default play music.

Authentication and Installing the phone

If you are ready to install the webrtc phone into your CRM or system there are a few elements to keep in mind.

  1. Each webphone user must be created as a user inside of Ytel

  2. Each webphone user must be assigned to a phone number in the account

  3. Each webphone user must have at least the user role of webrtc

Installing the Phone

https://webphone-widget.ytel.com/readme/

  • Please note the the username and password is the only authentication method that works the the UCaaS based phone

https://webphone-widget.ytel.com/ytel-webphone-3.0.3.min.js
https://webphone-widget.ytel.com/ytel-webphone-3.0.3.min.css

Authentication for the phone

It is important to note that a single phone number will be assigned to each user through the Account Settings section of the Ytel interface or through use of the Ytel APIs.

User interface

Log-in to the Ytel platform and navigate to Settings and then User. If this is your first time creating a user, check out this article. Once you are in the user section, you will click onto the name of the user you want to edit. In that section you will see the web-phone setting where you can select from one of your Ytel owned numbers. Once you have assigned a number to a user it can only be utilize for the WebRTC platform for inbound calls and can only be assigned to one user at a time. Before you select a number, make sure you are not using that number in the Tracking feature or have a custom inbound url assigned. If you do, that inbound XML will be ignored and all calls will go to the WebRTC phone.

APIs

Ideally it is best to create users, assign the role and assign the webphone number through the API. That way you can add those API calls onto the existing calls you have in your system. When a user is created through your system, your customer just sees that they have access to a webphone as well.

  1. Create a Long Lived Token

  2. Create a user

  3. Update Role

  4. Purchase a phone number

  5. Assign Webrtc phone

Create a Long Lived Token

The account owner role on the Ytel system is the only user who is able to create a Long Lived token. That token can be use for authentication to create and update users. For the account owner, log-in and navigate to the settings> API Token section. From that section click on create token. You will be prompted to name your token and also limit the amount of days you want to token to exist for. Once you create the token it will be exposed for you to copy and store. Once you create a token it is only exposed on creation and will not longer be viewable by the Ytel user interface for security.

Create a user

Once you have your long lived token you will want to use our API to create users.

Creating a user:

https://api.ytel.com/ams/v2/users

Request payload:
{
  “belongAcctId”: “ACCOUNTSID",
  “clientId”: null,
  “firstName”: “Annie”,
  “lastName”: “Apple”,
  “password”: “OneOneTwoTwo222”,
  “phone”: “+1234567899”,
  “roles”: [
    “ROLE”
  ],
  “status”: “active”,
  “username”: “example@dev.com”
}

The ROLE will be replaced by one of three user types:

"ucaas-webphone"
"ucaas-unified-webphone"
"ucaas-contact-center"

Purchase a phone number

If you don't have any phone numbers in your account you can purchase a number inside of the application as well as through the API - https://api-docs.ytel.com/#953fe60c-bc5b-4dec-8be2-d85395c498d1

Related articles