How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

8x8 Interactions API

The Interactions API from 8x8 — 11 operation(s) for interactions.

8x8 Interactions API is one of 71 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Interactions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 12 operations across 11 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.0.21.

Requests are made against a single base URL, https://api.8x8.com/qm/{region}/{apiversion}.

12 operations 11 paths 18 schemas 3 DELETE8 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.21
Base URL
https://api.8x8.com
Authentication
HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

8x8 Interactions API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (access_token) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 12

Across 11 paths, the API surfaces 12 operations — 3 DELETE, 8 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Interactions 12
GET
/interactions/count
Interaction count.
interactions count 7 params → 200default
GET
/interactions
The Interaction collection
interactions 10 params → 200default
DELETE
/interactions/{interactionGuid}
Deletes a single interaction.
delete interaction 1 param → 200default
DELETE
/interactions/{interactionGuid}/purge
This method purges a single interaction.
purge interaction 1 param → 200default
PUT
/interactions/{interactionGuid}/{customFieldNo}
This method updates custom fields.
update custom field 3 params body → 200default
DELETE
/interactions/{interactionGuid}/{customFieldNo}
Deletes custom field data
deletes the custom field 3 params → 200default
GET
/interactions/{interactionGuid}/transcriptions
This method queries a single interaction transcription record.
interaction transcription 2 params → 200default
GET
/interactions/{interactionGuid}/topics
Queries a single interaction for matched topics
topics 2 params → 200default
GET
/interactions/{interactionGuid}/labels
Query a single interaction attached label
labels 2 params → 200default
GET
/interactions/{interactionGuid}/notes
Query the attached notes for a single interaction
notes 2 params → 200default
GET
/interactions/{interactionGuid}/media
The requested interaction media file download
interaction media file 5 params → 200default
GET
/interactions/redirect
Webpage redirect
webpage redirect 1 param → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are customFieldMap (26 properties), telephonyDetails (9 properties), interactionContent (8 properties), interactionAgent (7 properties). Each schema is shown below with its type and property counts.

interactionContent
object
The interaction object model
8 properties
customFieldMap
object
The list of custom fields attached to an interaction object.
26 properties
creatorLink
object
The preformatted query URL for user details
3 properties
labelValue
object
The object model for a label description
3 properties
customFields
object
The object model for custom field key-pairs
2 properties
interactionType
string
media
object
The object model for media size and duration.
4 properties
interactionAgent
object
The object model for the agent details provided in interaction responses.
7 properties
notesLink
object
The preformmated query URL for the Note
3 properties
telephonyDetails
object
The object model for the telephony information.
9 properties
nextUrlLink
object
The preformatted query URL for the next page
3 properties
prevUrlLink
object
The preformatted query URL for the previous page
3 properties
topic
object
The object model for a topic definition
3 properties
transcriptionValueResponse
object
The object model for transcription text
7 properties
noteValue
object
The object model for the Note description
5 properties
interactionDetailsResponse
object
The object model for the interaction list
5 properties
customFieldNo
string
The custom field identifier
speechDetails
object
The object model for transcription analytics
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-interactions-api-openapi.yml Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Event Streaming API
Jitsi as a Service (JaaS)
8x8 CPaaS Voice Webhooks
8x8 Addresses API
8x8 Agent Activity API
8x8 Agent status API
8x8 Agents API
8x8 Analytics API
8x8 Attachments API
8x8 Audit API
8x8 Authentication API
8x8 Batch API
Where this information came from

This is an independent, third-party profile of 8x8 Interactions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.