@itentialopensource/adapter-ringcentral
Version:
This adapter integrates with system described as: ringcentralApi.
1,678 lines • 239 kB
JSON
{
"id": "@itentialopensource/adapter-ringcentral",
"type": "Adapter",
"export": "Ringcentral",
"title": "Ringcentral",
"src": "adapter.js",
"roles": [
"admin"
],
"methods": [
{
"name": "iapUpdateAdapterConfiguration",
"summary": "Updates the adapter configuration",
"description": "Updates the adapter configuration file with the provided changes",
"input": [
{
"name": "configFile",
"type": "string",
"info": "The name of the file to change",
"required": true,
"schema": {
"title": "configFile",
"type": "string"
}
},
{
"name": "changes",
"type": "object",
"info": "JSON object containing the configuration changes",
"required": true,
"schema": {
"title": "changes",
"type": "object"
}
},
{
"name": "entity",
"type": "string",
"info": "The entity in which the changes are being made",
"required": false,
"schema": {
"title": "entity",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "The type of file to change - action, schema, or mock",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "action",
"type": "string",
"info": "The action to be changed",
"required": false,
"schema": {
"title": "action",
"type": "string"
}
},
{
"name": "replace",
"type": "boolean",
"info": "True to replace entire mock data, false to merge/append",
"required": false,
"schema": {
"title": "replace",
"type": "boolean"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUpdateAdapterConfiguration"
},
"task": true
},
{
"name": "iapSuspendAdapter",
"summary": "Suspends the adapter",
"description": "Suspends the adapter",
"input": [
{
"name": "mode",
"type": "enum",
"enumerals": [
"pause",
"error"
],
"info": "How incoming requests are handled. Defaults to 'pause'",
"description": "How incoming requests are handled. Defaults to 'pause'",
"schema": {
"title": "mode",
"type": "string"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapSuspendAdapter"
},
"task": true
},
{
"name": "iapUnsuspendAdapter",
"summary": "Unsuspends the adapter",
"description": "Unsuspends the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter suspended status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapUnsuspendAdapter"
},
"task": true
},
{
"name": "iapGetAdapterQueue",
"summary": "Return the requests that are waiting in the queue if throttling is enabled",
"description": "Return the requests that are waiting in the queue if throttling is enabled",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the adapter queue",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetAdapterQueue"
},
"task": true
},
{
"name": "iapFindAdapterPath",
"summary": "Provides the ability to see if a particular API path is supported by the adapter",
"description": "Provides the ability to see if a particular API path is supported by the adapter",
"input": [
{
"name": "apiPath",
"type": "string",
"info": "The API Path you want to check - make sure to not include base path and version",
"description": "The API Path you want to check - make sure to not include base path and version",
"schema": {
"title": "apiPath",
"type": "string"
},
"required": true
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapFindAdapterPath"
},
"task": true
},
{
"name": "iapTroubleshootAdapter",
"summary": "Runs troubleshoot script for adapter",
"description": "Runs troubleshoot script for adapter",
"input": [
{
"name": "props",
"type": "object",
"info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
"required": true,
"schema": {
"title": "props",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapTroubleshootAdapter"
},
"task": true
},
{
"name": "iapRunAdapterHealthcheck",
"summary": "Runs healthcheck script for adapter",
"description": "Runs healthcheck script for adapter",
"input": [],
"output": {
"name": "result",
"type": "boolean",
"description": "Whether healthcheck passed or failed",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterHealthcheck"
},
"task": true
},
{
"name": "iapRunAdapterConnectivity",
"summary": "Runs connectivity check script for adapter",
"description": "Runs connectivity check script for adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterConnectivity"
},
"task": true
},
{
"name": "iapRunAdapterBasicGet",
"summary": "Runs basicGet script for adapter",
"description": "Runs basicGet script for adapter",
"input": [
{
"name": "maxCalls",
"required": false,
"type": "number",
"info": "How many GET endpoints to test (defaults to 5)",
"schema": {
"title": "maxCalls",
"type": "number",
"default": 5
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing the test results",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRunAdapterBasicGet"
},
"task": true
},
{
"name": "iapMoveAdapterEntitiesToDB",
"summary": "Moves entities from an adapter into the Itential Platform database",
"description": "Moves entities from an adapter into the Itential Platform database",
"input": [],
"output": {
"name": "res",
"type": "object",
"description": "A JSON Object containing status, code and the response from the mongo transaction",
"schema": {
"title": "res",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapMoveAdapterEntitiesToDB"
},
"task": true
},
{
"name": "iapDeactivateTasks",
"summary": "Deactivate the inputted tasks",
"description": "Deactivate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to deactivate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapDeactivateTasks"
},
"task": true
},
{
"name": "iapActivateTasks",
"summary": "Activate the inputted tasks",
"description": "activate the inputted tasks",
"input": [
{
"name": "tasks",
"type": "array",
"description": "Tasks to activate",
"schema": {
"title": "tasks",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing success status",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapActivateTasks"
},
"task": true
},
{
"name": "iapPopulateEntityCache",
"summary": "Populate the cache for the given entities",
"description": "Populate the cache for the given entities",
"input": [
{
"name": "entityTypes",
"type": "array",
"info": "the entity type(s) to populate",
"required": true,
"schema": {
"title": "entityTypes",
"type": "array"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapPopulateEntityCache"
},
"task": true
},
{
"name": "iapRetrieveEntitiesCache",
"summary": "Retrieves data from cache for specified entity type",
"description": "Retrieves data from cache for specified entity type",
"input": [
{
"name": "entityType",
"type": "string",
"info": "entity of which to retrieve",
"required": true,
"schema": {
"title": "entityType",
"type": "string"
}
},
{
"name": "options",
"type": "object",
"info": "settings of which data to return and how to return it",
"required": false,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapRetrieveEntitiesCache"
},
"task": true
},
{
"name": "getDevice",
"summary": "Get the Appliance",
"description": "Get the Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevice"
},
"task": false
},
{
"name": "getDevicesFiltered",
"summary": "Get Appliances that match the filter",
"description": "Get Appliances that match the filter",
"input": [
{
"name": "options",
"type": "object",
"info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }",
"required": true,
"schema": {
"title": "options",
"type": "object"
}
}
],
"output": {
"name": "result",
"type": "array",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "array"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getDevicesFiltered"
},
"task": false
},
{
"name": "isAlive",
"summary": "Checks the status for the provided Appliance",
"description": "Checks the status for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "boolean",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "boolean"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/isAlive"
},
"task": false
},
{
"name": "getConfig",
"summary": "Gets a config for the provided Appliance",
"description": "Gets a config for the provided Appliance",
"input": [
{
"name": "deviceName",
"type": "string",
"info": "An Appliance Device Name",
"required": true,
"schema": {
"title": "deviceName",
"type": "string"
}
},
{
"name": "format",
"type": "string",
"info": "The format to be returned - this is ignored as we always return json",
"required": false,
"schema": {
"title": "format",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getConfig"
},
"task": false
},
{
"name": "iapGetDeviceCount",
"summary": "Gets a device count from the system",
"description": "Gets a device count from the system",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapGetDeviceCount"
},
"task": false
},
{
"name": "iapExpandedGenericAdapterRequest",
"summary": "Makes the requested generic call with additional options",
"description": "Makes the requested generic call with additional options via metadata",
"input": [
{
"name": "metadata",
"type": "object",
"info": "metadata for the call (optional)",
"description": "metadata for the call - allows for many enhancements (optional)",
"schema": {
"title": "metadata",
"type": "object"
},
"required": false
},
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": false
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": false
},
{
"name": "pathVars",
"type": "object",
"info": "the parameters to be put within the url path (optional)",
"description": "the parameters to be put within the url path (optional)",
"schema": {
"title": "pathVars",
"type": "object"
},
"required": false
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/iapExpandedGenericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequest",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequest"
},
"task": true
},
{
"name": "genericAdapterRequestNoBasePath",
"summary": "Makes the requested generic call",
"description": "Makes the requested generic call",
"input": [
{
"name": "uriPath",
"type": "string",
"info": "the path of the api call - do not include the host, port, base path or version",
"description": "the path of the api call",
"schema": {
"title": "uriPath",
"type": "string"
},
"required": true
},
{
"name": "restMethod",
"type": "string",
"info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
"schema": {
"title": "restMethod",
"type": "string"
},
"required": true
},
{
"name": "queryData",
"type": "object",
"info": "the query parameters to be put on the url (optional)",
"description": "the query parameters to be put on the url (optional)",
"schema": {
"title": "queryData",
"type": "object"
},
"required": false
},
{
"name": "requestBody",
"type": "object",
"info": "the payload to be sent with the request (optional)",
"description": "the payload to be sent with the request (optional)",
"schema": {
"title": "requestBody",
"type": "object"
},
"required": false
},
{
"name": "addlHeaders",
"type": "object",
"info": "additional headers to be put on the call (optional)",
"description": "additional headers to be put on the call (optional)",
"schema": {
"title": "addlHeaders",
"type": "object"
},
"required": false
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/genericAdapterRequestNoBasePath"
},
"task": true
},
{
"name": "iapRunAdapterLint",
"summary": "Run the adapter lint script to return the results",
"description": "Run the adapter lint script to return the results",
"input": [],
"output": {
"name": "result",
"type": "string",
"description": "A string containing the run results",
"schema": {
"title": "result",
"type": "string"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterLint"
},
"task": true
},
{
"name": "iapRunAdapterTests",
"summary": "Run the adapter test scripts (baseunit and unit) to return the results",
"description": "Run the adapter test scripts (baseunit and unit) to return the results",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapRunAdapterTests"
},
"task": true
},
{
"name": "iapGetAdapterInventory",
"summary": "Provide inventory information abbout the adapter",
"description": "Provide inventory information abbout the adapter",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/iapGetAdapterInventory"
},
"task": true
},
{
"name": "getRestapi",
"summary": "Get Server Info",
"description": "Get Server Info",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getRestapi"
},
"task": true
},
{
"name": "postRestapiOauthAuthorize",
"summary": "OAuth2 Authorize",
"description": "OAuth2 Authorize",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"response_type\": \"string\", \"client_id\": \"string\", \"redirect_uri\": \"string\", \"state\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"response_type": {
"type": "string",
"description": "Must be set to code"
},
"client_id": {
"type": "string",
"description": "Required. Enter your application key (Production or Sandbox) here"
},
"redirect_uri": {
"type": "string",
"description": "Required. This is a callback URI which determines where the response will be sent to. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration. This URI can be HTTP/HTTPS address for web applications or custom scheme URI for mobile or desktop applications."
},
"state": {
"type": "string",
"description": "Optional, recommended. An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter should be used for preventing cross-site request forgery"
}
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/postRestapiOauthAuthorize"
},
"task": true
},
{
"name": "postRestapiOauthRevoke",
"summary": "OAuth2 Revoke Token",
"description": "OAuth2 Revoke Token",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"token\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Active access or refresh token to be revoked"
}
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/postRestapiOauthRevoke"
},
"task": true
},
{
"name": "postRestapiOauthToken",
"summary": "OAuth2 Get Token",
"description": "OAuth2 Get Token",
"input": [
{
"name": "body",
"type": "object",
"info": ": {\"grant_type\": \"string\", \"access_token_ttl\": 123, \"refresh_token_ttl\": 123, \"username\": \"string\", \"extension\": \"string\", \"password\": \"string\", \"scope\": \"string\", \"endpoint_id\": \"string\"}",
"required": false,
"schema": {
"type": "object",
"properties": {
"grant_type": {
"type": "string",
"description": "Must hold password value for Resource Owner Credentials flow. If client application is not authorized by the specified grant_type, response does not contain refresh_token and refresh_token_ttl attributes"
},
"access_token_ttl": {
"type": "integer",
"description": "Optional. Access token lifetime in seconds; the possible values are from 600 sec (10 min) to 3600 sec (1 hour). The default value is 3600 sec. If the value specified exceeds the default one, the default value is set. If the value specified is less than 600 seconds, the minimum value (600 sec) is set"
},
"refresh_token_ttl": {
"type": "integer",
"description": "Optional. Refresh token lifetime in seconds. The default value depends on the client application, but as usual it equals to 7 days. If the value specified exceeds the default one, the default value is applied. If client specifies refresh_token_ttl<=0, refresh token is not returned even if the corresponding grant type is supported"
},
"username": {
"type": "string",
"description": "Phone number linked to account or extension in account in E.164 format with or without leading \"+\" sign"
},
"extension": {
"type": "string",
"description": "Optional. Extension short number. If company number is specified as a username, and extension is not specified, the server will attempt to authenticate client as main company administrator"
},
"password": {
"type": "string",
"description": "User's password"
},
"scope": {
"type": "string",
"description": "Optional. List of API permissions to be used with access token (see Application Permissions). Can be omitted when requesting all permissions defined during the application registration phase"
},
"endpoint_id": {
"type": "string",
"description": "Optional. Unique identifier of a client application. You can pass it in request according to pattern [a-zA-Z0-9_\\-]{1,64}. Otherwise it is auto-generated by server. The value will be returned in response in both cases"
}
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/postRestapiOauthToken"
},
"task": true
},
{
"name": "getRestapiV10",
"summary": "Get API Version Info",
"description": "Get API Version Info",
"input": [],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "GET",
"path": "/getRestapiV10"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountId",
"summary": "Get Account Info by ID",
"description": "Get Account Info by ID",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getRestapiV10AccountAccountId"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountIdActiveCalls",
"summary": "Get Account Active (Recent) Calls",
"description": "Get Account Active (Recent) Calls",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
},
{
"name": "direction",
"type": "string",
"info": "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values ...(description truncated): Must be one of [Inbound, Outbound]",
"required": false,
"schema": {
"title": "direction",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted: Must be one of [Voice, Fax]",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "page",
"type": "number",
"info": "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'.: 123",
"required": false,
"schema": {
"title": "page",
"type": "number"
}
},
{
"name": "perPage",
"type": "number",
"info": "Indicates the page size (number of items). If not specified, the value is '100' by default.: 123",
"required": false,
"schema": {
"title": "perPage",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getRestapiV10AccountAccountIdActiveCalls"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountIdBusinessAddress",
"summary": "Get Company Business Address",
"description": "Get Company Business Address",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getRestapiV10AccountAccountIdBusinessAddress"
},
"task": true
},
{
"name": "putRestapiV10AccountAccountIdBusinessAddress",
"summary": "Update Company Business Address",
"description": "Update Company Business Address",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
},
{
"name": "body",
"type": "object",
"info": ": {\"company\": \"string\", \"email\": \"string\", \"businessAddress\": {\"country\": \"string\", \"state\": \"string\", \"city\": \"string\", \"street\": \"string\", \"zip\": \"string\"}}",
"required": false,
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"description": "Company business name"
},
"email": {
"type": "string",
"description": "Company business email address"
},
"businessAddress": {
"type": "object",
"properties": {
"country": {
"type": "string",
"description": "Name of a country"
},
"state": {
"type": "string",
"description": "Name of a state/province"
},
"city": {
"type": "string",
"description": "Name of a city"
},
"street": {
"type": "string",
"description": "Street address"
},
"zip": {
"type": "string",
"description": "Zip code"
}
}
}
}
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/putRestapiV10AccountAccountIdBusinessAddress"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountIdCallLog",
"summary": "Get Account Call Log",
"description": "Get Account Call Log",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
},
{
"name": "extensionNumber",
"type": "string",
"info": "Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter: string",
"required": false,
"schema": {
"title": "extensionNumber",
"type": "string"
}
},
{
"name": "phoneNumber",
"type": "string",
"info": "Phone number of a caller/call recipient. If specified, returns all calls (both incoming and outcoming) with the mentioned phone number. Cannot be specified together with ...(description truncated): string",
"required": false,
"schema": {
"title": "phoneNumber",
"type": "string"
}
},
{
"name": "direction",
"type": "string",
"info": "The direction for the result records. It is allowed to specify more than one direction. If not specified, both inbound and outbound records are returned. Multiple values ...(description truncated): Must be one of [Inbound, Outbound]",
"required": false,
"schema": {
"title": "direction",
"type": "string"
}
},
{
"name": "type",
"type": "string",
"info": "Call type of a record. It is allowed to specify more than one type. If not specified, all call types are returned. Multiple values are accepted: Must be one of [Voice, Fax]",
"required": false,
"schema": {
"title": "type",
"type": "string"
}
},
{
"name": "view",
"type": "string",
"info": "The default value is 'Simple' for both account and extension call log: Must be one of [Simple, Detailed]",
"required": false,
"schema": {
"title": "view",
"type": "string"
}
},
{
"name": "withRecording",
"type": "boolean",
"info": "'True' if only recorded calls have to be returned: boolean",
"required": false,
"schema": {
"title": "withRecording",
"type": "boolean"
}
},
{
"name": "dateFrom",
"type": "string",
"info": "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours: string",
"required": false,
"schema": {
"title": "dateFrom",
"type": "string"
}
},
{
"name": "dateTo",
"type": "string",
"info": "The end datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time: string",
"required": false,
"schema": {
"title": "dateTo",
"type": "string"
}
},
{
"name": "page",
"type": "number",
"info": "Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1': 123",
"required": false,
"schema": {
"title": "page",
"type": "number"
}
},
{
"name": "perPage",
"type": "number",
"info": "Indicates the page size (number of items). If not specified, the value is '100' by default.: 123",
"required": false,
"schema": {
"title": "perPage",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getRestapiV10AccountAccountIdCallLog"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountIdCallLogCallLogId",
"summary": "Get Account Call Log Record by ID",
"description": "Get Account Call Log Record by ID",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
},
{
"name": "callLogId",
"type": "number",
"info": "Internal identifier of a call log record: 123",
"required": true,
"schema": {
"title": "callLogId",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getRestapiV10AccountAccountIdCallLogCallLogId"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountIdDepartmentDepartmentIdMembers",
"summary": "Get Department Members",
"description": "Get Department Members",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
},
{
"name": "departmentId",
"type": "number",
"info": "Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid): 123",
"required": true,
"schema": {
"title": "departmentId",
"type": "number"
}
},
{
"name": "page",
"type": "number",
"info": "Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1': 123",
"required": false,
"schema": {
"title": "page",
"type": "number"
}
},
{
"name": "perPage",
"type": "number",
"info": "Indicates the page size (number of items). If not specified, the value is '100' by default: 123",
"required": false,
"schema": {
"title": "perPage",
"type": "number"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object containing status, code and the result",
"schema": {
"title": "result",
"type": "object"
}
},
"roles": [
"admin"
],
"route": {
"verb": "POST",
"path": "/getRestapiV10AccountAccountIdDepartmentDepartmentIdMembers"
},
"task": true
},
{
"name": "getRestapiV10AccountAccountIdDevice",
"summary": "Get Account Device List",
"description": "Get Account Device List",
"input": [
{
"name": "accountId",
"type": "string",
"info": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session: string",
"required": true,
"schema": {
"title": "accountId",
"type": "string"
}
}
],
"output": {
"name": "result",
"type": "object",
"description": "A JSON Object co