Skyvern: Search available managed SMS numbers

Skyvern smsNumbers.searchManagedSmsNumbers: arguments, response, policy and SDK examples.

Operation skyvern.search_available_numbers_v1_sms_numbers_available_get

Provider route: GET /v1/sms-numbers/available. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/skyvern with npm, or alter-sdk-skyvern with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { SkyvernIntegration } from "@alter-ai/skyvern";

async function execute(input: Parameters<SkyvernIntegration["smsNumbers"]["searchManagedSmsNumbers"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new SkyvernIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.smsNumbers.searchManagedSmsNumbers(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_skyvern import SkyvernIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = SkyvernIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.sms_numbers.search_managed_sms_numbers(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Optional	Additional keys: not allowed
`query.area_code`	JSON	Optional
`query.area_code (anyOf 1)`	string	Alternative	Maximum length: 3 Minimum length: 3 Pattern: ^[2-9][0-9]{2}$
`query.area_code (anyOf 2)`	null	Alternative

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	array	Root
`$[]`	Model	Each item	Expand Search available managed SMS numbers — response body — item

Referenced models: Search available managed SMS numbers — response body — item

Schemas

Search available managed SMS numbers — response body — item

Field	Type	Presence	Description and constraints
`$`	object	Root
`friendly_name`	JSON	Optional
`friendly_name (anyOf 1)`	string	Alternative
`friendly_name (anyOf 2)`	null	Alternative
`iso_country`	JSON	Optional
`iso_country (anyOf 1)`	string	Alternative
`iso_country (anyOf 2)`	null	Alternative
`locality`	JSON	Optional
`locality (anyOf 1)`	string	Alternative
`locality (anyOf 2)`	null	Alternative
`monthly_price_cents`	JSON	Required within parent
`monthly_price_cents (anyOf 1)`	integer	Alternative
`monthly_price_cents (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`phone_number`	string	Required within parent
`region`	JSON	Optional
`region (anyOf 1)`	string	Alternative
`region (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: skyvern.search_available_numbers_v1_sms_numbers_available_get. Catalog operation: search_available_numbers_v1_sms_numbers_available_get. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page