From 2e0db1ee8ba0791e119b92a13911334559b446a7 Mon Sep 17 00:00:00 2001 From: Darcy Ye Date: Tue, 12 Jul 2022 12:43:46 +0800 Subject: [PATCH] docs(connector): fix twilio readme according to bug bash (#1518) --- packages/connector-twilio-sms/README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/packages/connector-twilio-sms/README.md b/packages/connector-twilio-sms/README.md index 685fd8c83..882f8b5b7 100644 --- a/packages/connector-twilio-sms/README.md +++ b/packages/connector-twilio-sms/README.md @@ -10,12 +10,16 @@ Create a new account on [Twilio](https://www.twilio.com). (Jump to the next step Go to the [Twilio console page](https://console.twilio.com/) and sign in with your Twilio account. -Purchase a phone number under _Phone Numbers_ -> _Manage_ -> **_Buy a number_**. +Purchase a phone number under "Phone Numbers" -> "Manage" -> "Buy a number". -Once we have a valid number claimed, nav to the _Messaging_ -> **_Services_**. Create a new Message Service by clicking on the button. +> ℹ️ **Tip** +> +> Sometimes you may encounter the situation that SMS service is not supported in specific countries or areas. Pick a number from other regions to bypass. -Give a friendly service name and choose **_Notify my users_** as our service purpose. -Following the next step, choose `Phone Number` as _Sender Type_, and link the phone number we just claimed to this service. +Once we have a valid number claimed, nav to the "Messaging" -> "Services". Create a new Message Service by clicking on the button. + +Give a friendly service name and choose _Notify my users_ as our service purpose. +Following the next step, choose `Phone Number` as _Sender Type_, and add the phone number we just claimed to this service as a sender. > ℹ️ **Note** > @@ -25,9 +29,9 @@ Following the next step, choose `Phone Number` as _Sender Type_, and link the ph We will need the API credentials to make the connector work. Let's begin from the [Twilio console page](https://console.twilio.com/). -Click on the _Account_ menu in the top-right corner, then go to the _API keys & tokens_ page to get your `Account SID` and `Auth token`. +Click on the "Account" menu in the top-right corner, then go to the "API keys & tokens" page to get your `Account SID` and `Auth token`. -Back to _Messaging_ -> _Services_ settings page starting from the sidebar, and find the `Sid` of your service. +Back to "Messaging" -> "Services" settings page starting from the sidebar, and find the `Sid` of your service. ## Compose the connector JSON @@ -62,6 +66,11 @@ Here is an example of Twilio SMS connector config JSON. } ``` +### Test Twilio SMS connector + +You can enter a phone number and click on "Send" to see whether the settings can work before "Save and Done". + +That's it. Don't forget to [Enable connector in sign-in experience](https://docs.logto.io/docs/tutorials/get-started/enable-passcode-sign-in/#enable-connector-in-sign-in-experience). ### Config types @@ -77,3 +86,6 @@ Here is an example of Twilio SMS connector config JSON. | content | string | N/A | | usageType | enum string | 'Register' \| 'SignIn' \| 'Test' | +## Reference + +- [Twilio - Error and Warning Dictionary](https://www.twilio.com/docs/api/errors)