> **Building with AI coding agents?** Install the authstack plugin with one command. This equips your agent with accurate Scalekit implementation patterns.
>
> **Recommended** (the `-y` flags skip prompts, so the command runs without an interactive terminal):
> ```bash
> npx -y @scalekit-inc/cli setup -y
> ```
>
> Global:
> ```bash
> npm install -g @scalekit-inc/cli
> scalekit setup -y
> ```
>
> Supports Claude Code, Cursor, GitHub Copilot, Codex + skills for other Agent Skills-compatible agents in `~/.agents/skills`.
> Skills: integrate-agentkit, implement-saaskit, add-mcp-oauth, implement-sso, implement-scim.
> [Full setup guide](https://docs.scalekit.com/dev-kit/build-with-ai/)

---

# Connect AI agents to Vonage

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.

**Authentication:** API Key and Secret
**Categories:** Communication
**Tools:** 32: 8 read, 20 write, 4 destructive
**Users sign in with:** API key
**Built by:** Scalekit connector
**Try it:** [Playground in the Scalekit dashboard](https://app.scalekit.com/ws/signup?sk_intent=playground&provider=VONAGE)

## Setup

1. ### Install the SDK

   **Node.js**

   ```bash
   npm install @scalekit-sdk/node dotenv
   ```

   **Python**

   ```bash
   pip install scalekit-sdk-python python-dotenv
   ```

2. ### Set your credentials

   Add your Scalekit credentials to your `.env` file. Find values in **[app.scalekit.com](https://app.scalekit.com)** > **Developers** > **API Credentials**.

   ```sh title=".env"
   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>
   ```

3. ### Create the Vonage connection

   In **AgentKit > Connections**, create a Vonage connection. The name you give it is the `connection_name` your code passes. See [Configure connections](/agentkit/connections/).

## Tools

Pass the exact name to `execute_tool`, with an input like each tool's example. To ask for a tool that's missing, use the [request form](https://scalekitsupport.portal.usepylon.com/forms/request-a-connector-tool).

**Node.js**

```typescript
const result = await actions.executeTool({
  toolName: 'vonage_account_balance_get',
  toolInput: {},
  connector: 'vonage',
  identifier: 'user_123',
})
```

**Python**

```python
result = actions.execute_tool(
    tool_name="vonage_account_balance_get",
    tool_input={},
    connection_name="vonage",
    identifier="user_123",
)
```

`result.data` is the app's response as JSON, and `result.execution_id` (`executionId` in Node.js) is the ID of the call.

### `vonage_account_balance_get`

Get Account Balance · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs: none.

Example input: `{}`

### `vonage_number_insight_basic`

Get Basic Number Insight · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `number` (`string`, required): Phone number in national or international format. Example: 447700900000
- `country` (`string`, optional): ISO 3166-1 alpha-2 country code, needed when number is in national format. Example: GB

Example input: `{"number":"<number>"}`

### `vonage_numbers_list`

List Owned Numbers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `application_id` (`string`, optional): Only numbers linked to this Vonage application ID. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
- `country` (`string`, optional): Only numbers from this ISO 3166-1 alpha-2 country. Example: GB
- `has_application` (`boolean`, optional): true for numbers linked to any application, false for numbers not linked to one. Example: true
- `index` (`integer`, optional): Page index, starting at 1. Example: 1
- `pattern` (`string`, optional): Digits to match; use with search_pattern. Example: 7700
- `search_pattern` (`integer`, optional): How pattern matches: 0 starts with, 1 contains, 2 ends with. Example: 1. One of: `0`, `1`, `2`.
- `size` (`integer`, optional): Numbers per page, up to 100. Defaults to 10. Example: 50

Example input: `{}`

### `vonage_numbers_search`

Search Available Numbers · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `country` (`string`, required): ISO 3166-1 alpha-2 country to search. Example: GB
- `features` (`string`, optional): Required capabilities: SMS, VOICE, MMS or a comma-separated combination from the list. Example: SMS,VOICE. One of: `SMS`, `VOICE`, `SMS,VOICE`, `MMS`, `SMS,MMS`, `VOICE,MMS`, `SMS,MMS,VOICE`.
- `index` (`integer`, optional): Page index, starting at 1. Example: 1
- `pattern` (`string`, optional): Digits to match; use with search_pattern. Example: 7700
- `search_pattern` (`integer`, optional): How pattern matches: 0 starts with, 1 contains, 2 ends with. Example: 1. One of: `0`, `1`, `2`.
- `size` (`integer`, optional): Numbers per page, up to 100. Defaults to 10. Example: 20
- `type` (`string`, optional): Number type: landline, mobile-lvn or landline-toll-free. Example: mobile-lvn. One of: `landline`, `mobile-lvn`, `landline-toll-free`.

Example input: `{"country":"<country>"}`

### `vonage_verify_template_fragment_get`

Get Verify Template Fragment · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_fragment_id` (`string`, required): Template fragment UUID. Example: c70f446e-997a-4313-a081-60a02a31dc19
- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9

Example input: `{"template_fragment_id":"<template_fragment_id>","template_id":"<template_id>"}`

### `vonage_verify_template_fragments_list`

List Verify Template Fragments · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `page_size` (`integer`, optional): Fragments per page, 1 to 100. Defaults to 10. Example: 20

Example input: `{"template_id":"<template_id>"}`

### `vonage_verify_template_get`

Get Verify Template · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9

Example input: `{"template_id":"<template_id>"}`

### `vonage_verify_templates_list`

List Verify Templates · Read-only

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.

Read only: yes. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `page` (`integer`, optional): Page number, starting at 1. Example: 1
- `page_size` (`integer`, optional): Templates per page, 1 to 100. Defaults to 10. Example: 20

Example input: `{}`

### `vonage_account_settings_update`

Update Account Settings · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `dr_callback_url` (`string`, optional): Webhook URL for SMS delivery receipts. Send an empty string to clear it. Example: https://example.com/webhooks/delivery-receipt
- `http_forward_method` (`string`, optional): HTTP method Vonage uses to call these webhooks. Example: POST_JSON. One of: `GET_QUERY_PARAMS`, `POST_QUERY_PARAMS`, `POST_JSON`.
- `mo_callback_url` (`string`, optional): 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

Example input: `{}`

### `vonage_message_records_list`

List Message Records · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `account_id` (`string`, required): Your Vonage API key (or a subaccount's API key) whose records to search. Example: abcd1234
- `product` (`string`, required): 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: MESSAGES. One of: `SMS`, `MESSAGES`, `VERIFY-V2`, `VERIFY-API`, `VOICE-CALL`, `NUMBER-INSIGHT`.
- `cursor` (`string`, optional): Cursor from the previous page's response, to fetch the next page of a date-range search. Example: dGhpcyBpcyBhIGN1cnNvcg
- `date_end` (`string`, optional): End of the search window as ISO 8601. Defaults to now. Example: 2026-11-02T00:00:00Z
- `date_start` (`string`, optional): 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
- `direction` (`string`, optional): inbound (received by Vonage) or outbound (sent by you). Required by Vonage for SMS and MESSAGES. Example: outbound. One of: `inbound`, `outbound`.
- `from` (`string`, optional): Only records with this sender ID or number. Example: Acme
- `id` (`string`, optional): 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_message` (`boolean`, optional): Include the message text in each record (SMS and MESSAGES only). Example: false
- `iv` (`string`, optional): The iv value returned with the cursor; pass it with cursor. Example: aXYxMjM0NTY3ODkw
- `provider` (`string`, optional): For product MESSAGES: only this channel. Example: whatsapp. One of: `whatsapp`, `sms`, `mms`, `messenger`, `viber_service_msg`, `instagram`, `rcs`, `email`.
- `status` (`string`, optional): Only records with this status, for example delivered or failed. Example: delivered
- `to` (`string`, optional): Only records sent to this phone number. Example: 447700900000

Example input: `{"account_id":"<account_id>","product":"SMS"}`

### `vonage_messenger_send`

Send Facebook Messenger Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): The ID of your Facebook Page linked to the Vonage application. Example: 9876543210987654
- `message_type` (`string`, required): What to send: text, image, audio, video or file. text uses text; the other types use media_url. Example: text. One of: `text`, `image`, `audio`, `video`, `file`.
- `to` (`string`, required): Recipient. The recipient's Page-scoped user ID (PSID), taken from an inbound Messenger webhook. Example: 1234567890123456
- `category` (`string`, optional): Messenger message category. response is a reply within 24 hours; update is a proactive update within 24 hours; message_tag needs tag. Example: response. One of: `response`, `update`, `message_tag`.
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `media_url` (`string`, optional): 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
- `tag` (`string`, optional): 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
- `text` (`string`, optional): Message text, up to 640 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
- `webhook_url` (`string`, optional): 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

Example input: `{"from":"<from>","message_type":"text","to":"<to>"}`

### `vonage_mms_send`

Send MMS · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): A US or Canadian Vonage 10DLC, toll-free or short code number that is MMS-enabled, in E.164 format without +. Example: 14155550100
- `message_type` (`string`, required): What to send: text, image, vcard, audio, video or file. text uses text; every other type uses media_url. Example: image. One of: `text`, `image`, `vcard`, `audio`, `video`, `file`.
- `to` (`string`, required): Recipient. US or Canadian phone number in E.164 format without the leading + or 00. Example: 14155550101
- `caption` (`string`, optional): Optional caption shown with the media. Applies when message_type is image, vcard, audio, video or file; ignored otherwise. Example: Your receipt
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `media_url` (`string`, optional): 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
- `text` (`string`, optional): Message text, up to 5000 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
- `ttl` (`integer`, optional): How long Vonage keeps retrying delivery, in seconds (300 to 259200). Defaults to 72 hours. Example: 86400
- `webhook_url` (`string`, optional): 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

Example input: `{"from":"<from>","message_type":"text","to":"<to>"}`

### `vonage_number_buy`

Buy Number · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `country` (`string`, required): ISO 3166-1 alpha-2 country of the number. Example: GB
- `msisdn` (`string`, required): The available number to buy, from vonage_numbers_search. Example: 447700900123
- `target_api_key` (`string`, optional): API key of a subaccount to buy the number for. Leave empty for your own account. Example: 1a2b3c4d

Example input: `{"country":"<country>","msisdn":"<msisdn>"}`

### `vonage_number_insight_advanced`

Get Advanced Number Insight · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `number` (`string`, required): Phone number in national or international format. Example: 447700900000
- `cnam` (`boolean`, optional): Set true to also return the caller ID name (US numbers only; extra charge). Example: false
- `country` (`string`, optional): ISO 3166-1 alpha-2 country code, needed when number is in national format. Example: GB

Example input: `{"number":"<number>"}`

### `vonage_number_insight_standard`

Get Standard Number Insight · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `number` (`string`, required): Phone number in national or international format. Example: 447700900000
- `cnam` (`boolean`, optional): Set true to also return the caller ID name (US numbers only; extra charge). Example: false
- `country` (`string`, optional): ISO 3166-1 alpha-2 country code, needed when number is in national format. Example: GB

Example input: `{"number":"<number>"}`

### `vonage_number_update`

Update Number · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `country` (`string`, required): ISO 3166-1 alpha-2 country of the number. Example: GB
- `msisdn` (`string`, required): The owned number to update. Example: 447700900123
- `app_id` (`string`, optional): ID of the Vonage application that handles inbound messages and calls for this number. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
- `mo_http_url` (`string`, optional): Webhook URL for inbound SMS to this number (SMS API). Example: https://example.com/webhooks/inbound-sms
- `voice_callback_type` (`string`, optional): Forward inbound calls to sip, tel or app. Set together with voice_callback_value. Example: app. One of: `sip`, `tel`, `app`.
- `voice_callback_value` (`string`, optional): SIP URI, phone number or application ID that receives inbound calls. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
- `voice_status_callback` (`string`, optional): Webhook URL called when an inbound call ends. Example: https://example.com/webhooks/call-status

Example input: `{"country":"<country>","msisdn":"<msisdn>"}`

### `vonage_rcs_send`

Send RCS Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): Your RCS agent ID (sender ID) as registered with Vonage. Example: AcmeAgent
- `message_type` (`string`, required): What to send: text, image, video, file or custom. text uses text, custom uses custom, every other type uses media_url. Example: text. One of: `text`, `image`, `video`, `file`, `custom`.
- `to` (`string`, required): Recipient. Phone number in E.164 format without the leading + or 00. Example: 447700900000
- `category` (`string`, optional): RCS traffic category for billing and compliance. Example: transaction. One of: `authentication`, `transaction`, `promotion`, `service-request`, `acknowledgement`.
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `custom` (`object`, optional): 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_url` (`string`, optional): 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
- `text` (`string`, optional): Message text, up to 3072 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
- `ttl` (`integer`, optional): How long Vonage keeps retrying delivery, in seconds (20 to 259200). Example: 3600
- `webhook_url` (`string`, optional): 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

Example input: `{"from":"<from>","message_type":"text","to":"<to>"}`

### `vonage_sms_send`

Send SMS · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): 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
- `text` (`string`, required): Message text, up to 1000 characters. Longer texts are sent as several concatenated SMS parts and billed per part. Example: Your code is 482910
- `to` (`string`, required): Recipient. Phone number in E.164 format without the leading + or 00. Example: 447700900000
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `content_id` (`string`, optional): India DLT only: the content template ID registered for this message. Example: 1107160000000000000
- `encoding_type` (`string`, optional): 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: auto. One of: `text`, `unicode`, `auto`.
- `entity_id` (`string`, optional): India DLT only: the entity ID registered with the DLT platform. Example: 1101456000000000000
- `ttl` (`integer`, optional): 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_url` (`string`, optional): 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

Example input: `{"from":"<from>","text":"<text>","to":"<to>"}`

### `vonage_verify_code_check`

Check Verification Code · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `code` (`string`, required): The code the user entered, 4 to 10 alphanumeric characters. Example: 482910
- `request_id` (`string`, required): request_id returned by vonage_verify_request_create. Example: c11236f4-00bf-4b89-84ba-88b25df97315

Example input: `{"code":"<code>","request_id":"<request_id>"}`

### `vonage_verify_next_workflow`

Move to Next Verification Channel · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `request_id` (`string`, required): request_id returned by vonage_verify_request_create. Example: c11236f4-00bf-4b89-84ba-88b25df97315

Example input: `{"request_id":"<request_id>"}`

### `vonage_verify_request_create`

Start Verification · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `brand` (`string`, required): Your brand name shown in the message, 1 to 18 characters, without / { } : or $. Example: ACME
- `workflow` (`array`, required): 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_timeout` (`integer`, optional): Seconds to wait before moving to the next channel in the workflow (60 to 900). Defaults to 300. Example: 300
- `client_ref` (`string`, optional): Your own reference, up to 40 letters and digits (no spaces or punctuation), returned in Verify callbacks. Example: signup1234
- `code` (`string`, optional): Your own alphanumeric code (4 to 10 characters) instead of a generated one. Only allowed on the Verify Conversion pricing model. Example: AB12CD
- `code_length` (`integer`, optional): Number of digits in the generated code: 4 to 10. Defaults to 4. Example: 6. One of: `4`, `5`, `6`, `7`, `8`, `9`, `10`.
- `fraud_check` (`boolean`, optional): Set false to skip the network fraud check for this request (only if Vonage enabled that for your account). Defaults to true. Example: true
- `locale` (`string`, optional): Language of the message, for example en-us, en-gb, es-es or fr-fr. Defaults to en-us. Example: en-gb
- `template_id` (`string`, optional): 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

Example input: `{"brand":"<brand>","workflow":[{"channel":"sms","to":"447700900000"},{"channel":"voice","to":"447700900000"}]}`

### `vonage_verify_template_create`

Create Verify Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `name` (`string`, required): Reference name for the template, letters, numbers, - and _ only. Example: signup-otp

Example input: `{"name":"<name>"}`

### `vonage_verify_template_fragment_create`

Create Verify Template Fragment · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `channel` (`string`, required): Channel this text is for: sms or voice. Example: sms. One of: `sms`, `voice`.
- `locale` (`string`, required): Lowercase locale of the text, for example en-us or es-es. Example: en-us
- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
- `text` (`string`, required): 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}.

Example input: `{"channel":"sms","locale":"<locale>","template_id":"<template_id>","text":"<text>"}`

### `vonage_verify_template_fragment_update`

Update Verify Template Fragment · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_fragment_id` (`string`, required): Template fragment UUID. Example: c70f446e-997a-4313-a081-60a02a31dc19
- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
- `text` (`string`, required): New message text. Must contain ${code}; may also use ${brand}, ${time-limit} and ${time-limit-unit}. Example: ${brand}: your code is ${code}

Example input: `{"template_fragment_id":"<template_fragment_id>","template_id":"<template_id>","text":"<text>"}`

### `vonage_verify_template_update`

Update Verify Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9
- `is_default` (`boolean`, optional): Set true to use this template whenever a request gives no template_id. Example: true
- `name` (`string`, optional): New reference name. Example: signup-otp-v2

Example input: `{"template_id":"<template_id>"}`

### `vonage_viber_send`

Send Viber Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): Your Viber Business service message ID (sender ID) as approved by Vonage. Example: AcmeViber
- `message_type` (`string`, required): What to send: text, image or file. text uses text; image and file use media_url. Example: text. One of: `text`, `image`, `file`.
- `to` (`string`, required): Recipient. Viber user's phone number in E.164 format without the leading + or 00. Example: 447700900000
- `action_text` (`string`, optional): Label of the call-to-action button, up to 30 characters. Set it together with action_url. Example: Track order
- `action_url` (`string`, optional): URL opened by the call-to-action button. Set it together with action_text. Example: https://example.com/track/1234
- `category` (`string`, optional): Viber message category: transaction or promotion. Promotion messages need the user's opt-in. Example: transaction. One of: `transaction`, `promotion`.
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `file_name` (`string`, optional): Optional file name shown to the recipient when message_type is file. Example: invoice-1234.pdf
- `media_url` (`string`, optional): 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
- `text` (`string`, optional): Message text, up to 1000 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
- `viber_ttl` (`integer`, optional): How long Viber tries to deliver the message, in seconds (30 to 259200). Example: 600
- `webhook_url` (`string`, optional): 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

