RingCentral v0.1.0 RingCentral.API View Source

The Main module to interact with RingCentral REST APIs.

All functions are delegated to OAuth2.Client.

Example:

case RingCentral.API.get(client, "/") do
  {:ok, %OAuth2.Response{body: resp}} ->
    resp
    |> IO.inspect()

  {:error, %OAuth2.Response{status_code: 401, body: body}} ->
    Logger.error("Unauthorized token")

  {:error, %OAuth2.Error{reason: reason}} ->
    Logger.error("Error: reason")
end

Response:

%{
  "apiVersions" => [
    %{
      "releaseDate" => "2019-02-13T00:00:00.000Z",
      "uri" => "https://platform.devtest.ringcentral.com/restapi/v1.0",
      "uriString" => "v1.0",
      "versionString" => "1.0.38"
    }
  ],
  "serverRevision" => "3c520aea",
  "serverVersion" => "11.0.1.1400",
  "uri" => "https://platform.devtest.ringcentral.com/restapi/"
}

Link to this section Summary

Link to this section Functions

Link to this function

delete(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

delete!(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

get(client, url, headers \\ [], opts \\ []) View Source

Link to this function

get!(client, url, headers \\ [], opts \\ []) View Source

Link to this function

patch(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

patch!(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

post(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

post!(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

put(client, url, body \\ "", headers \\ [], opts \\ []) View Source

Link to this function

put!(client, url, body \\ "", headers \\ [], opts \\ []) View Source