@itentialopensource/adapter-ringcentral
Version:
This adapter integrates with system described as: ringcentralApi.
1,340 lines (1,339 loc) • 247 kB
YAML
openapi: 3.0.0
info:
title: RingCentral API
description: RingCentral Connect Platform API
contact: {}
version: 'v1.0'
servers:
- url: https://platform.devtest.ringcentral.com/restapi
variables: {}
paths:
/restapi:
get:
summary: Restapi_GET
description: Get Server Info
operationId: Restapi_GET
parameters: []
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ServerInfo'
deprecated: false
/restapi/oauth/authorize:
post:
summary: RestapiOauthAuthorize_POST
description: OAuth2 Authorize
operationId: RestapiOauthAuthorize_POST
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiOauthAuthorize_POSTException1'
deprecated: false
/restapi/oauth/revoke:
post:
summary: RestapiOauthRevoke_POST
description: OAuth2 Revoke Token
operationId: RestapiOauthRevoke_POST
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body1'
required: false
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
/restapi/oauth/token:
post:
summary: RestapiOauthToken_POST
description: OAuth2 Get Token
operationId: RestapiOauthToken_POST
parameters: []
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body2'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiOauthToken_POSTException1'
deprecated: false
/restapi/v1.0:
get:
summary: RestapiV10_GET
description: Get API Version Info
operationId: RestapiV10_GET
parameters: []
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/VersionInfo'
deprecated: false
/restapi/v1.0/account/{accountId}:
get:
summary: RestapiV10AccountByAccountId_GET
description: Get Account Info by ID
operationId: RestapiV10AccountByAccountId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AccountInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/active-calls:
get:
summary: RestapiV10AccountActiveCallsByAccountId_GET
description: Get Account Active (Recent) Calls
operationId: RestapiV10AccountActiveCallsByAccountId_GET
parameters:
- name: direction
in: query
description: 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 are accepted
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/direction41'
- description: 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 are accepted
- name: type
in: query
description: 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
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type141'
- description: 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
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'.
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default.
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountActiveCallsByAccountId_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/business-address:
get:
summary: RestapiV10AccountBusinessAddress_GET
description: Get Company Business Address
operationId: RestapiV10AccountBusinessAddress_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountBusinessAddress_GETException1'
deprecated: false
put:
summary: RestapiV10AccountBusinessAddress_PUT
description: Update Company Business Address
operationId: RestapiV10AccountBusinessAddress_PUT
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body3'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountBusinessAddress_PUTException1'
deprecated: false
/restapi/v1.0/account/{accountId}/call-log:
get:
summary: RestapiV10AccountCallLogByAccountId_GET
description: Get Account Call Log
operationId: RestapiV10AccountCallLogByAccountId_GET
parameters:
- name: extensionNumber
in: query
description: Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter
style: form
explode: true
schema:
type: string
- name: phoneNumber
in: query
description: 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 the extensionNumber filter
style: form
explode: true
schema:
type: string
- name: direction
in: query
description: 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 are accepted
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/direction41'
- description: 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 are accepted
- name: type
in: query
description: 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
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type141'
- description: 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
- name: view
in: query
description: The default value is 'Simple' for both account and extension call log
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/view1'
- description: The default value is 'Simple' for both account and extension call log
- name: withRecording
in: query
description: "'True' if only recorded calls have to be returned"
style: form
explode: true
schema:
type: boolean
- name: dateFrom
in: query
description: 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
style: form
explode: true
schema:
type: string
format: date-time
- name: dateTo
in: query
description: 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
style: form
explode: true
schema:
type: string
format: date-time
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. The default value is '1'
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default.
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountCallLogByAccountId_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/call-log/{callLogId}:
get:
summary: GetRestapiV10AccountCallLogByAccountId_GET
description: Get Account Call Log Record by ID
operationId: GetRestapiV10AccountCallLogByAccountId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: callLogId
in: path
description: Internal identifier of a call log record
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CallLogInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/department/{departmentId}/members:
get:
summary: RestapiV10AccountDepartmentMembers_GET
description: Get Department Members
operationId: RestapiV10AccountDepartmentMembers_GET
parameters:
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: departmentId
in: path
description: Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid)
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountDepartmentMembers_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/device:
get:
summary: RestapiV10AccountDeviceByAccountId_GET
description: Get Account Device List
operationId: RestapiV10AccountDeviceByAccountId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountDeviceByAccountId_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/device/{deviceId}:
get:
summary: GetRestapiV10AccountDeviceByAccountId_GET
description: Get Device by ID
operationId: GetRestapiV10AccountDeviceByAccountId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: deviceId
in: path
description: Internal identifier of a device
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DeviceInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/extension:
get:
summary: RestapiV10AccountExtensionByAccountId_GET
description: Get Extension List
operationId: RestapiV10AccountExtensionByAccountId_GET
parameters:
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default.
style: form
explode: true
schema:
type: integer
format: int32
- name: status
in: query
description: Extension current state. Multiple values are supported. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/status71'
- description: Extension current state. Multiple values are supported. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned
- name: type
in: query
description: Extension type. Multiple values are supported
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type161'
- description: Extension type. Multiple values are supported
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionByAccountId_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}:
get:
summary: GetRestapiV10AccountExtensionByAccountId_GET
description: Get Extension Info by ID
operationId: GetRestapiV10AccountExtensionByAccountId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionInfo'
deprecated: false
put:
summary: RestapiV10AccountExtensionByAccountId_PUT
description: Update Extension by ID
operationId: RestapiV10AccountExtensionByAccountId_PUT
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/body4'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExtensionInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls:
get:
summary: RestapiV10AccountExtensionActiveCalls_GET
description: Get Extension Active (Recent) Calls
operationId: RestapiV10AccountExtensionActiveCalls_GET
parameters:
- name: direction
in: query
description: 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 are accepted
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/direction41'
- description: 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 are accepted
- name: type
in: query
description: 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
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type141'
- description: 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
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionActiveCalls_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync:
get:
summary: RestapiV10AccountExtensionAddressBookSync_GET
description: Contacts Synchronization
operationId: RestapiV10AccountExtensionAddressBookSync_GET
parameters:
- name: syncType
in: query
description: Type of synchronization. The default value is 'FSync'
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/syncType11'
- description: Type of synchronization. The default value is 'FSync'
- name: syncToken
in: query
description: Value of syncToken property of the last sync request response
style: form
explode: true
schema:
type: string
- name: perPage
in: query
description: Number of records per page to be returned. The max number of records is 250, which is also the default. For FSync — if the number of records exceeds the parameter value (either specified or default), all of the pages can be retrieved in several requests. For ISync — if the number of records exceeds the page size, the number of incoming changes to this number is limited
style: form
explode: true
schema:
type: integer
format: int32
- name: pageId
in: query
description: Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionAddressBookSync_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact:
post:
summary: RestapiV10AccountExtensionAddressBookContact_POST
description: Create New Contact
operationId: RestapiV10AccountExtensionAddressBookContact_POST
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalContactInfo'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalContactInfo'
deprecated: false
get:
summary: RestapiV10AccountExtensionAddressBookContact_GET
description: Get Contact List
operationId: RestapiV10AccountExtensionAddressBookContact_GET
parameters:
- name: startsWith
in: query
description: If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive
style: form
explode: true
schema:
type: string
- name: sortBy
in: query
description: Sorts results by the specified property. The default is 'First Name'
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/sortBy1'
- description: Sorts results by the specified property. The default is 'First Name'
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionAddressBookContact_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}:
delete:
summary: RestapiV10AccountExtensionAddressBookContactContactId_DELETE
description: Delete Contact by ID
operationId: RestapiV10AccountExtensionAddressBookContactContactId_DELETE
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: contactId
in: path
description: Internal identifier of a contact record in the RingCentral database
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
get:
summary: RestapiV10AccountExtensionAddressBookContactContactId_GET
description: Get Contact by ID
operationId: RestapiV10AccountExtensionAddressBookContactContactId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: contactId
in: path
description: Internal identifier of a contact record in the RingCentral database
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalContactInfo'
deprecated: false
put:
summary: RestapiV10AccountExtensionAddressBookContactContactId_PUT
description: Update Contact by ID
operationId: RestapiV10AccountExtensionAddressBookContactContactId_PUT
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: contactId
in: path
description: Internal identifier of a contact record in the RingCentral database
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalContactInfo'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PersonalContactInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/group:
get:
summary: RestapiV10AccountExtensionAddressBookGroup_GET
description: Get Contact Group List
operationId: RestapiV10AccountExtensionAddressBookGroup_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionAddressBookGroup_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{answeringRuleId}:
get:
summary: RestapiV10AccountExtensionAnsweringRuleAnsweringRuleId_GET
description: Get Custom Answering Rule by ID
operationId: RestapiV10AccountExtensionAnsweringRuleAnsweringRuleId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: answeringRuleId
in: path
description: Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AnsweringRuleInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number:
post:
summary: RestapiV10AccountExtensionBlockedNumber_POST
description: Add New Blocked Number
operationId: RestapiV10AccountExtensionBlockedNumber_POST
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BlockedNumberInfo'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BlockedNumberInfo'
deprecated: false
get:
summary: RestapiV10AccountExtensionBlockedNumber_GET
description: Get Blocked Number List
operationId: RestapiV10AccountExtensionBlockedNumber_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionBlockedNumber_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/blocked-number/{blockedNumberId}:
delete:
summary: RestapiV10AccountExtensionBlockedNumberBlockedNumberId_DELETE
description: Delete Blocked Number by ID
operationId: RestapiV10AccountExtensionBlockedNumberBlockedNumberId_DELETE
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: blockedNumberId
in: path
description: Internal identifiers of a blocked number list entry
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
get:
summary: RestapiV10AccountExtensionBlockedNumberBlockedNumberId_GET
description: Get Blocked Number by ID
operationId: RestapiV10AccountExtensionBlockedNumberBlockedNumberId_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: blockedNumberId
in: path
description: Internal identifiers of a blocked number list entry
required: true
style: simple
schema:
type: integer
format: int32
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BlockedNumberInfo'
deprecated: false
put:
summary: RestapiV10AccountExtensionBlockedNumberBlockedNumberId_PUT
description: Update Blocked Number Label
operationId: RestapiV10AccountExtensionBlockedNumberBlockedNumberId_PUT
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: blockedNumberId
in: path
description: Internal identifiers of a blocked number list entry
required: true
style: simple
schema:
type: integer
format: int32
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/BlockedNumberInfo'
required: false
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/BlockedNumberInfo'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours:
get:
summary: RestapiV10AccountExtensionBusinessHours_GET
description: Get User Hours Setting
operationId: RestapiV10AccountExtensionBusinessHours_GET
parameters:
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionBusinessHours_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log:
delete:
summary: RestapiV10AccountExtensionCallLog_DELETE
description: Delete Extension Call Log
operationId: RestapiV10AccountExtensionCallLog_DELETE
parameters:
- name: dateTo
in: query
description: The end datetime for records deletion in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time
style: form
explode: true
schema:
type: string
format: date-time
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content: {}
deprecated: false
get:
summary: RestapiV10AccountExtensionCallLog_GET
description: Get Extension Call Log
operationId: RestapiV10AccountExtensionCallLog_GET
parameters:
- name: extensionNumber
in: query
description: Extension number of a user. If specified, returns call log for a particular extension only. Cannot be specified together with the phoneNumber filter
style: form
explode: true
schema:
type: string
- name: phoneNumber
in: query
description: 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 the extensionNumber filter
style: form
explode: true
schema:
type: string
- name: direction
in: query
description: 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 are accepted
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/direction41'
- description: 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 are accepted
- name: type
in: query
description: 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
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type141'
- description: 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
- name: view
in: query
description: The default value is 'Simple' for both account and extension call log
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/view1'
- description: The default value is 'Simple' for both account and extension call log
- name: withRecording
in: query
description: "'True' if only recorded calls have to be returned"
style: form
explode: true
schema:
type: boolean
- name: dateTo
in: query
description: 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
style: form
explode: true
schema:
type: string
format: date-time
- name: dateFrom
in: query
description: 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
style: form
explode: true
schema:
type: string
format: date-time
- name: page
in: query
description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1'
style: form
explode: true
schema:
type: integer
format: int32
- name: perPage
in: query
description: Indicates the page size (number of items). If not specified, the value is '100' by default
style: form
explode: true
schema:
type: integer
format: int32
- name: accountId
in: path
description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session
required: true
style: simple
schema:
type: string
- name: extensionId
in: path
description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session
required: true
style: simple
schema:
type: string
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/RestapiV10AccountExtensionCallLog_GETException1'
deprecated: false
/restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync:
get:
summary: RestapiV10AccountExtensionCallLogSync_GET
description: Call Log Synchronization
operationId: RestapiV10AccountExtensionCallLogSync_GET
parameters:
- name: syncType
in: query
description: Type of synchronization. 'FSync' is a default value
style: form
explode: true
schema: