{"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"},"id":"vonage/messages-api","name":"Vonage Messages API","vendor":"Vonage","status":"researched","last_verified":null,"last_researched":"2026-10-25","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.","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"}],"identity_requires":[],"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_url":"https://developer.vonage.com/en/account/guides/dashboard-management"},{"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_url":"https://api.support.vonage.com/hc/en-us/articles/204014853-How-do-I-add-test-numbers-during-my-Vonage-API-trial"},{"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_url":"https://developer.vonage.com/en/messages/code-snippets/before-you-begin"},{"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_url":"https://developer.vonage.com/en/dashboard/build/messaging/10dlc"}],"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","gate":"human_submit","human_only":true,"gate_label":"You press submit","depends_on":[],"optional":false,"url":"https://developer.vonage.com/","lead_time":null,"preflight":[],"captures":null},{"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","gate":"human_payment","human_only":true,"gate_label":"You add payment details","depends_on":["sign-up"],"optional":false,"url":null,"lead_time":null,"preflight":[],"captures":null},{"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","gate":"none","human_only":false,"gate_label":null,"depends_on":["sign-up"],"optional":false,"url":null,"lead_time":null,"preflight":[],"captures":"VONAGE_API_SECRET"},{"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","gate":"human_submit","human_only":true,"gate_label":"You press submit","depends_on":["sign-up"],"optional":false,"url":null,"lead_time":null,"preflight":[],"captures":null},{"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","gate":"human_payment","human_only":true,"gate_label":"You add payment details","depends_on":["add-credit","create-application"],"optional":false,"url":null,"lead_time":null,"preflight":[],"captures":null},{"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","gate":"third_party_review","human_only":true,"gate_label":"The provider reviews it","depends_on":["link-number"],"optional":true,"url":null,"lead_time":{"official":{"text":"Manual reviews by Vonage, vetting providers and carriers; allow several days or even weeks.","source_url":"https://developer.vonage.com/en/dashboard/build/messaging/10dlc","source_title":"Vonage docs – Brands and Campaigns (10DLC)"},"reported":null,"typical_minutes":null},"preflight":["legal_name_matches_documents","website_live"],"captures":null}],"gates":[{"step":"sign-up","gate":"human_submit","label":"You press submit"},{"step":"add-credit","gate":"human_payment","label":"You add payment details"},{"step":"create-application","gate":"human_submit","label":"You press submit"},{"step":"link-number","gate":"human_payment","label":"You add payment details"},{"step":"tendlc","gate":"third_party_review","label":"The provider reviews it"}],"lead_times":[{"step":"tendlc","what":"Register 10DLC brand and campaign (US only)","official":{"text":"Manual reviews by Vonage, vetting providers and carriers; allow several days or even weeks.","source_url":"https://developer.vonage.com/en/dashboard/build/messaging/10dlc","source_title":"Vonage docs – Brands and Campaigns (10DLC)"},"reported":null}],"outputs":[{"name":"VONAGE_API_KEY","description":"Vonage API key","secret":false,"example_format":null,"environments":null},{"name":"VONAGE_API_SECRET","description":"Vonage API secret","secret":true,"example_format":null,"environments":null},{"name":"VONAGE_APPLICATION_ID","description":"Application ID (UUID)","secret":false,"example_format":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","environments":null},{"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","environments":null},{"name":"VONAGE_NUMBER","description":"Linked sending number in E.164 without +","secret":false,"example_format":"447700900000","environments":null}],"renewals":[{"what":"Rotate the API secret (two secrets can be active during the switch)","every":"as needed","every_days":null,"source_url":"https://developer.vonage.com/en/getting-started/concepts/authentication"}],"estimated_minutes":null,"guide_url":"https://verapli.com/guides/vonage/messages-api"}