Request a managed Skysay phone number

post/v1/number-requests

Request

  • Base URL: https://api.skysay.ai
  • URL: https://api.skysay.ai/v1/number-requests
  • Auth: none declared

Request body

agent_endpoint_idstring

Backwards-compatible alias for external audio agents.

agent_idstring

The AI agent the number should answer with once it is active. Optional: when omitted, an activated number answers with the workspace's only active AI agent, and with nobody (an explicit do-not-answer rule) when there are several or none. A named agent that is no longer active is not replaced.

carrierstring

Plain alias for provider; defaults to the platform's managed carrier.

countrystring required

ISO country code or country name.

customer_referencestring
customer_typestring

business, individual, agent_builder, or internal.

number_typestring

local, national, mobile, toll_free, shared_cost, or UIFN.

organization_idstring required
preferred_phone_numberstring

Optional customer preference. Until the carrier enables exact-number search, this does not reserve or promise a specific DID.

project_idstring required
requested_capabilitiesstring[]

Response

Number request

Changes

No recorded changes to this operation across all 1 revision of this API.