2025 H1 Updates (#115)

Updates to code snippets to unify variable names and examples

Author: superchilled

.env-example

@@ -2,93 +2,134 @@
 VONAGE_API_KEY=
 VONAGE_API_SECRET=
 VONAGE_APPLICATION_ID=
-VONAGE_APPLICATION_PRIVATE_KEY_PATH=private.key
-TO_NUMBER=
+VONAGE_PRIVATE_KEY=private.key
+VONAGE_SIGNATURE_SECRET=
+VONAGE_VIRTUAL_NUMBER=
 VONAGE_NUMBER=
+COUNTRY_CODE=
 
-# Vonage Messages API variables
+# Account
+ACCOUNT_ID=
+ACCOUNT_SECRET_ID=
+ACCOUNT_SECRET_VALUE=
+ACCOUNT_SMS_CALLBACK_URL=
 
-## For Messages Sandbox
-MESSAGES_SANDBOX_URL=
-MESSAGES_SANDBOX_WHATSAPP_NUMBER=
-MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER=
-MESSAGES_SANDBOX_FB_ID=
-MESSAGES_SANDBOX_ALLOW_LISTED_FB_RECIPIENT_ID=
-MESSAGES_SANDBOX_VIBER_SERVICE_ID=
 
-## For Facebook messaging
-FB_SENDER_ID=
-FB_RECIPIENT_ID=
+# Applications (includes user endpoints)
 
-## For Viber messaging
-VIBER_SERVICE_MESSAGE_ID=
+# Audit
 
-## For WhatsApp messaging
-WHATSAPP_NUMBER=
-WHATSAPP_TEMPLATE_NAMESPACE=
-WHATSAPP_TEMPLATE_NAME=
-WHATSAPP_AUTH_TEMPLATE_NAME=
-WHATSAPP_TEMPLATE_REPLACEMENT_TEXT=
+# Conversation
+
+# Dispatch
+
+# Messages
+
+MESSAGES_TO_NUMBER=
+MESSAGES_API_URL=
+GEOSPECIFIC_MESSAGES_API_URL=
+MESSAGES_MESSAGE_ID=
+
+## For SMS messaging
+
+SMS_SENDER_ID=
+
+## For MMS messaging
+MMS_SENDER_ID=
 
 ## For RCS messaging
 RCS_SENDER_ID=
 
-## For media messaging (WhatsApp, Messenger, Viber)
-IMAGE_URL=
-IMAGE_CAPTION=
-FILE_URL=
-FILE_CAPTION=
-AUDIO_URL=
-VIDEO_URL=
-
-## For Update Action
+# For WhatsApp messaging
+WHATSAPP_SENDER_ID=
+WHATSAPP_TEMPLATE_NAME=
+WHATSAPP_CATALOG_ID=
+WHATSAPP_PRODUCT_ID_1=
+WHATSAPP_PRODUCT_ID_2=
+WHATSAPP_OTP=
 
-MESSAGE_UUID=
-GEOSPECIFIC_VONAGE_API_HOST=
+## For Facebook Messenger messaging
+MESSENGER_RECIPIENT_ID=
+MESSENGER_SENDER_ID=
 
-# Vonage Number Insight variables
+## For Viber messaging
+VIBER_SENDER_ID=
+
+## For media messaging (MMS, RCS, WhatsApp, Messenger, Viber)
+MESSAGES_IMAGE_URL=
+MESSAGES_AUDIO_URL=
+MESSAGES_VIDEO_URL=
+MESSAGES_VIDEO_DURATION=
+MESSAGES_VIDEO_FILE_SIZE=
+MESSAGES_FILE_URL=
+MESSAGES_VCARD_URL=
+MESSAGES_EMOJI=
+WHATSAPP_STICKER_ID=
+WHATSAPP_STICKER_URL=
+
+# Number Insight
 INSIGHT_NUMBER=
+INSIGHT_CALLBACK_URL=
 
-# Vonage Numbers API variables
-COUNTRY_CODE=
+# Number Verification
+
+# Numbers
+VONAGE_NUMBER=
 VONAGE_NUMBER_TYPE=
 VONAGE_NUMBER_FEATURES=
 NUMBER_SEARCH_CRITERIA=
 NUMBER_SEARCH_PATTERN=
-SMS_CALLBACK_URL=
 VOICE_CALLBACK_TYPE=
 VOICE_CALLBACK_VALUE=
 VOICE_STATUS_URL=
+SMS_CALLBACK_URL=
 
-# Vonage SMS API variables
-VONAGE_BRAND_NAME=
+# Reports
 
-# Vonage Account API variables
-VONAGE_SECRET_ID=
+# Sim Swap
 
-## Subaccounts
+# SMS
 
-START_DATE=
+## Note: Set SMS_SENDER_ID under the Messages section
+SMS_TO_NUMBER=
+SMS_SIGNATURE=
+SMS_TIMESTAMP=
+
+# Subaccounts
+SUBACCOUNT_KEY=
 NEW_SUBACCOUNT_NAME=
 NEW_SUBACCOUNT_SECRET=
-SUBACCOUNT_KEY=
+START_DATE=
 AMOUNT=
-COUNTRY=
 
-# Vonage Verify2 API variables
-REQUEST_ID=
-CODE=
-BRAND_NAME=
-TO_EMAIL=
+# VBC
+
+# Verify (v1 & v2)
+VERIFY_REQUEST_ID=
+VERIFY_CODE=
+VERIFY_WORKFLOW_ID=
 VERIFY_TEMPLATE_ID=
 VERIFY_TEMPLATE_FRAGMENT_ID=
-
-# Vonage Meetings API variables
-ROOM_DISPLAY_NAME=
-EXPIRATION_DATE=
-ROOM_ID=
-MAIN_COLOR=
-BRAND_TEXT=
-THEME_ID=
-RECORDING_ID=
-SESSION_ID=
+VERIFY_NUMBER=
+VERIFY_FROM_NUMBER=
+VERIFY_BRAND_NAME=
+VERIFY_PAYEE_NAME=
+VERIFY_AMOUNT=
+VERIFY_TO_EMAIL=
+VERIFY_FROM_EMAIL=
+
+# Voice / Programmable SIP
+VOICE_CALL_ID=
+VOICE_TO_NUMBER=
+VOICE_TEXT=
+VOICE_LANGUAGE=
+VOICE_DTMF_DIGITS=
+VOICE_CONFERENCE_NAME=
+VOICE_ANSWER_URL=
+VOICE_STREAM_URL=
+VOICE_RECORDING_URL=
+VOICE_NCCO_URL=
+SIP_DOMAIN=
+SIP_USER_ID=
+SIP_USER_SECRET=
+SIP_ACL_IP_ADDRESS=

.gitignore

@@ -51,4 +51,5 @@ build-iPhoneSimulator/
 
 .env
 private.key
+*.key
 .byebug_history

Gemfile.lock

@@ -1,45 +1,56 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.2)
     base64 (0.2.0)
