https://github.com/grokify/go-ringcentral-client
RingCentral Client SDK for Go: RingCentral Office, Engage Digital, Engage Voice
https://github.com/grokify/go-ringcentral-client
api-client glip go go-client golang ringcentral
Last synced: about 2 months ago
JSON representation
RingCentral Client SDK for Go: RingCentral Office, Engage Digital, Engage Voice
- Host: GitHub
- URL: https://github.com/grokify/go-ringcentral-client
- Owner: grokify
- License: mit
- Created: 2017-10-04T06:38:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-04T01:33:59.000Z (about 2 months ago)
- Last Synced: 2025-05-04T02:31:09.856Z (about 2 months ago)
- Topics: api-client, glip, go, go-client, golang, ringcentral
- Language: Go
- Homepage:
- Size: 6.31 MB
- Stars: 11
- Watchers: 2
- Forks: 13
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for RingCentral
[![Build Status][build-status-svg]][build-status-url]
[![Go Report Card][goreport-svg]][goreport-url]
[![Docs][docs-godoc-svg]][docs-godoc-url]
[![License][license-svg]][license-url]
[![Stack Overflow][stackoverflow-svg]][stackoverflow-url]
[![Twitter][twitter-svg]][twitter-url]
[build-status-svg]: https://github.com/grokify/go-ringcentral-client/actions/workflows/ci.yaml/badge.svg?branch=master
[build-status-url]: https://github.com/grokify/go-ringcentral-client/actions/workflows/ci.yaml
[goreport-svg]: https://goreportcard.com/badge/github.com/grokify/go-ringcentral-client
[goreport-url]: https://goreportcard.com/report/github.com/grokify/go-ringcentral-client
[docs-godoc-svg]: https://pkg.go.dev/badge/github.com/grokify/go-ringcentral-client
[docs-godoc-url]: https://pkg.go.dev/github.com/grokify/go-ringcentral-client
[license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/grokify/go-ringcentral-client/blob/master/LICENSE
[stackoverflow-svg]: https://img.shields.io/badge/Stack%20Overflow-ringcentral-orange.svg
[stackoverflow-url]: https://stackoverflow.com/questions/tagged/ringcentral
[twitter-svg]: https://img.shields.io/twitter/follow/ringcentraldevs.svg?style=social&label=follow
[twitter-url]: https://twitter.com/RingCentralDevs
## Overview
:bangbang: This module has been renamed to `go-ringcentral-client` from `go-ringcentral` to better work with Go modules and its new versioning requirements. Old versions are still available via `proxy.golang.org` :bangbang:
This module provides RingCentral API clients for RingCentral Office, Engage Digital and Engage Voice.
The clients are built using [OpenAPI Generator 4.x](https://github.com/OpenAPITools/openapi-generator) using this RingCentral API spec [`swagger_spec.yaml`](codegen/swagger_spec.yaml).
This API client does not include auth and relies on [`goauth/ringcentral`](https://github.com/grokify/goauth/tree/master/ringcentral) to create an `*http.Client` to use as a dependency injection.
## Installation
`$ go get github.com/grokify/go-ringcentral-client/...`
## Usage
See Office examples in the [`office/v1/examples`](office/v1/examples) directory. To get started, you can use [`office/v1/examples/get_me/get_me.go`](office/v1/examples/get_me/get_me.go).
By default, these use a `.env` file which can be specified by the `ENV_PATH` environment variable or a local `./.env` file. Using one `.env` file specified by `ENV_PATH` is useful so you only need one file to run all the examples.
## Documentation
The auto-generated Swagger files are in the `client` folder and you can find the Swagger docs there as `client/README.md`:
* Office: [`office/v1/client`](office/v1/client), [`office/v1/client/README.md`](office/v1/client/README.md)
* Engage Digital: [`engagedigital/v1/client`](engagedigital/v1/client), [`engagedigital/v1/client/README.md`](engagedigital/v1/client/README.md)
* Engage Voice: [`engagevoice/v1/client`](engagevoice/v1/client), [`engagevoice/v1/client/README.md`](engagevoice/v1/client/README.md)
## Related Packages
### GoAuth RingCentral
For RingCentral auth haandling see [`goauth/ringcentral`](https://github.com/grokify/goauth/tree/master/ringcentral). This is specifically a package to retrieve a `*http.Client` or `*oauth2.Token` without needing the auto-generated models.
### Beego Example
In addition to [`goauth/ringcentral`](https://github.com/grokify/goauth/tree/master/ringcentral), the following project provides a website with OAuth 2.0 authorization code flow example:
[`grokify/beegoutil`](https://github.com/grokify/beegoutil)