The Vonage connector lets your AI agent act in each user's Vonage account. Each user connects their own Vonage API key and secret once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 32 tools.
- Tools
- 32
- What they doRead · write · destructive
- 8 · 20 · 48 read20 write4 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Vonage connection
In AgentKit > Connections, create a Vonage connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolvonage_account_balance_getGet the current balance of your Vonage account.Read-onlyGet Account Balance
Get the current balance of your Vonage account. Returns value (balance in EUR), autoReload and the account's top-up settings. Use vonage_account_balance_get to check credit before large sends.
Inputs
This tool takes no inputs.
vonage_number_insight_basicLook up basic, free information about a phone number with Vonage Number Insight: its international and national formats and country.Read-onlyGet Basic Number Insight
Look up basic, free information about a phone number with Vonage Number Insight: its international and national formats and country. Returns status, international_format_number, national_format_number, country_code, country_name and country_prefix. Use vonage_number_insight_basic to normalise or validate a number for free. Use vonage_number_insight_standard or vonage_number_insight_advanced for carrier, porting and reachability data.
Inputs
numberstringrequired- Phone number in national or international format. Example: 447700900000
countrystring- ISO 3166-1 alpha-2 country code, needed when number is in national format. Example: GB
vonage_numbers_listList the virtual phone numbers your Vonage account owns.Read-onlyList Owned Numbers
List the virtual phone numbers your Vonage account owns. Returns count and numbers with msisdn, country, type, features and the linked application. Use vonage_numbers_list to find your sender numbers. Use vonage_numbers_search to find new numbers to buy.
Inputs
application_idstring- Only numbers linked to this Vonage application ID. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
countrystring- Only numbers from this ISO 3166-1 alpha-2 country. Example: GB
has_applicationboolean- true for numbers linked to any application, false for numbers not linked to one. Example: true
indexinteger- Page index, starting at 1. Example: 1
patternstring- Digits to match; use with search_pattern. Example: 7700
search_patterninteger- How pattern matches: 0 starts with, 1 contains, 2 ends with. Example: 1one of
012 sizeinteger- Numbers per page, up to 100. Defaults to 10. Example: 50
vonage_numbers_searchSearch the virtual numbers Vonage has available to buy in a country.Read-onlySearch Available Numbers
Search the virtual numbers Vonage has available to buy in a country. Returns count and numbers with msisdn, type, features and monthly cost. Use vonage_numbers_search before vonage_number_buy. Use vonage_numbers_list for numbers you already own.
Inputs
countrystringrequired- ISO 3166-1 alpha-2 country to search. Example: GB
featuresstring- Required capabilities: SMS, VOICE, MMS or a comma-separated combination from the list. Example: SMS,VOICEone of
SMSVOICESMS,VOICEMMSSMS,MMSVOICE,MMSSMS,MMS,VOICE indexinteger- Page index, starting at 1. Example: 1
patternstring- Digits to match; use with search_pattern. Example: 7700
search_patterninteger- How pattern matches: 0 starts with, 1 contains, 2 ends with. Example: 1one of
012 sizeinteger- Numbers per page, up to 100. Defaults to 10. Example: 20
typestring- Number type: landline, mobile-lvn or landline-toll-free. Example: mobile-lvnone of
landlinemobile-lvnlandline-toll-free
vonage_verify_template_fragment_getGet one text fragment of a Vonage Verify v2 template.Read-onlyGet Verify Template Fragment
Get one text fragment of a Vonage Verify v2 template. Returns template_fragment_id, channel, locale, text and timestamps. Use vonage_verify_template_fragment_get for one fragment. Use vonage_verify_template_fragments_list to browse a template's fragments.
Inputs
template_fragment_idstringrequired- Template fragment UUID. Example: c70f446e-997a-4313-a081-60a02a31dc19
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
vonage_verify_template_fragments_listList the per-channel, per-language texts (fragments) of a Vonage Verify v2 template.Read-onlyList Verify Template Fragments
List the per-channel, per-language texts (fragments) of a Vonage Verify v2 template. Returns fragments with template_fragment_id, channel, locale and text. Use vonage_verify_template_fragments_list to see a template's wording. Use vonage_verify_template_fragment_get for one fragment.
Inputs
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
pageinteger- Page number, starting at 1. Example: 1
page_sizeinteger- Fragments per page, 1 to 100. Defaults to 10. Example: 20
vonage_verify_template_getGet one Vonage Verify v2 custom template by ID.Read-onlyGet Verify Template
Get one Vonage Verify v2 custom template by ID. Returns template_id, name and is_default. Use vonage_verify_template_get for one template. Use vonage_verify_templates_list to browse.
Inputs
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
vonage_verify_templates_listList the custom message templates in your Vonage Verify v2 account.Read-onlyList Verify Templates
List the custom message templates in your Vonage Verify v2 account. Returns templates with template_id, name and is_default, plus paging links. Use vonage_verify_templates_list to find a template_id. Use vonage_verify_template_get for one template.
Inputs
pageinteger- Page number, starting at 1. Example: 1
page_sizeinteger- Templates per page, 1 to 100. Defaults to 10. Example: 20
vonage_account_settings_updateSet the account-wide default webhooks for inbound SMS and SMS delivery receipts on your Vonage account (SMS API).WriteUpdate Account Settings
Set the account-wide default webhooks for inbound SMS and SMS delivery receipts on your Vonage account (SMS API). Returns the saved mo-callback-url, dr-callback-url and request limits. Use vonage_account_settings_update to change account defaults. Use vonage_number_update to set a webhook for one number.
- Idempotent
Inputs
dr_callback_urlstring- Webhook URL for SMS delivery receipts. Send an empty string to clear it. Example: https://example.com/webhooks/delivery-receipt
http_forward_methodstring- HTTP method Vonage uses to call these webhooks. Example: POST_JSONone of
GET_QUERY_PARAMSPOST_QUERY_PARAMSPOST_JSON mo_callback_urlstring- Default webhook URL for inbound SMS on numbers without their own. Send an empty string to clear it. Example: https://example.com/webhooks/inbound-sms
vonage_message_records_listSearch Vonage usage records for messages, calls or verifications by message ID or by date range, using the Reports API.WriteList Message Records
Search Vonage usage records for messages, calls or verifications by message ID or by date range, using the Reports API. Returns records with id, direction, from, to, status, price and timestamps, plus a cursor for the next page. Use vonage_message_records_list to check what happened to sent messages or verifications. Records can lag a few minutes behind the send.
- Idempotent
Inputs
account_idstringrequired- Your Vonage API key (or a subaccount's API key) whose records to search. Example: abcd1234
productstringrequired- Which product's records to return: SMS (SMS API), MESSAGES (Messages API: SMS, MMS, WhatsApp, Viber, Messenger, RCS), VERIFY-V2, VOICE-CALL or NUMBER-INSIGHT. Example: MESSAGESone of
SMSMESSAGESVERIFY-V2VERIFY-APIVOICE-CALLNUMBER-INSIGHT cursorstring- Cursor from the previous page's response, to fetch the next page of a date-range search. Example: dGhpcyBpcyBhIGN1cnNvcg
date_endstring- End of the search window as ISO 8601. Defaults to now. Example: 2026-11-02T00:00:00Z
date_startstring- Start of the search window as ISO 8601, for example 2026-11-01T00:00:00Z. Use with date_end instead of id. Example: 2026-11-01T00:00:00Z
directionstring- inbound (received by Vonage) or outbound (sent by you). Required by Vonage for SMS and MESSAGES. Example: outboundone of
inboundoutbound fromstring- Only records with this sender ID or number. Example: Acme
idstring- One message or call UUID, or a comma-separated list of up to 20. Use either id or date_start/date_end. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
include_messageboolean- Include the message text in each record (SMS and MESSAGES only). Example: false
ivstring- The iv value returned with the cursor; pass it with cursor. Example: aXYxMjM0NTY3ODkw
providerstring- For product MESSAGES: only this channel. Example: whatsappone of
whatsappsmsmmsmessengerviber_service_msginstagramrcsemail statusstring- Only records with this status, for example delivered or failed. Example: delivered
tostring- Only records sent to this phone number. Example: 447700900000
vonage_messenger_sendSend a Facebook Messenger message (text, image, audio, video or file) from a Facebook Page linked to Vonage.WriteSend Facebook Messenger Message
Send a Facebook Messenger message (text, image, audio, video or file) from a Facebook Page linked to Vonage. Returns the message_uuid for status tracking. Use vonage_messenger_send to reply to a Messenger user who has contacted your Page. Use the other send tools for SMS, WhatsApp, RCS or Viber.
Inputs
fromstringrequired- The ID of your Facebook Page linked to the Vonage application. Example: 9876543210987654
message_typestringrequired- What to send: text, image, audio, video or file. text uses text; the other types use media_url. Example: textone of
textimageaudiovideofile tostringrequired- Recipient. The recipient's Page-scoped user ID (PSID), taken from an inbound Messenger webhook. Example: 1234567890123456
categorystring- Messenger message category. response is a reply within 24 hours; update is a proactive update within 24 hours; message_tag needs tag. Example: responseone of
responseupdatemessage_tag client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
media_urlstring- Public HTTPS URL of the media file. Required when message_type is image, audio, video or file; ignored for text. Example: https://example.com/files/receipt.jpg
tagstring- Messenger message tag, required when category is message_tag, for example CONFIRMED_EVENT_UPDATE, POST_PURCHASE_UPDATE, ACCOUNT_UPDATE or HUMAN_AGENT. Example: POST_PURCHASE_UPDATE
textstring- Message text, up to 640 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_mms_sendSend an MMS message (text, image, vCard, audio, video or file) to a US or Canadian number through the Vonage Messages API.WriteSend MMS
Send an MMS message (text, image, vCard, audio, video or file) to a US or Canadian number through the Vonage Messages API. Returns the message_uuid for status tracking. Use vonage_mms_send for multimedia to US/Canadian numbers. Use vonage_sms_send for plain text SMS anywhere.
Inputs
fromstringrequired- A US or Canadian Vonage 10DLC, toll-free or short code number that is MMS-enabled, in E.164 format without +. Example: 14155550100
message_typestringrequired- What to send: text, image, vcard, audio, video or file. text uses text; every other type uses media_url. Example: imageone of
textimagevcardaudiovideofile tostringrequired- Recipient. US or Canadian phone number in E.164 format without the leading + or 00. Example: 14155550101
captionstring- Optional caption shown with the media. Applies when message_type is image, vcard, audio, video or file; ignored otherwise. Example: Your receipt
client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
media_urlstring- Public HTTPS URL of the media file. Required when message_type is image, vcard, audio, video or file; ignored for text. Example: https://example.com/files/receipt.jpg
textstring- Message text, up to 5000 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
ttlinteger- How long Vonage keeps retrying delivery, in seconds (300 to 259200). Defaults to 72 hours. Example: 86400
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_number_buyBuy an available virtual number for your Vonage account.WriteBuy Number
Buy an available virtual number for your Vonage account. This charges your balance. Returns error-code 200 and error-code-label success when the purchase went through. Use vonage_number_buy with an msisdn found by vonage_numbers_search. Use vonage_number_update afterwards to link it to an application.
Inputs
countrystringrequired- ISO 3166-1 alpha-2 country of the number. Example: GB
msisdnstringrequired- The available number to buy, from vonage_numbers_search. Example: 447700900123
target_api_keystring- API key of a subaccount to buy the number for. Leave empty for your own account. Example: 1a2b3c4d
vonage_number_insight_advancedLook up a phone number's validity, reachability, carrier, porting and roaming status with Vonage Number Insight Advanced (synchronous).WriteGet Advanced Number Insight
Look up a phone number's validity, reachability, carrier, porting and roaming status with Vonage Number Insight Advanced (synchronous). This is a paid lookup. Returns the standard fields plus valid_number, reachable, lookup_outcome and roaming details. Use vonage_number_insight_advanced for fraud screening before you send. Use vonage_number_insight_standard when reachability is not needed.
- Idempotent
Inputs
numberstringrequired- Phone number in national or international format. Example: 447700900000
cnamboolean- Set true to also return the caller ID name (US numbers only; extra charge). Example: false
countrystring- ISO 3166-1 alpha-2 country code, needed when number is in national format. Example: GB
vonage_number_insight_standardLook up a phone number's type, current and original carrier and porting status with Vonage Number Insight Standard.WriteGet Standard Number Insight
Look up a phone number's type, current and original carrier and porting status with Vonage Number Insight Standard. This is a paid lookup. Returns the basic fields plus current_carrier, original_carrier, ported, roaming and, with cnam, the caller name for US numbers. Use vonage_number_insight_standard to tell mobile from landline or VoIP before sending. Use vonage_number_insight_advanced to also check reachability and validity.
- Idempotent
Inputs
numberstringrequired- Phone number in national or international format. Example: 447700900000
cnamboolean- Set true to also return the caller ID name (US numbers only; extra charge). Example: false
countrystring- ISO 3166-1 alpha-2 country code, needed when number is in national format. Example: GB
vonage_number_updateChange where an owned Vonage number sends inbound traffic: link it to an application or set its inbound SMS and voice webhooks.WriteUpdate Number
Change where an owned Vonage number sends inbound traffic: link it to an application or set its inbound SMS and voice webhooks. Returns error-code 200 and error-code-label success when the change was saved. Use vonage_number_update after vonage_number_buy, or to move a number between applications.
- Idempotent
Inputs
countrystringrequired- ISO 3166-1 alpha-2 country of the number. Example: GB
msisdnstringrequired- The owned number to update. Example: 447700900123
app_idstring- ID of the Vonage application that handles inbound messages and calls for this number. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
mo_http_urlstring- Webhook URL for inbound SMS to this number (SMS API). Example: https://example.com/webhooks/inbound-sms
voice_callback_typestring- Forward inbound calls to sip, tel or app. Set together with voice_callback_value. Example: appone of
siptelapp voice_callback_valuestring- SIP URI, phone number or application ID that receives inbound calls. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
voice_status_callbackstring- Webhook URL called when an inbound call ends. Example: https://example.com/webhooks/call-status
vonage_rcs_sendSend an RCS Business Messaging message (text, image, video, file or a custom RCS object) through the Vonage Messages API.WriteSend RCS Message
Send an RCS Business Messaging message (text, image, video, file or a custom RCS object) through the Vonage Messages API. Returns the message_uuid for status tracking. Use vonage_rcs_send for RCS-capable Android handsets with a registered RCS agent. Use vonage_sms_send to reach any phone.
Inputs
fromstringrequired- Your RCS agent ID (sender ID) as registered with Vonage. Example: AcmeAgent
message_typestringrequired- What to send: text, image, video, file or custom. text uses text, custom uses custom, every other type uses media_url. Example: textone of
textimagevideofilecustom tostringrequired- Recipient. Phone number in E.164 format without the leading + or 00. Example: 447700900000
categorystring- RCS traffic category for billing and compliance. Example: transactionone of
authenticationtransactionpromotionservice-requestacknowledgement client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
customobject- Custom RCS message object (for example a rich card or carousel with suggestions), sent as-is when message_type is custom. Example: {"contentMessage": {"text": "Pick a delivery slot", "suggestions": [{"reply": {"text": "Morning", "postbackData": "am"}}]}}
media_urlstring- Public HTTPS URL of the media file. Required when message_type is image, video or file; ignored for text. Example: https://example.com/files/receipt.jpg
textstring- Message text, up to 3072 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
ttlinteger- How long Vonage keeps retrying delivery, in seconds (20 to 259200). Example: 3600
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_sms_sendSend an SMS text message through the Vonage Messages API.WriteSend SMS
Send an SMS text message through the Vonage Messages API. Returns the message_uuid that identifies the message in status webhooks and reports. Use vonage_sms_send for plain SMS. Use vonage_mms_send for pictures or files and vonage_whatsapp_send, vonage_rcs_send, vonage_viber_send or vonage_messenger_send for those channels.
Inputs
fromstringrequired- Sender: a Vonage virtual number in E.164 format without + or 00, or an alphanumeric sender ID of up to 11 characters where the destination country allows it. Example: Acme
textstringrequired- Message text, up to 1000 characters. Longer texts are sent as several concatenated SMS parts and billed per part. Example: Your code is 482910
tostringrequired- Recipient. Phone number in E.164 format without the leading + or 00. Example: 447700900000
client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
content_idstring- India DLT only: the content template ID registered for this message. Example: 1107160000000000000
encoding_typestring- Character encoding. auto (default) picks text or unicode from the content; unicode is needed for non-GSM characters and lowers the characters per part. Example: autoone of
textunicodeauto entity_idstring- India DLT only: the entity ID registered with the DLT platform. Example: 1101456000000000000
ttlinteger- How long Vonage keeps trying to deliver the SMS, in seconds (20 to 604800). Defaults to 72 hours; most operators stop after 24 to 48 hours. Example: 86400
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_verify_code_checkCheck the code a user entered against a Vonage Verify v2 request.WriteCheck Verification Code
Check the code a user entered against a Vonage Verify v2 request. Returns request_id and status completed on a match; a wrong code returns an error and counts towards the attempt limit. Use vonage_verify_code_check after vonage_verify_request_create once the user types the code they received.
Inputs
codestringrequired- The code the user entered, 4 to 10 alphanumeric characters. Example: 482910
request_idstringrequired- request_id returned by vonage_verify_request_create. Example: c11236f4-00bf-4b89-84ba-88b25df97315
vonage_verify_next_workflowSkip the current channel of a Vonage Verify v2 request and send the code over the next channel in its workflow right away.WriteMove to Next Verification Channel
Skip the current channel of a Vonage Verify v2 request and send the code over the next channel in its workflow right away. Returns 200 with no body on success. Use vonage_verify_next_workflow when the user asks for the code another way, for example a voice call instead of SMS.
Inputs
request_idstringrequired- request_id returned by vonage_verify_request_create. Example: c11236f4-00bf-4b89-84ba-88b25df97315
vonage_verify_request_createStart a Vonage Verify v2 request that sends a one-time code to a user over SMS, WhatsApp, voice, email or RCS, falling back through up to three channels.WriteStart Verification
Start a Vonage Verify v2 request that sends a one-time code to a user over SMS, WhatsApp, voice, email or RCS, falling back through up to three channels. Returns the request_id to use with vonage_verify_code_check. Use vonage_verify_request_create to begin phone or email verification. Use vonage_verify_code_check to submit the code the user enters.
Inputs
brandstringrequired- Your brand name shown in the message, 1 to 18 characters, without / { } : or $. Example: ACME
workflowarrayrequired- Channels to try, in order, up to three. Each entry has channel (sms, whatsapp, voice, email, rcs or silent_auth) and to (phone number in E.164 without +, or an email address for email); whatsapp and rcs also need from, and email can take from. Example: [{"channel": "sms", "to": "447700900000"}, {"channel": "voice", "to": "447700900000"}]
channel_timeoutinteger- Seconds to wait before moving to the next channel in the workflow (60 to 900). Defaults to 300. Example: 300
client_refstring- Your own reference, up to 40 letters and digits (no spaces or punctuation), returned in Verify callbacks. Example: signup1234
codestring- Your own alphanumeric code (4 to 10 characters) instead of a generated one. Only allowed on the Verify Conversion pricing model. Example: AB12CD
code_lengthinteger- Number of digits in the generated code: 4 to 10. Defaults to 4. Example: 6one of
45678910 fraud_checkboolean- Set false to skip the network fraud check for this request (only if Vonage enabled that for your account). Defaults to true. Example: true
localestring- Language of the message, for example en-us, en-gb, es-es or fr-fr. Defaults to en-us. Example: en-gb
template_idstring- ID of a custom Verify template to use for sms or rcs channels. Create one with vonage_verify_template_create. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
vonage_verify_template_createCreate an empty custom Verify v2 template; add its per-language texts with vonage_verify_template_fragment_create.WriteCreate Verify Template
Create an empty custom Verify v2 template; add its per-language texts with vonage_verify_template_fragment_create. Returns the new template_id, name and is_default. Use vonage_verify_template_create when the default Verify wording does not fit. Custom templates need a Vonage account enabled for them.
Inputs
namestringrequired- Reference name for the template, letters, numbers, - and _ only. Example: signup-otp
vonage_verify_template_fragment_createAdd a message text for one channel and language to a Vonage Verify v2 template.WriteCreate Verify Template Fragment
Add a message text for one channel and language to a Vonage Verify v2 template. Returns the new template_fragment_id, channel, locale and text. Use vonage_verify_template_fragment_create after vonage_verify_template_create, once per channel and language you need.
Inputs
channelstringrequired- Channel this text is for: sms or voice. Example: smsone of
smsvoice localestringrequired- Lowercase locale of the text, for example en-us or es-es. Example: en-us
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
textstringrequired- Message text. Must contain ${code}; may also use ${brand}, ${time-limit} and ${time-limit-unit}. Example: Your ${brand} code is ${code}. It expires in ${time-limit} ${time-limit-unit}.
vonage_verify_template_fragment_updateReplace the text of one Vonage Verify v2 template fragment.WriteUpdate Verify Template Fragment
Replace the text of one Vonage Verify v2 template fragment. Returns the updated fragment. Use vonage_verify_template_fragment_update to reword an existing channel and language. Use vonage_verify_template_fragment_create to add a new one.
- Idempotent
Inputs
template_fragment_idstringrequired- Template fragment UUID. Example: c70f446e-997a-4313-a081-60a02a31dc19
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
textstringrequired- New message text. Must contain ${code}; may also use ${brand}, ${time-limit} and ${time-limit-unit}. Example: ${brand}: your code is ${code}
vonage_verify_template_updateRename a Vonage Verify v2 template or make it the default template for new requests.WriteUpdate Verify Template
Rename a Vonage Verify v2 template or make it the default template for new requests. Returns the updated template. Use vonage_verify_template_update to change name or default status. Use vonage_verify_template_fragment_update to change message text.
- Idempotent
Inputs
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
is_defaultboolean- Set true to use this template whenever a request gives no template_id. Example: true
namestring- New reference name. Example: signup-otp-v2
vonage_viber_sendSend a Viber Business message (text, image or file) through the Vonage Messages API, with an optional call-to-action button.WriteSend Viber Message
Send a Viber Business message (text, image or file) through the Vonage Messages API, with an optional call-to-action button. Returns the message_uuid for status tracking. Use vonage_viber_send for Viber users when you have an approved Viber Business sender. Use vonage_sms_send to reach any phone.
Inputs
fromstringrequired- Your Viber Business service message ID (sender ID) as approved by Vonage. Example: AcmeViber
message_typestringrequired- What to send: text, image or file. text uses text; image and file use media_url. Example: textone of
textimagefile tostringrequired- Recipient. Viber user's phone number in E.164 format without the leading + or 00. Example: 447700900000
action_textstring- Label of the call-to-action button, up to 30 characters. Set it together with action_url. Example: Track order
action_urlstring- URL opened by the call-to-action button. Set it together with action_text. Example: https://example.com/track/1234
categorystring- Viber message category: transaction or promotion. Promotion messages need the user's opt-in. Example: transactionone of
transactionpromotion client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
file_namestring- Optional file name shown to the recipient when message_type is file. Example: invoice-1234.pdf
media_urlstring- Public HTTPS URL of the media file. Required when message_type is image or file; ignored for text. Example: https://example.com/files/receipt.jpg
textstring- Message text, up to 1000 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
viber_ttlinteger- How long Viber tries to deliver the message, in seconds (30 to 259200). Example: 600
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_whatsapp_sendSend a WhatsApp message (text, image, audio, video, file, sticker or a custom WhatsApp object) through the Vonage Messages API.WriteSend WhatsApp Message
Send a WhatsApp message (text, image, audio, video, file, sticker or a custom WhatsApp object) through the Vonage Messages API. Returns the message_uuid for status tracking. Use vonage_whatsapp_send inside the 24-hour customer care window or for custom payloads such as interactive buttons. Use vonage_whatsapp_template_send to start a conversation with an approved template.
Inputs
fromstringrequired- Your WhatsApp Business number linked to the Vonage application, in E.164 format without +. Example: 447700900001
message_typestringrequired- What to send: text, image, audio, video, file, sticker or custom. text uses text, custom uses custom, every other type uses media_url. Example: textone of
textimageaudiovideofilestickercustom tostringrequired- Recipient. WhatsApp phone number in E.164 format without the leading + or 00. Example: 447700900000
captionstring- Optional caption shown with the media. Applies when message_type is image, video or file; ignored otherwise. Example: Your receipt
client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
customobject- Custom WhatsApp message object, sent as-is when message_type is custom. Use it for interactive lists, buttons, locations, contacts or reactions in WhatsApp Cloud API format. Example: {"type": "interactive", "interactive": {"type": "button", "body": {"text": "Confirm your order?"}, "action": {"buttons": [{"type": "reply", "reply": {"id": "yes", "title": "Yes"}}]}}}
file_namestring- Optional file name shown to the recipient when message_type is file. Example: invoice-1234.pdf
media_urlstring- Public HTTPS URL of the media file. Required when message_type is image, audio, video, file or sticker; ignored for text. Example: https://example.com/files/receipt.jpg
reply_to_message_uuidstring- message_uuid of an inbound message to quote as a reply. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
textstring- Message text, up to 4096 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_whatsapp_template_sendSend a pre-approved WhatsApp message template through the Vonage Messages API, filling its placeholders.WriteSend WhatsApp Template
Send a pre-approved WhatsApp message template through the Vonage Messages API, filling its placeholders. Returns the message_uuid for status tracking. Use vonage_whatsapp_template_send to message a user outside the 24-hour customer care window. Use vonage_whatsapp_send for free-form replies inside it.
Inputs
fromstringrequired- Your WhatsApp Business number linked to the Vonage application, in E.164 format without +. Example: 447700900001
localestringrequired- BCP 47 locale of the template version to send, for example en_US or pt_BR. Example: en_US
template_namestringrequired- Name of the approved template, in the form namespace:template_name as shown in the Vonage dashboard. Example: 9b6b4fcb_da19_4a26_8fe8_78074a91b584:verify
tostringrequired- Recipient. WhatsApp phone number in E.164 format without the leading + or 00. Example: 447700900000
client_refstring- Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
parametersarray- Values for the template body placeholders {{1}}, {{2}} and so on, in order. Example: ["482910", "10"]
webhook_urlstring- Status webhook URL for this message only. It overrides the status URL set on the Vonage application; leave empty to use the application default. Example: https://example.com/webhooks/status
vonage_number_cancelCancel (release) a virtual number your Vonage account owns.DestructiveCancel Number
Cancel (release) a virtual number your Vonage account owns. You lose the number and it may be bought by someone else. Returns error-code 200 and error-code-label success when the number was released. Use vonage_number_cancel to stop paying for a number you no longer need.
- Idempotent
Inputs
countrystringrequired- ISO 3166-1 alpha-2 country of the number. Example: GB
msisdnstringrequired- The owned number to cancel, from vonage_numbers_list. Example: 447700900123
target_api_keystring- API key of the subaccount that owns the number. Leave empty for your own account. Example: 1a2b3c4d
vonage_verify_request_cancelCancel an in-progress Vonage Verify v2 request so no further codes are sent.DestructiveCancel Verification
Cancel an in-progress Vonage Verify v2 request so no further codes are sent. Returns an empty 204 response on success. Use vonage_verify_request_cancel when the user abandons verification. A request can only be cancelled within 30 seconds of its start and before the second channel is tried.
- Idempotent
Inputs
request_idstringrequired- request_id returned by vonage_verify_request_create. Example: c11236f4-00bf-4b89-84ba-88b25df97315
vonage_verify_template_deleteDelete a Vonage Verify v2 custom template.DestructiveDelete Verify Template
Delete a Vonage Verify v2 custom template. The template must have no fragments left. Returns an empty 204 response on success. Use vonage_verify_template_delete after removing its fragments with vonage_verify_template_fragment_delete.
- Idempotent
Inputs
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
vonage_verify_template_fragment_deleteDelete one text fragment from a Vonage Verify v2 template.DestructiveDelete Verify Template Fragment
Delete one text fragment from a Vonage Verify v2 template. Returns an empty 204 response on success. Use vonage_verify_template_fragment_delete to drop a language or channel from a template.
- Idempotent
Inputs
template_fragment_idstringrequired- Template fragment UUID. Example: c70f446e-997a-4313-a081-60a02a31dc19
template_idstringrequired- Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
No tools match.