Configure a Computer Agent channel
Connects, updates, enables, or disables one supported channel for the selected Computer Agent. Send the channel identifier with the connection and access fields defined by the channel catalog. GetVoiceBot assigns the connection and incoming messages to the selected Computer Agent automatically.
OpenAPI
````yaml post /api/v2/computer/accounts/{targetAccountId}/channels/configure
openapi: 3.0.0
info:
version: 2.0.0
title: GetVoiceBot API
description: GetVoiceBot API Documentation
servers:
- url: https://api.getvoicebot.com
description: GetVoiceBot Production
variables:
baseUrl:
default: api.getvoicebot.com
description: Production API Root
security: []
tags:
- name: Agents
- name: Inbound Email
description: Control which senders may create inbound email work for an Agent.
- name: Features
description: Inspect capabilities available within an account hierarchy.
- name: Conversation Logs
description: Query conversation activity and calculate account-level metrics.
- name: Computer Agents
description: Set up, configure, inspect, and manage GetVoiceBot Computer Agents.
- name: Computer Agent Sessions
description: View and reset Computer Agent sessions.
- name: Accounts
- name: Agent Templates
description: Create, manage, and apply reusable Agent configurations.
paths:
/api/v2/computer/accounts/{targetAccountId}/channels/configure:
post:
tags:
- Computer Agents
summary: Configure a Computer Agent channel
description: >
Connects, updates, enables, or disables one supported channel for the
selected Computer Agent. Send the channel identifier with the connection
and access fields defined by the channel catalog. GetVoiceBot assigns the
connection and incoming messages to the selected Computer Agent
automatically.
operationId: channelsPostConfigure
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channel:
type: string
description: Channel identifier from the channel catalog.
connection:
type: object
properties: {}
description: >-
Connection fields defined by the selected channel catalog
entry.
access:
type: object
properties: {}
description: >-
Direct-message and group access settings for this Computer
Agent.
enabled:
type: boolean
description: Whether this Computer Agent can use the channel.
required:
- channel
responses:
'200':
description: Successful response
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
