Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kchudy committed Aug 2, 2023
1 parent dec13b7 commit fd869e0
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,29 @@

vonage-to-matrix is a simple tool that on the *input* handles [Vonage WebHook](https://developer.vonage.com/en/messaging/sms/guides/inbound-sms) data about incoming calls and SMS messages and on the *output* posts that data to the [Matrix Hookshot WebHook](https://github.com/matrix-org/matrix-hookshot).


# Configuration
The service can be configured by editing the `config.toml` file.
## Hookshot webhook URL
Place the webhook URL in the *hookshot* section like so:
```
[hookshot]
url = "https://hookshot.teonite.net/webhook/141d7f48-862e-42a8-a1e7-efab3a37ed09"
```
# Configuring message and call forwarding in Vonage
1. Sign in to vonage and add go to [your numbers](https://dashboard.nexmo.com/your-numbers).
2. Open configuration panel for a number by clicking the edit button.
3. Place the following URL under *SMS* -> *Inbound Webhook URL* to enable message forwarding
```
https://vonage.teonite.net/api/inbound-message
```
4. Enable call forwarding by picking *Phone* in the *Forward to* menu and typing in the *Number*. Place the following URL in *Event Webhook URL*
```
https://vonage.teonite.net/api/inbound-call
```
# Number labeling
The service can display labeled numbers in messages forwarded to a webhook. To add label to a number one needs to edit the config.toml. Labels should be places under *vonage.labels* key like in the following file:
```
[vonage.labels]
48111111111 = "Label for this number"
12222222222 = "Different label"
```

0 comments on commit fd869e0

Please sign in to comment.