Example input: `{"from":"<from>","message_type":"text","to":"<to>"}`

### `vonage_whatsapp_send`

Send WhatsApp Message · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): Your WhatsApp Business number linked to the Vonage application, in E.164 format without +. Example: 447700900001
- `message_type` (`string`, required): What to send: text, image, audio, video, file, sticker or custom. text uses text, custom uses custom, every other type uses media_url. Example: text. One of: `text`, `image`, `audio`, `video`, `file`, `sticker`, `custom`.
- `to` (`string`, required): Recipient. WhatsApp phone number in E.164 format without the leading + or 00. Example: 447700900000
- `caption` (`string`, optional): Optional caption shown with the media. Applies when message_type is image, video or file; ignored otherwise. Example: Your receipt
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `custom` (`object`, optional): 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_name` (`string`, optional): Optional file name shown to the recipient when message_type is file. Example: invoice-1234.pdf
- `media_url` (`string`, optional): 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_uuid` (`string`, optional): message_uuid of an inbound message to quote as a reply. Example: aaaaaaaa-bbbb-4ccc-8ddd-0123456789ab
- `text` (`string`, optional): Message text, up to 4096 characters. Required when message_type is text; ignored for other types. Example: Your order 1234 has shipped.
- `webhook_url` (`string`, optional): 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

