Provision voice-agent phone number
POST
/v1/voice-agents/agents/{agentId}/phone-numberHow to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
| agentId | path | string | Yes | Agent ID |
Query parameters
None.
Body schema
Content type: application/json · Optional
| Field | Type | Required | Description |
|---|---|---|---|
| origin | xai_provisioned | byo_trunk | No | — |
| name | string | No | Human-readable name. |
| phoneNumber | string | No | Required for BYO trunk phone numbers. |
| webhookUrl | string | No | — |
| webhookName | string | No | — |
| sipAuth | object | No | — |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201Phone number binding createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| agent | object | No | — |
| agent.id | string | No | Unique identifier. |
| agent.userId | string | No | User ID. |
| agent.organizationId | string | No | — |
| agent.createdByUserId | string | No | — |
| agent.name | string | No | Human-readable name. |
| agent.description | string | No | Human-readable description. |
| agent.model | string | No | Model identifier for the agent. Built-in managed models: - `claude-opus-4-8` - `claude-opus-4-7` - `claude-opus-4-6` - `claude-sonnet-4-5` - `claude-haiku-4-5` - `gpt-5.5-pro` - `gpt-5.5` - `gpt-5.4` - `gpt-5.4-mini` - `gpt-5.4-nano` - `grok-4.5` - `gemini-3-flash` - `gemini-3-1-flash` - `gemini-3-1-pro` - `deepseek-v4-pro` - `deepseek-v4-flash` - `minimax-m3` - `kimi-k2.6` - `kimi-k2.7-code` - `glm-5.2` - `qwen3.5-397b-a17b` Deployment-fixed installations may additionally expose `qwen3.8-flash-next`. Team and Enterprise organizations can also use connected external models in the form `external:{providerType}:{urlEncodedModelId}`. Use `GET /agents/models` to discover the exact managed and external model IDs available in the current workspace. |
| agent.instructions | string | No | — |
| agent.binary | Claude Code CLI | No | Execution binary used for the agent runtime. |
| agent.executionEngine | computer-agents-cli | native-claude | grok-build | No | Durable execution-engine choice. Native Claude is restricted to managed Anthropic models; Computer Agents CLI and Grok Build retain their provider-target policies. |
| agent.reasoningEffort | minimal | low | medium | high | No | Reasoning intensity used by the execution runtime. |
| agent.enabledSkills | string[] | No | Skill IDs enabled for this agent, for example `deep_research` or custom installed skills. |
| agent.deepResearchModel | gemini-3-flash-preview | gemini-3-pro-preview | No | Optional model override used by the deep research skill when enabled. |
| agent.permissionSet | object | No | Agent permission policy. The shape is intentionally subject-typed so it can also be reused for human users and teams later. |
| agent.permissionSet.version | 1 | No | — |
| agent.permissionSet.subjectType | agent | human_user | team | project | security_repository | No | — |
| agent.permissionSet.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.rings | object | No | — |
| agent.permissionSet.actions | object | No | — |
| agent.permissionSet.resources | object | No | — |
| agent.permissionSet.resources.agents | object | No | — |
| agent.permissionSet.resources.agents.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.agents.rules | object[] | No | — |
| agent.permissionSet.resources.agents.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.agents.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.agents.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.agents.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.agents.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.skills | object | No | — |
| agent.permissionSet.resources.skills.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.skills.rules | object[] | No | — |
| agent.permissionSet.resources.skills.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.skills.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.skills.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.skills.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.skills.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.servers | object | No | — |
| agent.permissionSet.resources.servers.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.servers.rules | object[] | No | — |
| agent.permissionSet.resources.servers.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.servers.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.servers.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.servers.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.servers.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.computers | object | No | — |
| agent.permissionSet.resources.computers.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.computers.rules | object[] | No | — |
| agent.permissionSet.resources.computers.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.computers.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.computers.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.computers.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.computers.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.files | object | No | — |
| agent.permissionSet.resources.files.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.files.rules | object[] | No | — |
| agent.permissionSet.resources.files.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.files.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.files.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.files.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.files.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.directories | object | No | — |
| agent.permissionSet.resources.directories.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.directories.rules | object[] | No | — |
| agent.permissionSet.resources.directories.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.directories.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.directories.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.directories.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.directories.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.projects | object | No | — |
| agent.permissionSet.resources.projects.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.projects.rules | object[] | No | — |
| agent.permissionSet.resources.projects.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.projects.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.projects.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.projects.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.projects.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.permissionSet.resources.security_repositories | object | No | — |
| agent.permissionSet.resources.security_repositories.defaultAccess | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.security_repositories.rules | object[] | No | — |
| agent.permissionSet.resources.security_repositories.rules[].id | string | No | Optional stable rule ID. |
| agent.permissionSet.resources.security_repositories.rules[].targetId | string | No | Optional resource identifier for agent, skill, server, computer, or project rules. |
| agent.permissionSet.resources.security_repositories.rules[].path | string | No | Optional file or directory path for path-scoped rules. |
| agent.permissionSet.resources.security_repositories.rules[].access | full_access | ask_for_permission | read_only | no_access | No | Access level for a resource category. `full_access` allows viewing and actions, `ask_for_permission` allows proposed actions that require approval, `read_only` allows viewing without mutation, and `no_access` blocks view and action access. |
| agent.permissionSet.resources.security_repositories.rules[].note | string | No | Optional human-readable note for the rule. |
| agent.voiceMode | off | web | phone | web_and_phone | No | Voice availability for an agent. |
| agent.voiceProvider | xai | No | — |
| agent.voiceModel | string | No | — |
| agent.voiceId | string | No | xAI built-in or custom voice ID. |
| agent.voiceInstructions | string | No | — |
| agent.voiceLanguageHint | string | No | — |
| agent.voiceTurnDetection | object | No | — |
| agent.voicePronunciationReplacements | object | No | — |
| agent.isDefault | boolean | No | — |
| agent.isSystem | boolean | No | — |
| agent.isActive | boolean | No | — |
| agent.metadata | object | No | Free-form metadata object. |
| agent.createdAt | string | No | ISO 8601 timestamp. |
| agent.updatedAt | string | No | ISO 8601 timestamp. |
| agent.lastRunAt | string | No | — |
| voice | object | No | — |
| phoneNumber | object | No | — |
| phoneNumber.id | string | No | Unique identifier. |
| phoneNumber.status | string | No | Current lifecycle status. |
| phoneNumber.origin | xai_provisioned | byo_trunk | No | — |
| phoneNumber.phoneNumber | string | No | — |
| phoneNumber.sipUri | string | No | — |
| phoneNumber.provider | xai | No | — |
| phoneNumber.channel | phone | No | — |
| phoneNumber.lastError | string | No | — |
| phoneNumber.metadata | object | No | Free-form metadata object. |
| phoneNumber.createdAt | string | No | ISO 8601 timestamp. |
| phoneNumber.updatedAt | string | No | ISO 8601 timestamp. |
| recentSessions | object[] | No | — |
| recentSessions[].id | string | No | Unique identifier. |
| recentSessions[].agentId | string | No | Agent ID. |
| recentSessions[].threadId | string | No | Thread ID. |
| recentSessions[].bindingId | string | No | — |
| recentSessions[].provider | xai | No | — |
| recentSessions[].channel | web | phone | No | — |
| recentSessions[].status | initializing | active | completed | failed | cancelled | No | Current lifecycle status. |
| recentSessions[].xaiCallId | string | No | — |
| recentSessions[].xaiSessionId | string | No | — |
| recentSessions[].fromNumber | string | No | — |
| recentSessions[].toNumber | string | No | — |
| recentSessions[].startedAt | string | No | ISO 8601 timestamp. |
| recentSessions[].endedAt | string | No | — |
| recentSessions[].durationSeconds | number | No | — |
| recentSessions[].metadata | object | No | Free-form metadata object. |
Provision voice-agent phone number
Loading...
Response 201
Loading...