Add /voice/:segment_id/events endpoint

[cassieemb]

REST API Update Pull Request

Related Issue

If there's an issue available, link it here: Issue #17309

Description

This PR adds a new endpoint under the api/voice directory. It extends the existing 'Retrieve Log' endpoint to allow a user to view all the events belonging to the log - similar to what they'd see viewing the same call in the Logs dashboard UI.

Type of Change

• New endpoint
• Update to existing endpoint

Motivation and Context

While going through our documentation, I noticed that one of the endpoints that could be exposed is not in the documentation.

Checklist:

• I have read and fully understand the process for updating the REST API
• Mandatory fields are present in the TypeSpec files.
• TypeSpec files successfully compiled OpenAPI spec files.
  • No new warnings were generated during the compilation process.
• OpenAPI spec files were validated with a SWAGGER UI tool to ensure they are correct.
• The DevEx team has been alerted with the new changed by including the team/developer-experience label in the PR.

[netlify]

✅ Deploy Preview for signalwire-docs ready!

Name	Link
🔨 Latest commit	02ed443
🔍 Latest deploy log	https://app.netlify.com/projects/signalwire-docs/deploys/695d19041bdc92000766b5d6
😎 Deploy Preview	https://deploy-preview-775--signalwire-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 20 (🟢 up 2 from production) Accessibility: 92 (no change from production) Best Practices: 92 (no change from production) SEO: 89 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[github-actions]

yarn run v1.22.22
$ /home/runner/work/docs/docs/node_modules/.bin/ts-node tools/scripts/generate-matrix.ts

OpenAPI Specification Analysis

Changes are compared to the main branch:

• 🟢 Improvements (higher scores or fewer issues)
• 🔴 Regressions (lower scores or more issues)
• ⚪ No changes

Spec	Docs	Completeness	SDK Gen	Security	Overall	Warnings	Errors	Report
specs/compatibility-api/_spec_.yaml	72/100 (=) ⚪	69/100 (=) ⚪	79/100 (=) ⚪	39/100 (=) ⚪	65/100 (=) ⚪	476 (=) ⚪	373 (=) ⚪	View
specs/signalwire-rest/calling-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	83/100 (=) ⚪	95/100 (=) ⚪	6 (=) ⚪	1 (=) ⚪	View
specs/signalwire-rest/chat-api/tsp-output/@typespec/openapi3/openapi.yaml	98/100 (=) ⚪	95/100 (=) ⚪	100/100 (=) ⚪	52/100 (=) ⚪	86/100 (=) ⚪	10 (=) ⚪	3 (=) ⚪	View
specs/signalwire-rest/datasphere-api/tsp-output/@typespec/openapi3/openapi.yaml	97/100 (=) ⚪	94/100 (=) ⚪	100/100 (=) ⚪	52/100 (=) ⚪	86/100 (=) ⚪	49 (=) ⚪	17 (=) ⚪	View
specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	84/100 (=) ⚪	95/100 (=) ⚪	557 (=) ⚪	2 (=) ⚪	View
specs/signalwire-rest/fax-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	84/100 (=) ⚪	95/100 (=) ⚪	10 (=) ⚪	1 (=) ⚪	View
specs/signalwire-rest/logs-api/tsp-output/@typespec/openapi3/openapi.yaml	98/100 (=) ⚪	95/100 (=) ⚪	100/100 (=) ⚪	52/100 (=) ⚪	86/100 (=) ⚪	9 (=) ⚪	4 (=) ⚪	View
specs/signalwire-rest/message-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	84/100 (=) ⚪	95/100 (=) ⚪	10 (=) ⚪	1 (=) ⚪	View
specs/signalwire-rest/project-api/_spec_.yaml	76/100 (=) ⚪	73/100 (=) ⚪	69/100 (=) ⚪	36/100 (=) ⚪	64/100 (=) ⚪	21 (=) ⚪	14 (=) ⚪	View
specs/signalwire-rest/pubsub-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	84/100 (=) ⚪	95/100 (=) ⚪	5 (=) ⚪	1 (=) ⚪	View
specs/signalwire-rest/space-api/_spec_.yaml	76/100 (=) ⚪	73/100 (=) ⚪	88/100 (=) ⚪	40/100 (=) ⚪	69/100 (=) ⚪	380 (=) ⚪	275 (=) ⚪	View
specs/signalwire-rest/video-api/_spec_.yaml	86/100 (=) ⚪	85/100 (=) ⚪	86/100 (=) ⚪	39/100 (=) ⚪	74/100 (=) ⚪	179 (=) ⚪	131 (=) ⚪	View
specs/signalwire-rest/voice-api/tsp-output/@typespec/openapi3/openapi.yaml	99/100 (=) ⚪	99/100 (=) ⚪	100/100 (=) ⚪	84/100 (=) ⚪	95/100 (=) ⚪	15 (+5) 🔴	1 (=) ⚪	View

Done in 148.16s.

[Devon-White]

tested and working on docs :)