Skip to content

Commit 220b00d

Browse files
authored
Merge pull request #7 from Nexmo/config-ex
Adding configuration details
2 parents da2cc72 + 82a608f commit 220b00d

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
## Getting Started
99

10+
### Create a Nexmo App
11+
1012
Create an application and take a note of the application UUID:
1113

1214
```sh
@@ -21,12 +23,26 @@ If you don't know the URLs for your proxy-call and event webhooks yet you can up
2123
nexmo app:update APP_ID voice-proxy https://example.com/proxy-call https://example.com/event
2224
```
2325

26+
### Configuration
27+
2428
Copy the `example.env` to `.env` and update the content as appropriate:
2529

2630
```
2731
cp example.env .env
2832
```
2933

34+
Configuration is as follows:
35+
36+
| Environment Variable | Required? | Description |
37+
| -------------------- | --------- | ----------- |
38+
| NEXMO_API_KEY | Yes | Your Nexmo API key (Get from the [Nexmo Dashboard](https://dashboard.nexmo.com/settings)) |
39+
| NEXMO_API_SECRET | Yes | Your Nexmo API secret (Get from the [Nexmo Dashboard](https://dashboard.nexmo.com/settings)) |
40+
| NEXMO_APP_ID | Yes | The id generated when you created your Nexmo application. |
41+
| NEXMO_DEBUG | No | Determines if interactions with the Nexmo API should be logged to the console. A non-falsy value will result in debug being on |
42+
| PROVISIONED_NUMBERS | No | If supplied it should be in the format `[{"country":"GB","msisdn":"NUMBER_1"},{"country":"GB","msisdn":"NUMBER_2"}]` |
43+
44+
### Run the App
45+
3046
Start the application:
3147

3248
```sh
@@ -68,8 +84,7 @@ You should see a response such as the following:
6884
"msisdn":"USER_B_VIRTUAL_NUMBER",
6985
"country":"GB"
7086
}
71-
},
72-
"callLogs":[]
87+
}
7388
}]
7489
```
7590

0 commit comments

Comments
 (0)