Fetch multiple conversations
Returns up to 200 authorized conversations in one request. Use the roomId and uuid values returned by GET /api/v2/logs.
OpenAPI
````yaml post /api/v2/conversation/batch
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/conversation/batch:
post:
tags:
- Conversations
summary: Fetch multiple conversations
description: >-
Returns up to 200 authorized conversations in one request. Use the
roomId and uuid values returned by GET /api/v2/logs.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- items
properties:
items:
description: List of conversation lookup items (max 200).
type: array
items:
type: object
required:
- roomId
- uuid
properties:
roomId:
description: Conversation room ID.
type: string
example: '2236859:2550714'
uuid:
description: >-
Conversation UUID from logs. Supports call format
{uuid}:{timestamp} or message format
{uuid}:{openTimestamp}:{closeTimestamp}.
type: string
example: bf0011ed-8175-458a-8fba-1e62ddc77567:1770763782
example:
items:
- roomId: '2236859:2550714'
uuid: bf0011ed-8175-458a-8fba-1e62ddc77567:1770763782
- roomId: '2236859:2535655'
uuid: edf65410-9f78-4d5e-82d2-2ee773ad4a49:1770765260
responses:
'200':
description: Batch lookup complete. Each item includes per-item success/failure.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
message:
type: string
example: Success
stats:
type: object
properties:
requested:
type: number
example: 2
ok:
type: number
example: 2
failed:
type: number
example: 0
results:
type: array
items:
type: object
properties:
success:
type: boolean
example: true
roomId:
type: string
example: '2236859:2550714'
uuid:
type: string
example: bf0011ed-8175-458a-8fba-1e62ddc77567:1770763782
message:
type: string
example: Success
conversation:
type: array
items:
type: object
additionalProperties: true
'400':
description: Invalid request body (e.g., missing items or too many items).
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: items array is required
'401':
description: Unauthorized request.
content:
application/json:
schema:
type: string
example: Unauthorized Request
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: query
name: token
description: GetVoiceBot API Token
````