-    byebug (11.0.1)
-    connection_pool (2.4.1)
-    daemons (1.3.1)
+    byebug (11.1.3)
+    connection_pool (2.5.0)
+    daemons (1.4.1)
     dotenv (2.7.6)
     eventmachine (1.2.7)
     faye-websocket (0.11.0)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
-    jaro_winkler (1.5.3)
-    jwt (2.9.3)
+    json (2.10.1)
+    jwt (2.10.1)
       base64
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
     multi_json (1.15.0)
     multipart-post (2.4.1)
-    mustermann (1.1.1)
+    mustermann (1.1.2)
       ruby2_keywords (~> 0.0.1)
-    net-http-persistent (4.0.4)
+    net-http-persistent (4.0.5)
       connection_pool (~> 2.2)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    phonelib (0.9.3)
-    rack (2.2.3)
+    parallel (1.26.3)
+    parser (3.3.7.1)
+      ast (~> 2.4.1)
+      racc
+    phonelib (0.10.4)
+    racc (1.8.1)
+    rack (2.2.11)
     rack-contrib (2.3.0)
       rack (~> 2.0)
     rack-protection (2.1.0)
       rack
-    rainbow (3.0.0)
-    rexml (3.3.9)
-    rubocop (0.72.0)
-      jaro_winkler (~> 1.5.1)
+    rainbow (3.1.1)
+    regexp_parser (2.10.0)
+    rexml (3.4.1)
+    rubocop (1.72.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.4)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     sinatra (2.1.0)
       mustermann (~> 1.0)
       rack (~> 2.2)
