From 0d0d859e3898a11c4e0fc92a624054e691fd1699 Mon Sep 17 00:00:00 2001
From: Kelley Robinson <3673341+robinske@users.noreply.github.com>
Date: Thu, 20 Jun 2024 11:39:41 -0400
Subject: [PATCH] Update telephony hook docs to use Twilio Verify
---
.../telephony-inline-hook/main/index.md | 16 +++-------
.../main/nodejs/sendotp.md | 17 ++++++++++
.../main/nodejs/sendsmsmakecall.md | 32 -------------------
3 files changed, 22 insertions(+), 43 deletions(-)
create mode 100644 packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendotp.md
delete mode 100644 packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendsmsmakecall.md
diff --git a/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/index.md b/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/index.md
index 83ed10c39c7..d333683ec71 100644
--- a/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/index.md
+++ b/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/index.md
@@ -34,14 +34,9 @@ This guide provides an example of an Okta telephony inline hook. This guide uses
* Make sure you have a user in your org with a Phone authenticator enrolled. See [MFA Usage report](https://help.okta.com/okta_help.htm?type=oie&id=ext-mfa-usage).
-* Make sure you have an active phone number in Twilio with SMS and MMS capabilities.
+* Create a [Twilio Verify Service](https://twilio.com/console/verify/services) in your Twilio account for sending OTPs.
-* Create a [TwiML bin](https://www.twilio.com/docs/runtime/tutorials/twiml-bins#create-a-new-twiml-bin) in your Twilio account for use with voice call messages. Use the automatically generated handler URL as a variable. Also, include an `otp` tag key within double brackets in the prepopulated XML. This tag key references the dynamic `otp` used later in this exercise. For example:
-
- ```xml
-
- Your code is {{otp}}
- ```
+* [Enable custom code](https://www.twilio.com/docs/verify/api/customization-options#custom-verification-codes). Select "Enable Custom Verification Code" in the Code Configuration settings for your [Verify Service](https://twilio.com/console/verify/services)
## About telephony inline hook implementation
@@ -112,15 +107,14 @@ Alternatively, you can use the Inline Hooks Management API to create an inline h
## Add Twilio credentials to the external service
-Copy the account SID and auth token from your Twilio account and add them as variables in the `.env` file in the Glitch project.
+Copy the account SID, auth token, and Verify service SID from your Twilio account and add them as variables in the `.env` file in the Glitch project.
> **Note:** Make sure you have the required default code and packages in your project. See [Common Hook set-up steps](https://developer.okta.com/docs/guides/common-hook-set-up-steps/nodejs/main/).
1. From the left navigation in the Glitch project, click **.env**.
1. In the first blank variable line that appears, add **ACCOUNT_SID** and then paste your account SID as the value on the right.
1. In the second blank variable line, add **AUTH_TOKEN** and then paste your account authentication token as the value on the right.
-1. Click **Add a Variable** and then add **FROM_PHONE_NUMBER** as the variable and then the Twilio phone number from your account as the value.
-1. Click **Add a Variable** and then add **TWIML_URL** as the variable and then the [TwiML URL](https://www.twilio.com/docs/runtime/tutorials/twiml-bins#create-a-new-twiml-bin) from your Twilio account.
+1. Click **Add a Variable** and then add **VERIFY_SERVICE_SID** as the variable and then the Twilio Verify Service from your account as the value.
> **Note:** See the code comments in the Glitch `server.js` file where these variable values appear.
@@ -140,7 +134,7 @@ The following code retrieves the value of the OTP code sent by Okta from the `da
The following code is used to send the SMS or voice call to the user:
-
+
## Send a response to Okta
diff --git a/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendotp.md b/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendotp.md
new file mode 100644
index 00000000000..b1b55ff5285
--- /dev/null
+++ b/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendotp.md
@@ -0,0 +1,17 @@
+```javascript
+function sendOtp(userPhoneNumber, userOtpCode, channel, response) {
+ client.verify.v2
+ .services(serviceSid)
+ .verifications.create({
+ to: userPhoneNumber,
+ customCode: userOtpCode,
+ channel: channel,
+ })
+ .then((verification) => {
+ response.status(200).json(getSuccessResponse(channel, verification.sid));
+ })
+ .catch((error) => {
+ response.status(400).json(getErrorResponse(channel, error));
+ });
+}
+```
diff --git a/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendsmsmakecall.md b/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendsmsmakecall.md
deleted file mode 100644
index 8bf0402595f..00000000000
--- a/packages/@okta/vuepress-site/docs/guides/telephony-inline-hook/main/nodejs/sendsmsmakecall.md
+++ /dev/null
@@ -1,32 +0,0 @@
-```javascript
-function sendSms(from, userPhoneNumber, userOtpCode, response) {
- client.messages
- .create({
- body: "Your One-Time Passcode from the Glitch project is " + userOtpCode,
- to: userPhoneNumber,
- from: from,
- })
- .then((message) => {
- response.status(200).json(getSuccessResponse("SMS", message.sid));
- })
- .catch((error) => {
- response.status(400).json(getErrorResponse("SMS", error));
- });
-}
-
-function makeCall(from, to, otp, response) {
- // Add space to OTP digits for correct pronunciation
- otp = otp.replace(/\B(?=(\d{1})+(?!\d))/g, " ");
- otp = "?otp=" + otp;
- const url = encodeURI(process.env.TWIML_URL + otp);
-
- client.calls
- .create({ to, from, url })
- .then((call) => {
- response.status(200).json(getSuccessResponse("VOICE", call.sid));
- })
- .catch((error) => {
- response.status(400).json(getErrorResponse("VOICE", error));
- });
-}
-```