data
Vonage CLI for AI Agents
Use the Vonage CLI from KosmoKrator to call Vonage tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.Vonage CLI Setup
Vonage can be configured headlessly with `kosmokrator integrations:configure vonage`.
# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash
# Configure and verify this integration.
kosmokrator integrations:configure vonage --set api_key="$VONAGE_API_KEY" --set api_secret="$VONAGE_API_SECRET" --enable --read allow --write ask --json
kosmokrator integrations:doctor vonage --json
kosmokrator integrations:status --json Credentials
Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.
| Key | Env var | Type | Required | Label |
|---|---|---|---|---|
api_key | VONAGE_API_KEY | Text text | yes | API Key |
api_secret | VONAGE_API_SECRET | Secret secret | yes | API Secret |
Command Patterns
The generic command is stable across every integration. The provider shortcut is shorter for humans.
kosmo integrations:call vonage.vonage_get_account_balance '{}' --json kosmo integrations:vonage vonage_get_account_balance '{}' --json Discovery
These commands return structured output for coding agents that need to inspect capabilities before choosing a function.
kosmo integrations:docs vonage --json
kosmo integrations:docs vonage.vonage_get_account_balance --json
kosmo integrations:schema vonage.vonage_get_account_balance --json
kosmo integrations:search "Vonage" --json
kosmo integrations:list --json Automation Contexts
The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.
CLI Functions
Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.
vonage.vonage_get_account_balance
Get the current balance of your Vonage account.
read - Parameters
- none
kosmo integrations:call vonage.vonage_get_account_balance '{}' --json kosmo integrations:vonage vonage_get_account_balance '{}' --json vonage.vonage_list_applications
List Vonage applications configured on your account. Applications define how Vonage handles calls and messages.
read - Parameters
- page_size, page
kosmo integrations:call vonage.vonage_list_applications '{"page_size":1,"page":1}' --json kosmo integrations:vonage vonage_list_applications '{"page_size":1,"page":1}' --json vonage.vonage_list_messages
Search and list SMS messages from your Vonage account. Requires a date in YYYY-MM-DD format. Optionally filter by recipient number.
read - Parameters
- date, to
kosmo integrations:call vonage.vonage_list_messages '{"date":"example_date","to":"example_to"}' --json kosmo integrations:vonage vonage_list_messages '{"date":"example_date","to":"example_to"}' --json vonage.vonage_list_numbers
List phone numbers purchased on your Vonage account. Optionally filter by pattern.
read - Parameters
- pattern, search_pattern, size, index
kosmo integrations:call vonage.vonage_list_numbers '{"pattern":"example_pattern","search_pattern":1,"size":1,"index":1}' --json kosmo integrations:vonage vonage_list_numbers '{"pattern":"example_pattern","search_pattern":1,"size":1,"index":1}' --json vonage.vonage_send_sms
Send an SMS message via Vonage. Provide sender, recipient, and message text. The recipient number must be in E.164 format (e.g., 14155552671).
write - Parameters
- from, to, text, type
kosmo integrations:call vonage.vonage_send_sms '{"from":"example_from","to":"example_to","text":"example_text","type":"example_type"}' --json kosmo integrations:vonage vonage_send_sms '{"from":"example_from","to":"example_to","text":"example_text","type":"example_type"}' --json vonage.vonage_verify_check
Check a verification code against a Vonage Verify request. Provide the request_id from the verification and the code entered by the user.
read - Parameters
- request_id, code
kosmo integrations:call vonage.vonage_verify_check '{"request_id":"example_request_id","code":"example_code"}' --json kosmo integrations:vonage vonage_verify_check '{"request_id":"example_request_id","code":"example_code"}' --json vonage.vonage_verify_request
Send a verification code to a phone number via Vonage Verify. Returns a request_id used to check the code later.
read - Parameters
- number, brand
kosmo integrations:call vonage.vonage_verify_request '{"number":"example_number","brand":"example_brand"}' --json kosmo integrations:vonage vonage_verify_request '{"number":"example_number","brand":"example_brand"}' --json Function Schemas
Use these parameter tables when building CLI payloads without calling integrations:schema first.
vonage.vonage_get_account_balance 0 parameters
kosmo integrations:schema vonage.vonage_get_account_balance --json | Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
vonage.vonage_list_applications 2 parameters
kosmo integrations:schema vonage.vonage_list_applications --json | Parameter | Type | Required | Description |
|---|---|---|---|
page_size | integer | no | Number of applications per page (default: 10). |
page | integer | no | Page number for pagination (1-based). |
vonage.vonage_list_messages 2 parameters
kosmo integrations:schema vonage.vonage_list_messages --json | Parameter | Type | Required | Description |
|---|---|---|---|
date | string | yes | Date to search messages for, in YYYY-MM-DD format (e.g., "2025-01-15"). |
to | string | no | Recipient phone number to filter by (E.164 format). |
vonage.vonage_list_numbers 4 parameters
kosmo integrations:schema vonage.vonage_list_numbers --json | Parameter | Type | Required | Description |
|---|---|---|---|
pattern | string | no | A pattern to search for in the phone numbers. |
search_pattern | integer | no | How to match the pattern: 0 = starts with, 1 = contains, 2 = ends with. |
size | integer | no | Number of results per page (default: 10). |
index | integer | no | Page index for pagination (1-based). |
vonage.vonage_send_sms 4 parameters
kosmo integrations:schema vonage.vonage_send_sms --json | Parameter | Type | Required | Description |
|---|---|---|---|
from | string | yes | Sender ID or phone number (e.g., "VonageAPI" or a purchased number). |
to | string | yes | Recipient phone number in E.164 format (e.g., "14155552671"). |
text | string | yes | The SMS message body text. |
type | string | no | Message type: "text" (default), "unicode", or "binary". |
vonage.vonage_verify_check 2 parameters
kosmo integrations:schema vonage.vonage_verify_check --json | Parameter | Type | Required | Description |
|---|---|---|---|
request_id | string | yes | The request_id returned by the verify request. |
code | string | yes | The verification code entered by the user. |
vonage.vonage_verify_request 2 parameters
kosmo integrations:schema vonage.vonage_verify_request --json | Parameter | Type | Required | Description |
|---|---|---|---|
number | string | yes | Phone number to verify in E.164 format (e.g., "14155552671"). |
brand | string | yes | The name of the company or app shown in the verification message (e.g., "MyApp"). |
Permissions
Headless calls still follow the integration read/write permission policy. Configure read/write defaults with
integrations:configure. Add --force only for trusted automation that should bypass that policy.