Find a Computer Agent session chat
Returns the GetVoiceBot chat associated with an authorized session for the selected Computer Agent, including a direct messages reference when the chat is available. Omit sessionKey to resolve the default direct session for the requester and selected agent.
OpenAPI
````yaml post /api/v2/computer/accounts/{targetAccountId}/session/resolve
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}/session/resolve:
post:
tags:
- Computer Agent Sessions
summary: Find a Computer Agent session chat
description: >
Returns the GetVoiceBot chat associated with an authorized session for the
selected Computer Agent, including a direct messages reference when the
chat is available. Omit sessionKey to resolve the default direct session
for the requester and selected agent.
operationId: sessionsPostResolveManagedSessionRoom
parameters:
- name: targetAccountId
in: path
required: true
description: ''
schema:
type: string
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
sessionKey:
type: string
description: >-
Optional session key belonging to the selected Computer
Agent.
responses:
'200':
description: Session chat resolution
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
configured:
type: boolean
sessionKey:
type: string
roomId:
type: string
nullable: true
chatRef:
type: object
nullable: true
required:
- roomId
- targetAccountId
- href
properties:
roomId:
type: string
targetAccountId:
oneOf:
- type: integer
- type: string
description: >-
Selected Agent account used to authorize the messages
request.
href:
type: string
description: Relative API URL for reading the chat messages.
targetAgentId:
oneOf:
- type: integer
- type: string
requesterAccountId:
oneOf:
- type: integer
- type: string
sessionType:
type: string
sessionContextLabel:
type: string
required:
- configured
- sessionKey
- roomId
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
