Skip to content

Commit 59b941a

Browse files
authored
Update README.md
1 parent 9396fa7 commit 59b941a

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
# tutorial-messages-node-rcs_standalone-rich-card
1+
# How to Send Standalone RCS Rich Cards with Node.js
2+
A node application that allows you to send and receive Rich Communications Services suggested reply messages.
3+
4+
> You can find full step-by-step instructions on the [Vonage Developer Blog](https://developer.vonage.com/en/blog).
5+
6+
7+
8+
## Prerequisites
9+
1. [Node.js installed on your machine.](https://nodejs.org/en/download)
10+
2. [ngrok installed for exposing your local server to the internet.](https://ngrok.com/downloads/mac-os)
11+
3. [Vonage Developer Account](https://developer.vonage.com/sign-up)
12+
4. A registered RCS Business Messaging (RBM) Agent.
13+
5. A phone with RCS capabilities for testing.
14+
15+
16+
17+
## Instructions
18+
1. Clone this repo
19+
2. Initialize your Node application and install dependencies:
20+
```
21+
npm init -y
22+
npm install express dotenv @vonage/server-sdk
23+
```
24+
4. Rename the `.env.example` file to `.env`, and add your `VONAGE_APPLICATION_ID` and `RCS_SENDER_ID` values.
25+
5. Add your `private.key` file in the root of the project directory.
26+
6. Start your Node server:
27+
```
28+
node index.js
29+
```
30+
7. Create a tunnel using ngrok:
31+
```
32+
ngrok http 3000
33+
```
34+
8. Test your app by sending an RCS suggested reply from the command line:
35+
```
36+
curl -X POST https://**YOUR_NGROK_URL***/send-standalone-rich-card \
37+
-H "Content-Type: application/json" \
38+
-d '{
39+
"to": "**YOUR_RCS_TEST_NUMBER"
40+
}'
41+
```

0 commit comments

Comments
 (0)