docs(calling): add ai-docs specifications for Voicemail module#4932
docs(calling): add ai-docs specifications for Voicemail module#4932Kesari3008 wants to merge 4 commits intowebex:nextfrom
Conversation
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4fbb968a9d
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| ### HTTP Client Usage | ||
|
|
||
| All three backends use `this.webex.request()` exclusively (no browser `fetch`). |
There was a problem hiding this comment.
This section states that all backends use this.webex.request() and never use fetch, but BroadworksBackendConnector currently performs voicemail operations with browser fetch (for example getVoicemailList and getVoicemailContent in packages/calling/src/Voicemail/BroadworksBackendConnector.ts). Because these docs are positioned as implementation guidance for future changes, this mismatch can cause contributors or agents to implement Broadworks paths with the wrong request stack and error/response handling patterns.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f8595c743a
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| ### WXC Pagination (Client-Side Caching) | ||
|
|
||
| WXC fetches the **entire** voicemail list from XSI on `refresh=true`, sorts it, and stores it in an in-memory cache keyed by a random `context` string. Subsequent calls paginate from this cache using `fetchVoicemailList(context, offset, limit)`. Returns status 204 when offset exceeds available messages. |
There was a problem hiding this comment.
This line describes voicemail pagination state as an in-memory cache, but storeVoicemailList/fetchVoicemailList persist data in sessionStorage (packages/calling/src/common/Utils.ts), which has different lifecycle and visibility characteristics than in-memory state. Keeping this wording inaccurate can lead follow-up changes to skip required storage handling (cleanup, stale-session behavior, and storage access assumptions) because contributors will reason about the wrong persistence model.
Useful? React with 👍 / 👎.
|
|
||
| ### WXC Pagination (Client-Side Caching) | ||
|
|
||
| WXC fetches the **entire** voicemail list from XSI on `refresh=true`, sorts it, and stores it in an in-memory cache keyed by a random `context` string. Subsequent calls paginate from this cache using `fetchVoicemailList(context, offset, limit)`. Returns status 204 when offset exceeds available messages. |
There was a problem hiding this comment.
The docs currently say 204 is returned when the offset exceeds available messages, but the connectors return 204 whenever there are no additional pages (moreVMAvailable is false), including cases where the current page still contains messages (for example, first page smaller than offsetLimit). This mismatch can cause callers and future contributors to implement incorrect pagination handling because they will treat 204 as an empty/out-of-range signal only.
Useful? React with 👍 / 👎.
1 participant
COMPLETES
This pull request addresses
Specs for Voicemail module within Calling SDK
by making the following changes
Added AGENTS.ms and ARCHITECTURE.md for Voicemail module
Change Type
The following scenarios were tested
< ENUMERATE TESTS PERFORMED, WHETHER MANUAL OR AUTOMATED >
The GAI Coding Policy And Copyright Annotation Best Practices
I certified that
Make sure to have followed the contributing guidelines before submitting.