Example input: `{"from":"<from>","message_type":"text","to":"<to>"}`

### `vonage_whatsapp_template_send`

Send WhatsApp Template · Write

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.

Read only: no. Destructive: no. Idempotent (safe to retry): no.

Inputs:

- `from` (`string`, required): Your WhatsApp Business number linked to the Vonage application, in E.164 format without +. Example: 447700900001
- `locale` (`string`, required): BCP 47 locale of the template version to send, for example en_US or pt_BR. Example: en_US
- `template_name` (`string`, required): Name of the approved template, in the form namespace:template_name as shown in the Vonage dashboard. Example: 9b6b4fcb_da19_4a26_8fe8_78074a91b584:verify
- `to` (`string`, required): Recipient. WhatsApp phone number in E.164 format without the leading + or 00. Example: 447700900000
- `client_ref` (`string`, optional): Your own reference for this message, up to 100 characters. Vonage returns it in every status webhook for the message. Example: order-1234
- `parameters` (`array`, optional): Values for the template body placeholders {{1}}, {{2}} and so on, in order. Example: ["482910", "10"]
- `webhook_url` (`string`, optional): 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

Example input: `{"from":"<from>","locale":"<locale>","template_name":"<template_name>","to":"<to>"}`

### `vonage_number_cancel`

