Skip to content

Latest commit

 

History

History
214 lines (142 loc) · 6.85 KB

README.md

File metadata and controls

214 lines (142 loc) · 6.85 KB
Raw

Overview

This project provides a node module that extends the ringcentral-js-concise module with a more semantic interface. The concise module is optimized for being light-weight. As a result, it tends to be more abstract, and harder to use for beginners.

This module hopes to make the vastness of the RingCentral API more accessible to beginners.

To illustrate, here are two functionally equivalent code samples using the two modules:

Other Node Modules to Consider

This is "yet another ringcentral npm" developed as a proof-of-concept to offer developers a simpler interface over the the ringcentral-js-concise library. Developers have a number of choices when choosing a RingCentral npm, here are some of them:

  • ringcentral - The official javascript library maintained by RingCentral.
  • ringcentral-client - In part, inspiration for this module, as it provides a more explicit (a.k.a. "semantic") interface for supported methods. etc. The author had difficulty using this module however (which could be entirely his own darn fault).
  • ringcentral-js-concise - An npm optimized for size. It is effective, but more abstract. The author had a personal affinity for this module.
  • ringcentral-semantic - This npm, a wrapper around ringcentral-js-concise that attempts to combine they best parts of the modules above.

Sending an SMS using ringcentral-js-concise

const promise = client.post('/restapi/v1.0/account/~/extension/~/sms', {
    from: { phoneNumber: '+12054387726' },
    to:  [{ phoneNumber: '+15105553204' }],
    text: 'This is a test SMS.'
})

Sending an SMS using ringcentral-semantic

const promise = client.sendSMS({
    sender:   '+12054387726',
    receiver: '+15105553204',
    text:     'This is a test SMS.'
})

Hopefully, what you can see is a slightly more intuitive interface, one that exposes explicit functions for each of RingCentral's capabilities, and abstracts developers completely away from having to know API endpoints, or methods.

Usage

Path Parameters

All of RingCentral's APIs can be scoped to a specific organization and user by specifying the corresponding account and/or extension in the endpoint's path. You can set these path parameters by passing in the following parameters into each method supported by this SDK:

  • accountId
  • extension

If these parameters are omitted, they will both default to ~, which refers to the account/extension of the currently authed user.

Example

client.sendSMS({
    accountId: '+12125558373',
    extension: '110',
    from: { phoneNumber: '+12054387726' },
    to:   [{ phoneNumber: '+15105553204'}],
    text:  'This is a test SMS.'
})

Request Parameters

Each method supported by this library takes as input an associative array of request parameters. For all methods, developers are free to use the raw input format of the RingCentral API (as documented in RingCentral's API Explorer).

In some circumstances however, this SDK will accept simpler formats so that code can be easier to read and input by the developer. In these circumstances, the method documented below will highlight a "Simplified Syntax" one can utilize.

To illustrate, let's look at how one might compose a request to send an SMS using the raw input format, and the simplified format.

Using the Raw Input Format

client.sendSMS({
    from: { phoneNumber: '+12054387726' },
    to:   [{ phoneNumber: '+15105553204'}],
    text:  'This is a test SMS.'
})

Using the Simplified Syntax:

client.sendSMS({
    sender:   '+12054387726',
    receiver: '+15105553204',
    text:  'This is a test SMS.'
})

Getting, Updating and Deleting Records

When one needs to get, update or delete a specific record via id, this is done by passing in an id parameter in the array of request parameters for the corresponding method. For example:

client.updateContact({ id: '736483937493', email: '[email protected]' })
client.getContact({ id: '736483937493' })
client.deleteContact({ id: '736483937493' })

Accessing Response Data and Handling Exceptions

This library utilizes ES6 asynchronous methods. Each method returns a promise, to which you can attach then, catch and finally blocks.

The then block is called when the method returns successfully, and is passed the axios response object. This is how you can access the data returned by RingCentral.

For example:

client.sendSMS({
    sender:   '+12054387726',
    receiver: '+15105553204',
    text:  'This is a test SMS.'
}).then( function (response) {
    console.log( "Message ID" + response.data['id'] )
}).catch( function (error) {
    console.log( "Something went wrong: " + error.message )
}).finally( function () {
    console.log( "All finished. ")
})

Supported Methods

Call Log

getUserCallLog

deleteUserCallLog

getUserCallLogRecord

getUserActiveCalls

getCompanyCallLog

getCompanyCallLogRecord

getCompanyActiveCall

Contacts

createContact

Creates a new contact in the associated account. This method has no simplified syntax.

updateContact

Updates a single contact with the specified id. Developers need only specify the contact properties they wish to update. See "Getting, Updating and Deleting Records."

Simplified Syntax

client.updateContact({
    id:   '736483937493',
    email: '[email protected]'
})

getContact

Returns a single contact with the specified id. See "Getting, Updating and Deleting Records."

getContactList

Returns a list of contacts associated the current account. This method has no simplified syntax.

getExtensionList

Returns a list of extensions associated with the given account. See "Path Parameters" above for how to scope this call to a given account and/or extension.

Messages

sendSMS

Will send an SMS to the designated recipient.

Simplified Syntax

client.sendSMS({
    sender:   '+12054387726',
    receiver: '+15105553204',
    text:  'This is a test SMS.'
})

getMessageList

Returns a list of messages associated the current account. This method has no simplified syntax.

Voice

ringOut

Will dial the caller first, then connect the sender to the receiver when they pick up. Optionally accepts a callerId parameter.

Simplified Syntax

client.ringOut({
    caller:   '+15105553204',
    receiver: '+12054387726',
    callerId: '+15105555555'
})

cancelRingOut

getRingOutStatus

License

This module is licensed under the MIT license.