Skip to content

Commit 951b030

Browse files
committed
refactor: organized env examples
1 parent d427330 commit 951b030

File tree

1 file changed

+89
-166
lines changed

1 file changed

+89
-166
lines changed

.env-example

+89-166
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,48 @@
1+
# Node JS Specific
2+
PORT=
3+
14
# General
25
VONAGE_API_KEY=
36
VONAGE_API_SECRET=
47
VONAGE_APPLICATION_ID=
58
VONAGE_PRIVATE_KEY=
69
VONAGE_SIGNATURE_SECRET=
7-
VONAGE_VIRTUAL_NUMBER=
8-
910

1011
# Account
1112
ACCOUNT_ID=
1213
ACCOUNT_SECRET_ID=
1314
ACCOUNT_SECRET_VALUE=
1415
ACCOUNT_SMS_CALLBACK_URL=
1516

16-
17-
# Applications (includes user endpoints)
17+
# Applications
18+
USER_DISPLAY_NAME=
19+
USER_ID=
20+
USER_NAME=
1821

1922
# Audit
23+
DATE_FROM=
24+
DATE_TO=
25+
EVENT_UUID=
26+
SEARCH_TEXT=
2027

2128
# Conversation
22-
23-
# Dispatch
29+
CONV_ID=
30+
CONV_NAME=
31+
CONV_DISPLAY_NAME=
32+
CONV_EVENT_TYPE=
33+
CONV_EVENT_FROM=
34+
CONV_USER_ID=
35+
CONV_MEMBER_ID=
36+
CONV_MEMBER_STATE=
37+
38+
# Meetings (This API is deprecated)
39+
ROOM_DISPLAY_NAME=
2440

2541
# Messages
26-
MESSAGES_TO_NUMBER=
27-
MESSAGES_API_URL=
2842
GEOSPECIFIC_MESSAGES_API_URL=
43+
MESSAGES_API_URL=
2944
MESSAGES_MESSAGE_ID=
45+
MESSAGES_TO_NUMBER=
3046

3147
## For SMS messaging
3248
SMS_SENDER_ID=
@@ -37,13 +53,13 @@ MMS_SENDER_ID=
3753
## For RCS messaging
3854
RCS_SENDER_ID=
3955

40-
# For WhatsApp messaging
41-
WHATSAPP_SENDER_ID=
42-
WHATSAPP_TEMPLATE_NAME=
56+
## For WhatsApp messaging
4357
WHATSAPP_CATALOG_ID=
58+
WHATSAPP_OTP=
4459
WHATSAPP_PRODUCT_ID_1=
4560
WHATSAPP_PRODUCT_ID_2=
46-
WHATSAPP_OTP=
61+
WHATSAPP_SENDER_ID=
62+
WHATSAPP_TEMPLATE_NAME=
4763

4864
## For Facebook Messenger messaging
4965
MESSENGER_RECIPIENT_ID=
@@ -53,183 +69,90 @@ MESSENGER_SENDER_ID=
5369
VIBER_SENDER_ID=
5470

5571
## For media messaging (MMS, RCS, WhatsApp, Messenger, Viber)
56-
MESSAGES_IMAGE_URL=
5772
MESSAGES_AUDIO_URL=
58-
MESSAGES_VIDEO_URL=
59-
MESSAGES_VIDEO_DURATION=
60-
MESSAGES_VIDEO_FILE_SIZE=
73+
MESSAGES_EMOJI=
6174
MESSAGES_FILE_URL=
75+
MESSAGES_IMAGE_URL=
6276
MESSAGES_VCARD_URL=
63-
MESSAGES_EMOJI=
77+
MESSAGES_VIDEO_DURATION=
78+
MESSAGES_VIDEO_FILE_SIZE=
79+
MESSAGES_VIDEO_URL=
6480
WHATSAPP_STICKER_ID=
6581
WHATSAPP_STICKER_URL=
6682

6783
## For Sandbox messaging
6884
MESSAGES_SANDBOX_URL=
6985