@@ -51,14 +62,16 @@ GEM
       rack-protection (= 2.1.0)
       sinatra (= 2.1.0)
       tilt (~> 2.0)
-    sorbet-runtime (0.5.11625)
+    sorbet-runtime (0.5.11834)
     thin (1.8.0)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
-    tilt (2.0.10)
-    unicode-display_width (1.6.0)
-    vonage (7.28.0)
+    tilt (2.6.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    vonage (7.29.1)
       multipart-post (~> 2.0)
       net-http-persistent (~> 4.0, >= 4.0.2)
       phonelib
@@ -68,10 +81,11 @@ GEM
       zeitwerk (~> 2, >= 2.2)
     vonage-jwt (0.2.0)
       jwt (~> 2)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.7)
+      base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   ruby

account/configure-account.rb

@@ -3,18 +3,13 @@
 
 VONAGE_API_KEY = ENV['VONAGE_API_KEY']
 VONAGE_API_SECRET = ENV['VONAGE_API_SECRET']
-
-SMS_CALLBACK_URL = ENV['SMS_CALLBACK_URL']
+ACCOUNT_SMS_CALLBACK_URL = ENV['ACCOUNT_SMS_CALLBACK_URL']
 
 client = Vonage::Client.new(
   api_key: VONAGE_API_KEY,
   api_secret: VONAGE_API_SECRET
 )
 
-result = client.account.update(
+response = client.account.update(
   moHttpUrl: SMS_CALLBACK_URL
 )
-
-result.to_h.each do |key, value|
-  puts "#{key}: #{value}"
-end

account/get-balance.rb

@@ -9,4 +9,4 @@
   api_secret: VONAGE_API_SECRET
 )
 
-puts "#{client.account.balance.value.round(2)} EUR"
+response = client.account.balance

account/secret-management/create-a-secret.rb

@@ -5,15 +5,11 @@
 
 VONAGE_API_KEY = ENV['VONAGE_API_KEY']
 VONAGE_API_SECRET = ENV['VONAGE_API_SECRET']
+ACCOUNT_SECRET_VALUE = ENV['ACCOUNT_SECRET_VALUE']
 
 client = Vonage::Client.new(
   api_key: VONAGE_API_KEY,
   api_secret: VONAGE_API_SECRET
 )
 
-begin
-  response = client.secrets.create(secret: 'Th1s-I5-my_n3w-s3cr3t')
-  puts 'Secret Created Successfully' if response.created_at
-rescue StandardError => e
-  puts e.message
-end
+response = client.secrets.create(secret: ACCOUNT_SECRET_VALUE)

account/secret-management/fetch-a-secret.rb

@@ -5,13 +5,11 @@
 
 VONAGE_API_KEY = ENV['VONAGE_API_KEY']
 VONAGE_API_SECRET = ENV['VONAGE_API_SECRET']
-
-VONAGE_SECRET_ID = ENV['VONAGE_SECRET_ID']
+ACCOUNT_SECRET_ID = ENV['ACCOUNT_SECRET_ID']
 
 client = Vonage::Client.new(
   api_key: VONAGE_API_KEY,
   api_secret: VONAGE_API_SECRET
 )
-result = client.secrets.get(VONAGE_SECRET_ID)
 
-puts "ID: #{result.id} created on #{result.created_at}"
+response = client.secrets.get(ACCOUNT_SECRET_ID)

account/secret-management/list-all-secrets.rb

@@ -11,8 +11,4 @@
   api_secret: VONAGE_API_SECRET
 )
 
-result = client.secrets.list
-
-result._embedded.secrets.each do |secret|
-  puts "ID: #{secret.id} created on #{secret.created_at}"
-end
+response = client.secrets.list