https://github.com/ringcentral/engage-voice-api-docs
Engage Voice API Docs. Currently in draft state. Rendered here: https://ringcentral-ringcx-api-documentation.readthedocs-hosted.com/en/latest/, http://ringcentral.github.io/engage-voice-api-docs
https://github.com/ringcentral/engage-voice-api-docs
Last synced: 11 months ago
JSON representation
Engage Voice API Docs. Currently in draft state. Rendered here: https://ringcentral-ringcx-api-documentation.readthedocs-hosted.com/en/latest/, http://ringcentral.github.io/engage-voice-api-docs
- Host: GitHub
- URL: https://github.com/ringcentral/engage-voice-api-docs
- Owner: ringcentral
- License: mit
- Created: 2020-04-24T16:05:08.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-11T22:41:58.000Z (about 1 year ago)
- Last Synced: 2025-07-21T13:42:31.971Z (11 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.89 MB
- Stars: 5
- Watchers: 5
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RingCentral RingCX API Docs
[![Specs Status][specs-status-svg]][specs-status-url]
[![Docs Status][docs-status-svg]][docs-status-url]
[![Docs Status][docs-svg]][docs-url]
This repository is the home of the RingCentral RingCX Developer Guide: a collection of materials, and documentation to help educate developers on how to build on top of the RingCentral RingCX platform.
Visit at: https://engage-voice-api-docs.rtfd.org
## Contributing
If you would like to contribute to the RingCentral documentation effort, fork this repository, make your desired edits and contributions, and issue a pull request accordingly.
### Running ReadTheDocs Locally
```
% git clone https://github.com/ringcentral/engage-voice-api-docs.git
% cd engage-voice-api-docs
% pip install mkdocs
% pip install mkdocs-ringcentral
% pip install markdown-include
% mkdocs serve
```
Then you should be able to load http://localhost:8000 to view the documentation.
### Testing OpenAPI Specs
This repo holds OpenAPI specs for RingCX. For each commit, tests are run on Travis CI to verify that the OpenAPI 3.0 specs validate.
* RingCX Spec: [specs/voice/engage-voice_openapi3.json](specs/voice/engage-voice_openapi3.json)
* Tests: [specs_test.go](specs_test.go)
You can verify the specs locally with the following if you have [Go installed](https://golang.org/).
```
% git clone https://github.com/ringcentral/engage-voice-api-docs.git
% cd engage-voice-api-docs
% go test -v ./...
```
If you wish to change the specs being tested edit the [specs_test.go](specs_test.go) file.
[specs-status-svg]: https://github.com/ringcentral/engage-voice-api-docs/workflows/build/badge.svg?branch=master
[specs-status-url]: https://github.com/ringcentral/engage-voice-api-docs/actions
[docs-status-svg]: https://readthedocs.org/projects/engage-voice-api-docs/badge/?version=latest
[docs-status-url]: https://readthedocs.org/projects/engage-voice-api-docs/builds/
[docs-svg]: https://img.shields.io/badge/docs-preview-blue.svg
[docs-url]: https://engage-voice-api-docs.readthedocs.io/