Skip to content

grokify/go-ringcentral-client

Repository files navigation

Go API client for RingCentral

Build Status Go Report Card Docs License Stack Overflow Twitter

Overview

‼️ 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 ‼️

This module provides RingCentral API clients for RingCentral Office, Engage Digital and Engage Voice.

The clients are built using OpenAPI Generator 4.x using this RingCentral API spec swagger_spec.yaml.

This API client does not include auth and relies on goauth/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 directory. To get started, you can use 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:

Related Packages

GoAuth RingCentral

For RingCentral auth haandling see goauth/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, the following project provides a website with OAuth 2.0 authorization code flow example:

grokify/beegoutil