{"registry_version":"2026.1025.387","generated_at":"2026-10-25T06:27:00Z","content_sha256":"089d16f627d9365e3d0663cc8069203706d7cb23a76c332226e29686968811a5","signed":true,"signature":{"key_id":"ed25519:74ca19268e364242","algorithm":"ed25519","expires_at":"2026-11-24T06:27:09Z","expired":false,"manifest":"/registry/manifest.json"},"entry_sha256":"0d8fbfea6e11d4d7e61b2c3f945e15ad9ff370848cde79008237032fad6f435d","entry":{"id":"vonage/messages-api","name":"Vonage Messages API","vendor":"Vonage","summary":"One API for SMS, MMS, RCS, WhatsApp, Messenger, Viber and email. New accounts start in demo mode with restricted destinations; adding credit lifts it. US SMS from long codes needs 10DLC brand and campaign registration.","aliases":["nexmo","vonage-sms","vonage-messages"],"category":"messaging","group":"B","homepage":"https://www.vonage.com/communications-apis/messages/","docs":["https://developer.vonage.com/en/messages/overview","https://developer.vonage.com/en/messages/code-snippets/before-you-begin","https://developer.vonage.com/en/getting-started/concepts/authentication"],"status":"researched","last_verified":null,"last_researched":"2026-10-25","sources":[{"id":"overview","url":"https://developer.vonage.com/en/messages/overview","title":"Vonage docs – Messages API overview","accessed":"2026-10-25","supports":"Channels (SMS, MMS, RCS, WhatsApp, Messenger, Viber, Email); JWT auth; Messages API Sandbox in dashboard; 10DLC APIs for brand, vetting, campaign and number linking","kind":"official"},{"id":"before","url":"https://developer.vonage.com/en/messages/code-snippets/before-you-begin","title":"Vonage docs – Messages API, before you begin","accessed":"2026-10-25","supports":"Need a Vonage API account and Application; Application ID + private.key generate JWT; inbound and status webhook URLs set on the Application; env names VONAGE_API_KEY, VONAGE_API_SECRET, VONAGE_APPLICATION_ID, VONAGE_APPLICATION_PRIVATE_KEY_PATH, VONAGE_NUMBER","kind":"official"},{"id":"auth","url":"https://developer.vonage.com/en/getting-started/concepts/authentication","title":"Vonage docs – Authentication","accessed":"2026-10-25","supports":"Messages supports Basic (key+secret) and JWT; Basic does not support webhooks or advanced features; private key generated from the application dashboard or vonage apps create; two API secrets can be active for rotation","kind":"official"},{"id":"dashboard","url":"https://developer.vonage.com/en/account/guides/dashboard-management","title":"Vonage docs – Using the Vonage Dashboard for account management","accessed":"2026-10-25","supports":"Demo mode sends to up to 10 destination numbers with a demo notice; API key and secret under Settings > API settings; adding credit moves the account out of demo mode","kind":"official"},{"id":"tendlc","url":"https://developer.vonage.com/en/dashboard/build/messaging/10dlc","title":"Vonage docs – Brands and Campaigns (10DLC)","accessed":"2026-10-25","supports":"US 10DLC SMS/MMS requires registration; steps brand, verify/vet, campaign, link numbers; Low Volume Mixed only without vetting; sole proprietor OTP; brand registration €4.50; allow several days or weeks","kind":"official"},{"id":"trial-support","url":"https://api.support.vonage.com/hc/en-us/articles/204014853-How-do-I-add-test-numbers-during-my-Vonage-API-trial","title":"Vonage API Support – How do I add test numbers during my Vonage API trial","accessed":"2026-10-25","supports":"€2 free trial credit; only primary users add test numbers by PIN; \"[FREE SMS DEMO, TEST MESSAGE]\" appended; error \"Non White-listed Destination - rejected (29)\"; trial credit cannot buy numbers (read via search snippet, page blocked to fetch) [to verify]","kind":"official"},{"id":"tendlc-fees","url":"https://api.support.vonage.com/hc/en-us/articles/360058158511-10-DLC-Pricing-and-Fees","title":"Vonage API Support – 10 DLC pricing and fees","accessed":"2026-10-25","supports":"Standard vetting about 41.50, campaign vetting 15 per event, appeal 11, plus possible fines for violations (read via search snippet, page blocked to fetch) [to verify]","kind":"official"}],"allowed_domains":["vonage.com"],"account_model":{"summary":"A Vonage API account (API key + secret) holds Applications. Each Application has an Application ID and a private key, Messages capability and webhook URLs; numbers are linked to an Application. Subaccounts are available.","accounts":[{"name":"Vonage API account","kind":"organisation","owned_by":"the person or the company","required":true,"note":"Starts in demo mode until credit is added."},{"name":"Application","kind":"project","parent":"Vonage API account","required":true,"note":"Needed for JWT auth, webhooks and linked numbers."},{"name":"Subaccount","kind":"project","parent":"Vonage API account","required":false}]},"prerequisites":[{"need":"Email address and mobile phone for sign-up and test-number PINs"}],"have_ready":[{"kind":"payment_card","description":"A card to add credit","why":"Adding credit is what moves the account out of demo mode.","needed_for":["add-credit"],"auto_check":"none","source":"dashboard"},{"kind":"phone_for_2fa","description":"Your own mobile number","why":"Test numbers are verified with a PIN by SMS or voice. [to verify]","needed_for":["sign-up"],"auto_check":"none","source":"trial-support"},{"kind":"live_website","description":"Public HTTPS endpoint for inbound and status webhooks","why":"Webhook URLs are set on the Application; Basic auth does not support webhooks.","needed_for":["create-application"],"auto_check":"none","source":"before"},{"kind":"tax_id","description":"US business details (legal name, EIN) if texting US numbers from a long code","why":"10DLC brand registration. [field list to verify]","needed_for":["tendlc"],"auto_check":"none","source":"tendlc"}],"steps":[{"id":"sign-up","title":"Create a Vonage API account","summary":"Sign up yourself on the Vonage developer site. The account starts in demo mode.","route":"guided","depends_on":[],"gate":"human_submit","url":"https://developer.vonage.com/","recovery":[{"hiccup":"SMS fails with \"Non White-listed Destination - rejected (29)\"","fix":"In demo mode you can only send to test numbers; add the number as a test number or add credit. [to verify]","source":"trial-support"}],"sources":["dashboard"]},{"id":"add-credit","title":"Add credit","summary":"Add credit with your card to leave demo mode and send to any number within local rules.","route":"guided","depends_on":["sign-up"],"gate":"human_payment","sources":["dashboard"]},{"id":"copy-key","title":"Copy API key and secret","summary":"Open Settings > API settings in the dashboard (arrow next to your username) and capture the API key and secret into your vault.","route":"guided","depends_on":["sign-up"],"gate":"none","capture":{"env":"VONAGE_API_SECRET","kind":"secret"},"sources":["dashboard"]},{"id":"create-application","title":"Create an Application with Messages capability","summary":"Create an Application, switch on Messages, set inbound and status webhook URLs, and generate the key pair. The private key file downloads to your machine; keep it in your vault, never in the repo.","route":"guided","depends_on":["sign-up"],"gate":"human_submit","sources":["before","auth"]},{"id":"link-number","title":"Buy and link a number","summary":"Buy a virtual number (needs paid credit) and link it to the Application.","route":"guided","depends_on":["add-credit","create-application"],"gate":"human_payment","sources":["before","trial-support"]},{"id":"tendlc","title":"Register 10DLC brand and campaign (US only)","summary":"Register the brand, get it verified or vetted, register a campaign per use case, then link numbers.","route":"guided","depends_on":["link-number"],"gate":"third_party_review","lead_time":{"official":{"text":"Manual reviews by Vonage, vetting providers and carriers; allow several days or even weeks.","source":"tendlc"}},"preflight":["legal_name_matches_documents","website_live"],"optional":true,"sources":["tendlc"]}],"outputs":[{"name":"VONAGE_API_KEY","description":"Vonage API key","secret":false,"from_step":"copy-key"},{"name":"VONAGE_API_SECRET","description":"Vonage API secret","secret":true,"from_step":"copy-key"},{"name":"VONAGE_APPLICATION_ID","description":"Application ID (UUID)","secret":false,"example_format":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","from_step":"create-application"},{"name":"VONAGE_APPLICATION_PRIVATE_KEY_PATH","description":"Path to the downloaded private.key for JWT signing (the key itself is secret)","secret":false,"example_format":"./private.key","from_step":"create-application"},{"name":"VONAGE_NUMBER","description":"Linked sending number in E.164 without +","secret":false,"example_format":"447700900000","from_step":"link-number"}],"terms_notes":[{"kind":"rules_say","severity":"amber","text":"10DLC carries separate fees (brand registration €4.50, vetting and campaign charges), and fines can be applied for 10DLC violations.","source":"tendlc-fees"},{"kind":"rules_say","severity":"yellow","text":"Demo-mode messages carry a demo notice and reach only a small set of test numbers.","source":"dashboard"},{"kind":"rules_say","severity":"yellow","text":"A Low Volume Mixed campaign is the only option for a brand without external vetting.","source":"tendlc"}],"renewals":[{"what":"Rotate the API secret (two secrets can be active during the switch)","every":"as needed","source":"auth"}],"pricing_notes":{"free_tier":"Small free trial credit (€2 per Vonage support) in demo mode [to verify].","costs":"Pay as you go from account credit; per-message rates by channel and country.","source":"trial-support"},"stripe_projects":false,"api_provisioning":{"available":"partial","notes":"Applications can be created by API or with `vonage apps create`; 10DLC brand and campaign have APIs; the account itself and payment are human-only.","docs":["https://developer.vonage.com/en/application/overview"],"source":"auth"},"detect":{"env_names":["VONAGE_API_KEY","VONAGE_API_SECRET","VONAGE_APPLICATION_ID","NEXMO_API_KEY"],"packages":["@vonage/server-sdk","vonage"]}}}