Skip to content

Commit b254a13

Browse files
authored
[VBLOCKS-5119] chore: sync readme with docs (#43)
* chore: sync readme with docs * nit * nit
1 parent defc1c0 commit b254a13

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ Twilio Voice JavaScript Reference Components leverages [Web Components](https://
77
The reference components demonstrate several common Twilio Voice use cases. These use cases include:
88

99
- Dialer
10-
- Make outgoing calls
10+
- Place outgoing calls
1111
- Receive incoming calls
12-
- Basic Call Control (leveraging Conference)
13-
- Perform cold and warm transfers
12+
- Basic Call Control (uses Conference)
13+
- Perform cold or warm transfers
1414
- Add or remove participants from a call
1515
- Hold and Resume a call
1616
- Mute and Unmute a call
17-
- Monitoring (leveraging Conference)
18-
- Callee call progress
19-
- Conference call status
20-
- Quality metrics
21-
- Warnings
22-
- Errors
17+
- Monitoring (uses Conference)
18+
- Observe call progress
19+
- Track conference call status
20+
- View quality metrics
21+
- Receive warnings
22+
- View errors
2323
- Voice AI Assistant
24-
- Make outgoing call to connect with an agent
25-
- Websocket server
24+
- Place an outbound call and connect to an agent
25+
- Provide a Websocket server to interface with Conversation Relay
2626
- Basic OpenAI integration
2727

2828
## Installation
@@ -39,15 +39,15 @@ git clone https://github.com/twilio/twilio-voice-js-reference-components.git
3939
npm install
4040
```
4141

42-
3. Create a `.env` file from the `example.env` file. Go through the [quickstarts](https://www.twilio.com/docs/voice/sdks/javascript/get-started) for more information about these variables.
42+
3. Copy `example.env` to `.env`, then supply the required values. For details about each variable, see the [quickstart](https://www.twilio.com/docs/voice/sdks/javascript/get-started).
4343

4444
```bash
4545
cp example.env .env
4646
```
4747

48-
4. In the Twilio Console, navigate to your `TwiML App` settings and set the `Voice Request URL` to the URL endpoint of your desired component. Options:
48+
4. In the Twilio Console, open your **TwiML App** settings and set **Voice Request URL** to the endpoint for the component you want to test:
4949

50-
```bash
50+
```text
5151
https://yourdomain/twilio-voice-dialer/twiml
5252
https://yourdomain/twilio-voice-basic-call-control/twiml
5353
https://yourdomain/twilio-voice-monitoring/twiml
@@ -62,9 +62,9 @@ https://yourdomain/twilio-voice-ai-assistant/twiml
6262
npm start
6363
```
6464

65-
2. Access the following components under the following URLs.
65+
2. Open a browser and navigate to a component URL.
6666

67-
- Dialer, access [http://localhost:3030/twilio-voice-dialer?identity=bob](http://localhost:3030/twilio-voice-dialer?identity=bob).
68-
- Basic Call Control, access [http://localhost:3030/twilio-voice-basic-call-control?identity=bob](http://localhost:3030/twilio-voice-basic-call-control?identity=bob).
69-
- Monitoring, access [http://localhost:3030/twilio-voice-monitoring?identity=bob](http://localhost:3030/twilio-voice-monitoring?identity=bob).
70-
- Voice AI Assistant, access [http://localhost:3030/twilio-voice-ai-assistant?identity=bob](http://localhost:3030/twilio-voice-ai-assistant?identity=bob).
67+
- Dialer: [http://localhost:3030/twilio-voice-dialer?identity=bob](http://localhost:3030/twilio-voice-dialer?identity=bob).
68+
- Basic Call Control: [http://localhost:3030/twilio-voice-basic-call-control?identity=bob](http://localhost:3030/twilio-voice-basic-call-control?identity=bob).
69+
- Monitoring: [http://localhost:3030/twilio-voice-monitoring?identity=bob](http://localhost:3030/twilio-voice-monitoring?identity=bob).
70+
- Voice AI Assistant: [http://localhost:3030/twilio-voice-ai-assistant?identity=bob](http://localhost:3030/twilio-voice-ai-assistant?identity=bob).

example.env

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ API_KEY_SID=SKxxxxxxxxxxxxxx
1212
# Twilio API secret
1313
API_KEY_SECRET=xxxxxxxxxxxxxx
1414

15-
# Twilio TwiML App sid where the Voice Request URL is set to
16-
# https://yourdomain/twilio-voice-dialer/twiml
17-
# See more info about TwiML set up by visiting https://www.twilio.com/docs/voice/sdks/javascript#twiml-applications
15+
# Twilio TwiML App SID
16+
# The Voice Request URL must point to one of the /twiml endpoints listed in the README.
17+
# For details, see https://www.twilio.com/docs/voice/sdks/javascript#twiml-applications
1818
APP_SID=APxxxxxxxxxxxxxx
1919

2020
# Twilio auth token
@@ -23,14 +23,14 @@ AUTH_TOKEN=xxxxxxxxxxxxxx
2323
# Caller ID
2424
CALLER_ID=+11234567890
2525

26-
# If developing locally and running the Reference Components locally, consider using a tool like ngrok to proxy the server endpoints. Once proxied, change CALLBACK_BASE_URL to the ngrok URL endpoints.
27-
# See more info about ngrok by visiting https://ngrok.com.
28-
# Note: do not include "https://" or "wss://" in the URL.
26+
# Public base URL that Twilio can reach.
27+
# If you run the components locally, use a tunneling service such as ngrok.
28+
# Do not include the scheme (https:// or wss://) in the URL.
2929
CALLBACK_BASE_URL=foo.ngrok.dev
3030

3131
# Default identity to use
3232
DEFAULT_IDENTITY=alice
3333

3434
# twilio-voice-ai-assistant
3535
# See https://platform.openai.com/settings/organization/api-keys
36-
OPENAI_API_KEY="sk-proj......."
36+
OPENAI_API_KEY=sk-proj.......

0 commit comments

Comments
 (0)