86+
# Network APIs
87+
VNA_ACCESS_TOKEN=
88+
VNA_AUTH_REQ_ID=
89+
VNA_PHONE_NUMBER=
90+
VNA_SCOPE=
91+
VNA_STATE=
92+
93+
## Sim Swap
94+
SIMSWAP_MAX_AGE=
95+
7096
# Number Insight
71-
INSIGHT_NUMBER=
7297
INSIGHT_CALLBACK_URL=
98+
INSIGHT_NUMBER=
7399

74100
# Number Verification
101+
NV_AUTH_CODE=
102+
NV_REDIRECT_URI=
75103

76104
# Numbers
105+
COUNTRY_CODE=
106+
NUMBER_SEARCH_CRITERIA=
107+
NUMBER_SEARCH_PATTERN=
108+
SMS_CALLBACK_URL=
109+
VOICE_CALLBACK_TYPE=
110+
VOICE_CALLBACK_VALUE=
111+
VOICE_STATUS_URL=
112+
VONAGE_NUMBER=
113+
VONAGE_NUMBER_FEATURES=
114+
VONAGE_NUMBER_TYPE=
77115

78116
# Reports
79117

80-
# Sim Swap
81-
82118
# SMS
119+
## Note: Set SMS_SENDER_ID under the Messages section
120+
SMS_TIMESTAMP=
121+
SMS_TO_NUMBER=
122+
SMS_SIGNATURE=
83123

84124
# Subaccounts
85-
86-
# VBC
87-
88-
# Verify (v1 & v2)
89-
90-
# Voice / Programmable SIP
91-
VOICE_CALL_ID=
92-
VOICE_TO_NUMBER=
93-
VOICE_TEXT=
94-
VOICE_LANGUAGE=
95-
VOICE_DTMF_DIGITS=
96-
VOICE_CONFERENCE_NAME=
97-
VOICE_ANSWER_URL=
98-
VOICE_STREAM_URL=
99-
VOICE_RECORDING_URL=
100-
VOICE_NCCO_URL=
101-
SIP_DOMAIN=
102-
SIP_USER_ID=
103-
SIP_USER_SECRET=
104-
SIP_ACL_IP_ADDRESS=
105-
106-
# -----------------------------------
107-
108-
TO_NUMBER=
109-
RECIPIENT_NUMBER=
110-
FROM_NUMBER=
111-
VONAGE_NUMBER=
112-
BRAND=
113-
PAYEE=
114125
AMOUNT=
115-
OTP=
116-
EMAIL_TO=
117-
118-
# For downloading a recording
119-
SMS_CALLBACK_URL=
120-
121-
# For Facebook messaging
122-
FB_SENDER_ID=
123-
FB_RECIPIENT_ID=
124-
125-
# For Viber messaging
126-
VIBER_SERVICE_MESSAGE_ID=
127-
128-
# For WhatsApp messaging
129-
WHATSAPP_NUMBER=
130-
WHATSAPP_TEMPLATE_NAMESPACE=
131-
WHATSAPP_TEMPLATE_NAME=
132-
WHATSAPP_AUTH_TEMPLATE_NAME=
133-
WHATSAPP_TEMPLATE_REPLACEMENT_TEXT=
134-
135-
# For media messaging (WhatsApp, Messenger, Viber)
136-
IMAGE_URL=
137-
IMAGE_CAPTION=
138-
FILE_URL=
139-
FILE_CAPTION=
140-
AUDIO_URL=
141-
VIDEO_URL=
142-
143-
# Production testing
144-
MESSAGES_API_URL=
145-
GEOSPECIFIC_MESSAGES_API_URL=
146-
DISPATCH_API_URL=
147-
148-
# Messages Sandbox testing
149-
MESSAGES_SANDBOX_URL=
150-
MESSAGES_SANDBOX_WHATSAPP_NUMBER=
151-
MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER=
152-
MESSAGES_SANDBOX_FB_ID=
153-
MESSAGES_SANDBOX_ALLOW_LISTED_FB_RECIPIENT_ID=
154-
MESSAGES_SANDBOX_VIBER_SERVICE_ID=
155-
156-
157-
# Subaccounts API
158126
NEW_SUBACCOUNT_NAME=
159127
NEW_SUBACCOUNT_SECRET=
160-
SUBACCOUNT_KEY=
161-
AMOUNT=
162128
START_DATE=
129+
SUBACCOUNT_KEY=
163130

