SMS Integration Guide: Yeastar Linkus Web Client and TNZ SMS

Linkus Web Client is a web-based client for the Yeastar P-Series Phone System. The web client has an omnichannel 'chat' function, allowing you to use SMS to chat with a mobile.

This guide explains how to set up the Chat functionality for use with TNZ SMS.

Step 1: Generate Credentials in the TNZ Dashboard

First, you need to activate your Yeastar credentials from the TNZ dashboard.

1. Log in to your TNZ Account at https://my.tnz.co.nz.

2. From the menu, navigate to Service Settings, then Integrations, then Yeastar.

3. Click Connect Yeastar.
4. Keep this window open. You will need to copy the API Key and API Address in the next step.

Step 2: Configure the Yeastar Message Channel

Now, you must tell the Yeastar system to use TNZ as its SMS provider.

1. Log into your Yeastar web client.

2. Switch to the Access Management Portal view.

3. Under Messaging, select Message Channel and click + Add, then SMS.

4. Adjust these settings:
   
   

   Field	Value/Action
   Name	Set: "TNZ SMS"
   ITSP	Set: "General"
   API Key	Copy the API Key from TNZ and paste into Yeastar
   API Address for Sending Messages	Copy the API Address for Sending Messages from TNZ and paste into Yeastar
   Webhook URL	Copy the Webhook URL from Yeastar and paste into TNZ
   Secret	Leave blank
   API Address for Verifying Authentication	Leave blank

   
   Important: Once you have copied the Webhook URL from Yeastar and pasted it into the TNZ Dashboard, ensure you click Update in the TNZ Dashboard and Save in Yeastar to finalize the handshake.
   
   

Step 3: Configure Numbers and Routing

After the channel is established, you need to define which numbers are used for SMS and how incoming messages are routed to your staff.

1. In the Yeastar Management Portal, click on the new TNZ SMS channel, then click on the Messaging Settings Messaging Settings tab.
2. Click + Add to register your SMS number.
3. Number: Enter your TNZ-provided SMS number (if using TNZ's generic settings, set +0000).

4. Destination for Inbound Messaging:

   Message Queue is best for support teams where any available agent can pick up the chat.

   Extension is best for direct lines where messages should go to a specific person.
   
   

5. Extensions Allowed to Create Messaging Sessions: Toggle the switch for the specific team members who need the ability to initiate outbound SMS chats.
6. Click Save.

You'll now be able to use the Linkus Chat function to send SMS messages.

Understanding the Linkus User Experience

Once configured, users will see an "SMS" option within the Chat sidebar of the Linkus Web Client.

• Outbound: Users can click the "New Chat" icon, enter a mobile number, and select the TNZ SMS channel to start a conversation.

• Inbound: When a customer replies, the message will appear in the chat window. If routed to a queue, the first agent to respond will "own" the session.

Troubleshooting Tips

• Message Not Sending: Verify that the API Key in Yeastar matches the one in the TNZ Dashboard exactly. Check your TNZ Dashboard's View Messages section to see if the request reached our servers.

• Inbound Not Received: Ensure the Webhook URL from Yeastar is correctly pasted into the TNZ Yeastar Integration settings. Without this, TNZ doesn't know where to "push" the incoming text. Changing the URL will only apply to new messages, so be sure to send a new outbound message and reply to it.

• Permission Issues: If a user cannot see the SMS option, double-check the Extensions Allowed to Create Messaging Sessions setting in Step 3.