CT Text for Webex - Admin Guide
CT Text Installation into Webex
Overview
Adding CT Text to Webex chat enables you to send and receive text messages in the same way as chatting to colleagues. You will need admin permission to the Webex Developer and Admin portal to complete the following step by step instructions
Add CT Text as a Webex Bot
Open the https://developer.webex.com, sign in as an administrator and then click or your avatar (top right) to select My Webex Apps.
When the My Apps page is displayed, click on the Create a New App button.
When the Create a New App page is displayed, click on the Create a Bot button.
When the New Bot page is displayed, complete the following information:
- Enter the Bot Name and Bot Username of your choice.
- Add the CT Text icon which you can download from here (the icon needs to be exactly 512x512px).
- Enter the App Hub description e.g. "Send and receive text messages from a Webex Space".
- Once you have completed your form, click Add bot.
Note: The Bot Name is used to create a space to enable new text messages to be sent using Webex Chat and so it needs to be recognizable and found using Search.
Webex will provide a Bot access token. Copy this token and paste it somewhere safe for now as this will be used later in the installation.
Create a new Integration in Webex
Navigate back to the Create a New App page and this time click on the Create an integration button.
When the New Integration page is opened, complete the following information:
- Enter the Integration name e.g. "CT Text Integration"
- Add the CT Text icon that was downloaded in a previous step.
- Enter the App Hub Description for example "This integration is used to enable CT Text to send messages from within a Webex space by simply replying to an inbound text message."
- Enter the following Redirect URI(s): https://webex-api.yakchat.com/UserAuth
Scroll down the page and select the following from the list of Scopes:
- spark:messages_read
- spark:people_read
- spark:rooms_read
- spark:rooms_write
- spark:memberships_read
- spark:teams_read
Note: There is a long list of scopes and the above are listed in the same order as they appear in the Webex developer portal to make it easier.
Scroll right to the bottom and click the Add Integration button.
Copy the Client ID and Client Secret displayed in the OAuth settings (to be used in the next step)
Add integration details into CT Text
Open the YakChat Admin Portal and navigate to the Integrations page. Click on the Add button the Webex tile and add the Webex bot token, the client id and the client secret obtained in the above steps.
Adding CT Text messaging app to the Webex sidebar
Overview
Adding CT Text to the Webex sidebar provides instant access to the messaging app. You will need admin permission to the Webex Developer and Admin portal to complete the following step by step instructions.
Create an Embedded App
Open the https://developer.webex.com, sign in as an administrator and then click or your avatar (top right) to select My Webex Apps.
When the My Apps page is displayed, click on the Create a New App button.
When the Create a New App page is displayed, click on the Create Embedded App button.
When the New Embedded App page is displayed, complete the following information:
- Select Sidebar under Where does your app work?
- Enter the app name "CT Text" and the description "SMS for Webex".
- Add the CT Text icon which you can download from here (the icon needs to be exactly 512x512px).
Scroll down the page to enter the following information:
- Enter the "yakchat.com" as the Valid domains.
- Enter https://cttext.calltower.com/webex as the Start page URL.
- Select Always-on App support tick box.
- Click the Add Embedded App button at the bottom of the page to create the app.
Approve the Embedded App
The new embedded app must be approved you your Webex administrator. Go to your Webex Control Hub at https://admin.webex.com/ and sign-in as an administrator.
- Select Apps in the left side menu.
- Select Embedded Apps along the top tabs and then click on the Private tab to display the list of private apps that require approval.
Select the new Embedded App that you created in the previous step which will open a panel on the righthand side. Enter the following settings:
- Click on the Approved radio button and choose whether to approve for All users or Select groups of users.
- Tick the Recommended tick box.
- Turn on the in the Show app in sidebar and Make always on switches in the Sidebar settings section.
- Click on the Save button at the bottom of the page and check that the embedded app is showing as "Approved".
Scroll down and enter the following settings:
- Turn on the in the Show app in sidebar switch.
- Turn on Make always on switch.
- Click on the Save button at the bottom of the page.
Your CT Text app has now been added to your Webex system.
Access CT Text from the Webex sidebar
When a user signs in, the CT Text embedded app will show at the bottom of the left hand sidebar in Webex. Simply click on the app to display the CT Text messaging app.
Note: You may need to re-sign in to the Webex app for the embedded app to be added to the sidebar.