164-
# Audit API
165-
EVENT_UUID=
166-
SEARCH_TEXT=
167-
DATE_FROM=
168-
DATE_TO=
169-
170-
# Messages API
171-
172-
MESSAGE_UUID=
173-
EMOJI=
174-
175-
# Numbers
176-
NUMBER_SEARCH_CRITERIA=
177-
NUMBER_SEARCH_PATTERN=
178-
VONAGE_NUMBER_TYPE=
179-
VONAGE_NUMBER_FEATURES=
180-
COUNTRY_CODE=
181-
MESSAGES_APPLICATION_ID=
182-
VOICE_CALLBACK_TYPE=
183-
VOICE_CALLBACK_VALUE=
184-
VOICE_STATUS_URL=
185-
186-
# MMS
187-
IMG_URL=
188-
189-
# Reports v2 API
190-
ACCOUNT_ID=
191-
DATE_START=
192-
DATE_END=
193-
REPORT_DIRECTION=
194-
REPORT_PRODUCT=
195-
REPORT_STATUS=
196-
ID=
197-
REQUEST_ID=
198-
FILE_ID=
199-
TYPE=
200-
INCLUDE_SUBACCOUNTS=
201-
INCLUDE_MESSAGE=
202-
STATUS=
203-
204-
# Verify
205-
REQUEST_ID=
206-
CODE=
207-
WORKFLOW_ID=
208-
TEMPLATE_ID=
209-
TEMPLATE_FRAGMENT_ID=
210-
211-
# Vonage Business Cloud
212-
VBC_CLIENT_ID=
213-
VBC_CLIENT_SECRET=
214-
VBC_ACCOUNT_ID=
215-
VBC_LOCATION_ID=
216-
VBC_EXTENSION=
217-
VBC_USER_ID=
218-
VBC_USERNAME=
219-
VBC_PASSWORD=
220-
221-
# Meetings API
222-
ROOM_DISPLAY_NAME=
223-
EXPIRATION_DATE=
224-
225-
# Network APIs
226-
PHONE_NUMBER=
227-
MAX_AGE=
228-
AUTH_REQ_ID=
229-
AUTH_CODE=
230-
REDIRECT_URI=
231-
232-
# Application API
233-
USER_ID=
234-
USER_NAME=
235-
USER_DISPLAY_NAME=
131+
# Verify (v1 & v2)
132+
VERIFY_AMOUNT=
133+
VERIFY_BRAND_NAME=
134+
VERIFY_CODE=
135+
VERIFY_FROM_EMAIL=
136+
VERIFY_FROM_NUMBER=
137+
VERIFY_NUMBER=
138+
VERIFY_PAYEE_NAME=
139+
VERIFY_REQUEST_ID=
140+
VERIFY_TEMPLATE_FRAGMENT_ID=
141+
VERIFY_TEMPLATE_ID=
142+
VERIFY_TO_EMAIL=
143+
VERIFY_WORKFLOW_ID=
144+
145+
# Voice
146+
VOICE_ANSWER_URL=
147+
VOICE_CALL_ID=
148+
VOICE_CONFERENCE_NAME=
149+
VOICE_CONF_NAME=
150+
VOICE_DTMF_DIGITS=
151+
VOICE_LANGUAGE=
152+
VOICE_NCCO_URL=
153+
VOICE_RECORDING_DESTINATION=
154+
VOICE_RECORDING_URL=
155+
VOICE_STREAM_URL=
156+
VOICE_TEXT=
157+
VOICE_TO_NUMBER=
158+
VONAGE_VIRTUAL_NUMBER=

0 commit comments

Comments
 (0)