Cancel Number · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `country` (`string`, required): ISO 3166-1 alpha-2 country of the number. Example: GB
- `msisdn` (`string`, required): The owned number to cancel, from vonage_numbers_list. Example: 447700900123
- `target_api_key` (`string`, optional): API key of the subaccount that owns the number. Leave empty for your own account. Example: 1a2b3c4d

Example input: `{"country":"<country>","msisdn":"<msisdn>"}`

### `vonage_verify_request_cancel`

Cancel Verification · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `request_id` (`string`, required): request_id returned by vonage_verify_request_create. Example: c11236f4-00bf-4b89-84ba-88b25df97315

Example input: `{"request_id":"<request_id>"}`

### `vonage_verify_template_delete`

Delete Verify Template · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9

Example input: `{"template_id":"<template_id>"}`

### `vonage_verify_template_fragment_delete`

Delete Verify Template Fragment · Destructive

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.

Read only: no. Destructive: yes. Idempotent (safe to retry): yes.

Inputs:

- `template_fragment_id` (`string`, required): Template fragment UUID. Example: c70f446e-997a-4313-a081-60a02a31dc19
- `template_id` (`string`, required): Template UUID. Example: 8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9

Example input: `{"template_fragment_id":"<template_fragment_id>","template_id":"<template_id>"}`

## Related

Other Communication connectors ([all 132](/agentkit/connectors/?category=communication)):

- [Gmail](/agentkit/connectors/gmail/): Scalekit connector, OAuth, 48 tools
- [Slack](/agentkit/connectors/slack/): Scalekit connector, OAuth, 96 tools
- [Google Calendar](/agentkit/connectors/googlecalendar/): Scalekit connector, OAuth, 30 tools


---

## More Scalekit documentation

| Resource | What it contains | When to use it |
|----------|-----------------|----------------|
| [/llms.txt](/llms.txt) | Structured index with routing hints per product area | Start here — find which documentation set covers your topic before loading full content |
| [/llms-full.txt](/llms-full.txt) | Complete documentation for all Scalekit products in one file | Use when you need exhaustive context across multiple products or when the topic spans several areas |
| [sitemap-0.xml](https://docs.scalekit.com/sitemap-0.xml) | Full URL list of every documentation page | Use to discover specific page URLs you can fetch for targeted, page-level answers |
