swagger: "2.0" info: title: RingCentral Connect Platform API description: RingCentral Connect Platform API version: 1.0.36 contact: name: RingCentral Connect Platform url: http://developers.ringcentral.com email: platform@ringcentral.com license: name: RingCentral API License Agreement and Terms of Use url: https://www.ringcentral.com/legal/apilitos.html host: platform.ringcentral.com schemes: - https basePath: / produces: - application/json tags: - name: API Info - name: ADG - name: Presence - name: Subscriptions - name: Application Settings - name: Devices - name: SCIM - name: Verification Call description: ' ' - name: Call Control - name: RDG security: - OAuth2: [] x-auth-required: true x-blacklisting-strategy: "Off" x-internal-api: false x-metered-api: true x-metering-group: System x-service-interface: rest x-service-name: pas x-service-version: v1 paths: /restapi: get: tags: - API Info summary: Get API Versions description: Returns current API version(s) and server info. operationId: readAPIVersions consumes: - application/json produces: - application/json parameters: [] responses: 200: description: Success schema: $ref: '#/definitions/GetVersionsResponse' x-api-group: restapi x-auth-required: false x-throttling-group: NoThrottling x-metered-api: true x-metering-group: Free x-docs-level: Public /restapi/{apiVersion}: get: tags: - API Info summary: Get Version Info description: Returns current API version info by apiVersion. operationId: readAPIVersion consumes: - application/json produces: - application/json parameters: - name: apiVersion in: path description: API version to be requested, for example 'v1.0' required: true type: string responses: 200: description: API Version schema: $ref: '#/definitions/GetVersionResponse' x-api-group: restapi/version x-auth-required: false x-throttling-group: NoThrottling x-metered-api: true x-metering-group: Free x-docs-level: Public /restapi/v1.0/status: get: tags: - API Info summary: Get Service Status description: Returns current PAS service status. operationId: readAPIStatus responses: 200: description: OK 503: description: VoIP-only Mode x-api-group: restapi/status x-auth-required: false x-throttling-group: NoThrottling x-metered-api: true x-metering-group: Free x-docs-level: Public x-availability: Limited /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log: get: tags: - Call Log summary: Get User Call Log Records description: Returns call log records filtered by parameters specified. operationId: readUserCallLog consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: extensionNumber in: query description: Extension number of a user. If specified, returns call log for a particular extension only required: false type: string - name: showBlocked in: query description: If 'True' then calls from/to blocked numbers are returned default: true required: false type: boolean - name: phoneNumber in: query description: Phone number of a caller/callee. If specified, returns all calls (both incoming and outcoming) with the phone number specified required: false type: string - name: direction in: query description: The direction for the resulting records. If not specified, both inbound and outbound records are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Inbound - Outbound - name: sessionId in: query description: Internal identifier of a session required: false type: string - 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 required: false type: array collectionFormat: multi items: type: string enum: - Voice - Fax - name: transport in: query description: Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled required: false type: array collectionFormat: multi items: type: string enum: - PSTN - VoIP - name: view description: View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync in: query default: Simple required: false type: string enum: - Simple - Detailed - name: withRecording in: query description: '**Deprecated**. Supported for compatibility reasons. `True` if only recorded calls are returned. If both `withRecording` and `recordingType` are specified, then `withRecording` is ignored' default: false required: false type: boolean - name: recordingType in: query description: Type of a call recording. If not specified, then calls without recordings are also returned type: string enum: - Automatic - OnDemand - All - 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 required: false 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 required: false type: string format: date-time - name: page in: query description: Indicates the page number to retrieve. Only positive number values are allowed default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: showDeleted in: query description: If 'True' then deleted calls are returned default: false required: false type: boolean responses: 200: description: Success schema: $ref: '#/definitions/UserCallLogResponse' x-api-group: extension/call-log x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: ReadCallLog x-docs-level: Public delete: tags: - Call Log summary: Delete User Call Log description: Deletes filtered call log records. operationId: deleteUserCallLog consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - 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 required: false type: string format: date-time - name: phoneNumber in: query required: false type: string - name: extensionNumber in: query required: false type: string - name: type in: query required: false type: array collectionFormat: multi items: type: string enum: - Voice - Fax - name: direction in: query required: false type: array collectionFormat: multi items: type: string enum: - Inbound - Outbound - name: dateFrom in: query format: date-time required: false type: string responses: default: description: Success x-api-group: extension/call-log x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditCallLog x-user-permission: EditCallLog x-docs-level: Public x-availability: Limited /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync: get: tags: - Call Log summary: Sync User Call Log description: Synchronizes call log records operationId: syncUserCallLog consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: syncType in: query description: Type of synchronization required: false type: array collectionFormat: multi items: type: string enum: - FSync - ISync - name: syncToken in: query description: Value of syncToken property of last sync request response required: false type: string - 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 the current moment required: false type: string format: date-time - name: recordCount in: query description: For 'FSync' the parameter is mandatory, it limits the number of records to be returned in response. For 'ISync' it specifies with how many records to extend sync Frame to the past, the maximum number of records is 250 required: false type: integer - name: statusGroup in: query description: Type of calls to be returned. The default value is 'All' required: false type: array collectionFormat: multi items: type: string enum: - Missed - All - name: view in: query description: View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync required: false type: string default: Simple enum: - Simple - Detailed - name: showDeleted in: query description: Supproted for ISync. If 'True' then deleted call records are returned default: false required: false type: boolean responses: default: description: Success schema: $ref: '#/definitions/CallLogSync' x-api-group: extension/call-log-sync x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: ReadCallLog x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}: get: tags: - Call Log summary: Get User Call Record description: Returns call log records by ID. operationId: readUserCallRecord consumes: - application/json produces: - application/json parameters: - name: callRecordId in: path required: true type: array collectionFormat: csv items: type: string - name: view description: View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync in: query required: false type: string default: Simple enum: - Simple - Detailed - 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 type: string - name: accountId in: path required: true description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session type: string responses: 200: description: Call Log Record schema: $ref: '#/definitions/UserCallLogRecord' x-api-group: extension/call-log x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: ReadCallLog x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls: get: tags: - Call Log summary: Get User Active Calls description: Returns records of all extension calls that are in progress, ordered by start time in descending order. operationId: listExtensionActiveCalls consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: direction in: query description: The direction for the result records. If not specified, both inbound and outbound records are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Inbound - Outbound - name: view description: View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync in: query default: Simple required: false type: string enum: - Simple - Detailed - name: type in: query description: Call type of a record. If not specified, all call types are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Voice - Fax - name: page in: query description: Indicates the page number to retrieve. Only positive number values are allowed default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: default: description: Success schema: $ref: '#/definitions/ActiveCallsResponse' x-api-group: extension/active-calls x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: ReadCallLog x-docs-level: Public x-availability: Limited /restapi/v1.0/account/{accountId}/call-log: get: tags: - Call Log summary: Get Company Call Log Records description: Returns call log records filtered by parameters specified. operationId: readCompanyCallLog consumes: - application/json produces: - application/json 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 type: string default: "~" - name: extensionNumber in: query description: Extension number of a user. If specified, returns call log for a particular extension only required: false 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 phone number specified. Cannot be specified together with the extensionNumber filter required: false type: string - name: direction in: query description: The direction for the result records. If not specified, both inbound and outbound records are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Inbound - Outbound - name: type in: query description: Call type of a record. If not specified, all call types are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Voice - Fax - name: view description: View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync in: query default: Simple required: false type: string enum: - Simple - Detailed - name: withRecording in: query description: '**Deprecated**. Supported for compatibility reasons only. `true` if only recorded calls are returned. The default value is `false`. If both `withRecording` and `recordingType` are specified, `withRecording` is ignored' required: false type: boolean - name: recordingType in: query description: Type of a call recording. If not specified, then calls without recordings are also returned type: string enum: - Automatic - OnDemand - All - 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 required: false 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 required: false type: string format: date-time - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: sessionId description: Internal identifier of a session in: query required: false type: string responses: default: description: Success schema: $ref: '#/definitions/AccountCallLogResponse' x-api-group: account/call-log x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: FullCompanyCallLog x-docs-level: Public /restapi/v1.0/account/{accountId}/call-log/{callRecordId}: get: tags: - Call Log summary: Get Company Call Log Record(s) description: Returns individual call log record(s) by ID(s). Batch request is supported. operationId: readCompanyCallRecord consumes: - application/json produces: - application/json 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 type: string default: "~" - name: callRecordId in: path description: Internal identifier of a call log record required: true type: string responses: default: description: Success schema: $ref: '#/definitions/CompanyCallLogRecord' x-api-group: account/call-log x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: FullCompanyCallLog x-docs-level: Public /restapi/v1.0/account/{accountId}/active-calls: get: tags: - Call Log summary: Get Company Active Calls description: Returns records of all calls that are in progress, ordered by start time in descending order. operationId: listCompanyActiveCalls consumes: - application/json produces: - application/json 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 type: string default: "~" - name: direction in: query description: The direction for the result records. If not specified, both inbound and outbound records are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Inbound - Outbound - name: view description: View of call records. The same view parameter specified for FSync will be applied for ISync, the view cannot be changed for ISync in: query default: Simple required: false type: string enum: - Simple - Detailed - name: type in: query description: Call type of a record. If not specified, all call types are returned. Multiple values are accepted required: false type: array collectionFormat: multi items: type: string enum: - Voice - Fax - name: transport in: query description: Call transport type. 'PSTN' specifies that a call leg is initiated from the PSTN network provider; 'VoIP' - from an RC phone. By default this filter is disabled required: false type: array collectionFormat: multi items: type: string enum: - PSTN - VoIP - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted required: false default: 1 type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: default: description: Success schema: $ref: '#/definitions/ActiveCallsResponse' x-api-group: account/active-calls x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallLog x-user-permission: ReadCallLog x-docs-level: Public x-availability: Limited /restapi/v1.0/account/{accountId}/recording/{recordingId}: get: tags: - Call Recordings summary: Get Call Recording description: Returns call recordings by ID(s). operationId: readCallRecording consumes: - application/json produces: - application/json 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 type: string default: "~" - name: recordingId in: path description: Internal identifier of a recording (returned in Call Log) required: true type: string responses: default: description: Success schema: $ref: '#/definitions/GetCallRecordingResponse' x-api-group: account/recording x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallRecording x-user-permission: ReadCallRecording x-docs-level: Public /restapi/v1.0/account/{accountId}/recording/{recordingId}/content: get: tags: - Call Recordings summary: Get Call Recordings Data description: Returns media content of a call recording. operationId: listCallRecordingData consumes: - application/json produces: - audio/x-wav - audio/mpeg 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 type: string default: "~" - name: recordingId in: path description: Internal identifier of a recording (returned in Call Log) required: true type: string responses: 200: description: Call Recording Media Data schema: type: string format: binary x-api-group: account/recording/content x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadCallRecording x-user-permission: ReadCallRecording x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms: post: tags: - SMS summary: Create SMS/MMS Message description: Creates and sends a new message. Yoiu can send SMS messages simultaneously to different recipients up to 50 requests per minute; this limitation is relevant for all client applications. Sending and receiving SMS is available for Toll-Free Numbers within the USA. You can send up to 10 attachments in one MMS message; the size of all attachments linked is limited to 15000000 bytes. operationId: createSMSMessage consumes: - application/json - multipart/mixed - multipart/form-data produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CreateSMSMessage' responses: default: description: Success schema: $ref: '#/definitions/GetMessageInfoResponse' x-api-group: extension/sms x-throttling-group: Medium x-metered-api: true x-metering-group: Messaging x-app-permission: SMS x-user-permission: OutboundSMS x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager: post: tags: - Pager Messages summary: Create Internal Text Message description: Creates and sends an internal text message. operationId: createInternalTextMessage consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CreateInternalTextMessageRequest' responses: 200: description: Created Text Message schema: $ref: '#/definitions/GetMessageInfoResponse' x-api-group: extension/company-pager x-throttling-group: Medium x-metered-api: true x-metering-group: Messaging x-app-permission: InternalMessages x-user-permission: InternalSMS x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax: post: tags: - Fax summary: Create Fax Message operationId: createFaxMessage description: Creates and sends/resends a new fax message. Resend can be done if sending failed. consumes: - multipart/form-data produces: - application/json parameters: - name: accountId in: path description: Internal identifier of a RingCentral account (integer) or tilde (~) to indicate the account which was logged-in within the current session. required: true type: string - name: extensionId in: path description: Internal identifier of an extension (integer) or tilde (~) to indicate the extension assigned to the account logged-in within the current session required: true type: string - name: attachment in: formData description: File to upload required: true type: array items: type: string format: binary - name: faxResolution in: formData description: Resolution of Fax required: false type: string enum: - High - Low - name: to in: formData description: To Phone Number required: true type: array items: type: string - name: sendTime in: formData description: Timestamp to send fax at. If not specified (current or the past), the fax is sent immediately required: false type: string format: date-time - name: isoCode in: formData description: ISO Code. e.g UK type: string - name: coverIndex in: formData description: Cover page identifier. For the list of available cover page identifiers please call the method Fax Cover Pages. If not specified, the default cover page which is configured in 'Outbound Fax Settings' is attached type: integer - name: coverPageText in: formData description: Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols type: string responses: 200: description: Fax Message schema: $ref: '#/definitions/FaxResponse' x-api-group: extension/fax x-throttling-group: Heavy x-metered-api: true x-metering-group: Time-based x-app-permission: Faxes x-user-permission: OutboundFaxes x-docs-level: Public x-team: PLA Inno x-availability: High /restapi/v1.0/dictionary/fax-cover-page: get: tags: - Fax summary: Get Fax Cover Page List operationId: listFaxCoverPages description: Returns fax cover pages available for the current extension. consumes: - application/json produces: - application/json parameters: - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: 200: description: List of Fax Cover Pages schema: $ref: '#/definitions/ListFaxCoverPagesResponse' x-api-group: dictionary/fax-cover-page x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High x-team: PLA Inno /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store: get: tags: - Message Store summary: Get Message List description: Returns the list of messages from an extension mailbox. operationId: listMessages consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: availability in: query description: Specifies the availability status for the resulting messages. Multiple values are accepted required: false type: array items: type: string enum: - Alive - Deleted - Purged collectionFormat: multi - name: conversationId in: query description: Specifies the conversation identifier for the resulting messages required: false type: integer - name: dateFrom in: query description: The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours required: false type: string format: date-time - name: dateTo in: query description: The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time required: false type: string format: date-time - name: direction in: query description: The direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted required: false type: array items: type: string enum: - Inbound - Outbound collectionFormat: multi - name: distinctConversations in: query description: If 'True', then the latest messages per every conversation ID are returned required: false type: boolean - name: messageType in: query description: The type of the resulting messages. If not specified, all messages without message type filtering are returned. Multiple values are accepted required: false type: array items: type: string enum: - Fax - SMS - VoiceMail - Pager - Text collectionFormat: multi - name: readStatus in: query description: The read status for the resulting messages. Multiple values are accepted required: false type: array items: type: string enum: - Read - Unread collectionFormat: multi - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: phoneNumber in: query description: The phone number. If specified, messages are returned for this particular phone number only required: false type: string responses: 200: description: Success schema: $ref: '#/definitions/GetMessageList' x-api-group: extension/message-store x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadMessages x-user-permission: ReadMessages x-docs-level: Public x-availability: High x-notifications: - $ref: '#/definitions/InboundMessageEvent' - $ref: '#/definitions/InstantMessageEvent' - $ref: '#/definitions/MessageEvent' delete: tags: - Message Store summary: Delete Conversation description: Deletes conversation(s) by conversation ID(s). Batch request is supported. operationId: deleteMessageByFilter consumes: - application/json produces: - application/json parameters: - name: conversationId in: query required: false type: array items: type: string collectionFormat: multi - name: dateTo in: query required: false type: string description: Messages received earlier then the date specified will be deleted. The default value is 'Now' format: date-time - name: type in: query required: false description: Type of messages to be deleted type: string enum: - Fax - SMS - VoiceMail - Pager - Text - All default: All - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: 204: description: No Content x-api-group: extension/message-store x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditMessages x-user-permission: EditMessages x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}: get: tags: - Message Store summary: Get Message description: Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported. operationId: readMessage consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: messageId in: path description: Internal identifier of a message required: true type: integer responses: 200: description: OK schema: $ref: '#/definitions/GetMessageInfoResponse' 207: description: Multi-Status schema: $ref: '#/definitions/GetMessageMultiResponse' x-api-group: extension/message-store x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadMessages x-user-permission: ReadMessages x-docs-level: Public x-availability: High put: tags: - Message Store summary: Update Message(s) description: Updates message(s) by ID(s). Batch request is supported, see Batch Requests for details. Currently, only the message read status updating is supported. operationId: updateMessage consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: messageId in: path description: Internal identifier of a message required: true type: integer - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/UpdateMessageRequest' responses: 200: description: OK schema: $ref: '#/definitions/GetMessageInfoResponse' 207: description: Multi-Status schema: $ref: '#/definitions/GetMessageMultiResponse' x-api-group: extension/message-store x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditMessages x-user-permission: EditMessages x-docs-level: Public delete: tags: - Message Store summary: Delete Message description: Deletes message(s) by the given message ID(s). The first call of this method transfers the message to the 'Delete' status. The second call transfers the deleted message to the 'Purged' status. If it is required to make the message 'Purged' immediately (from the first call), then set the query parameter purge to 'True'. operationId: deleteMessage consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: messageId in: path description: Internal identifier of a message required: true type: integer - name: purge in: query description: If the value is 'True', then the message is purged immediately with all the attachments default: false required: false type: boolean - name: conversationId in: query description: Internal identifier of a message thread required: false type: integer responses: 204: description: No Content x-api-group: extension/message-store x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditMessages x-user-permission: EditMessages x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}: get: tags: - Message Store summary: Get Message Content operationId: readMessageContent description: Returns a specific message attachment data as media stream. consumes: - application/json produces: - text/plain - image/tiff 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 type: string default: "~" - 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 type: string default: "~" - name: attachmentId in: path description: Internal identifier of a message attachment required: true type: integer - name: messageId in: path description: Internal identifier of a message required: true type: integer - name: Range in: header required: false type: string - name: contentDisposition in: query required: false description: Content disposition of a response type: string enum: - Inline - Attachment default: Inline responses: 200: description: Attachment Data schema: type: string format: binary x-api-group: extension/message-store/content x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadMessages x-user-permission: ReadMessageContent x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync: get: tags: - Message Store summary: Sync Messages description: Synchronizes messages. operationId: syncMessages consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: conversationId in: query description: Conversation identifier for the resulting messages. Meaningful for SMS and Pager messages only. required: false type: integer - name: dateFrom in: query description: The start datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is dateTo minus 24 hours required: false type: string format: date-time - name: dateTo in: query description: The end datetime for resulting messages in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is current time required: false type: string format: date-time - name: direction in: query description: Direction for the resulting messages. If not specified, both inbound and outbound messages are returned. Multiple values are accepted required: false type: array items: type: string enum: - Inbound - Outbound collectionFormat: multi - name: distinctConversations in: query description: If 'True', then the latest messages per every conversation ID are returned required: false type: boolean - name: messageType in: query description: Type for the resulting messages. If not specified, all types of messages are returned. Multiple values are accepted required: false type: array items: type: string enum: - Fax - SMS - VoiceMail - Pager - Text collectionFormat: multi - name: recordCount in: query description: Limits the number of records to be returned (works in combination with dateFrom and dateTo if specified) required: false type: integer - name: syncToken in: query description: Value of syncToken property of last sync request response required: false type: string - name: syncType in: query description: Type of message synchronization required: false type: array items: type: string enum: - FSync - ISync collectionFormat: multi responses: default: description: Success schema: $ref: '#/definitions/GetMessageSyncResponse' x-api-group: extension/message-sync x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadMessages x-user-permission: ReadMessages x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/message-store-configuration: get: tags: - Message Store summary: Get Message Store Configuration operationId: readMessageStoreConfiguration description: Returns message store settings. produces: - application/json parameters: - name: accountId description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session in: path required: true type: string responses: 200: description: Successful operation schema: $ref: '#/definitions/MessageStoreConfiguration' x-api-group: account/message-store-configuration x-throttling-group: Light x-metered-api: true x-metering-group: System x-user-permission: AccountAdministration x-app-permission: EditAccounts x-docs-level: Public put: tags: - Message Store summary: Update Message Store Configuration operationId: updateMessageStoreConfiguration description: Updates message store settings. produces: - application/json parameters: - name: accountId description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session in: path required: true type: string - name: body in: body description: JSON body schema: $ref: '#/definitions/MessageStoreConfiguration' required: true responses: 200: description: Successful operation schema: $ref: '#/definitions/MessageStoreConfiguration' x-api-group: account/message-store-configuration x-throttling-group: Light x-metered-api: true x-metering-group: System x-user-permission: AccountAdministration x-app-permission: EditAccounts x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out: post: tags: - RingOut summary: Make RingOut Call description: Makes a 2-leg RingOut call. operationId: createRingOutCall consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: body in: body description: JSON body required: true schema: $ref: '#/definitions/MakeRingOutRequest' responses: default: description: Success schema: $ref: '#/definitions/GetRingOutStatusResponse' x-api-group: extension/ringout x-throttling-group: Heavy x-metered-api: true x-metering-group: Time-based x-app-permission: RingOut x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}: get: tags: - RingOut summary: Get RingOut Call Status description: Returns the status of a 2-leg RingOut call. operationId: readRingOutCallStatus consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ringoutId in: path description: Internal identifier of a RingOut call required: true type: string responses: default: description: Success schema: $ref: '#/definitions/GetRingOutStatusResponse' x-api-group: extension/ringout x-throttling-group: Light x-metered-api: true x-metering-group: Time-based x-app-permission: RingOut x-docs-level: Public delete: tags: - RingOut summary: Cancel RingOut Call description: Cancels a 2-leg RingOut call. operationId: deleteRingOutCall consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ringoutId in: path description: Internal identifier of a RingOut call required: true type: string responses: default: description: Success x-api-group: extension/ringout x-throttling-group: Heavy x-metered-api: true x-metering-group: Time-based x-app-permission: RingOut x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout: post: tags: - RingOut summary: Make RingOut Call deprecated: true description: Makes a 2-leg RingOut call. operationId: createRingOutCallDeprecated consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: body in: body description: JSON body required: true schema: $ref: '#/definitions/MakeRingOutRequest' responses: default: description: Success schema: $ref: '#/definitions/GetRingOutStatusResponseIntId' x-api-group: extension/ringout x-throttling-group: Heavy x-metered-api: true x-metering-group: Time-based x-app-permission: RingOut x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}: get: tags: - RingOut deprecated: true summary: Get RingOut Call Status description: Returns status of a 2-leg RingOut call. operationId: readRingOutCallStatusDeprecated consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ringoutId in: path description: Internal identifier of a RingOut call required: true type: integer responses: default: description: Success schema: $ref: '#/definitions/GetRingOutStatusResponse' x-api-group: extension/ringout x-throttling-group: Light x-metered-api: true x-metering-group: Time-based x-app-permission: RingOut x-docs-level: Public delete: tags: - RingOut deprecated: true summary: Cancel RingOut Call description: Cancels a 2-leg RingOut call. operationId: deleteRingOutCallDeprecated consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ringoutId in: path description: Internal identifier of a RingOut call required: true type: integer responses: 204: description: No Content x-api-group: extension/ringout x-throttling-group: Heavy x-metered-api: true x-metering-group: Time-based x-app-permission: RingOut x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact: get: tags: - External Contacts summary: Get Contact List description: Returns user personal contacts. operationId: listContacts consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: startsWith in: query description: If specified, only contacts whose First name or Last name start with the mentioned substring are returned. Case-insensitive required: false type: string - name: sortBy in: query description: Sorts results by the specified property required: false type: array items: type: string enum: - FirstName - LastName - Company collectionFormat: multi - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: phoneNumber in: query required: false type: array items: type: string collectionFormat: multi responses: default: description: Success schema: $ref: '#/definitions/ContactList' x-api-group: extension/address-book/contact x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadContacts x-user-permission: ReadPersonalContacts x-docs-level: Public x-availability: High post: tags: - External Contacts summary: Create Contact description: Creates personal user contact. operationId: createContact consumes: - application/json produces: - application/json 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 type: string default: "~" - name: dialingPlan in: query description: A country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The default value is home country of the current extension required: false 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 type: string default: "~" - in: body name: body required: false schema: $ref: '#/definitions/PersonalContactRequest' responses: "200": description: New Contact schema: $ref: '#/definitions/PersonalContactResource' "400": description: 'Contact cannot be created: max contacts count reached ($limit)' x-api-group: extension/address-book/contact x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: Contacts x-user-permission: EditPersonalContacts x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}: get: tags: - External Contacts summary: Get Contact description: Returns contact(s) by ID(s). Batch request is supported. operationId: readContact consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: contactId in: path description: Internal identifier of a contact record in the RingCentral database required: true type: integer responses: default: description: Contact schema: $ref: '#/definitions/PersonalContactResource' x-api-group: extension/address-book/contact x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadContacts x-user-permission: ReadPersonalContacts x-docs-level: Public x-availability: High put: tags: - External Contacts summary: Update Contact description: Updates personal contact information by contact ID(s). Batch request is supported operationId: updateContact consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: contactId in: path description: Internal identifier of a contact record in the RingCentral database required: true type: integer - name: dialingPlan in: query description: A country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. The default value is home country of the current extension required: false type: string - in: body name: body required: false schema: $ref: '#/definitions/PersonalContactRequest' responses: default: description: Success schema: $ref: '#/definitions/PersonalContactResource' x-api-group: extension/address-book/contact x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: Contacts x-user-permission: EditPersonalContacts x-docs-level: Public delete: tags: - External Contacts summary: Delete Contact description: Deletes contact(s) by ID(s). Batch request is supported. operationId: deleteContact consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: contactId in: path description: Internal identifier of a contact record in the RingCentral database required: true type: integer responses: default: description: Success x-api-group: extension/address-book/contact x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: Contacts x-user-permission: EditPersonalContacts x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync: get: tags: - External Contacts summary: Address Book Synchronization description: Synchronizes user contacts. operationId: syncAddressBook consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: syncType in: query description: Type of synchronization required: false type: array items: type: string enum: - FSync - ISync collectionFormat: multi - name: syncToken in: query description: Value of syncToken property of the last sync request response required: false 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 required: false type: integer - name: pageId in: query description: Internal identifier of a page. It can be obtained from the 'nextPageId' parameter passed in response body required: false type: integer responses: default: description: Success schema: $ref: '#/definitions/AddressBookSync' x-api-group: extension/address-book-sync x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadContacts x-user-permission: ReadPersonalContacts x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite: get: tags: - External Contacts summary: Get Favorite Contact List description: Returns the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records). operationId: listFavoriteContacts consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" responses: default: description: successful operation x-api-group: extension/favorite x-throttling-group: Light x-metered-api: true x-metering-group: System x-user-permission: ReadPersonalContacts x-app-permission: ReadContacts x-docs-level: Public x-availability: High x-notifications: - $ref: '#/definitions/ExtensionFavoritesEvent' put: tags: - External Contacts summary: Update Favorite Contact List description: 'Updates the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).**Please note**: currently personal address book size is limited to 10 000 contacts.' operationId: updateFavoriteContactList consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body required: false schema: $ref: '#/definitions/FavoriteCollection' responses: default: description: successful operation x-api-group: extension/favorite x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: Contacts x-user-permission: EditPersonalContacts x-docs-level: Public /restapi/v1.0/account/{accountId}/directory/entries/search: post: tags: - Internal Contacts summary: Search Company Directory Entries operationId: searchDirectoryEntries description: Returns contact information on corporate users of federated accounts according to the specified filtering and ordering. consumes: - application/json produces: - application/json 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 type: string - in: body name: body required: false schema: $ref: '#/definitions/SearchDirectoryEntriesRequest' responses: "200": description: Paged collection of all contacts information for a given account according to filtering and ordering. Records can be empty if no data found schema: $ref: '#/definitions/DirectoryResource' "400": description: Current request cannot be processed due to error in its body and/or url schema: $ref: '#/definitions/ErrorResponse' "500": description: Some unexpected error during current request processing. schema: $ref: '#/definitions/ErrorResponse' "503": description: Network error during request schema: $ref: '#/definitions/ErrorResponse' x-api-group: account/directory/entries x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-auth-required: true x-internal-api: false x-rewrite-uri-from: /restapi/v1.0/account/(.*)/directory/(.*) x-rewrite-uri-to: /account-directory/v1/account/$1/directory/$2 x-service-interface: rest x-service-name: adg x-service-version: v1 x-throttling-group: Heavy x-docs-level: Public /restapi/v1.0/account/{accountId}/directory/entries/{entryId}: get: tags: - Internal Contacts summary: Get Corporate Directory Entry description: Returns contact information on a particular corporate user of a federated account. operationId: readDirectoryEntry consumes: - application/json produces: - application/json parameters: - name: entryId in: path description: Internal identifier of extension to read information for required: true type: string - name: accountId in: path description: Internal identifier of owning account required: true type: string responses: 200: description: Contact information for given parameters. If value doesn't found then empty body will be returned schema: $ref: '#/definitions/ContactResource' 400: description: Current request cannot be processed due to error in its body and/or url schema: $ref: '#/definitions/ErrorResponse' 500: description: Some unexpected error during current request processing schema: $ref: '#/definitions/ErrorResponse' 503: description: Network error during request. One should check connection between ADG processing node and ADX data node schema: $ref: '#/definitions/ErrorResponse' x-api-group: account/directory/entries x-app-permission: ReadAccounts x-auth-required: true x-internal-api: false x-rewrite-uri-from: /restapi/v1.0/account/(.*)/directory/(.*) x-rewrite-uri-to: /account-directory/v1/account/$1/directory/$2 x-service-interface: rest x-service-name: adg x-service-version: v1 x-throttling-group: Medium x-docs-level: Public /restapi/v1.0/account/{accountId}/directory/entries: get: tags: - Internal Contacts summary: Get Company Directory Entries operationId: listDirectoryEntries description: 'Returns contact information on corporate users of federated accounts. Please note: 1. `User`, `DigitalUser`, `VirtualUser` and `FaxUser` types are returned as `User` type. 2. `ApplicationExtension` type is not returned. 3. Only extensions in `Enabled`, `Disabled` and `NotActivated` state are returned.' consumes: - application/json produces: - application/json 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 type: string - name: showFederated in: query description: If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case required: false type: boolean default: true - name: type in: query description: Type of an extension required: false type: string enum: - User - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnly - IvrMenu - ParkLocation - Limited - name: page in: query description: Page number required: false type: string default: "1" - name: perPage in: query description: 'Records count to be returned per one page. The default value is 1000. Specific keyword values: `all` - all records are returned in one page; `max` - maximum count of records that can be returned in one page' maximum: 2000 default: 1000 required: false type: integer - name: siteId in: query description: Internal identifier of the business site to which extensions belong required: false type: string - name: If-None-Match in: header description: If-None-Match required: false type: string responses: "200": description: Paged collection of all contacts information for a given account. Records can be empty if no data found. schema: $ref: '#/definitions/DirectoryResource' "400": description: Current request cannot be processed due to error in its body and/or url. schema: $ref: '#/definitions/ErrorResponse' "500": description: Some unexpected error during current request processing. schema: $ref: '#/definitions/ErrorResponse' "503": description: Network error during request schema: $ref: '#/definitions/ErrorResponse' x-api-group: account/directory/entries x-app-permission: ReadAccounts x-auth-required: true x-internal-api: false x-rewrite-uri-from: /restapi/v1.0/account/(.*)/directory/(.*) x-rewrite-uri-to: /account-directory/v1/account/$1/directory/$2 x-service-interface: rest x-service-name: adg x-service-version: v1 x-throttling-group: Medium x-docs-level: Public /restapi/v1.0/account/{accountId}/directory/federation: get: tags: - Internal Contacts summary: Get Account Federation description: Returns information on a federation and associated accounts. operationId: readAccountFederation consumes: - application/json produces: - application/json 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 type: string - name: RCExtensionId in: header description: RCExtensionId required: false type: string responses: "200": description: List of found federations. Records array can be empty if no data found schema: $ref: '#/definitions/FederationResource' "400": description: Current request cannot be processed due to error in its body and/or url schema: $ref: '#/definitions/ErrorResponse' "500": description: Some unexpected error during current request processing. schema: $ref: '#/definitions/ErrorResponse' "503": description: Network error during request schema: $ref: '#/definitions/ErrorResponse' x-api-group: account/directory/federation x-app-permission: ReadAccounts x-auth-required: true x-internal-api: false x-rewrite-uri-from: /restapi/v1.0/account/(.*)/directory/(.*) x-rewrite-uri-to: /account-directory/v1/account/$1/directory/$2 x-service-interface: rest x-service-name: adg x-service-version: v1 x-throttling-group: Medium x-user-permission: ReadCompanyInfo x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence: get: tags: - Presence summary: Get User Presence Status description: 'Returns presence status of an extension or several extensions by their ID(s). Batch request is supported. The ''presenceStatus'' is returned as Offline (the parameters ''telephonyStatus'', ''message'', ''userStatus'' and ''dndStatus'' are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off. Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message ''Extension Presence Info multipart request is limited to 30 extensions''.' operationId: readUserPresenceStatus 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 type: string default: "~" - 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 type: string default: "~" - name: detailedTelephonyState in: query description: Whether to return detailed telephony state required: false type: boolean - name: sipData in: query description: Whether to return SIP data required: false type: boolean responses: 200: description: OK schema: $ref: '#/definitions/GetPresenceInfo' x-api-group: extension/presence x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadPresence x-user-permission: ReadPresenceStatus x-docs-level: Public x-notifications: - $ref: '#/definitions/ExtensionPresenceEvent' - $ref: '#/definitions/DetailedExtensionPresenceEvent' - $ref: '#/definitions/DetailedExtensionPresenceWithSIPEvent' put: tags: - Presence summary: Update User Presence Status operationId: updateUserPresenceStatus description: 'Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension.' parameters: - in: body name: body required: false schema: $ref: '#/definitions/PresenceInfoResource' - 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 type: string default: "~" - 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 type: string default: "~" responses: 200: description: OK schema: $ref: '#/definitions/PresenceInfoResource' x-api-group: extension/presence x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditPresence x-docs-level: Public x-notifications: - $ref: '#/definitions/IncomingCallEvent' - $ref: '#/definitions/MissedCallEvent' /restapi/v1.0/account/{accountId}/presence: get: tags: - Presence summary: Get User Presence Status List operationId: readAccountPresence description: 'Returns presence status of all extensions of an account. Please note: The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department, Announcement Only, Voicemail (Take Messages Only), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension.' 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 type: string default: "~" - name: detailedTelephonyState in: query description: Whether to return detailed telephony state required: false type: boolean - name: sipData in: query description: Whether to return SIP data required: false type: boolean - name: page in: query description: Page number for account presence information required: false type: integer format: int32 - name: perPage in: query description: Number for account presence information items per page required: false type: integer format: int32 responses: 200: description: OK schema: $ref: '#/definitions/AccountPresenceInfo' x-api-group: account/presence x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadPresence x-user-permission: ReadPresenceStatus x-docs-level: Public x-notifications: - $ref: '#/definitions/AccountPresenceEvent' /restapi/v1.0/glip/chats: get: tags: - Chats operationId: listGlipChats summary: Get Chats description: Returns the list of chats where the user is a member and also public teams that can be joined. All records in response are sorted by creation time of a chat in ascending order. produces: - application/json parameters: - name: type in: query description: Type of chats to be fetched. By default all type of chats will be fetched required: false type: array collectionFormat: multi items: type: string enum: - Everyone - Group - Personal - Direct - Team - name: recordCount in: query description: Number of chats to be fetched by one request. The maximum value is 250, by default - 30. required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Pagination token. required: false type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipChatsList' x-api-group: glip/chats x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats x-rewrite-uri-to: /glip/v1/chats x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/chats/{chatId}: get: tags: - Chats summary: Get Chat operationId: readGlipChat description: Returns information about a chat by ID. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat. If tilda (~) is specified, then `/me` (Personal) chat will be returned required: true responses: 200: description: OK schema: $ref: '#/definitions/GlipChatInfo' 404: description: Chat Not Found. x-api-group: glip/chats x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*) x-rewrite-uri-to: /glip/v1/chats/$1 x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/conversations: get: tags: - Conversations operationId: listGlipConversations summary: Get Conversations description: Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a chat in ascending order. produces: - application/json parameters: - name: recordCount in: query description: Number of conversations to be fetched by one request. The maximum value is 250, by default - 30 required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Pagination token. required: false type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipConversationsList' x-api-group: glip/conversations x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/conversations x-rewrite-uri-to: /glip/v1/conversations x-throttling-group: Medium x-beta-api: true post: tags: - Conversations operationId: createGlipConversation summary: Create/Open Conversation description: Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation. consumes: - application/json produces: - application/json parameters: - name: body in: body description: JSON body schema: $ref: '#/definitions/CreateGlipConversationRequest' required: true responses: 200: description: Conversation is opened schema: $ref: '#/definitions/GlipConversationInfo' 201: description: Conversation is created schema: $ref: '#/definitions/GlipConversationInfo' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/conversations x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/conversations x-rewrite-uri-to: /glip/v1/conversations x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/conversations/{chatId}: get: tags: - Conversations summary: Get Conversation operationId: readGlipConversation description: Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a conversation to be returned. required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipConversationInfo' 404: description: Conversation Not Found. x-api-group: glip/conversations x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/conversations/(.*) x-rewrite-uri-to: /glip/v1/conversations/$1 x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/teams: get: tags: - Teams operationId: listGlipTeams summary: Get Teams description: Returns the list of teams where the user is a member (both archived and active) combined with a list of public teams that can be joined by the current user. All records in response are sorted by creation time of a chat in ascending order. produces: - application/json parameters: - name: recordCount in: query description: Number of teams to be fetched by one request. The maximum value is 250, by default - 30 required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Pagination token. required: false type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipTeamsList' x-api-group: glip/teams x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams x-rewrite-uri-to: /glip/v1/teams x-throttling-group: Medium x-beta-api: true post: tags: - Teams operationId: createGlipTeam summary: Create Team description: Creates a team, and adds a list of people to the team. consumes: - application/json produces: - application/json parameters: - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipPostTeamBody' required: true responses: 201: description: Created schema: $ref: '#/definitions/GlipTeamInfo' 400: description: One of body parameters has invalid value. x-api-group: glip/teams x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams x-rewrite-uri-to: /glip/v1/teams x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}: get: tags: - Teams summary: Get Team operationId: readGlipTeam description: Returns information about the specified team. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to be returned. required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipTeamInfo' 404: description: Team Not Found. x-api-group: glip/teams x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*) x-rewrite-uri-to: /glip/v1/teams/$1 x-docs-level: Public x-beta-api: true patch: tags: - Teams summary: Update Team operationId: patchGlipTeam description: Updates the name and description of the specified team. consumes: - application/json produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to be updated. required: true - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipPatchTeamBody' required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipTeamInfo' 400: description: One of body parameters has invalid value. 403: description: User is not Team Admin or Team is not active. 404: description: Team Not Found. x-api-group: glip/teams x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*) x-rewrite-uri-to: /glip/v1/teams/$1 x-throttling-group: Medium x-beta-api: true delete: tags: - Teams summary: Delete Team operationId: deleteGlipTeam description: Deletes the specified team. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team. required: true responses: 204: description: No Content. 403: description: User is not Team Admin. 404: description: Team Not Found. x-api-group: glip/teams x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*) x-rewrite-uri-to: /glip/v1/teams/$1 x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}/join: post: tags: - Teams operationId: joinGlipTeam summary: Join Team description: Adds the current user to the specified team. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to be joined. required: true responses: 204: description: No Content 205: description: Reset Content 403: description: Team status is not Active or Team is not public 404: description: Team Not Found. x-api-group: glip/teams/join x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*)/join x-rewrite-uri-to: /glip/v1/teams/$1/join x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}/leave: post: tags: - Teams operationId: leaveGlipTeam summary: Leave Team description: Removes the current user from the specified team. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to be left. required: true responses: 204: description: No Content 205: description: Reset Content. 403: description: Team status is not Active. 404: description: Team Not Found. x-api-group: glip/teams/leave x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*)/leave x-rewrite-uri-to: /glip/v1/teams/$1/leave x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}/add: post: tags: - Teams operationId: addGlipTeamMembers summary: Add Team Members description: Adds members to the specified team. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to add members to. required: true - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipPostMembersListBody' required: true responses: 204: description: No Content. 403: description: User is not Team Admin. 404: description: Team Not Found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/teams/add-members x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*)/add x-rewrite-uri-to: /glip/v1/teams/$1/add x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}/remove: post: tags: - Teams operationId: removeGlipTeamMembers summary: Remove Team Members description: Removes members from the specified team. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to remove members from. required: true - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipPostMembersIdsListBody' required: true responses: 204: description: No Content. 403: description: User is not Team Admin. 404: description: Team Not Found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/teams/remove-members x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*)/remove x-rewrite-uri-to: /glip/v1/teams/$1/remove x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}/archive: post: tags: - Teams operationId: archiveGlipTeam summary: Archive Team description: Changes the status of the specified team to 'Archived'. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to be archived. required: true responses: 204: description: No Content 205: description: Reset Content 403: description: User is not Team Admin 404: description: Team Not Found x-api-group: glip/teams/archive x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*)/archive x-rewrite-uri-to: /glip/v1/teams/$1/archive x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/teams/{chatId}/unarchive: post: tags: - Teams operationId: unarchiveGlipTeam summary: Unarchive Team description: Changes the status of the specified team to 'Active'. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a team to be made active. required: true responses: 204: description: No Content 205: description: Reset Content 403: description: User is not Team Admin 404: description: Team Not Found x-api-group: glip/teams/unarchive x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/teams/(.*)/unarchive x-rewrite-uri-to: /glip/v1/teams/$1/unarchive x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/everyone: get: tags: - Teams summary: Get Everyone Chat operationId: readGlipEveryone description: Returns information about Everyone chat. produces: - application/json responses: 200: description: Success schema: $ref: '#/definitions/GlipEveryoneInfo' 404: description: Chat Not Found. x-api-group: glip/everyone x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/everyone x-rewrite-uri-to: /glip/v1/everyone x-docs-level: Public x-beta-api: true patch: tags: - Teams summary: Update Everyone Сhat operationId: patchGlipEveryone description: Updates Everyone chat information. produces: - application/json parameters: - name: body in: body description: JSON body schema: $ref: '#/definitions/UpdateGlipEveryoneRequest' required: false responses: 200: description: Success schema: $ref: '#/definitions/GlipEveryoneInfo' 404: description: Chat Not Found. x-api-group: glip/everyone x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/everyone x-rewrite-uri-to: /glip/v1/everyone x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/recent/chats: get: tags: - Chats summary: Get Recent Chats operationId: listRecentChats description: Returns recent chats where the user is a member. All records in response are sorted by the `lastModifiedTime` in descending order (the latest changed chat is displayed first on page) produces: - application/json parameters: - name: type in: query description: Type of chats to be fetched. By default all chat types are returned required: false type: array collectionFormat: multi items: type: string enum: - Everyone - Group - Personal - Direct - Team - name: recordCount in: query description: Max number of chats to be fetched by one request (Not more than 250). required: false type: integer default: 30 maximum: 250 responses: 200: description: Success schema: $ref: '#/definitions/GlipChatsListWithoutNavigation' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/recent x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/recent/chats x-rewrite-uri-to: /glip/v1/recent/chats x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/favorites: get: tags: - Chats summary: Get Favorite Chats operationId: listFavoriteChats description: Returns a list of the current user's favorite chats. produces: - application/json parameters: - name: recordCount in: query description: Max number of chats to be fetched by one request (Not more than 250). required: false type: integer default: 30 maximum: 250 responses: 200: description: Success schema: $ref: '#/definitions/GlipChatsListWithoutNavigation' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/favorites x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/favorites x-rewrite-uri-to: /glip/v1/favorites x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/chats/{chatId}/favorite: post: tags: - Chats operationId: favoriteGlipChat summary: Add Chat to Favorites description: Adds the specified chat to the users's list of favorites. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat to add to favorite list. required: true responses: 204: description: No Content 403: description: User is not member of chat 404: description: Chat not found 400: description: Favorite chat list is limited to 250 unique chats x-api-group: glip/chats/favorite x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/favorite x-rewrite-uri-to: /glip/v1/chats/$1/favorite x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/chats/{chatId}/unfavorite: post: tags: - Chats operationId: unfavoriteGlipChat summary: Remove Chat from Favorites description: Removes the specified chat from the users's list of favorites. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat to remove from favorite list. required: true responses: 204: description: No Content 404: description: Chat not found x-api-group: glip/chats/unfavorite x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/unfavorite x-rewrite-uri-to: /glip/v1/chats/$1/unfavorite x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/chats/{chatId}/read: post: tags: - Chats operationId: markChatRead summary: Mark Chat as Read description: Sets the specified chat status to 'Read' for the current user. produces: - application/json parameters: - name: chatId in: path description: Id of chat to be marked required: true type: string responses: 204: description: No Content 200: description: OK 403: description: You have no permissions to mark this chat 404: description: Chat is not found x-api-group: glip/glpum x-metered-api: true x-metering-group: System x-app-permission: GlipInternal x-rewrite-uri-from: /restapi/v1.0/glip/chats/([0-9]+)/read x-rewrite-uri-to: /glip/v1/chats/$1/read x-docs-level: Public x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/chats/{chatId}/unread: post: tags: - Chats operationId: markChatUnread summary: Mark Chat as Unread description: Sets the specified chat status to 'Unread' for the current user. produces: - application/json parameters: - name: chatId in: path description: Id of chat to be marked required: true type: string responses: 204: description: No Content 200: description: OK 403: description: You have no permissions to mark this chat 404: description: Chat is not found x-api-group: glip/glpum x-metered-api: true x-metering-group: System x-app-permission: GlipInternal x-rewrite-uri-from: /restapi/v1.0/glip/chats/([0-9]+)/unread x-rewrite-uri-to: /glip/v1/chats/$1/unread x-docs-level: Public x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/chats/{chatId}/posts/{postId}: get: tags: - Posts summary: Get Post operationId: readGlipPost description: Returns information about the specified post. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat. required: true - name: postId in: path type: string description: Internal identifier of a post. required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipPostInfo' 404: description: Post Not Found. x-api-group: glip/chats/posts x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/posts/(.*) x-rewrite-uri-to: /glip/v1/chats/$1/posts/$2 x-beta-api: true patch: tags: - Posts operationId: patchGlipPost description: Updates a specific post within a chat. summary: Update Post consumes: - application/json produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat. required: true - name: postId in: path type: string description: Internal identifier of a post to be updated. required: true - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipPatchPostBody' required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipPostInfo' 400: description: One of body parameters has invalid value. 403: description: Requestor has no permissions to do this action. 404: description: Chat not found. x-api-group: glip/chats/posts x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/posts/(.*) x-rewrite-uri-to: /glip/v1/chats/$1/posts/$2 x-throttling-group: Medium x-beta-api: true delete: tags: - Posts operationId: deleteGlipPost description: Deletes the specified post from the chat. summary: Delete Post parameters: - name: chatId in: path type: string description: Internal identifier of a chat. required: true - name: postId in: path type: string description: Internal identifier of a post to be deleted. required: true responses: 204: description: No Content. 403: description: Requestor has no permissions to do this action. 404: description: Post Not Found. x-api-group: glip/chats/posts x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/posts/(.*) x-rewrite-uri-to: /glip/v1/chats/$1/posts/$2 x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/chats/{chatId}/posts: get: tags: - Posts operationId: readGlipPosts summary: Get Posts description: Returns a list of posts from the specified chat. produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat. required: true - name: recordCount in: query description: Max number of posts to be fetched by one request (Not more than 250). required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Pagination token. required: false type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipPostsList' x-api-group: glip/chats/posts x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/posts/? x-rewrite-uri-to: /glip/v1/chats/$1/posts x-throttling-group: Medium x-beta-api: true post: tags: - Posts operationId: createGlipPost description: Creates a post within the specified chat. Attachments are supported. summary: Create Post consumes: - application/json produces: - application/json parameters: - name: chatId in: path type: string description: Internal identifier of a chat. required: true - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipPostPostBody' required: true responses: 201: description: Success schema: $ref: '#/definitions/GlipPostInfo' 400: description: One of body parameters has invalid value. 404: description: Resource for parameter [chatId] is not found. x-api-group: glip/chats/posts x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/glip/chats/(.*)/posts/? x-rewrite-uri-to: /glip/v1/chats/$1/posts x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/groups/{groupId}/posts: get: tags: - Posts deprecated: true operationId: listGlipGroupPosts summary: Get Group Posts description: Returns posts which are available for the current user by group ID. produces: - application/json parameters: - name: groupId in: path description: Internal identifier of a group required: true type: string - name: recordCount in: query description: Max number of records to be returned required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Pagination token required: false type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipPosts' 404: description: Group with specified ID is not found. x-api-group: glip/posts x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/posts x-rewrite-uri-to: /glip/v1/groups/$1/posts x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-notifications: - $ref: '#/definitions/GlipPostEvent' x-throttling-group: Medium x-beta-api: true post: tags: - Posts deprecated: true summary: Create Post in Group operationId: createGlipGroupPost description: Creates a new post in a group specified. produces: - application/json consumes: - application/json parameters: - name: groupId in: path description: Internal identifier of a group. required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/GlipCreatePost' responses: 200: description: OK schema: $ref: '#/definitions/GlipPostInfo' 400: description: Some of parameters are missing or have invalid format. 404: description: Group not found. x-api-group: glip/posts x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/posts x-rewrite-uri-to: /glip/v1/groups/$1/posts x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/groups/{groupId}/posts/{postId}/text: put: tags: - Posts deprecated: true summary: Update Post operationId: updateGlipPostText description: Modifies text of a post. produces: - text/plain - application/json consumes: - text/* parameters: - name: groupId in: path description: Internal identifier of a group required: true type: string - name: postId in: path description: Internal identifier of a post required: true type: string - name: text in: body required: true schema: type: string responses: 200: description: OK schema: type: string 400: description: Some of parameters are missing or have invalid format. 403: description: Forbidden x-api-group: glip/posts x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/posts/([0-9]+)/text x-rewrite-uri-to: /glip/v1/groups/$1/posts/$2/text x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/cards: post: tags: - Posts deprecated: true operationId: createGlipCard summary: Create Card description: Creates a new message. produces: - application/json consumes: - application/json parameters: - name: body in: body required: true schema: $ref: '#/definitions/GlipMessageAttachmentInfoRequest' - name: groupId in: query description: Internal identifier of a group where to create a post with the card type: integer responses: 200: description: OK schema: $ref: '#/definitions/GlipMessageAttachmentInfo' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/cards x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/cards x-rewrite-uri-to: /glip/v1/cards x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/cards/{cardId}: get: tags: - Posts deprecated: true operationId: readGlipCard summary: Get Card description: Returns card(s) with given id(s). produces: - application/json - multipart/mixed parameters: - name: cardId in: path description: Internal identifier of a card or comma separated list of card IDs. required: true type: array items: type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipMessageAttachmentInfo' 404: description: Card not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/cards x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/cards/(.*) x-rewrite-uri-to: /glip/v1/cards/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true put: tags: - Posts deprecated: true summary: Update Card operationId: updateGlipCard description: Updates a card. produces: - application/json consumes: - application/json parameters: - name: cardId in: path description: Internal identifier of a card required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/GlipMessageAttachmentInfoRequest' responses: 200: description: OK 400: description: Some of parameters are missing or have invalid format. 404: description: Card for update does not exist. x-api-group: glip/cards x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/cards/(.*) x-rewrite-uri-to: /glip/v1/cards/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true delete: tags: - Posts deprecated: true summary: Delete Card operationId: deleteGlipCard description: Deletes a card by ID. produces: - text/plain parameters: - name: cardId in: path description: Card ID to be deleted. required: true type: string responses: 200: description: OK 404: description: Card not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/cards x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/cards/(.*) x-rewrite-uri-to: /glip/v1/cards/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/events: get: tags: - Calendar Events description: Returns all calendar events created by the current user. summary: Get User Events List operationId: readGlipEvents parameters: - name: recordCount in: query description: Number of groups to be fetched by one request. The maximum value is 250, by default - 30. required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Token of a page to be returned required: false type: string produces: - application/json - multipart/mixed responses: 200: description: OK schema: $ref: '#/definitions/GlipEventsInfo' x-api-group: glip/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/events x-rewrite-uri-to: /glip/v1/events x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true post: tags: - Calendar Events summary: Create Event description: Creates a new calendar event. operationId: createEvent produces: - application/json consumes: - application/json parameters: - in: body name: body required: true schema: $ref: '#/definitions/GlipEventCreate' responses: 200: description: Success schema: $ref: '#/definitions/GlipEventInfo' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/events x-rewrite-uri-to: /glip/v1/events x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/events/{eventId}: get: tags: - Calendar Events description: Returns the specified calendar event(s) by ID(s). summary: Get Event operationId: readEvent produces: - application/json - multipart/mixed parameters: - name: eventId in: path description: event id or comma separated list of event ids. required: true type: array items: type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipEventInfo' 404: description: Event not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/events/(.*) x-rewrite-uri-to: /glip/v1/events/$1 x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true put: tags: - Calendar Events description: Updates the specified calendar event. summary: Update Event operationId: updateEvent produces: - application/json consumes: - application/json parameters: - name: eventId in: path description: Internal identifier of an event required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/GlipEventCreate' responses: 200: description: OK schema: $ref: '#/definitions/GlipEventInfo' 400: description: Some of parameters are missing or have invalid format. 404: description: Event to update not exists. x-api-group: glip/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/events/(.*) x-rewrite-uri-to: /glip/v1/events/$1 x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true delete: tags: - Calendar Events description: Deletes the specified calendar event. summary: Delete Event operationId: deleteEvent produces: - text/plain parameters: - name: eventId in: path description: Internal identifier of an event to be deleted required: true type: string responses: 200: description: OK 404: description: Event not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/events/(.*) x-rewrite-uri-to: /glip/v1/events/$1 x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/groups/{groupId}/events: post: tags: - Calendar Events summary: Create Event by Group ID description: Creates a new calendar event within the specified group. operationId: createEventbyGroupId produces: - application/json consumes: - application/json parameters: - in: body name: body required: true schema: $ref: '#/definitions/GlipEventCreate' - name: groupId in: path description: Internal identifier of a group required: true type: string responses: 200: description: Success schema: $ref: '#/definitions/GlipEventInfo' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/groups/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/events x-rewrite-uri-to: /glip/v1/groups/$1/events x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true get: tags: - Calendar Events operationId: listGroupEvents summary: Get Group Events description: Returns a list of calendar events available for the current user within the specified group. Users can only see their personal tasks and public tasks. produces: - application/json parameters: - name: groupId in: path description: Internal identifier of a group required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipEventInfo' 404: description: Group with specified Id is not found. x-api-group: glip/events x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/events x-rewrite-uri-to: /glip/v1/groups/$1/events x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/persons/{personId}: get: tags: - Glip Profile summary: Get Person operationId: readGlipPerson description: Returns a user or multiple users by their ID(s). Batch request is supported. consumes: - application/json produces: - application/json parameters: - name: personId type: string in: path description: Internal identifier of a user to be returned, the maximum number of IDs is 30 required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipPersonInfo' 207: description: Mixed Result 404: description: Person Not Found 403: description: You do not have permissions to get such kind of information x-api-group: glip/persons x-throttling-group: Light x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/persons/(.*) x-rewrite-uri-to: /glip/v1/persons/$1 x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/companies/{companyId}: get: tags: - Glip Profile summary: Get Company Info operationId: readGlipCompany description: Returns information about one or more companies by their IDs. consumes: - application/json produces: - application/json - multipart/mixed parameters: - name: companyId type: string in: path description: Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to. required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipCompany' 207: description: Mixed Result 404: description: Company Not Found 403: description: You do not have permissions to get such kind of information x-api-group: glip/companies x-throttling-group: Light x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/companies/(.*) x-rewrite-uri-to: /glip/v1/companies/$1 x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/groups/{groupId}/webhooks: post: tags: - Glip Webhooks summary: Create Webhook in Group operationId: createGlipGroupWebhook description: Creates a new webhook produces: - application/json consumes: - application/json parameters: - name: groupId in: path description: Internal identifier of a group required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipWebhookInfo' 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/webhooks x-rewrite-uri-to: /glip/v1/groups/$1/webhooks x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true get: tags: - Glip Webhooks summary: Get Webhooks in Group operationId: listGlipGroupWebhooks description: Returns webhooks which are available for the current user by group ID. produces: - application/json parameters: - name: groupId in: path description: Internal identifier of a group required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipWebhookList' 404: description: Group with specified ID is not found. x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/webhooks x-rewrite-uri-to: /glip/v1/groups/$1/webhooks x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/webhooks: get: tags: - Glip Webhooks summary: Get Webhooks operationId: listGlipWebhooks description: Returns a list of all webhooks associated with the current account. produces: - application/json - multipart/mixed responses: 200: description: OK schema: $ref: '#/definitions/GlipWebhookList' x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/webhooks x-rewrite-uri-to: /glip/v1/webhooks x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/webhooks/{webhookId}: get: tags: - Glip Webhooks summary: Get Webhook operationId: readGlipWebhook description: Returns webhooks(s) with the specified id(s). produces: - application/json - multipart/mixed parameters: - name: webhookId in: path description: Internal identifier of a webhook or comma separated list of webhooks IDs required: true type: array items: type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipWebhookList' 404: description: Webhooks not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/webhooks/(.*) x-rewrite-uri-to: /glip/v1/webhooks/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true delete: tags: - Glip Webhooks summary: Delete Webhook operationId: deleteGlipWebhook description: Deletes the webhook by ID. produces: - application/json parameters: - name: webhookId in: path description: Internal identifier of a webhook required: true type: string responses: 200: description: The resource was deleted successfully. 404: description: Webhook not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/webhooks/(.*) x-rewrite-uri-to: /glip/v1/webhooks/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/webhooks/{webhookId}/activate: post: tags: - Glip Webhooks summary: Activate Webhook operationId: activateGlipWebhook description: Activates webhook by ID. produces: - application/json parameters: - name: webhookId in: path description: Internal identifier of a webhook required: true type: string responses: 200: description: OK 404: description: Webhook not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/webhooks/(.*) x-rewrite-uri-to: /glip/v1/webhooks/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/webhooks/{webhookId}/suspend: post: tags: - Glip Webhooks summary: Suspend Webhook operationId: suspendGlipWebhook description: Suspends webhook by ID. produces: - application/json parameters: - name: webhookId in: path description: Internal identifier of a webhook required: true type: string responses: 200: description: OK 404: description: Webhook not found. 400: description: Some of parameters are missing or have invalid format. x-api-group: glip/webhooks x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/webhooks/(.*) x-rewrite-uri-to: /glip/v1/webhooks/$1 x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/preferences: get: tags: - Glip Profile summary: Get Preferences operationId: readGlipPreferences description: Returns information about user preferences. produces: - application/json responses: 200: description: Success schema: $ref: '#/definitions/GlipPreferencesInfo' x-api-group: glip/preferences x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/preferences/? x-rewrite-uri-to: /glip/v1/preferences x-docs-level: Public x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/groups: get: deprecated: true tags: - Chats operationId: listGlipGroups summary: Get User Groups description: Returns the list of groups where the user is a member. produces: - application/json parameters: - name: type in: query description: Type of groups to be fetched (by default all type of groups will be fetched) required: false type: string enum: - Group - Team - PrivateChat - PersonalChat - name: recordCount in: query description: Number of groups to be fetched by one request. The maximum value is 250, by default - 30 required: false type: integer default: 30 maximum: 250 - name: pageToken in: query description: Pagination token. required: false type: string responses: 200: description: OK schema: $ref: '#/definitions/GlipGroupList' 404: description: Group with the specified ID is not found. x-api-group: glip/groups x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-notifications: - $ref: '#/definitions/GlipGroupsEvent' x-rewrite-uri-from: /restapi/v1.0/glip/groups x-rewrite-uri-to: /glip/v1/groups x-beta-api: true post: deprecated: true tags: - Chats summary: Create Group operationId: createGlipGroup description: Creates a new private chat/team. consumes: - application/json produces: - application/json parameters: - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipCreateGroup' required: true responses: 200: description: OK schema: $ref: '#/definitions/GlipGroupInfo' 400: description: Some of parameters are missing or have invalid format. 403: description: Forbidden x-api-group: glip/groups x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups x-rewrite-uri-to: /glip/v1/groups x-app-permission: Glip x-user-permission: Glip x-throttling-group: Medium x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/groups/{groupId}: get: deprecated: true tags: - Chats summary: Get Group operationId: readGlipGroup description: Returns information about a group or multiple groups by their ID(s). Batch request is supported. consumes: - application/json produces: - application/json - multipart/mixed parameters: - name: groupId in: path type: array items: type: string description: Internal identifier of a group to be returned, the maximum number of IDs is 30 required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipGroupInfo' 207: description: Mixed Result 404: description: Person Not Found. 403: description: You do not have permissions to get such kind of information. x-api-group: glip/groups x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Glip x-user-permission: Glip x-rewrite-uri-from: /restapi/v1.0/glip/groups/(.*) x-rewrite-uri-to: /glip/v1/groups/$1 x-docs-level: Public x-beta-api: true /restapi/v1.0/glip/groups/{groupId}/bulk-assign: post: deprecated: true tags: - Chats summary: Edit Group Members operationId: assignGlipGroupMembers description: Updates group members. **Please note:** Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported. consumes: - application/json produces: - application/json parameters: - name: groupId type: string in: path description: Internal identifier of a group required: true - name: body in: body description: JSON body schema: $ref: '#/definitions/EditGroupRequest' required: true responses: 200: description: OK schema: $ref: '#/definitions/GlipGroupInfo' 400: description: Some of parameters are missing or have invalid format. 403: description: Forbidden x-api-group: glip/groups x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/groups/([0-9]+)/bulk-assign x-rewrite-uri-to: /glip/v1/groups/$1/bulk-assign x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-throttling-group: Medium x-beta-api: true /restapi/v1.0/glip/posts: get: tags: - Posts summary: Get Posts operationId: listGlipPosts deprecated: true description: Returns posts available for the current user by group ID. consumes: - application/json produces: - application/json parameters: - name: groupId type: string in: query description: Identifier of a group to filter posts required: false - name: pageToken type: string in: query description: Token of a page to be returned required: false - name: recordCount type: integer format: int64 in: query description: Number of records to be returned. The maximum value is 250, by default - 30 default: 30 maximum: 250 required: false responses: 200: description: Success schema: $ref: '#/definitions/GlipPosts' 404: description: Group with the specified ID is not found. x-api-group: glip/posts x-throttling-group: Light x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/posts x-rewrite-uri-to: /glip/v1/posts x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-beta-api: true post: tags: - Posts summary: Create Post operationId: createPost deprecated: true description: Creates a post. consumes: - application/json produces: - application/json parameters: - name: body in: body description: JSON body schema: $ref: '#/definitions/GlipCreatePost' required: true responses: 200: description: Success schema: $ref: '#/definitions/GlipPostInfo' 400: description: Some of parameters are missing or have invalid format. 404: description: Group not found. x-api-group: glip/posts x-throttling-group: Light x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/posts x-rewrite-uri-to: /glip/v1/posts x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting: get: tags: - Meeting Management summary: Get Scheduled Meetings operationId: listMeetings description: Returns a list of meetings for a particular extension. The list of meetings does not include meetings of 'Instant' type. consumes: - application/json produces: - application/json parameters: - name: extensionId description: Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session in: path required: true type: string - name: accountId description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session in: path required: true type: string responses: 200: description: 'OK: Scheduled Meeting List' schema: $ref: '#/definitions/MeetingsResource' x-api-group: extension/meeting x-throttling-group: Light x-metered-api: true x-metering-group: System x-user-permission: Meetings x-app-permission: Meetings x-docs-level: Public x-beta-api: true post: tags: - Meeting Management summary: Create Meetings operationId: createMeeting description: Creates a new meeting. consumes: - application/json produces: - application/json parameters: - in: body name: body required: false schema: $ref: '#/definitions/MeetingRequestResource' - 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 type: string - 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 type: string responses: 201: description: Created Meeting schema: $ref: '#/definitions/MeetingResponseResource' x-api-group: extension/meeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-user-permission: Meetings x-app-permission: Meetings x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}: get: tags: - Meeting Management summary: Get Meeting Info operationId: readMeeting description: Returns a particular meetings details by ID. consumes: - application/json produces: - application/json parameters: - name: meetingId in: path description: Internal identifier of a RingCentral meeting required: true 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 type: string - 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 type: string responses: 200: description: 'OK: Meeting Info' schema: $ref: '#/definitions/MeetingResponseResource' x-api-group: extension/meeting x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true put: tags: - Meeting Management summary: Update Meeting operationId: updateMeeting description: Modifies a particular meeting. consumes: - application/json produces: - application/json parameters: - name: meetingId in: path description: Internal identifier of a RingCentral meeting required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/MeetingRequestResource' - 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 type: string - 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 type: string responses: 200: description: 'OK: Updated Meeting Info' schema: $ref: '#/definitions/MeetingResponseResource' x-api-group: extension/meeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true delete: tags: - Meeting Management summary: Delete Meeting operationId: deleteMeeting description: Deletes a scheduled meeting. consumes: - application/json produces: - application/json parameters: - name: meetingId in: path description: Internal identifier of a RingCentral meeting required: true 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 type: string - 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 type: string responses: 204: description: No Content x-api-group: extension/meeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end: post: tags: - Meeting Management summary: End Meeting operationId: endMeeting description: Ends a meetings which is in progress. consumes: - application/json produces: - application/json parameters: - name: meetingId in: path description: Internal identifier of a RingCentral meeting required: true 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 type: string - name: accountId in: path required: true type: string responses: 204: description: No Content x-api-group: extension/meeting/end x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info: get: tags: - Meeting Configuration summary: Get Meeting Service Info operationId: readMeetingServiceInfo description: Returns information on dial-in numbers for meetings, support and international dial-in numbers URIs and meeting account information. consumes: - application/json produces: - application/json parameters: - 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 type: string - 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 type: string responses: 200: description: 'OK: Meeting Service Info' schema: $ref: '#/definitions/MeetingServiceInfoResource' x-api-group: extension/meeting/service-info x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/meetings-configuration/assistants: get: tags: - Meeting Configuration summary: Get Assistants operationId: readAssistants description: Returns assistants information. consumes: - application/json produces: - application/json 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 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 type: string responses: 200: description: 'OK: Assistants Info' schema: $ref: '#/definitions/AssistantsResource' x-api-group: extension/meeting/assistant-info x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/meetings-configuration/assisted: get: tags: - Meeting Configuration summary: Get Assisted Users operationId: readAssistedUsers description: Returns assisted users information. consumes: - application/json produces: - application/json 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 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 type: string responses: 200: description: Assisted User Info schema: $ref: '#/definitions/AssistedUsersResource' x-api-group: extension/meeting/assistant-info x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: Meetings x-user-permission: Meetings x-docs-level: Public x-beta-api: true /restapi/v1.0/subscription: get: tags: - Subscriptions summary: Get Subscriptions operationId: listSubscriptions description: Returns a list of subscriptions created by a particular user on a particular client app. consumes: - application/json produces: - application/json parameters: [] responses: 200: description: List of Subscriptions schema: $ref: '#/definitions/RecordsCollectionResourceSubscriptionResponse' x-api-group: subscription x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public post: tags: - Subscriptions summary: Create Subscription description: Creates a new subscription. operationId: createSubscription consumes: - application/json produces: - application/json parameters: - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CreateSubscriptionRequest' responses: 200: description: Created Subscription schema: $ref: '#/definitions/SubscriptionInfo' x-api-group: subscription x-throttling-group: Medium x-metered-api: true x-metering-group: System x-docs-level: Public /restapi/v1.0/subscription/{subscriptionId}: get: tags: - Subscriptions summary: Get Subscription description: Returns the requested subscription. operationId: readSubscription consumes: - application/json produces: - application/json parameters: - name: subscriptionId in: path description: Internal identifier of a subscription required: true type: string responses: 200: description: Existing Subscription schema: $ref: '#/definitions/SubscriptionInfo' x-api-group: subscription x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public put: tags: - Subscriptions summary: Renew Subscription / Update Event Filters description: Renews the existent subscription if the request body is empty. If event filters are specified, calling this method modifies the event filters for the existing subscription. The client application can extend or narrow the events for which it receives notifications in the frame of one subscription. operationId: updateSubscription consumes: - application/json produces: - application/json parameters: - name: subscriptionId in: path description: Internal identifier of a subscription required: true type: string - name: aggregated in: query description: If 'True' then aggregated presence status is returned in a notification payload required: false type: boolean - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/ModifySubscriptionRequest' responses: 200: description: Updated Subscription schema: $ref: '#/definitions/SubscriptionInfo' x-api-group: subscription x-throttling-group: Medium x-metered-api: true x-metering-group: System x-docs-level: Public delete: tags: - Subscriptions summary: Cancel Subscription description: Cancels the existent subscription. operationId: deleteSubscription consumes: - application/json produces: - application/json parameters: - name: subscriptionId in: path description: Internal identifier of a subscription required: true type: string responses: 204: description: No Content x-api-group: subscription x-throttling-group: Medium x-metered-api: true x-metering-group: System x-docs-level: Public /restapi/v1.0/subscription/{subscriptionId}/renew: post: tags: - Subscriptions summary: Renew Subscription description: Renews an existent subscription by ID by posting request with an empty body. operationId: renewSubscription consumes: - application/json produces: - application/json parameters: - name: subscriptionId in: path required: true type: string responses: 200: description: Updated Subscription schema: $ref: '#/definitions/SubscriptionInfo' x-api-group: subscription x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile: get: tags: - User Permissions summary: Get Authorization Profile operationId: readAuthorizationProfile description: 'Returns a list of user permissions granted at authorization procedure. Please note: Some permissions may be restricted by extension type.' consumes: - application/json produces: - application/json parameters: - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: default: description: successful operation schema: $ref: '#/definitions/AuthProfileResource' x-api-group: extension/authz-profile x-throttling-group: Medium x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check: get: tags: - User Permissions summary: Check User Permission operationId: checkUserPermission description: Checks if a certain user permission is activated for a particular extension. consumes: - application/json produces: - application/json parameters: - name: permissionId in: query required: false type: string - name: targetExtensionId in: query required: false type: string - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: default: description: successful operation schema: $ref: '#/definitions/AuthProfileCheckResource' x-api-group: extension/authz-profile/check x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours: get: tags: - Business Hours summary: Get User Business Hours description: Returns the user hours when the call handling rules are applied. **Please note:** If user hours are set to 'Custom hours' then a particular schedule is returned; however if set to '24 hours/7 days a week' an empty schedule is returned. operationId: readUserBusinessHours consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" responses: 200: description: OK schema: $ref: '#/definitions/GetUserBusinessHoursResponse' x-api-group: extension/business-hours x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-availability: High put: tags: - Business Hours summary: Update User Business Hours operationId: updateUserBusinessHours description: Updates the extension user hours when answering rules are to be applied. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: extensionId type: string 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 default: "~" - name: body in: body description: JSON body schema: $ref: '#/definitions/UserBusinessHoursUpdateRequest' required: true responses: 200: description: OK schema: $ref: '#/definitions/UserBusinessHoursUpdateResponse' x-api-group: extension/business-hours x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserAnsweringRules x-docs-level: Public /restapi/v1.0/account/{accountId}/business-hours: get: tags: - Business Hours summary: Get Company Business Hours description: Returns company hours when answering rules are to be applied. operationId: readCompanyBusinessHours consumes: - application/json produces: - application/json 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 type: string default: "~" responses: 200: description: OK schema: $ref: '#/definitions/CompanyBusinessHours' x-api-group: extension/answering-rule x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserAnsweringRules x-docs-level: Public x-availability: High put: tags: - Business Hours summary: Update Company Business Hours description: Updates company hours when answering rules are to be applied. operationId: updateCompanyBusinessHours consumes: - application/json produces: - application/json 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CompanyBusinessHoursUpdateRequest' responses: 200: description: OK schema: $ref: '#/definitions/CompanyBusinessHours' x-api-group: extension/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserAnsweringRules x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking: get: tags: - Call Blocking summary: Get Caller Blocking Settings description: Returns the current caller blocking settings of a user. operationId: readCallerBlockingSettings consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/CallerBlockingSettings' x-api-group: extension/caller-blocking x-throttling-group: Light x-app-permission: ReadAccounts x-user-permission: ReadBlockedNumbers x-docs-level: Public x-availability: High put: tags: - Call Blocking summary: Update Caller Blocking Settings operationId: updateCallerBlockingSettings description: Updates the current caller blocking settings of a user. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string - name: body in: body required: false schema: $ref: '#/definitions/CallerBlockingSettingsUpdate' responses: 200: description: OK schema: $ref: '#/definitions/CallerBlockingSettings' x-api-group: extension/caller-blocking x-throttling-group: Light x-app-permission: EditExtensions x-user-permission: EditBlockedNumbers x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers: get: tags: - Call Blocking summary: Get Blocked/Allowed Phone Numbers description: Returns the lists of blocked and allowed phone numbers. operationId: listBlockedAllowedNumbers consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string - name: page in: query required: false type: integer - name: perPage in: query required: false type: integer - name: status in: query required: false type: string enum: - Blocked - Allowed responses: 200: description: OK schema: $ref: '#/definitions/BlockedAllowedPhoneNumbersList' x-api-group: extension/caller-blocking/phone-numbers x-throttling-group: Light x-app-permission: ReadAccounts x-user-permission: ReadBlockedNumbers x-docs-level: Public x-availability: High post: tags: - Call Blocking summary: Add Blocked/Allowed Number description: Updates either blocked or allowed phone number list with a new phone number. operationId: createBlockedAllowedNumber consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string - name: body in: body description: JSON body required: true schema: $ref: '#/definitions/AddBlockedAllowedPhoneNumber' responses: 200: description: OK schema: $ref: '#/definitions/BlockedAllowedPhoneNumberInfo' x-api-group: extension/caller-blocking/phone-numbers x-throttling-group: Medium x-app-permission: EditExtensions x-user-permission: EditBlockedNumbers x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}: get: tags: - Call Blocking summary: Get Blocked/Allowed Number operationId: readBlockedAllowedNumber description: Returns blocked or allowed phone number(s) by their ID(s). Batch request is supported. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string - name: blockedNumberId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/BlockedAllowedPhoneNumberInfo' x-api-group: extension/caller-blocking/phone-numbers x-throttling-group: Light x-app-permission: ReadAccounts x-user-permission: ReadBlockedNumbers x-docs-level: Public x-availability: High delete: tags: - Call Blocking summary: Delete Blocked/Allowed Number operationId: deleteBlockedAllowedNumber description: Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string - name: blockedNumberId in: path required: true type: string responses: 200: description: OK x-api-group: extension/caller-blocking/phone-numbers x-throttling-group: Medium x-app-permission: EditExtensions x-user-permission: EditBlockedNumbers x-docs-level: Public put: tags: - Call Blocking summary: Update Blocked/Allowed Number operationId: updateBlockedAllowedNumber description: Updates blocked or allowed phone number(s) by their ID(s). Batch request is supported. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: extensionId in: path required: true type: string - name: blockedNumberId in: path required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/AddBlockedAllowedPhoneNumber' responses: 200: description: OK schema: $ref: '#/definitions/BlockedAllowedPhoneNumberInfo' x-api-group: extension/caller-blocking/phone-numbers x-throttling-group: Medium x-app-permission: EditExtensions x-user-permission: EditBlockedNumbers x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number: get: tags: - Call Forwarding summary: Get Forwarding Number List description: Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers used for call forwarding and call flip. operationId: listForwardingNumbers consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted. default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items). default: 100 required: false type: integer responses: 200: description: OK schema: $ref: '#/definitions/GetExtensionForwardingNumberListResponse' x-api-group: extension/forwarding-number x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserForwardingFlipNumbers x-docs-level: Public x-availability: High post: tags: - Call Forwarding summary: Create Forwarding Number description: Adds a new forwarding number to the forwarding number list. operationId: createForwardingNumber consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CreateForwardingNumberRequest' responses: 200: description: OK schema: $ref: '#/definitions/ForwardingNumberInfo' x-api-group: extension/forwarding-number x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserForwardingFlipNumbers x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}: get: tags: - Call Forwarding summary: Get Forwarding Number operationId: readForwardingNumber description: Returns a specific forwarding number. consumes: - application/json produces: - application/json parameters: - name: forwardingNumberId in: path required: true type: string - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/ForwardingNumberResource' x-api-group: extension/forwarding-number x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserForwardingFlipNumbers x-docs-level: Public x-availability: High put: tags: - Call Forwarding summary: Update Forwarding Number description: Updates the existing forwarding number from the forwarding number list. operationId: updateForwardingNumber consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: forwardingNumberId in: path description: Internal identifier of a forwarding number; returned in response in the 'id' field required: true type: string - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/UpdateForwardingNumberRequest' responses: 200: description: OK schema: $ref: '#/definitions/ForwardingNumberInfo' x-api-group: extension/forwarding-number x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserForwardingFlipNumbers x-docs-level: Public delete: tags: - Call Forwarding summary: Delete Forwarding Number description: Deletes a forwarding number from the forwarding number list by its ID. operationId: deleteForwardingNumber consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: forwardingNumberId in: path description: Internal identifier of a forwarding number required: true type: string responses: 200: description: OK x-api-group: extension/forwarding-number x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserForwardingFlipNumbers x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule: get: tags: - Rule Management summary: Get Call Handling Rules description: Returns the extension answering rules. operationId: listAnsweringRules consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: view in: query required: false type: string enum: - Detailed - Simple default: Simple - name: enabledOnly in: query description: If true, then only active call handling rules are returned required: false type: boolean default: false - name: page in: query required: false type: string default: "1" - name: perPage in: query required: false type: string default: "100" responses: 200: description: OK schema: $ref: '#/definitions/UserAnsweringRuleList' x-api-group: extension/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserAnsweringRules x-docs-level: Public x-availability: High post: tags: - Rule Management summary: Create Call Handling Rule description: Creates a custom answering rule for a particular caller ID. operationId: createAnsweringRule consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CreateAnsweringRuleRequest' responses: 200: description: OK schema: $ref: '#/definitions/AnsweringRuleInfo' x-api-group: extension/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserAnsweringRules x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}: get: tags: - Rule Management summary: Get Call Handling Rule operationId: readAnsweringRule description: Returns an answering rule by ID. consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ruleId 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 type: string - name: showInactiveNumbers in: query description: Indicates whether inactive numbers should be returned or not default: false required: false type: boolean responses: 200: description: OK schema: $ref: '#/definitions/AnsweringRuleInfo' x-api-group: extension/answering-rule x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserAnsweringRules x-docs-level: Public x-availability: High put: tags: - Rule Management summary: Update Call Handling Rule description: Updates a custom answering rule for a particular caller ID. operationId: updateAnsweringRule consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ruleId in: path description: Internal identifier of an answering rule required: true type: string - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/UpdateAnsweringRuleRequest' responses: 200: description: OK schema: $ref: '#/definitions/AnsweringRuleInfo' x-api-group: extension/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserAnsweringRules x-docs-level: Public delete: tags: - Rule Management summary: Delete Call Handling Rule operationId: deleteAnsweringRule description: Deletes a custom answering rule by a particular ID. consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: ruleId in: path description: Internal identifier of an answering rule required: true type: string responses: 204: description: No Content x-api-group: extension/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserAnsweringRules x-docs-level: Public /restapi/v1.0/account/{accountId}/answering-rule: post: tags: - Rule Management summary: Create Company Call Handling Rule operationId: createCompanyAnsweringRule description: Creates a company answering rule for a particular caller ID. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: body in: body description: JSON body schema: $ref: '#/definitions/CompanyAnsweringRuleRequest' required: true responses: 200: description: OK schema: $ref: '#/definitions/CompanyAnsweringRuleInfo' x-api-group: account/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyAnsweringRules x-docs-level: Public get: tags: - Rule Management summary: Get Company Call Handling Rule List operationId: listCompanyAnsweringRules description: Returns a list of company answering rules. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" responses: 200: description: OK schema: $ref: '#/definitions/CompanyAnsweringRuleList' x-api-group: account/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyAnsweringRules x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}: get: tags: - Rule Management summary: Get Company Call Handling Rule operationId: readCompanyAnsweringRule description: Returns a company answering rule by ID. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: ruleId type: string 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 responses: 200: description: OK schema: $ref: '#/definitions/CompanyAnsweringRuleInfo' x-api-group: account/answering-rule x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyAnsweringRules x-docs-level: Public x-availability: High put: tags: - Rule Management summary: Update Company Call Handling Rule operationId: updateCompanyAnsweringRule description: Updates a company answering rule. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: ruleId type: string 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 - name: body in: body description: JSON body schema: $ref: '#/definitions/CompanyAnsweringRuleUpdate' required: true responses: 200: description: OK schema: $ref: '#/definitions/CompanyAnsweringRuleInfo' x-api-group: account/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyAnsweringRules x-docs-level: Public delete: tags: - Rule Management summary: Delete Company Call Handling Rule operationId: deleteCompanyAnsweringRule description: Deletes a company custom answering rule by a particular ID. consumes: - application/json produces: - application/json 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 type: string default: "~" - name: ruleId in: path description: Internal identifier of an answering rule required: true type: string responses: 204: description: No Content x-api-group: account/answering-rule x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyAnsweringRules x-docs-level: Public /restapi/v1.0/dictionary/greeting: get: tags: - Rule Management summary: Get Standard Greeting List description: Returns the list of predefined standard greetings. Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings. operationId: listStandardGreetings consumes: - application/json produces: - application/json parameters: - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted. default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items). default: 100 required: false type: integer - name: type in: query description: Type of a greeting, specifying the case when the greeting is played required: false type: string enum: - Introductory - Announcement - ConnectingMessage - ConnectingAudio - Voicemail - Unavailable - HoldMusic - Company - name: usageType in: query type: string description: Usage type of a greeting, specifying if the greeting is applied for user extension or department extension enum: - UserExtensionAnsweringRule - ExtensionAnsweringRule - DepartmentExtensionAnsweringRule - CompanyAnsweringRule - CompanyAfterHoursAnsweringRule - VoicemailExtensionAnsweringRule - AnnouncementExtensionAnsweringRule responses: 200: description: OK schema: $ref: '#/definitions/DictionaryGreetingList' x-api-group: dictionary/greeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/greeting/{greetingId}: get: tags: - Rule Management summary: Get Standard Greeting description: Returns a standard greeting by ID. operationId: readStandardGreeting consumes: - application/json produces: - application/json parameters: - name: greetingId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/DictionaryGreetingInfo' x-api-group: dictionary/greeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/greeting: post: tags: - Rule Management summary: Create Company Greeting operationId: createCompanyGreeting description: Creates a custom company greeting. consumes: - multipart/mixed - multipart/form-data produces: - application/json 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 type: string default: "~" - name: type in: formData type: string description: Type of a greeting, specifying the case when the greeting is played. enum: - Company - StartRecording - StopRecording - AutomaticRecording required: true - name: answeringRuleId in: formData type: string description: Internal identifier of an answering rule - name: binary in: formData type: file description: Meida file to upload required: true responses: 200: description: OK schema: $ref: '#/definitions/CustomCompanyGreetingInfo' x-api-group: extension/greeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: ReadUserInfo x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting: post: tags: - Rule Management summary: Create Custom User Greeting operationId: createCustomUserGreeting description: Creates custom greeting for an extension user. consumes: - multipart/mixed - multipart/form-data produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: type in: formData type: string description: Type of a greeting, specifying the case when the greeting is played. enum: - Introductory - Announcement - ConnectingMessage - ConnectingAudio - Voicemail - Unavailable - HoldMusic required: true - name: answeringRuleId in: formData type: string description: Internal identifier of an answering rule required: true - name: binary in: formData type: file description: Meida file to upload required: true responses: 200: description: OK schema: $ref: '#/definitions/CustomUserGreetingInfo' x-api-group: extension/greeting x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserAnsweringRules x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}: get: tags: - Rule Management summary: Get Custom Greeting operationId: readCustomGreeting description: Returns a custom user greeting by ID. consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: greetingId in: path description: Internal identifier of a greeting required: true type: integer responses: 200: description: OK schema: $ref: '#/definitions/CustomUserGreetingInfo' x-api-group: extension/greeting x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserInfo x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/ivr-prompts: post: tags: - Call Routing summary: Create IVR Prompts operationId: createIVRPrompt description: Creates an IVR prompt. consumes: - multipart/form-data produces: - application/json parameters: - name: accountId in: path required: true type: string - in: formData name: attachment type: file required: true description: Audio file that will be used as a prompt. Attachment cannot be empty, only audio files are supported - in: formData name: name type: string required: false description: Description of file contents. responses: 200: description: OK schema: $ref: '#/definitions/PromptInfo' x-api-group: account/ivr-prompts x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyGreetings x-docs-level: Public get: tags: - Call Routing summary: Get IVR Prompt List operationId: listIVRPrompts description: Returns the list of IVR prompts. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/IVRPrompts' x-api-group: account/ivr-prompts x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyGreetings x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}: get: tags: - Call Routing summary: Get IVR Prompt operationId: readIVRPrompt description: Returns an IVR prompt by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: promptId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/PromptInfo' x-api-group: account/ivr-prompts x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyGreetings x-docs-level: Public x-availability: High delete: tags: - Call Routing summary: Delete IVR Prompt operationId: deleteIVRPrompt description: Deletes an IVR prompt by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: promptId in: path required: true type: string responses: 204: description: No Content x-api-group: account/ivr-prompts x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyGreetings x-docs-level: Public put: tags: - Call Routing operationId: updateIVRPrompt summary: Update IVR Prompt description: Updates an IVR prompt by ID consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: promptId in: path required: true type: string responses: 200: description: Success x-api-group: account/ivr-prompts x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyGreetings x-docs-level: Public /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content: get: tags: - Call Routing summary: Get IVR Prompt Content operationId: readIVRPromptContent description: Returns media content of an IVR prompt by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: promptId in: path required: true type: string responses: 200: description: OK x-api-group: account/ivr-prompts x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyGreetings x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/ivr-menus: post: tags: - Call Routing operationId: createIVRMenu summary: Create IVR Menu description: Creates a company IVR menu. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: body in: body description: JSON body schema: $ref: '#/definitions/IVRMenuInfo' required: true responses: 200: description: OK schema: $ref: '#/definitions/IVRMenuInfo' x-api-group: account/ivr-menus x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: AutoReceptionist x-docs-level: Public /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}: get: tags: - Call Routing summary: Get IVR Menu operationId: readIVRMenu description: Returns a company IVR menu by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: ivrMenuId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/IVRMenuInfo' x-api-group: account/ivr-menus x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: AutoReceptionist x-docs-level: Public x-availability: High put: tags: - Call Routing summary: Update IVR Menu operationId: updateIVRMenu description: Updates a company IVR menu by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: ivrMenuId in: path required: true type: string - name: body in: body description: JSON body schema: $ref: '#/definitions/IVRMenuInfo' required: true responses: 200: description: OK schema: $ref: '#/definitions/IVRMenuInfo' x-api-group: account/ivr-menus x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: AutoReceptionist x-docs-level: Public /restapi/v1.0/account/{accountId}/call-recording: get: tags: - Rule Management operationId: readCallRecordingSettings description: Returns call recording settings. summary: Get Call Recording Settings consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/CallRecordingSettingsResource' x-api-group: account/call-recording x-throttling-group: Light x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public x-availability: High put: tags: - Rule Management operationId: updateCallRecordingSettings description: Updates current call recording settings. summary: Update Call Recording Settings consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: body in: body schema: $ref: '#/definitions/CallRecordingSettingsResource' responses: 200: schema: $ref: '#/definitions/CallRecordingSettingsResource' description: 'OK: Updated Call Recording Settings' x-api-group: account/call-recording x-throttling-group: Medium x-app-permission: EditAccounts x-user-permission: EditCompanyInfo x-docs-level: Public /restapi/v1.0/account/{accountId}/call-recording/extensions: get: tags: - Rule Management operationId: listCallRecordingExtensions description: Returns the list of extensions to be recorded. summary: Get Call Recording Extension List consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string responses: 200: description: Extension List schema: $ref: '#/definitions/CallRecordingExtensions' x-api-group: account/call-recording/extensions x-throttling-group: Medium x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/call-recording/bulk-assign: post: tags: - Rule Management operationId: updateCallRecordingExtensionList description: Creates or updates the list of extensions to be recorded. summary: Update Call Recording Extension List consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/BulkAccountCallRecordingsResource' responses: 200: description: Success x-api-group: account/call-recording/bulk-assign x-throttling-group: Medium x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public /restapi/v1.0/account/{accountId}/call-recording/custom-greetings: get: tags: - Rule Management operationId: listCallRecordingCustomGreetings summary: Get Call Recording Custom Greeting List description: Returns call recording custom greetings. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: type in: query required: false type: string enum: - StartRecording - StopRecording - AutomaticRecording responses: 200: description: Success schema: $ref: '#/definitions/CallRecordingCustomGreetings' x-beta-api: true x-api-group: account/call-recording/custom-greetings x-throttling-group: Medium x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-metered-api: true x-docs-level: Public x-metering-group: System x-availability: High delete: tags: - Rule Management operationId: deleteCallRecordingCustomGreetingList summary: Delete Call Recording Custom Greeting List description: Deletes call recording custom greetings. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string responses: 204: description: No Content x-api-group: account/call-recording/custom-greetings x-throttling-group: Medium x-app-permission: EditAccounts x-user-permission: EditCompanyInfo x-metered-api: true x-docs-level: Public x-metering-group: System /restapi/v1.0/account/{accountId}/call-recording/custom-greetings/{greetingId}: delete: tags: - Rule Management operationId: deleteCallRecordingCustomGreeting description: Deletes call recording custom greeting(s). summary: Delete Call Recording Custom Greeting consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: greetingId in: path required: true type: string responses: 200: description: Success x-api-group: account/call-recording/custom-greetings x-throttling-group: Medium x-app-permission: EditAccounts x-user-permission: EditCompanyInfo x-metered-api: true x-docs-level: Public x-metering-group: System /restapi/v1.0/client-info/sip-provision: post: tags: - SIP summary: Register SIP Device description: Creates SIP registration of a device/application (WebPhone, Mobile, softphone) operationId: createSIPRegistration consumes: - application/json produces: - application/json parameters: - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CreateSipRegistrationRequest' responses: default: description: Success schema: $ref: '#/definitions/CreateSipRegistrationResponse' x-api-group: client-info/sip-provision x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: VoipCalling x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number: get: tags: - Phone Numbers summary: Get Extension Phone Number List description: Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension. operationId: listExtensionPhoneNumbers consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: usageType in: query description: Usage type of a phone number required: false type: array items: type: string enum: - MainCompanyNumber - AdditionalCompanyNumber - CompanyNumber - DirectNumber - CompanyFaxNumber - ForwardedNumber - ForwardedCompanyNumber collectionFormat: multi - name: page in: query description: Indicates the page number to retrieve. Only positive number values are allowed. Default value is '1' required: false type: integer - name: perPage in: query description: Indicates the page size (number of items). If not specified, the value is '100' by default required: false type: integer responses: 200: description: 'OK: User Phone Number List' schema: $ref: '#/definitions/GetExtensionPhoneNumbersResponse' x-api-group: extension/phone-number x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserPhoneNumbers x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/account/{accountId}/extension/{extensionId}: get: tags: - User Settings summary: Get Extension description: Returns basic information about a particular extension. operationId: readExtension consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" responses: default: description: Success schema: $ref: '#/definitions/GetExtensionInfoResponse' x-api-group: extension x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-availability: High x-service-level: 500 x-notifications: - $ref: '#/definitions/ExtensionInfoEvent' put: tags: - User Settings summary: Update Extension description: Updates user settings. operationId: updateExtension consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/ExtensionUpdateRequest' responses: default: description: Success schema: $ref: '#/definitions/GetExtensionInfoResponse' x-api-group: extension x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserInfo OR EditUserCredentials x-docs-level: Public x-beta-api: true delete: tags: - User Settings summary: Delete Extension description: Deletes extension(s) by ID(s). operationId: deleteExtension consumes: - application/json produces: - application/json parameters: - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: default: description: successful operation x-api-group: extension x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: AddRemoveUsers x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id: get: tags: - User Settings summary: Get Extension Caller ID operationId: readExtensionCallerId description: Returns information on an outbound caller ID of an extension. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: extensionId type: string 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 default: "~" responses: default: description: Success schema: $ref: '#/definitions/ExtensionCallerIdInfo' x-api-group: extension/caller-id x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCallerIDSettings x-docs-level: Public x-availability: High put: tags: - User Settings summary: Update Extension Caller ID operationId: updateExtensionCallerId description: Updates outbound caller ID information of an extension. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: extensionId type: string 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 default: "~" - name: body in: body description: JSON body schema: $ref: '#/definitions/ExtensionCallerIdInfo' required: true responses: default: description: Success schema: $ref: '#/definitions/ExtensionCallerIdInfo' x-api-group: extension/caller-id x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditCallerIDSettings x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/grant: get: tags: - User Settings summary: Get Extension Grant List description: Returns the list of extension grants. operationId: listExtensionGrants consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: page in: query required: false type: string default: "1" - name: perPage in: query required: false type: string default: "100" responses: default: description: Success schema: $ref: '#/definitions/GetExtensionGrantListResponse' x-api-group: extension/grant x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-availability: High x-notifications: - $ref: '#/definitions/ExtensionGrantListEvent' x-service-level: 1000 /restapi/v1.0/account/{accountId}/emergency-address-auto-update/users: get: tags: - Automatic Location Updates summary: Get Users description: Returns the list of users with their status of Automatic Location Updates feature. operationId: readAutomaticLocationUpdatesUsers consumes: - application/json produces: - application/json 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 type: string default: "~" - name: type in: query type: string description: Extension type. Multiple values are supported enum: - User - Limited responses: default: description: Success x-api-group: account/emergency-address-auto-update/users x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Medium x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/users/bulk-assign: post: tags: - Automatic Location Updates operationId: assignMultipleUsersAutomaticaLocationUpdates summary: Enable Automatic Location Updates for Users description: Enables or disables Automatic Location Updates feature for multiple account users. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: false schema: $ref: '#/definitions/EmergencyAddressAutoUpdateUsersBulkAssignResource' responses: 204: description: Success x-api-group: account/emergency-address-auto-update/users/bulk-assign x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points: get: tags: - Automatic Location Updates summary: Get Wireless Point List description: Returns account wireless points configured and used for Automatic Location Updates feature. operationId: listWirelessPoints consumes: - application/json produces: - application/json 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 type: string default: "~" - name: siteId in: query description: Internal identifier of a site. To filter Main Site (Company) 'main-site' must be specified. Supported only If multi-site feature is enabled for the account required: false type: string - name: searchString in: query description: Filters entries by the specified substring (search by chassis ID, switch name or address) The characters range is 0-64 (if empty the filter is ignored) required: false type: string - name: orderBy in: query description: Comma-separated list of fields to order results prefixed by '+' sign (ascending order) or '-' sign (descending order). The default sorting is by `name` type: string - name: perPage in: query description: 'Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page' type: integer - name: page in: query description: Indicates the page number to retrieve. Only positive number values are supported type: integer default: 1 responses: 200: description: Wireless Points schema: $ref: '#/definitions/WirelessPointsList' x-api-group: account/emergency-address-auto-update/wireless-points x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Medium x-docs-level: Public x-beta-api: true post: tags: - Automatic Location Updates operationId: createWirelessPoint summary: Create Wireless Point description: Creates a new wireless point in network configuration with the emergency address assigned. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/CreateWirelessPoint' responses: 200: description: Wireless Point schema: $ref: '#/definitions/WirelessPointInfo' x-api-group: account/emergency-address-auto-update/wireless-points x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}: get: tags: - Automatic Location Updates operationId: readWirelessPoint summary: Get Wireless Point description: Returns the specified wireless access point of a corporate map with the emergency address assigned. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: pointId in: path required: true type: string responses: 200: description: Wireless Point schema: $ref: '#/definitions/WirelessPointInfo' x-api-group: account/emergency-address-auto-update/wireless-points x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Medium x-docs-level: Public x-beta-api: true put: tags: - Automatic Location Updates operationId: updateWirelessPoint summary: Update Wireless Point description: Updates the specified wireless access point of a corporate map by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: pointId in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/UpdateWirelessPoint' responses: 200: description: Wireless Point schema: $ref: '#/definitions/WirelessPointInfo' x-api-group: account/emergency-address-auto-update/wireless-points x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true delete: tags: - Automatic Location Updates operationId: deleteWirelessPoint summary: Delete Wireless Point description: Deletes wireless point(s) of a corporate map by ID(s). consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: pointId in: path required: true type: array items: type: string collectionFormat: csv responses: 204: description: No Content x-api-group: account/emergency-address-auto-update/wireless-points x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks: get: tags: - Automatic Location Updates summary: Get Network Map description: Returns corporate networks map with emergency addresses assigned to the current account. operationId: listNetworks consumes: - application/json produces: - application/json 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 type: string default: "~" responses: default: description: Success x-api-group: account/emergency-address-auto-update/networks x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true post: tags: - Automatic Location Updates description: Creates a new network in corporate ethernet map for assignment of emergency addresses to network access points. summary: Create Network operationId: createNetwork consumes: - application/json produces: - application/json 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 type: string default: "~" responses: 200: description: Success x-api-group: account/emergency-address-auto-update/networks x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}: get: tags: - Automatic Location Updates description: Returns the specified network with emergency addresses assigned to the current account. summary: Get Network operationId: readNetwork consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: networkId in: path required: true type: string responses: 200: description: Success x-api-group: account/emergency-address-auto-update/networks x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Medium x-docs-level: Public x-beta-api: true put: tags: - Automatic Location Updates summary: Update Network description: Updates network in corporate ethernet map for assignment of emergency addresses to network access points. operationId: updateNetwork consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: networkId in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/UpdateNetworkRequest' responses: 200: description: Success x-api-group: account/emergency-address-auto-update/networks x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true delete: tags: - Automatic Location Updates summary: Delete Network description: Deletes network(s) in corporate ethernet map for Automatic Location Updates feature. operationId: deleteEmergencyAddressAutoUpdateNetwork consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: networkId in: path required: true type: array items: type: string collectionFormat: csv responses: 204: description: No Content x-api-group: account/emergency-address-auto-update/networks x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices: get: tags: - Automatic Location Updates summary: Get Device List description: Returns the list of common devices with their status of Automatic Location Updates feature. operationId: listDevicesAutomaticLocationUpdates consumes: - application/json produces: - application/json 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 type: string default: "~" - name: siteId type: string in: query description: Internal identifier of a site. To filter devices of Main Site (Company) `main-site` must be specified. Supported only If Multi-Site feature is enabled for the account - name: featureEnabled in: query type: boolean description: Filters entries by their status of Automatic Location Updates feature - name: model in: query description: Internal identifier of a device model for filtering. Multiple values are supported type: string - name: compatibleOnly type: boolean description: Filters devices which support HELD protocol in: query - name: searchString type: string in: query description: Filters entries which have device name or model name containing the mentioned substring. The value should be split by spaces; the range is 0 - 64 characters, not case-sensitive. If empty the filter is ignored - name: orderBy in: query type: string description: 'Comma-separated list of fields to order results prefixed by plus sign ''+'' (ascending order) or minus sign ''-'' (descending order). Supported values: ''name'', ''modelName'', ''siteName'', ''featureEnabled''' default: name - name: perPage in: query description: 'Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page' type: integer - name: page in: query description: Indicates the page number to retrieve. Only positive number values are supported type: integer default: 1 responses: 200: description: Device List with their status of Automatic Location Updates feature schema: $ref: '#/definitions/ListDevicesAutomaticLocationUpdates' x-api-group: account/emergency-address-auto-update/devices x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Medium x-team: PLA Inno x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices/bulk-assign: post: tags: - Automatic Location Updates operationId: assignMultipleDevicesAutomaticLocationUpdates summary: Enable Automatic Location Updates for Devices description: Enables or disables Automatic Location Updates feature for the specified common phones. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: false schema: $ref: '#/definitions/AssignMultipleDevicesAutomaticLocationUpdates' responses: 204: description: No Content x-api-group: account/emergency-address-auto-update/devices/bulk-assign x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-team: PLA Inno x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches: get: tags: - Automatic Location Updates summary: Get Account Switch List description: Returns corporate map of configured network switches with the assigned emergency addresses for the logged-in account. operationId: listAccountSwitches consumes: - application/json produces: - application/json 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 type: string default: "~" - name: siteId in: query description: Internal identifier of a site. To filter Main Site (Company) main-site must be specified. Supported only If multi-site feature is enabled for the account required: false type: string - name: searchString in: query description: Filters entries by the specified substring (search by chassis ID, switch name or address) The characters range is 0-64 (if empty the filter is ignored) required: false type: string - name: orderBy in: query description: Comma-separated list of fields to order results prefixed by '+' sign (ascending order) or '-' sign (descending order). The default sorting is by `name` type: string - name: perPage in: query description: 'Indicates the page size (number of items). The values supported: `Max` or numeric value. If not specified, 100 records are returned per one page' type: integer - name: page in: query description: Indicates the page number to retrieve. Only positive number values are supported type: integer default: 1 responses: 200: description: Switches Map schema: $ref: '#/definitions/SwitchesList' x-api-group: account/emergency-address-auto-update/switches x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true post: tags: - Automatic Location Updates summary: Create Switch description: Creates a new switch in corporate map based on chassis ID and used for Automatic Locations Update feature. operationId: createSwitch consumes: - application/json produces: - application/json 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 type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/CreateSwitchInfo' responses: 200: description: Switch information schema: $ref: '#/definitions/SwitchInfo' x-api-group: account/emergency-address-auto-update/switches x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-team: PLA Inno x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}: get: tags: - Automatic Location Updates operationId: readSwitch summary: Get Switch description: Returns the specified switch with the assigned emergency address. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: switchId in: path required: true type: string responses: 200: description: Switch information schema: $ref: '#/definitions/SwitchInfo' x-api-group: account/emergency-address-auto-update/switches x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Medium x-team: PLA Inno x-docs-level: Public x-beta-api: true put: tags: - Automatic Location Updates summary: Update Switch description: Updates switch. Partial update is not supported, all switch parameters should be specified. If null value is received or parameter is missing, its value is removed. operationId: updateSwitch consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: switchId in: path required: true type: string - name: body in: body required: true schema: $ref: '#/definitions/CreateSwitchInfo' responses: 200: description: Switch information schema: $ref: '#/definitions/SwitchInfo' x-api-group: account/emergency-address-auto-update/switches x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-team: PLA Inno x-docs-level: Public x-beta-api: true delete: tags: - Automatic Location Updates operationId: deleteSwitch summary: Delete Switch description: Deletes wireless switch(es) in network configuration for Automatic Location Updates feature. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: switchId in: path required: true type: array items: type: string collectionFormat: csv responses: 204: description: No Content x-api-group: account/emergency-address-auto-update/switches x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-team: PLA Inno x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-create: post: tags: - Automatic Location Updates operationId: createMultipleSwitches summary: Create Multiple Switches description: Creates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/CreateMultipleSwitchesRequest' responses: 202: description: Multiple Switches Creation Task schema: $ref: '#/definitions/CreateMultipleSwitchesResponse' x-api-group: account/emergency-address-auto-update/switches-bulk-create x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-update: post: tags: - Automatic Location Updates operationId: updateMultipleSwitches summary: Update Multiple Switches description: Updates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/UpdateMultipleSwitchesRequest' responses: 202: description: Multiple Switches Update Task schema: $ref: '#/definitions/UpdateMultipleSwitchesResponse' x-api-group: account/emergency-address-auto-update/switches-bulk-update x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create: post: tags: - Automatic Location Updates operationId: createMultipleWirelessPoints summary: Create Multiple Wireless Points description: Creates multiple wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/CreateMultipleWirelessPointsRequest' responses: 202: description: Multiple Wireless Points Creation Task schema: $ref: '#/definitions/CreateMultipleWirelessPointsResponse' x-api-group: account/emergency-address-auto-update/wireless-points-bulk-create x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update: post: tags: - Automatic Location Updates operationId: updateMultipleWirelessPoints summary: Update Multiple Wireless Points description: Updates wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/UpdateMultipleWirelessPointsRequest' responses: 202: description: Multiple Wireless Points Update Task schema: $ref: '#/definitions/UpdateMultipleWirelessPointsResponse' x-api-group: account/emergency-address-auto-update/wireless-points-bulk-update x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate: post: tags: - Automatic Location Updates operationId: validateMultipleWirelessPoints summary: Validate Multiple Wireless Points description: Validates wireless points before creation or update. The maximum number of wireless points per request is 10 000. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/ValidateMultipleWirelessPointsRequest' responses: 200: description: Success schema: $ref: '#/definitions/ValidateMultipleWirelessPointsResponse' x-api-group: account/emergency-address-auto-update/wireless-points-bulk-validate x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-validate: post: tags: - Automatic Location Updates operationId: validateMultipleSwitches summary: Validate Multiple Switches description: Validates switches before creation or update. The maximum number of switches per request is 10 000. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string default: "~" - name: body in: body required: true schema: $ref: '#/definitions/ValidateMultipleSwitchesRequest' responses: 200: description: Success schema: $ref: '#/definitions/ValidateMultipleSwitchesResponse' x-api-group: account/emergency-address-auto-update/switches-points-bulk-validate x-app-permission: EditAccounts x-user-permission: ConfigureEmergencyMaps x-throttling-group: Heavy x-docs-level: Public x-beta-api: true /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings: get: tags: - User Settings summary: Get Notification Settings description: |- Returns notification settings for the current extension.

Knowledge Article: User Settings - Set up Message Notifications

operationId: readNotificationSettings consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string responses: default: description: Success schema: $ref: '#/definitions/NotificationSettings' x-api-group: extension/notification-settings x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadMessagesNotificationsSettings x-docs-level: Public x-availability: High put: tags: - User Settings summary: Update Notification Settings description: |- Updates notification settings for the current extension.

Knowledge Article: User Settings - Set up Message Notifications

operationId: updateNotificationSettings consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: integer - in: body name: body required: true schema: $ref: '#/definitions/NotificationSettingsUpdateRequest' responses: default: description: Success schema: $ref: '#/definitions/NotificationSettings' x-api-group: extension/notification-settings x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditMessagesNotificationsSettings x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image: get: tags: - User Settings summary: Get User Profile Image description: Returns a profile image of an extension. operationId: readUserProfileImage consumes: - application/json produces: - '*/*' - image/png - image/jpeg - image/gif parameters: - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: 200: description: User Profile Image Media Data schema: type: string format: binary x-api-group: extension/profile-image x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-availability: High x-service-level: 3000 post: tags: - User Settings summary: Upload User Profile Image description: Uploads the extension profile image. operationId: createUserProfileImage consumes: - multipart/form-data produces: - application/json parameters: - name: image in: formData required: true type: file - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: 204: description: No Content x-api-group: extension/profile-image x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserInfo x-docs-level: Public x-availability: High x-service-level: 3000 x-team: PLA RnD put: tags: - User Settings summary: Update User Profile Image description: Updates the extension profile image operationId: updateUserProfileImage consumes: - multipart/form-data produces: - application/json parameters: - name: image in: formData required: false type: file - name: extensionId in: path required: true type: string - name: accountId in: path required: true type: string responses: 204: description: No Content x-api-group: extension/profile-image x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditExtensions x-user-permission: EditUserInfo x-docs-level: Public x-availability: High x-service-level: 3000 x-team: PLA RnD /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}: get: tags: - User Settings summary: Get Scaled User Profile Image description: Returns scaled profile image of an extension. operationId: readScaledPofileImage consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: scaleSize in: path description: Dimensions of a profile image which will be returned in response. If this path parameter is not specified in request URI then required: true type: string responses: 200: description: User Profile Image Media Data schema: type: string format: binary x-api-group: extension/profile-image x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-availability: High x-service-level: 3000 x-team: PLA RnD /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing: get: tags: - User Settings summary: Get User Conferencing Settings description: Returns the information on the Free Conference Calling (FCC) feature for a given extension. operationId: readConferencingSettings consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: countryId in: query description: Internal identifier of a country. If not specified, the response is returned for the brand country required: false type: string responses: default: description: Success schema: $ref: '#/definitions/GetConferencingInfoResponse' x-api-group: extension/conferencing x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: OrganizeConference x-docs-level: Public x-availability: High put: tags: - User Settings summary: Update User Conferencing Settings description: Updates the default conferencing number for the current extension. The number can be selected from conferencing numbers of the current extension. Updates the setting, allowing participants join the conference before host. operationId: updateConferencingSettings consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/UpdateConferencingInfoRequest' responses: default: description: Success schema: $ref: '#/definitions/GetConferencingInfoResponse' x-api-group: extension/conferencing x-throttling-group: Medium x-metered-api: true x-metering-group: System x-user-permission: OrganizeConference x-app-permission: EditExtensions x-docs-level: Public /restapi/v1.0/account/{accountId}: get: tags: - Company summary: Get Account Info description: Returns basic information about a particular RingCentral customer account. operationId: readAccountInfo consumes: - application/json produces: - application/json 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 type: string default: "~" responses: default: description: Success schema: $ref: '#/definitions/GetAccountInfoResponse' x-api-group: account x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/business-address: get: tags: - Company summary: Get Account Business Address description: Returns business address of a company. operationId: readAccountBusinessAddress consumes: - application/json produces: - application/json 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 type: string default: "~" responses: default: description: Success schema: $ref: '#/definitions/AccountBusinessAddressResource' x-api-group: account/business-address x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public x-availability: High put: tags: - Company summary: Update Company Business Address description: Updates the business address of a company that account is linked to. Batch request is supported. operationId: updateAccountBusinessAddress consumes: - application/json produces: - application/json 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/ModifyAccountBusinessAddressRequest' responses: default: description: Success schema: $ref: '#/definitions/AccountBusinessAddressResource' x-api-group: account/business-address x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyInfo x-docs-level: Public /restapi/v1.0/account/{accountId}/service-info: get: tags: - Company summary: Get Account Service Info description: Returns the information about service plan, available features and limitations for a particular RingCentral customer account. operationId: readAccountServiceInfo consumes: - application/json produces: - application/json 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 type: string default: "~" responses: default: description: Success schema: $ref: '#/definitions/GetServiceInfoResponse' x-beta-api: true x-api-group: account/service-info x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadServicePlanInfo x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/language: get: tags: - Regional Settings summary: Get Language List description: Returns the information about supported languages. operationId: listLanguages consumes: - application/json produces: - application/json responses: default: description: Success schema: $ref: '#/definitions/LanguageList' x-api-group: dictionary/language x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/dictionary/language/{languageId}: get: tags: - Regional Settings summary: Get Language description: Returns language by ID. operationId: readLanguage consumes: - application/json produces: - application/json parameters: - name: languageId in: path description: Internal identifier of a language required: true type: integer responses: default: description: Success schema: $ref: '#/definitions/LanguageInfo' x-api-group: dictionary/language x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/country: get: tags: - Regional Settings summary: Get Country List description: Returns all the countries available for calling. operationId: listCountries consumes: - application/json produces: - application/json parameters: - name: loginAllowed in: query description: Specifies whether login with the phone numbers of this country is enabled or not required: false type: boolean - name: signupAllowed in: query description: Indicates whether signup/billing is allowed for a country. If not specified all countries are returned (according to other filters specified if any) required: false type: boolean - name: numberSelling in: query description: Specifies if RingCentral sells phone numbers of this country required: false type: boolean - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: freeSoftphoneLine in: query description: Specifies if free phone line for softphone is available for a country or not required: false type: boolean responses: default: description: Success schema: $ref: '#/definitions/GetCountryListResponse' x-api-group: dictionary/country x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/country/{countryId}: get: tags: - Regional Settings summary: Get Country description: Returns the information on a specific country. operationId: readCountry consumes: - application/json produces: - application/json parameters: - name: countryId in: path description: Internal identifier of a country required: true type: integer responses: default: description: Success schema: $ref: '#/definitions/GetCountryInfoDictionaryResponse' x-api-group: dictionary/country x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/location: get: tags: - Regional Settings summary: Get Location List description: Returns all available locations for a certain state. operationId: listLocations consumes: - application/json produces: - application/json parameters: - name: orderBy in: query description: Sorts results by the property specified required: false default: City type: string enum: - Npa - City - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted required: false default: 1 type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: stateId in: query description: Internal identifier of a state required: false type: string - name: withNxx in: query description: Specifies if nxx codes are returned required: false type: boolean responses: default: description: Success schema: $ref: '#/definitions/GetLocationListResponse' x-api-group: dictionary/location x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/dictionary/state: get: tags: - Regional Settings summary: Get States List description: Returns all the states of a certain country operationId: listStates consumes: - application/json produces: - application/json parameters: - name: allCountries in: query type: boolean description: If set to 'True' then states for all countries are returned and `countryId` is ignored, even if specified. If the value is empty then the parameter is ignored required: false - name: countryId in: query description: Internal identifier of a country required: false type: integer - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: withPhoneNumbers in: query description: If 'True', the list of states with phone numbers available for buying is returned default: false required: false type: boolean responses: default: description: Success schema: $ref: '#/definitions/GetStateListResponse' x-api-group: dictionary/state x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/state/{stateId}: get: tags: - Regional Settings summary: Get State description: Returns the information on a specific state. operationId: readState consumes: - application/json produces: - application/json parameters: - name: stateId in: path description: Internal identifier of a state required: true type: integer responses: default: description: Success schema: $ref: '#/definitions/GetStateInfoResponse' x-api-group: dictionary/state x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/timezone: get: tags: - Regional Settings summary: Get Timezone List description: Returns all available timezones. operationId: listTimezones consumes: - application/json produces: - application/json parameters: - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: "1" required: false type: string - name: perPage in: query description: Indicates the page size (number of items) default: "100" required: false type: string responses: default: description: Success schema: $ref: '#/definitions/GetTimezoneListResponse' x-api-group: dictionary/timezone x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/dictionary/timezone/{timezoneId}: get: tags: - Regional Settings summary: Get Timezone description: Returns the information on a certain timezone. operationId: readTimezone consumes: - application/json produces: - application/json parameters: - name: timezoneId in: path description: Internal identifier of a timezone required: true type: integer - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: "1" required: false type: string - name: perPage in: query description: Indicates the page size (number of items) default: "100" required: false type: string responses: default: description: Success schema: $ref: '#/definitions/GetTimezoneInfoResponse' x-api-group: dictionary/timezone x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/phone-number: get: tags: - Phone Numbers summary: Get Company Phone Number List description: Returns the list of phone numbers assigned to RingCentral customer account. Both company-level and extension-level numbers are returned. operationId: listAccountPhoneNumbers consumes: - application/json produces: - application/json 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 type: string default: "~" - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: usageType in: query description: Usage type of a phone number required: false type: array items: type: string enum: - MainCompanyNumber - AdditionalCompanyNumber - CompanyNumber - DirectNumber - CompanyFaxNumber - ForwardedNumber - ForwardedCompanyNumber - ContactCenterNumber - ConferencingNumber - MeetingsNumber collectionFormat: multi responses: default: description: Success schema: $ref: '#/definitions/AccountPhoneNumbers' x-api-group: account/phone-number x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyPhoneNumbers x-docs-level: Public /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}: get: tags: - Phone Numbers summary: Get Phone Number description: Returns the phone number(s) belonging to a certain account or extension by phoneNumberId(s). Batch request is supported. operationId: readAccountPhoneNumber consumes: - application/json produces: - application/json 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 type: string default: "~" - name: phoneNumberId in: path description: Internal identifier of a phone number required: true type: integer responses: default: description: Success schema: $ref: '#/definitions/CompanyPhoneNumberInfo' x-api-group: account/phone-number x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyPhoneNumbers x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/extension: get: tags: - Extensions summary: Get Extension List operationId: listExtensions description: Returns the list of extensions created for a particular account. All types of extensions are included in this list. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: extensionId type: string in: query description: Extension number to retrieve required: false - name: email type: string in: query description: Extension email address required: false - name: page type: integer format: int64 in: query description: Indicates the page number to retrieve. Only positive number values are allowed default: 1 required: false - name: perPage type: integer format: int64 in: query description: Indicates the page size (number of items) default: 100 required: false - name: status type: array items: type: string enum: - Enabled - Disabled - NotActivated - Unassigned collectionFormat: multi allowEmptyValue: true 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. required: false - name: type type: array items: type: string enum: - User - FaxUser - VirtualUser - DigitalUser - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnly - IvrMenu - ApplicationExtension - ParkLocation - Limited - Bot collectionFormat: multi allowEmptyValue: true in: query description: Extension type. Multiple values are supported required: false responses: default: description: Success schema: $ref: '#/definitions/GetExtensionListResponse' x-api-group: extension x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-notifications: - $ref: '#/definitions/ExtensionListEvent' x-service-level: 1000 x-availability: High post: tags: - Extensions summary: Create Extension operationId: createExtension description: Creates an extension. consumes: - application/json produces: - application/json parameters: - name: accountId type: string in: path description: Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session required: true default: "~" - name: body in: body description: JSON body schema: $ref: '#/definitions/ExtensionCreationRequest' required: true responses: default: description: Success schema: $ref: '#/definitions/ExtensionCreationResponse' x-api-group: extension x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: AddRemoveUsers x-docs-level: Public /restapi/v1.0/account/{accountId}/templates: get: tags: - Extensions operationId: listUserTemplates description: Returns the list of user templates for the current account. summary: Get User Template List consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: type in: query type: string enum: - UserSettings - CallHandling - name: page in: query type: string - name: perPage in: query type: string responses: default: description: Success schema: $ref: '#/definitions/UserTemplates' x-api-group: account/templates x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/account/{accountId}/templates/{templateId}: get: tags: - Extensions operationId: readUserTemplate description: Returns the user template by ID. summary: Get User Template consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: templateId in: path required: true type: string responses: default: description: Success schema: $ref: '#/definitions/TemplateInfo' x-api-group: account/templates x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyInfo x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/call-queues: get: tags: - Call Queues summary: Get Call Queues operationId: listCallQueues description: Returns call queue group list consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer - name: memberExtensionId in: query description: Internal identifier of an extension that is a member of every group within the result type: string responses: 200: description: Success schema: $ref: '#/definitions/CallQueues' x-api-group: account/call-queues x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-throttling-group: Medium x-docs-level: Public x-service-level: 1000 x-availability: High /restapi/v1.0/account/{accountId}/call-queues/{groupId}/members: get: tags: - Call Queues operationId: listCallQueueMembers summary: Get Call Queue Members description: Returns call queue group members. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: groupId in: path required: true type: string - name: page in: query description: Indicates the page number to retrieve. Only positive number values are allowed default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: 200: description: Success schema: $ref: '#/definitions/CallQueueMembers' x-api-group: account/call-queues/members x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-throttling-group: Light x-docs-level: Public x-service-level: 1000 x-availability: High /restapi/v1.0/account/{accountId}/call-queues/{groupId}/bulk-assign: post: tags: - Call Queues operationId: assignMultipleCallQueueMembers summary: Assign Multiple Call Queue Members description: Updates a call queue group. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: groupId in: path required: true type: string - name: body in: body description: Changes for the given group required: true schema: $ref: '#/definitions/CallQueueBulkAssignResource' responses: 204: description: Success 400: description: Extension of type [${extensionType}] cannot be included into call queue x-api-group: account/call-queues/call-queues x-app-permission: EditExtensions x-user-permission: Groups x-throttling-group: Heavy x-docs-level: Public x-service-level: 1000 /restapi/v1.0/account/{accountId}/department/{departmentId}/members: get: deprecated: true tags: - Call Queues summary: Get Department Member List description: Viewing user account info (including name, business name, address and phone number/account number) operationId: listDepartmentMembers consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: integer - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: default: description: Success schema: $ref: '#/definitions/DepartmentMemberList' x-api-group: account/department/members x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/account/{accountId}/department/bulk-assign: post: deprecated: true tags: - Call Queues summary: Assign Multiple Department Members description: Adds and/or removes multiple call queue members operationId: assignMultipleDepartmentMembers consumes: - application/json produces: - application/json parameters: - in: body name: body required: false schema: $ref: '#/definitions/DepartmentBulkAssignResource' - name: accountId in: path required: true type: string default: "~" responses: default: description: successful operation x-api-group: account/department x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: UserGroups x-docs-level: Public x-service-level: 1000 /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users: get: tags: - Paging Only Groups summary: Get Paging Group Users operationId: listPagingGroupUsers description: Returns the list of users allowed to page this group. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: pagingOnlyGroupId in: path required: true type: string - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: default: description: Success schema: $ref: '#/definitions/PagingOnlyGroupUsers' x-api-group: account/paging-only-groups/users x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserInfo x-docs-level: Public x-service-level: 1000 x-availability: High /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices: get: tags: - Paging Only Groups summary: Get Paging Group Devices operationId: listPagingGroupDevices description: Returns the list of paging devices assigned to this group. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: pagingOnlyGroupId in: path required: true type: string - name: page in: query description: Indicates the page number to retrieve. Only positive number values are accepted default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: default: description: Success schema: $ref: '#/definitions/PagingOnlyGroupDevices' x-api-group: account/paging-only-groups/devices x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyDevices x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign: post: tags: - Paging Only Groups summary: Assign Paging Group Users and Devices operationId: assignMultiplePagingGroupUsersDevices description: Adds and/or removes paging group users and devices. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: pagingOnlyGroupId in: path required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/EditPagingGroupRequest' responses: default: description: Success x-api-group: account/paging-only-groups/bulk-assign x-throttling-group: Heavy x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: Groups x-docs-level: Public x-service-level: 1000 /restapi/v1.0/account/{accountId}/call-monitoring-groups: post: tags: - Call Monitoring Groups summary: Create Call Monitoring Group operationId: createCallMonitoringGroup description: Creates a new call monitoring group. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: body in: body description: Parameters of a call monitoring group that will be created required: true schema: $ref: '#/definitions/CreateCallMonitoringGroupRequest' responses: 200: description: Success schema: $ref: '#/definitions/CallMonitoringGroup' x-api-group: account/call-monitoring-groups x-app-permission: EditExtensions x-user-permission: Groups x-throttling-group: Medium x-docs-level: Public x-availability: High x-service-level: 1000 get: tags: - Call Monitoring Groups summary: Get Call Monitoring Groups List operationId: listCallMonitoringGroups description: Returns call monitoring groups that can be filtered by some extension. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: page in: query description: Indicates the page number to retrieve. Only positive number values are allowed default: "1" required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) required: false default: "100" type: integer - name: memberExtensionId in: query description: Internal identifier of an extension that is a member of every group within the result type: string responses: 200: description: Success schema: $ref: '#/definitions/CallMonitoringGroups' x-api-group: account/call-monitoring-groups x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-throttling-group: Medium x-docs-level: Public x-availability: High /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}: put: tags: - Call Monitoring Groups summary: Updates Call Monitoring Group operationId: updateCallMonitoringGroup description: Updates call monitoring group name by ID. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: groupId in: path description: Internal identifier of a call monitoring group required: true type: string - name: body in: body description: Parameters of a call monitoring group that will be updated required: true schema: $ref: '#/definitions/CreateCallMonitoringGroupRequest' responses: 200: description: Success schema: $ref: '#/definitions/CallMonitoringGroup' 400: description: Value for group name is unacceptable. 403: description: User has no permissions to create groups. 404: description: Group with the given identifier doesn't belong to the account. x-api-group: account/call-monitoring-groups x-app-permission: EditExtensions x-user-permission: Groups x-throttling-group: Medium x-docs-level: Public x-availability: High x-service-level: 1000 delete: tags: - Call Monitoring Groups summary: Delete Call Monitoring Group operationId: deleteCallMonitoringGroup description: Remove infromation about the given call monitoring group. consumes: - application/json produces: - applciation/json parameters: - name: accountId in: path required: true type: string - name: groupId in: path required: true type: string responses: 204: description: No Content 404: description: Group with the given identifier doesn't belong to the account. x-api-group: account/call-monitoring-groups x-app-permission: EditExtensions x-user-permission: Groups x-throttling-group: Medium x-docs-level: Public x-service-level: 1000 /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/members: get: tags: - Call Monitoring Groups summary: Get Call Monitoring Group Member List operationId: listCallMonitoringGroupMembers description: Returns call monitoring group members. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: groupId in: path required: true type: string - name: page in: query description: Indicates the page number to retrieve. Only positive number values are allowed default: 1 required: false type: integer - name: perPage in: query description: Indicates the page size (number of items) default: 100 required: false type: integer responses: 200: description: Success schema: $ref: '#/definitions/CallMonitoringGroupMemberList' x-api-group: account/call-monitoring-groups/members x-app-permission: ReadAccounts x-user-permission: ReadExtensions x-throttling-group: Medium x-docs-level: Public x-availability: High x-service-level: 1000 /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/bulk-assign: post: tags: - Call Monitoring Groups summary: Update Call Monitoring Group List operationId: updateCallMonitoringGroupList description: Updates call monitoring groups. consumes: - application/json produces: - application/json parameters: - name: accountId in: path required: true type: string - name: groupId in: path required: true type: string - name: body in: body description: Changes for the given group required: true schema: $ref: '#/definitions/CallMonitoringBulkAssign' responses: 204: description: No Content 400: description: Extension of type [ParkLocation] could not be a member of [call monitoring] x-api-group: account/call-monitoring-groups/bulk-assign x-app-permission: EditExtensions x-user-permission: Groups x-throttling-group: Heavy x-docs-level: Public x-service-level: 1000 /restapi/v1.0/number-parser/parse: post: tags: - Phone Numbers summary: Parse Phone Number description: Returns one or more parsed and/or formatted phone numbers that are passed as a string. operationId: parsePhoneNumber consumes: - application/json produces: - application/json parameters: - name: homeCountry in: query description: Internal identifier of a home country. The default value is ISO code (ISO 3166) of the user's home country or brand country, if the user is undefined required: false type: string - name: nationalAsPriority in: query description: The default value is 'False'. If 'True', the numbers that are closer to the home country are given higher priority required: false type: boolean - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/ParsePhoneNumberRequest' responses: default: description: Success schema: $ref: '#/definitions/ParsePhoneNumberResponse' x-beta-api: true x-api-group: number-parser/parse x-throttling-group: Light x-metered-api: true x-metering-group: System x-docs-level: Public /restapi/v1.0/account/{accountId}/device/{deviceId}: get: tags: - Devices summary: Get Device description: Returns account device(s) by their ID(s). operationId: readDevice consumes: - application/json produces: - application/json 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 type: string default: "~" - name: deviceId in: path description: Internal identifier of a device required: true type: integer - name: syncEmergencyAddress in: query description: Specifies if emergency address should be synchronized or not type: boolean default: false responses: default: description: Success schema: $ref: '#/definitions/GetDeviceInfoResponse' x-api-group: account/device x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadCompanyDevices x-docs-level: Public x-availability: High put: tags: - Devices summary: Update Device operationId: updateDevice description: Updates account device(s) by their ID(s). consumes: - application/json produces: - application/json parameters: - name: deviceId in: path required: true type: string - in: body name: body required: false schema: $ref: '#/definitions/AccountDeviceUpdate' - name: accountId in: path required: true type: string responses: default: description: successful operation schema: $ref: '#/definitions/DeviceResource' x-api-group: account/device x-throttling-group: Medium x-metered-api: true x-metering-group: System x-app-permission: EditAccounts x-user-permission: EditCompanyDevices x-docs-level: Public /restapi/v1.0/account/{accountId}/extension/{extensionId}/device: get: tags: - Devices summary: Get Extension Device List description: Returns devices of the extension(s) by their ID(s). Batch request is supported operationId: listExtensionDevices consumes: - application/json produces: - application/json 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 type: string default: "~" - 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 type: string default: "~" - name: linePooling in: query type: string description: Pooling type of a device required: false enum: - Host - Guest - None - name: feature in: query type: string description: Device feature or multiple features supported required: false enum: - Intercom - Paging - BLA - HELD responses: default: description: Success schema: $ref: '#/definitions/GetExtensionDevicesResponse' x-api-group: extension/device x-throttling-group: Light x-metered-api: true x-metering-group: System x-app-permission: ReadAccounts x-user-permission: ReadUserDevices x-docs-level: Public x-availability: High /scim/health: get: tags: - SCIM summary: check health operationId: checkHealth responses: 200: description: healthy x-api-group: scim/Health x-auth-required: false x-throttling-group: NoThrottling x-docs-level: Public x-availability: High /scim/v2/health: get: tags: - SCIM summary: check health operationId: checkHealth2 responses: 200: description: healthy x-api-group: scim/Health x-auth-required: false x-throttling-group: NoThrottling x-docs-level: Public x-availability: High /scim/v2/ServiceProviderConfig: get: tags: - SCIM summary: Get Service Provider Config operationId: readServiceProviderConfig2 responses: 200: description: Service Provider Configuration schema: $ref: '#/definitions/ServiceProviderConfig' x-api-group: scim/ServiceProviderConfig x-auth-required: false x-throttling-group: NoThrottling x-docs-level: Public x-availability: High /scim/ServiceProviderConfig: get: tags: - SCIM summary: Get Service Provider Config operationId: readServiceProviderConfig responses: 200: description: Service Provider Configuration schema: $ref: '#/definitions/ServiceProviderConfig' x-api-group: scim/ServiceProviderConfig x-auth-required: false x-throttling-group: NoThrottling x-docs-level: Public x-availability: High /scim/v2/Users: get: tags: - SCIM summary: Search or List Users operationId: searchViaGet2 parameters: - name: filter in: query description: only support 'userName' or 'email' filter expressions for now required: false type: string - name: startIndex in: query description: start index (1-based) required: false type: integer default: 1 format: int32 - name: count in: query description: page size required: false type: integer default: 100 format: int32 responses: 200: description: successful operation schema: $ref: '#/definitions/UserSearchResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: ReadAccounts x-throttling-group: Light x-docs-level: Public x-availability: High post: tags: - SCIM summary: Create User operationId: createUser2 parameters: - in: body name: body description: a new user without 'id' required: false schema: $ref: '#/definitions/User' responses: 201: description: successfully created user schema: $ref: '#/definitions/UserResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 404: description: not found schema: $ref: '#/definitions/ScimErrorResponse' 409: description: duplicate email schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: EditAccounts x-throttling-group: Heavy x-request-max-body-size: 10m x-docs-level: Public /scim/Users: get: tags: - SCIM summary: search or list users operationId: searchViaGet parameters: - name: filter in: query description: only support 'userName' or 'email' filter expressions for now required: false type: string - name: startIndex in: query description: start index (1-based) required: false type: integer default: 1 format: int32 - name: count in: query description: page size required: false type: integer default: 100 format: int32 responses: 200: description: successful operation schema: $ref: '#/definitions/UserSearchResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: ReadAccounts x-throttling-group: Light x-docs-level: Public x-availability: High post: tags: - SCIM summary: create a user operationId: createUser parameters: - in: body name: body description: a new user without 'id' required: false schema: $ref: '#/definitions/User' responses: 201: description: successfully created user schema: $ref: '#/definitions/UserResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 404: description: not found schema: $ref: '#/definitions/ScimErrorResponse' 409: description: duplicate email schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: EditAccounts x-throttling-group: Heavy x-request-max-body-size: 10m x-docs-level: Public /scim/v2/Users/.search: post: tags: - SCIM summary: Search or List Users operationId: searchViaPost2 parameters: - in: body name: body description: search parameters required: false schema: $ref: '#/definitions/SearchRequest' responses: 200: description: successful operation schema: $ref: '#/definitions/UserSearchResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: ReadAccounts x-throttling-group: Light x-docs-level: Public x-availability: High /scim/v2/Users/{id}: get: tags: - SCIM summary: Get User operationId: readUser2 parameters: - name: id in: path description: user id required: true type: string responses: 200: description: successful operation schema: $ref: '#/definitions/UserResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 404: description: not found schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: ReadAccounts x-throttling-group: Light x-docs-level: Public x-availability: High put: tags: - SCIM summary: Update/Replace User operationId: replaceUser2 parameters: - name: id in: path description: user id required: true type: string - in: body name: body description: an existing user required: false schema: $ref: '#/definitions/User' responses: 200: description: successfully fully updated a user schema: $ref: '#/definitions/UserResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 404: description: not found schema: $ref: '#/definitions/ScimErrorResponse' 409: description: duplicate email schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: EditAccounts x-throttling-group: Heavy x-request-max-body-size: 10m x-docs-level: Public delete: tags: - SCIM summary: Delete User operationId: deleteUser2 parameters: - name: id in: path description: user id required: true type: string responses: 204: description: successfully deleted 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 404: description: not found schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: EditAccounts x-throttling-group: Heavy x-docs-level: Public patch: tags: - SCIM summary: Update/Patch User operationId: patchUser2 parameters: - name: id in: path description: user id required: true type: string - in: body name: body description: patch operations list required: false schema: $ref: '#/definitions/UserPatch' responses: 200: description: successfully partially updated user schema: $ref: '#/definitions/UserResponse' 400: description: bad request schema: $ref: '#/definitions/ScimErrorResponse' 401: description: authorization failure schema: $ref: '#/definitions/ScimErrorResponse' 403: description: permissions denied schema: $ref: '#/definitions/ScimErrorResponse' 404: description: not found schema: $ref: '#/definitions/ScimErrorResponse' 409: description: duplicate email schema: $ref: '#/definitions/ScimErrorResponse' 429: description: too many requests schema: $ref: '#/definitions/ScimErrorResponse' 500: description: internal server error schema: $ref: '#/definitions/ScimErrorResponse' x-api-group: scim/Users x-app-permission: EditAccounts x-throttling-group: Heavy x-request-max-body-size: 10m x-docs-level: Public /restapi/v1.0/account/{accountId}/telephony/call-out: post: tags: - Call Control x-beta-api: true summary: Create CallOut Call Session description: Creates a CallOut Call session. operationId: createCallOutCallSession externalDocs: description: Find more info about body and response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Sessions/op_session_add_CallOut consumes: - application/json produces: - application/json 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 type: string default: "~" - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/MakeCallOutRequest' responses: 201: description: Created schema: $ref: '#/definitions/CallSession' 503: description: Service Temporary Unavailable x-api-group: telephony/call-out x-throttling-group: Heavy x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-failover-strategy: Hardening x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/call-out x-rewrite-uri-to: /telephony/v1/account/$1/call-out /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}: get: tags: - Call Control summary: Get Call Session Status description: Returns the status of a call session by ID. operationId: readCallSessionStatus consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: timestamp in: query description: The date and time of a call session latest change required: false type: string - name: timeout in: query description: The time frame of awaiting for a status change before sending the resulting one in response required: false type: string responses: 200: description: Success schema: $ref: '#/definitions/CallSessionObject' 403: description: Forbidden 404: description: Not Found 503: description: Service Temporary Unavailable x-api-group: telephony/sessions x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*) x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2 x-beta-api: false delete: tags: - Call Control summary: Drop Call Session description: Drops a call session. operationId: deleteCallSession consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string responses: 204: description: No Content 403: description: Forbidden 404: description: Not Found 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions x-throttling-group: Light x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*) x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2 x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold: post: tags: - Call Control summary: Hold Call Party description: Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back. operationId: holdCallParty consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string responses: 200: description: Success schema: $ref: '#/definitions/CallParty' 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/hold x-throttling-group: Light x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/hold x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/hold x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/unhold: post: tags: - Call Control summary: Unhold Call Party description: Brings a party back into a call and stops to play Hold Music. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back. operationId: unholdCallParty externalDocs: description: Find more info about response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_unhold consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string responses: 200: description: Success schema: $ref: '#/definitions/CallParty' 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/unhold x-throttling-group: Light x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/unhold x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/unhold x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reject: post: tags: - Call Control summary: Reject Call Party description: Rejects an inbound call in a "Setup" or "Proceeding" state operationId: rejectParty consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string responses: 204: description: No Content 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/reject x-throttling-group: Light x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/reject x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/reject x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/transfer: post: tags: - Call Control summary: Transfer Call Party description: Transfers a party by placing a new call to the specified target operationId: transferCallParty consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string - in: body name: body description: Defines a target for a party transfer. Only a single target is allowed required: true schema: $ref: '#/definitions/TransferTarget' responses: 200: description: Success schema: $ref: '#/definitions/CallParty' 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/transfer x-throttling-group: Light x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/transfer x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/transfer x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/forward: post: tags: - Call Control summary: Forward Call Party description: Distributes a non-answered call to the defined target. Applicable for "Setup" or "Proceeding" states operationId: forwardCallParty externalDocs: description: Find more info about body and response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_forward consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string - in: body name: body description: Distributes a non-answered call to the defined target. Only a single target is allowed required: true schema: $ref: '#/definitions/ForwardTarget' responses: 200: description: Success schema: $ref: '#/definitions/CallParty' 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/forward x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/forward x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/forward x-beta-api: false /v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip: post: tags: - Call Control summary: Call Flip on Party description: Performs call flip procedure by holding opposite party and calling to the specified target operationId: callFlipParty externalDocs: description: Find more info about body and response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_flip consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CallPartyFlip' responses: 200: description: Success 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/flip x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/flip x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/flip x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}: get: tags: - Call Control summary: Get Call Party Status description: Returns a party status of a call session by ID. operationId: readCallPartyStatus externalDocs: description: Find more info about response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_get consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string responses: 200: description: Success schema: $ref: '#/definitions/CallParty' 403: description: Forbidden 404: description: Not Found 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*) x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3 x-beta-api: false patch: tags: - Call Control summary: Update Call Party description: 'Modify the party of a call session by ID. There is a known limitation for Mute scenario - mute via REST API doesn''t work with mute placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and Ringcentral Desktop app you need to unmute both endpoints to bring media back. ' operationId: updateCallParty consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/PartyUpdateRequest' responses: 200: description: Success schema: $ref: '#/definitions/CallParty' 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*) x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3 x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings: post: tags: - Call Control summary: Create Recording description: Starts a new call recording for the party operationId: startCallRecording externalDocs: description: Find more info about response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_addRecording consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string responses: 201: description: Created 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/recordings x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/recordings x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/recordings x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings/{recordingId}: patch: tags: - Call Control summary: Pause/Resume Recording description: Pause/resume recording operationId: pauseResumeCallRecording externalDocs: description: Find more info about response format url: https://wiki.ringcentral.com/display/TA/Telephony+Platform+API+-+TAS+10.2#/Parties/op_party_modifyRecording consumes: - application/json produces: - application/json parameters: - name: brandId in: query description: Identifies a brand of a logged in user or a brand of a sign-up session required: true type: string default: "~" - 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - name: partyId in: path description: Internal identifier of a call party required: true type: string - name: recordingId in: path description: Internal identifier of a recording required: true type: string - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/CallRecordingUpdate' responses: 200: description: Success schema: $ref: '#/definitions/CallRecording' 400: description: Bad Request 403: description: Forbidden 404: description: Not Found 409: description: Conflict 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions/parties/recordings x-throttling-group: Light x-internal-api: false x-docs-level: Public x-app-permission: CallControl x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/parties/(.*)/recordings/(.*) x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/parties/$3/recordings/$4 x-beta-api: false /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/supervise: post: tags: - Call Control summary: Supervise Call x-beta-api: true description: Allows to monitor a call in 'Listen' mode. Input parameters should contain extension number of a monitored user and internal identifier of a supervisor's device. Call session should be specified in path. Currently is not supported for Sandbox environment. operationId: superviseCallSession consumes: - application/json produces: - application/json 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 type: string default: "~" - name: telephonySessionId in: path description: Internal identifier of a call session required: true type: string - in: body name: body description: JSON body required: true schema: $ref: '#/definitions/SuperviseCallSessionRequest' responses: 201: description: Created schema: $ref: '#/definitions/SuperviseCallSession' 403: description: Forbidden 404: description: Not Found 500: description: Internal Server Error 503: description: Service Temporary Unavailable x-api-group: telephony/sessions x-throttling-group: Light x-internal-api: false x-app-permission: CallControl x-docs-level: Public x-rewrite-uri-from: /restapi/v1.0/account/(.*)/telephony/sessions/(.*)/supervise x-rewrite-uri-to: /telephony/v1/account/$1/sessions/$2/supervise /restapi/v1.0/glip/data-export/{taskId}/archive/{archiveId}: get: tags: - Glip Compliance Exports operationId: readComplianceArchive summary: Get Glip Data Archive description: Returns data archive by ID in application/zip format. Returns a data archive in application/zip format for the specified task and archive ID. The archive ID is a sequential number associated with the task ID and can be obtained by calling Get Data Export Task. parameters: - name: taskId description: Internal identifier of a data export task in: path required: true type: string - name: archiveId in: path required: true type: string responses: 200: description: OK x-api-group: glip/data-export/archive x-throttling-group: Heavy x-app-permission: Glip x-user-permission: Glip x-docs-level: Public x-metering-group: System x-rewrite-uri-from: /media/v1/glip/data-export/([^/]+)/archive/(.*) x-rewrite-uri-to: /glip/v1/data-export/$1/archive/$2 /restapi/v1.0/glip/data-export: post: tags: - Glip Compliance Exports description: Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented. The exported data can be downloaded by calling Get Data Export Task method with the specific task ID. operationId: createDataExportTask summary: Create Data Export Task produces: - application/json parameters: - name: body in: body description: JSON body schema: $ref: '#/definitions/CreateDataExportTaskRequest' required: false responses: 200: description: OK schema: $ref: '#/definitions/DataExportTask' x-api-group: glip/data-export x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/data-export x-rewrite-uri-to: /glip/v1/data-export x-throttling-group: Heavy x-app-permission: Glip x-docs-level: Public /restapi/v1.0/glip/data-export/{taskId}: get: tags: - Glip Compliance Exports description: Returns the links for downloading Glip data exported within the specified task. If the export task is still in progress, then only the task status will be returned. If the data is ready for downloading, then the list of URLs will be returned. summary: Get Data Export Task operationId: readDataExportTask produces: - application/json parameters: - name: taskId in: path description: Internal identifier of a task to be retrieved required: true type: string responses: 200: description: OK schema: $ref: '#/definitions/DataExportTask' x-api-group: glip/compliance x-metered-api: true x-metering-group: System x-rewrite-uri-from: /restapi/v1.0/glip/data-export/(.*) x-rewrite-uri-to: /glip/v1/data-export/$1 x-docs-level: Public x-throttling-group: Medium /restapi/v1.0/account/{accountId}/message-store-report: post: tags: - Message Exports description: Creates a task to collect all account messages for a specified time interval. summary: Create Message Store Report operationId: createMessageStoreReport parameters: - name: accountId in: path required: true type: string - name: body in: body required: false schema: $ref: '#/definitions/CreateMessageStoreReportRequest' responses: 202: description: Success schema: $ref: '#/definitions/MessageStoreReport' 503: description: Internal error 400: description: Wrong request provided x-api-group: message-store/task x-app-permission: ReadMessages x-user-permission: Users x-docs-level: Public x-throttling-group: Heavy /restapi/v1.0/account/{accountId}/message-store-report/{taskId}: get: tags: - Message Exports description: Returns the current status of a task on report creation. summary: Get Message Store Report Task operationId: readMessageStoreReportTask parameters: - name: accountId in: path required: true type: string - name: taskId in: path required: true type: string responses: 200: description: Success schema: $ref: '#/definitions/MessageStoreReport' x-api-group: message-store/task x-app-permission: ReadMessages x-user-permission: Users x-docs-level: Public x-throttling-group: Heavy /restapi/v1.0/account/{accountId}/message-store-report/{taskId}/archive: get: tags: - Message Exports description: Returns the created report with message data not including attachments. summary: Get Message Store Report Archive operationId: readMessageStoreReportArchive parameters: - name: accountId in: path required: true type: string - name: taskId in: path required: true type: string responses: 200: description: Success schema: $ref: '#/definitions/MessageStoreReportArchive' x-api-group: message-store/task/archive x-app-permission: ReadMessages x-user-permission: Users x-docs-level: Public x-throttling-group: Heavy /restapi/v1.0/account/{accountId}/message-store-report/{taskId}/archive/{archiveId}: get: tags: - Message Exports description: Returns one of the report archives with message contents in application/zip format. summary: Get Message Store Report Archive Content operationId: readMessageStoreReportArchiveContent produces: - application/zip parameters: - name: accountId in: path required: true type: string - name: taskId in: path required: true type: string - name: archiveId in: path required: true type: string responses: 200: description: Archived Data schema: type: file x-api-group: message-store/task/archive x-app-permission: ReadMessages x-user-permission: Users x-docs-level: Public x-throttling-group: Heavy /restapi/oauth/authorize: get: tags: - Authentication summary: Authorize operationId: authorize description: Returns link to a login page location. consumes: - application/x-www-form-urlencoded parameters: - name: response_type required: true in: formData type: string enum: - code - token description: 'Determines authorization flow: **code** - Authorization Code, **token** - Implicit Grant' - name: redirect_uri required: true in: formData type: string description: This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration - name: client_id required: true in: formData type: string description: Identifier (key) of a client application - name: state type: string in: formData description: Client state. Returned back to the client at the end of the flow - name: brand_id type: string in: formData description: Brand identifier. If it is not provided in request, server will try to determine brand from client app profile. The default value is '1210' - RingCentral US - name: display type: string enum: - page - popup - touch - mobile in: formData description: Style of login form. The default value is 'page'. The 'popup' and 'touch' values are featured for mobile applications - name: prompt type: string enum: - login - sso - consent in: formData description: 'Specifies which login form will be displayed. Space-separated set of the following values: ''login'' - official RingCentral login form, ''sso'' - Single Sign-On login form, ''consent'' - form to show the requested scope and prompt user for consent. Either ''login'' or ''sso'' (or both) must be specified. The default value is ''login&sso''' - name: localeId type: string in: formData description: Localization code of a language. Overwrites 'Accept-Language' header value - name: ui_locales type: string in: formData description: Localization code of a language. Overwrites 'localeId' parameter value - name: ui_options type: string in: formData enum: - hide_logo - hide_tos - hide_remember_me - external_popup - old_ui description: User interface options data responses: 302: description: Found examples: text/plain: 'Location: https://service.ringcentral.com/mobile/loginDispatcher?session=2008293087662283621&clientId=A50F55593E224b381E81D6A969391D0e49E27FB9A1C3&state=ABC123&brandId=1210&appUrlScheme=https%3A%2F%2Fmyapp%2Eexample%2Ecom%2Foauthredirect&localeId=en_US&display=page&prompt=login&hideNavigationBar=true' x-api-group: oauth/authorize x-metered-api: true x-metering-group: Free x-docs-level: Public x-throttling-group: Auth /restapi/oauth/token: post: tags: - Authentication summary: Get Token operationId: getToken description: Returns access tokens for making API requests consumes: - application/x-www-form-urlencoded produces: - application/json parameters: - name: username in: formData description: Phone number linked to an account or extension in E.164 format with or without leading '+' sign required: false type: string - name: password in: formData description: User's password required: false type: string format: password - name: extension in: formData 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 required: false type: string - name: grant_type in: formData description: Grant type required: false type: string enum: - authorization_code - password - refresh_token - client_credentials default: password - name: code type: string in: formData description: Authorization code - name: redirect_uri type: string in: formData description: This is a callback URI which determines where the response is sent. The value of this parameter must exactly match one of the URIs you have provided for your app upon registration - name: access_token_ttl in: formData description: Access token lifetime in seconds required: false type: integer format: int64 minimum: 600 maximum: 3600 default: 3600 - name: refresh_token_ttl in: formData description: Refresh token lifetime in seconds required: false type: integer format: int64 default: 604800 maximum: 604800 - name: scope in: formData description: List of API permissions to be used with access token. Can be omitted when requesting all permissions defined during the application registration phase required: false type: string - name: refresh_token in: formData description: Previously issued refresh token. This is the only formData field used for the Refresh Token Flow. required: false type: string - name: endpoint_id in: formData required: false type: string description: The unique identifier of a client application. If not specified, the previously specified or auto generated value is used by default responses: 200: description: Access/Refresh Tokens schema: $ref: '#/definitions/TokenInfo' 400: description: | 1. invalid_request: Unsupported grant type 2. invalid_client: Bad Application Release Status: Blocked 415: description: Unsupported Media Type 429: description: Request rate exceeded x-api-group: oauth/token x-metered-api: true x-metering-group: System x-rewrite-uri-to: /authorization/v1/oauth/token x-docs-level: Public x-throttling-group: Auth /restapi/oauth/revoke: post: tags: - Authentication summary: Revoke Token operationId: revokeToken description: Revokes access/refresh token. Requests to this endpoint must be authenticated with HTTP Basic scheme using the application key and application secret as login and password, correspondingly. consumes: - application/x-www-form-urlencoded parameters: - name: token in: formData description: Active access or refresh token to be revoked required: true type: string responses: 200: description: OK x-api-group: oauth/revoke x-rewrite-uri-to: /authorization/v1/oauth/revoke x-metered-api: true x-metering-group: Free x-docs-level: Public x-throttling-group: Auth definitions: GetVersionsResponse: type: object properties: uri: type: string description: Canonical URI of the API version apiVersions: type: array description: 'Full API version information: uri, number, release date' items: $ref: '#/definitions/VersionInfo' serverVersion: type: string description: Server version serverRevision: type: string description: Server revision example: application/json: uri: https://platform.ringcentral.com/restapi apiVersions: - uri: https://platform.ringcentral.com/restapi/v1.0 versionString: 1.0.34 releaseDate: "2018-02-09T00:00:00.000Z" uriString: v1.0 serverVersion: 10.0.4.7854 serverRevision: 32f2a96b769c GetVersionResponse: type: object properties: uri: type: string description: Canonical URI of the version info resource versionString: type: string description: Version of the RingCentral REST API releaseDate: type: string description: Release date of this version uriString: type: string description: URI part determining the current version example: application/json: uri: https://platform.ringcentral.com/restapi/v1.0 versionString: 1.0.34 releaseDate: "2018-02-09T00:00:00.000Z" uriString: v1.0 VersionInfo: type: object properties: uri: type: string description: Canonical URI of API versions versionString: type: string description: Version of the RingCentral REST API releaseDate: type: string description: Release date of this version uriString: type: string description: URI part determining the current version UserCallLogResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of call log records items: $ref: '#/definitions/CallLogRecord' navigation: $ref: '#/definitions/CallLogNavigationInfo' description: Information on navigation paging: $ref: '#/definitions/CallLogPagingInfo' description: Information on paging CallLogSync: type: object properties: records: type: array description: List of call log records with synchronization information. For ISync the total number of returned records is limited to 250; this includes both new records and the old ones, specified by the recordCount parameter items: $ref: '#/definitions/CallLogRecord' syncInfo: $ref: '#/definitions/SyncInfoCallLog' description: Sync information (type, token and time) UserCallLogRecord: type: object properties: id: type: string description: Internal identifier of a cal log record uri: type: string description: Canonical URI of a call log record sessionId: type: string description: Internal identifier of a call session from: $ref: '#/definitions/CallLogCallerInfo' to: $ref: '#/definitions/CallLogCallerInfo' type: type: string description: Call type enum: - Voice - Fax direction: type: string description: Call direction enum: - Inbound - Outbound startTime: type: string description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z deleted: type: boolean description: Indicates whether the record is deleted. Returned for deleted records, for ISync requests duration: type: integer description: Call duration in seconds recording: $ref: '#/definitions/CallLogRecordingInfo' action: type: string description: Action description of the call operation enum: - Unknown - Phone Call - Phone Login - Incoming Fax - Accept Call - FindMe - FollowMe - Outgoing Fax - Call Return - Calling Card - Ring Directly - RingOut Web - VoIP Call - RingOut PC - RingMe - Transfer - 411 Info - Emergency - E911 Update - Support - RingOut Mobile result: type: string description: Status description of the call operation enum: - Unknown - ResultInProgress - Missed - Call accepted - Voicemail - Rejected - Reply - Received - Receive Error - Fax on Demand - Partial Receive - Blocked - Call connected - No Answer - International Disabled - Busy - Send Error - Sent - No fax machine - ResultEmpty - Account - Suspended - Call Failed - Call Failure - Internal Error - IP Phone offline - Restricted Number - Wrong Number - Stopped - Hang up - Poor Line Quality - Partially Sent - International Restriction - Abandoned - Declined - Fax Receipt Error - Fax Send Error reason: type: string enum: - Accepted - Connected - line Busy - Not Answered - No Answer - Hang Up - Stopped - Internal Error - No Credit - Restricted Number - Wrong Number - International Restricted - Bad Number - Info 411 Restricted - Customer 611 Restricted - No Digital Line - Failed Try Again - Max Call Limit - Too Many Calls - Calls Not Accepted - Number Not Allowed - Number Blocked - Number Disabled - Resource Error - Call Loop - Fax Not Received - Fax Partially Sent - Fax Not Sent - Fax Poor Line - Fax Prepare Error - Fax Save Error - Fax Send Error description: "Reason of a call result:\n * `Accepted` - The call was connected to and accepted by this number\n * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push \"1\" to accept)\n * `Line Busy` - The phone number you dialed was busy\n * `Not Answered` - The phone number you dialed was not answered\n * `No Answer` - You did not answer the call\n * `Hang Up` - The caller hung up before the call was answered\n * `Stopped` - This attempt was stopped because the call was answered by another phone\n * `Internal Error` - An internal error occurred when making the call. Please try again\n * `No Credit` - There was not enough Calling Credit on your account to make this call\n * `Restricted Number` - The number you dialed is restricted by RingCentral\n * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again\n * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling\n * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator\n * `Bad Number` - An error occurred when making the call. Please check the number before trying again\n * `Info 411 Restricted` - Calling to 411 Information Services is restricted\n * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212>\n * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection\n * `Failed Try Again` - Call failed. Please try again\n * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit\n * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service\n * `Calls Not Accepted` - Your account was not accepting calls at this time\n * `Number Not Allowed` - The number that was dialed to access your account is not allowed\n * `Number Blocked` - This number is in your Blocked Numbers list\n * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator\n * `Resource Error` - An error occurred when making the call. Please try again\n * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account\n * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established\n * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped\n * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine\n * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax\n * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again\n * `Fax Save Error` - An internal error occurred when saving the fax. Please try again\n * `Fax Send Error` - An error occurred when sending the fax. Please try again \n" ActiveCallsResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of call log records items: $ref: '#/definitions/CallLogRecord' navigation: $ref: '#/definitions/CallLogNavigationInfo' description: Information on navigation paging: $ref: '#/definitions/CallLogPagingInfo' description: Information on paging AccountCallLogResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of call log records items: $ref: '#/definitions/CallLogRecord' navigation: $ref: '#/definitions/CallLogNavigationInfo' description: Information on navigation paging: $ref: '#/definitions/CallLogPagingInfo' description: Information on paging CompanyCallLogRecord: type: object properties: id: type: string description: Internal identifier of a cal log record uri: type: string description: Canonical URI of a call log record sessionId: type: string description: Internal identifier of a call session from: $ref: '#/definitions/CallLogCallerInfo' description: Caller information to: $ref: '#/definitions/CallLogCallerInfo' description: Callee information type: type: string description: Call type enum: - Voice - Fax direction: type: string description: Call direction enum: - Inbound - Outbound deleted: type: boolean description: Indicates whether the record is deleted. Returned for deleted records, for ISync requests action: type: string description: Action description of the call operation enum: - Unknown - Phone Call - Phone Login - Incoming Fax - Accept Call - FindMe - FollowMe - Outgoing Fax - Call Return - Calling Card - Ring Directly - RingOut Web - VoIP Call - RingOut PC - RingMe - Transfer - 411 Info - Emergency - E911 Update - Support - RingOut Mobile result: type: string description: Status description of the call operation enum: - Unknown - ResultInProgress - Missed - Call accepted - Voicemail - Rejected - Reply - Received - Receive Error - Fax on Demand - Partial Receive - Blocked - Call connected - No Answer - International Disabled - Busy - Send Error - Sent - No fax machine - ResultEmpty - Account - Suspended - Call Failed - Call Failure - Internal Error - IP Phone offline - Restricted Number - Wrong Number - Stopped - Hang up - Poor Line Quality - Partially Sent - International Restriction - Abandoned - Declined - Fax Receipt Error - Fax Send Error startTime: type: string format: date-time description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z duration: type: integer description: Call duration in seconds recording: $ref: '#/definitions/CallLogRecordingInfo' description: Call recording data. Returned if a call is recorded GetCallRecordingResponse: type: object properties: id: type: string description: Internal identifier of a call recording contentUri: type: string description: Link to a call recording binary content contentType: type: string description: Call recording file format. Supported format is audio/x-wav duration: type: integer description: Recorded call duration SyncInfoCallLog: type: object properties: syncType: type: string description: Type of synchronization enum: - FSync - ISync syncToken: type: string description: Synchronization token syncTime: type: string format: date-time description: The last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z CallLogCallerInfo: type: object properties: phoneNumber: type: string description: Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS extensionNumber: type: string description: Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message location: type: string description: Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers) name: type: string description: Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then device: $ref: '#/definitions/CallLogRecordDeviceInfo' CallLogRecordingInfo: type: object properties: id: type: string description: Internal identifier of the call recording uri: type: string description: Link to the call recording metadata resource type: type: string description: Indicates recording mode used enum: - Automatic - OnDemand contentUri: type: string description: Link to the call recording binary content CallLogRecord: type: object required: - legs properties: id: type: string description: Internal identifier of a cal log record uri: type: string description: Canonical URI of a call log record sessionId: type: string description: Internal identifier of a call session from: $ref: '#/definitions/CallLogCallerInfo' description: Caller information to: $ref: '#/definitions/CallLogCallerInfo' description: Callee information type: type: string description: Call type enum: - Voice - Fax direction: type: string description: Call direction enum: - Inbound - Outbound action: type: string description: Action description of the call operation enum: - Unknown - Phone Call - Phone Login - Incoming Fax - Accept Call - FindMe - FollowMe - Outgoing Fax - Call Return - Calling Card - Ring Directly - RingOut Web - VoIP Call - RingOut PC - RingMe - Transfer - 411 Info - Emergency - E911 Update - Support - RingOut Mobile result: type: string description: Status description of the call operation enum: - Unknown - ResultInProgress - Missed - Call accepted - Voicemail - Rejected - Reply - Received - Receive Error - Fax on Demand - Partial Receive - Blocked - Call connected - No Answer - International Disabled - Busy - Send Error - Sent - No fax machine - ResultEmpty - Account - Suspended - Call Failed - Call Failure - Internal Error - IP Phone offline - Restricted Number - Wrong Number - Stopped - Hang up - Poor Line Quality - Partially Sent - International Restriction - Abandoned - Declined - Fax Receipt Error - Fax Send Error reason: type: string enum: - Accepted - Connected - line Busy - Not Answered - No Answer - Hang Up - Stopped - Internal Error - No Credit - Restricted Number - Wrong Number - International Restricted - Bad Number - Info 411 Restricted - Customer 611 Restricted - No Digital Line - Failed Try Again - Max Call Limit - Too Many Calls - Calls Not Accepted - Number Not Allowed - Number Blocked - Number Disabled - Resource Error - Call Loop - Fax Not Received - Fax Partially Sent - Fax Not Sent - Fax Poor Line - Fax Prepare Error - Fax Save Error - Fax Send Error description: | Reason of a call result: * `Accepted` - The call was connected to and accepted by this number * `Connected` - The call was answered, but there was no response on how to handle the call (for example, a voice mail system answered the call and did not push "1" to accept) * `Line Busy` - The phone number you dialed was busy * `Not Answered` - The phone number you dialed was not answered * `No Answer` - You did not answer the call * `Hang Up` - The caller hung up before the call was answered * `Stopped` - This attempt was stopped because the call was answered by another phone * `Internal Error` - An internal error occurred when making the call. Please try again * `No Credit` - There was not enough Calling Credit on your account to make this call * `Restricted Number` - The number you dialed is restricted by RingCentral * `Wrong Number` - The number you dialed has either been disconnected or is not a valid phone number. Please check the number and try again * `International Disabled` - International calling is not enabled on your account. Contact customer service to activate International Calling * `International Restricted` - The country and/or area you attempted to call has been prohibited by your administrator * `Bad Number` - An error occurred when making the call. Please check the number before trying again * `Info 411 Restricted` - Calling to 411 Information Services is restricted * `Customer 611 Restricted` - 611 customer service is not supported. Please contact customer service at <(888) 555-1212> * `No Digital Line` - This DigitalLine was either not plugged in or did not have an internet connection * `Failed Try Again` - Call failed. Please try again * `Max Call Limit` - The number of simultaneous calls to your account has reached its limit * `Too Many Calls` - The number of simultaneous calls for per DigitalLine associated with Other Phone has reached its limit. Please contact customer service * `Calls Not Accepted` - Your account was not accepting calls at this time * `Number Not Allowed` - The number that was dialed to access your account is not allowed * `Number Blocked` - This number is in your Blocked Numbers list * `Number Disabled` - The phone number and/or area you attempted to call has been prohibited by your administrator * `Resource Error` - An error occurred when making the call. Please try again * `Call Loop` - A call loop occurred due to an incorrect call forwarding configuration. Please check that you are not forwarding calls back to your own account * `Fax Not Received` - An incoming fax could not be received because a proper connection with the sender's fax machine could not be established * `Fax Partially Sent` - The fax was only partially sent. Possible explanations include phone line quality to poor to maintain the connection or the call was dropped * `Fax Not Sent` - An attempt to send the fax was made, but could not connect with the receiving fax machine * `Fax Poor Line` - An attempt to send the fax was made, but the phone line quality was too poor to send the fax * `Fax Prepare Error` - An internal error occurred when preparing the fax. Please try again * `Fax Save Error` - An internal error occurred when saving the fax. Please try again * `Fax Send Error` - An error occurred when sending the fax. Please try again startTime: type: string format: date-time description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z duration: type: integer description: Call duration in seconds recording: $ref: '#/definitions/CallLogRecordingInfo' description: Call recording data. Returned if the call is recorded, the withRecording parameter is set to 'True' in this case lastModifiedTime: type: string format: date-time description: For 'Detailed' view only. The datetime when the call log record was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z transport: type: string description: For 'Detailed' view only. Call transport enum: - PSTN - VoIP extension: description: Information about extension on whose behalf a call is initiated. For Secretary call log the Boss extension info is returned $ref: '#/definitions/ActiveCallsRecordExtensionInfo' delegate: description: Information on a delegate extension that actually implemented a call action. For Secretary call log the field is returned if the current extension implemented a call. For Boss call log the field contains information on a Secretary extension which actually implemented a call on behalf of the current extension $ref: '#/definitions/DelegateInfo' legs: type: array description: For 'Detailed' view only. Leg description items: $ref: '#/definitions/CallLogRecordLegInfo' message: $ref: '#/definitions/CallLogRecordMessage' deleted: type: boolean description: Returned only if this call was deleted. Value is set to 'True' in this case CallLogNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/CallLogNavigationInfoURI' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/CallLogNavigationInfoURI' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/CallLogNavigationInfoURI' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/CallLogNavigationInfoURI' CallLogPagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer default: 100 description: Current page size, describes how many items are in each page. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons DelegateInfo: type: object properties: id: type: string description: Internal identifier of a Secretary extension name: type: string description: Custom name of a Secretary extension CallLogRecordLegInfo: type: object properties: action: type: string description: Action description of the call operation enum: - Unknown - Phone Call - Phone Login - Incoming Fax - Accept Call - FindMe - FollowMe - Outgoing Fax - Call Return - Calling Card - Ring Directly - RingOut Web - VoIP Call - RingOut PC - RingMe - Transfer - 411 Info - Emergency - E911 Update - Support - RingOut Mobile direction: type: string description: Call direction enum: - Inbound - Outbound duration: type: integer description: Call duration in seconds extension: $ref: '#/definitions/ExtensionInfoCallLog' description: Information on extension legType: type: string description: Leg type enum: - SipForwarding - ServiceMinus2 - ServiceMinus3 - PstnToSip - Accept - FindMe - FollowMe - TestCall - FaxSent - CallBack - CallingCard - RingDirectly - RingOutWebToSubscriber - RingOutWebToCaller - SipToPstnMetered - RingOutClientToSubscriber - RingOutClientToCaller - RingMe - TransferCall - SipToPstnUnmetered - RingOutDeviceToSubscriber - RingOutDeviceToCaller - RingOutOneLegToCaller - ExtensionToExtension - CallPark - PagingServer - Hunting - OutgoingFreeSpDl - ParkLocation - ConferenceCall - MobileApp - MoveToConference - Unknown startTime: type: string format: date-time description: The call start datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z type: type: string description: Call type enum: - Voice - Fax result: type: string description: Status description of the call operation enum: - Unknown - ResultInProgress - Missed - Call accepted - Voicemail - Rejected - Reply - Received - Receive Error - Fax on Demand - Partial Receive - Blocked - Call connected - No Answer - International Disabled - Busy - Send Error - Sent - No fax machine - ResultEmpty - Account - Suspended - Call Failed - Call Failure - Internal Error - IP Phone offline - Restricted Number - Wrong Number - Stopped - Hang up - Poor Line Quality - Partially Sent - International Restriction - Abandoned - Declined - Fax Receipt Error - Fax Send Error from: $ref: '#/definitions/CallLogCallerInfo' description: Caller information to: $ref: '#/definitions/CallLogCallerInfo' description: Callee information transport: type: string description: Call transport enum: - PSTN - VoIP recording: $ref: '#/definitions/CallLogRecordingInfo' description: Call recording data. Returned if the call is recorded master: type: boolean description: Returned for 'Detailed' call log. Specifies if the leg is master-leg CallLogRecordMessage: type: object description: Linked message (Fax/Voicemail) properties: id: type: string description: Internal identifier of a message type: type: string description: Type of a message uri: type: string description: Link to a message resource CallLogNavigationInfoURI: type: object properties: uri: type: string CallLogRecordDeviceInfo: type: object properties: id: type: string description: Internal identifier of a device uri: type: string description: string to a device ActiveCallsRecordExtensionInfo: type: object properties: uri: type: string description: Link to an extension on whose behalf a call is initiated id: type: string description: Internal identifier of an extension on whose behalf a call is initiated ExtensionInfoCallLog: type: object properties: id: type: string description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension CreateSMSMessage: type: object required: - from - text - to properties: from: description: Sender of an SMS message. The phoneNumber property must be filled to correspond to one of the account phone numbers which is allowed to send SMS $ref: '#/definitions/MessageStoreCallerInfoRequest' to: type: array description: Receiver of an SMS message. The phoneNumber property must be filled items: $ref: '#/definitions/MessageStoreCallerInfoRequest' text: type: string description: Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols FaxResponse: type: object properties: id: type: integer format: int64 description: Internal identifier of a message uri: type: string description: Canonical URI of a message type: type: string description: Message type - 'Fax' from: description: Sender information $ref: '#/definitions/CallerInfoFrom' to: type: array description: Recipient information items: $ref: '#/definitions/CallerInfoTo' creationTime: type: string format: date-time description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z readStatus: type: string description: Message read status enum: - Read - Unread priority: type: string description: Message priority enum: - Normal - High attachments: type: array description: The list of message attachments items: $ref: '#/definitions/MessageAttachmentInfoIntId' direction: type: string description: Message direction enum: - Inbound - Outbound availability: type: string description: Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly enum: - Alive - Deleted - Purged messageStatus: type: string description: Message status. 'Queued' - the message is queued for sending; 'Sent' - a message is successfully sent; 'SendingFailed' - a message sending attempt has failed; 'Received' - a message is received (inbound messages have this status by default) enum: - Queued - Sent - SendingFailed - Received faxResolution: type: string description: Resolution of a fax message. ('High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi) enum: - High - Low faxPageCount: type: integer description: Page count in a fax message lastModifiedTime: type: string format: date-time description: Datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z coverIndex: type: integer description: Cover page identifier. For the list of available cover page identifiers please call the Fax Cover Pages method coverPageText: type: string description: Cover page text, entered by the fax sender and printed on the cover page. Maximum length is limited to 1024 symbols ListFaxCoverPagesResponse: type: object properties: uri: type: string records: type: array items: $ref: '#/definitions/FaxCoverPageInfo' navigation: description: Information on navigation $ref: '#/definitions/MessagingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/MessagingPagingInfo' InboundMessageEvent: type: object properties: aps: description: Information on a notification $ref: '#/definitions/NotificationInfo' messageId: type: string description: Internal identifier of a message conversationId: type: string description: Internal identifier of an conversation from: type: string description: Sender phone number. For GCM transport type '_from' property should be used to: type: string description: Receiver phone number ownerId: type: string description: Internal identifier of a subscription owner extension MessageEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/MessageEventBody' GetMessageInfoResponse: type: object properties: id: type: string description: Internal identifier of a message uri: type: string description: Canonical URI of a message attachments: type: array description: The list of message attachments items: $ref: '#/definitions/MessageAttachmentInfo' availability: type: string description: Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly enum: - Alive - Deleted - Purged conversationId: type: integer description: SMS and Pager only. Identifier of a conversation the message belongs to conversation: description: SMS and Pager only. Identifier of a conversation the message belongs to $ref: '#/definitions/ConversationInfo' creationTime: type: string format: date-time description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z deliveryErrorCode: type: string description: SMS only. Delivery error code returned by gateway direction: type: string description: Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound enum: - Inbound - Outbound faxPageCount: type: integer description: Fax only. Page count in a fax message faxResolution: type: string description: Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi enum: - High - Low from: description: Sender information $ref: '#/definitions/MessageStoreCallerInfoResponse' lastModifiedTime: type: string format: date-time description: The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z messageStatus: type: string description: 'Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is ''Queued'', then ''Queued'' value is returned If status for at least one recipient is ''SendingFailed'', then ''SendingFailed'' value is returned In other cases Sent status is returned' enum: - Queued - Sent - Delivered - DeliveryFailed - SendingFailed - Received pgToDepartment: type: boolean description: '''Pager'' only. ''True'' if at least one of the message recipients is ''Department'' extension' priority: type: string description: Message priority enum: - Normal - High readStatus: type: string description: Message read status enum: - Read - Unread smsDeliveryTime: type: string format: date-time description: SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral smsSendingAttemptsCount: type: integer description: SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable) subject: type: string description: Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment to: type: array description: Recipient information items: $ref: '#/definitions/MessageStoreCallerInfoResponse' type: type: string description: Message type enum: - Fax - SMS - VoiceMail - Pager - Text vmTranscriptionStatus: type: string description: Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned enum: - NotAvailable - InProgress - TimedOut - Completed - CompletedPartially - Failed CreateInternalTextMessageRequest: type: object required: - from - text properties: from: description: Sender of a pager message. $ref: '#/definitions/PagerCallerInfoRequest' replyOn: type: integer description: Internal identifier of a message this message replies to text: type: string description: Text of a pager message. Max length is 1024 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 512 symbols example: hello world to: type: array description: Optional if replyOn parameter is specified. Receiver of a pager message. items: $ref: '#/definitions/PagerCallerInfoRequest' GetMessageList: type: object required: - navigation - paging - records properties: records: type: array description: List of records with message information items: $ref: '#/definitions/GetMessageInfoResponse' navigation: description: Information on navigation $ref: '#/definitions/MessagingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/MessagingPagingInfo' InstantMessageEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/InstantMessageEventBody' GetMessageMultiResponse: type: array items: type: object $ref: '#/definitions/GetMessageInfoMultiResponse' UpdateMessageRequest: type: object properties: readStatus: type: string description: Read status of a message to be changed. Multiple values are accepted enum: - Read - Unread GetMessageSyncResponse: type: object required: - records - syncInfo properties: records: type: array description: List of message records with synchronization information items: $ref: '#/definitions/GetMessageInfoResponse' syncInfo: description: Sync type, token and time $ref: '#/definitions/SyncInfoMessages' MessageStoreConfiguration: type: object properties: retentionPeriod: type: integer description: Retention policy setting, specifying how long to keep messages; the supported value range is 7-90 days minimum: 7 maximum: 90 CallerInfoFrom: type: object properties: phoneNumber: type: string name: type: string location: type: string MessagingNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/MessagingNavigationInfoURI' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/MessagingNavigationInfoURI' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/MessagingNavigationInfoURI' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/MessagingNavigationInfoURI' PagerCallerInfoRequest: type: object required: - extensionId properties: extensionId: type: string description: Extension identifier example: "123456789" SyncInfoMessages: type: object properties: syncType: type: string description: Type of synchronization enum: - FSync - ISync syncToken: type: string description: Synchronization token syncTime: type: string format: date-time description: Last synchronization datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z MessageStoreCallerInfoRequest: type: object properties: phoneNumber: type: string description: Phone number in E.164 format NotificationInfo: type: object properties: alert: description: Alert information $ref: '#/definitions/AlertInfo' badge: type: string description: Number of incoming messages sound: type: string description: Message sound content-available: type: string description: Content availability category: type: string description: Category of a message ConversationInfo: type: object properties: id: type: string description: Internal identifier of a conversation uri: type: string description: Deprecated. Link to a conversation resource GetMessageInfoMultiResponse: type: object properties: resourceId: type: string description: Internal identifier of a resource status: type: integer description: Status code of resource retrieval body: type: object $ref: '#/definitions/MessageBody' CallerInfoTo: type: object properties: phoneNumber: type: string name: type: string location: type: string messageStatus: type: string enum: - Sent - SendingFailed - Queued faxErrorCode: type: string enum: - Undefined - NoFaxSendPermission - NoInternationalPermission - NoFaxMachine - OutgoingCallError - RenderingFailed - TooManyPages - ReturnToDBQueue - NoCallTime - WrongNumber - ProhibitedNumber - InternalError - FaxSendingProhibited - ThePhoneIsBlacklisted - UserNotFound - ConvertError - DBGeneralError - SkypeBillingFailed - AccountSuspended - ProhibitedDestination - InternationalDisabled MessagingPagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons MessageStoreCallerInfoResponse: type: object required: - extensionNumber properties: extensionNumber: type: string description: Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message location: type: string description: Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers) messageStatus: type: string description: Status of a message. Returned for outbound fax messages only enum: - Queued - Sent - Delivered - DeliveryFailed - SendingFailed - Received faxErrorCode: type: string description: Fax only. Error code returned in case of fax sending failure. Returned if messageStatus value is 'SendingFailed' enum: - InternationalCallingDisabled - DestinationCountryDisabled - NoAnswer - LineBusy - CallerHungUp - UnknownCountryCode - InvalidNumber - NotAccepted - CallDeclined - TooManyCallsPerLine - NotEnoughCredits - SentPartially - CallFailed name: type: string description: Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then phoneNumber: type: string description: Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS MessageAttachmentInfoIntId: type: object properties: id: type: integer format: int64 description: Internal identifier of a message attachment uri: type: string description: Canonical URI of a message attachment type: type: string description: Type of message attachment enum: - AudioRecording - AudioTranscription - Text - SourceDocument - RenderedDocument - MmsAttachment contentType: type: string description: MIME type for a given attachment, for instance 'audio/wav' vmDuration: type: integer description: Voicemail only Duration of the voicemail in seconds filename: type: string description: Name of a file attached size: type: integer description: Size of attachment in bytes FaxCoverPageInfo: type: object properties: id: type: integer description: Internal identifier of a fax cover page. The possible value range is 0-13 (for language setting en-US) and 0, 15-28 (for all other languages) name: type: string description: Name of a fax cover page pattern MessageEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension lastUpdated: type: string format: date-time description: Datetime when the message was last modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z changes: type: array description: Message Changes items: $ref: '#/definitions/MessageChanges' ownerId: type: string description: Internal identifier of a subscription owner extension MessageAttachmentInfo: type: object properties: id: type: string description: Internal identifier of a message attachment uri: type: string description: Canonical URI of a message attachment type: type: string description: Type of message attachment enum: - AudioRecording - AudioTranscription - Text - SourceDocument - RenderedDocument - MmsAttachment contentType: type: string description: MIME type for a given attachment, for instance 'audio/wav' vmDuration: type: integer description: Supported for `Voicemail` only. Duration of a voicemail in seconds filename: type: string description: Name of a file attached size: type: integer description: Size of attachment in bytes InstantMessageEventBody: type: object properties: id: type: string description: Internal identifier of a message to: type: array description: Message receiver(s) information items: $ref: '#/definitions/NotificationRecipientInfo' from: description: Extension Type. For GCM transport type '_from' property should be used $ref: '#/definitions/SenderInfo' type: type: string description: Type of a message. The default value is 'SMS' creationTime: type: string format: date-time description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z lastModifiedTime: type: string format: date-time description: Datetime when the message was modified in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z readStatus: type: string description: Status of a message default: Unread priority: type: string default: Normal attachments: description: Message attachment data type: array items: $ref: '#/definitions/MessageAttachmentInfo' direction: type: string description: Message direction default: Inbound availability: type: string description: Message availability status default: Alive subject: type: string description: Message subject. It replicates message text which is also returned as an attachment messageStatus: type: string description: Status of a message default: Received conversationId: type: string description: Deprecated. Identifier of a conversation the message belongs to conversation: type: object description: Information about a conversation the message belongs to $ref: '#/definitions/ConversationInfo' ownerId: type: string description: Internal identifier of a subscription owner extension AlertInfo: type: object properties: title: type: string description: Title of a message body: type: string description: Message Description MessageBody: type: object properties: uri: type: string description: Canonical URI of a message id: type: string description: Internal identifier of a message attachments: type: array description: The list of message attachments items: $ref: '#/definitions/MessageAttachmentInfo' availability: type: string description: Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly enum: - Alive - Deleted - Purged conversationId: type: integer description: SMS and Pager only. Identifier of a conversation the message belongs to conversation: description: SMS and Pager only. Identifier of a conversation the message belongs to $ref: '#/definitions/ConversationInfo' creationTime: type: string format: date-time description: Message creation datetime in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z deliveryErrorCode: type: string description: SMS only. Delivery error code returned by gateway direction: type: string description: Message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound enum: - Inbound - Outbound faxPageCount: type: integer description: Fax only. Page count in a fax message faxResolution: type: string description: Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi enum: - High - Low from: description: Sender information $ref: '#/definitions/MessageSenderInfo' lastModifiedTime: type: string format: date-time description: The datetime when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z messageStatus: type: string description: 'Message status. Different message types may have different allowed status values.For outbound faxes the aggregated message status is returned: If status for at least one recipient is ''Queued'', then ''Queued'' value is returned If status for at least one recipient is ''SendingFailed'', then ''SendingFailed'' value is returned In other cases Sent status is returned' enum: - Queued - Sent - Delivered - DeliveryFailed - SendingFailed - Received pgToDepartment: type: boolean description: '''Pager'' only. ''True'' if at least one of the message recipients is ''Department'' extension' priority: type: string description: Message priority enum: - Normal - High readStatus: type: string description: Message read status enum: - Read - Unread smsDeliveryTime: type: string format: date-time description: SMS only. The datetime when outbound SMS was delivered to recipient's handset in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. It is filled only if the carrier sends a delivery receipt to RingCentral smsSendingAttemptsCount: type: integer description: SMS only. Number of attempts made to send an outbound SMS to the gateway (if gateway is temporary unavailable) subject: type: string description: Message subject. For SMS and Pager messages it replicates message text which is also returned as an attachment to: type: array description: Recipient information items: $ref: '#/definitions/MessageRecipientInfo' type: type: string description: Message type enum: - Fax - SMS - VoiceMail - Pager - Text vmTranscriptionStatus: type: string description: Voicemail only. Status of voicemail to text transcription. If VoicemailToText feature is not activated for account, the 'NotAvailable' value is returned enum: - NotAvailable - InProgress - TimedOut - Completed - CompletedPartially - Failed MessageChanges: type: object properties: type: type: string description: Message type enum: - Voicemail - SMS - Fax - Pager newCount: type: integer description: The number of new messages. Can be omitted if the value is zero updatedCount: type: integer description: The number of updated messages. Can be omitted if the value is zero NotificationRecipientInfo: type: object properties: phoneNumber: type: string description: Phone number in E.164 (with '+' sign) format extensionNumber: type: string description: Extension number target: type: boolean description: '''True'' specifies that message is sent exactly to this recipient. Returned in to field for group MMS. Useful if one extension has several phone numbers' location: type: string description: Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers) name: type: string description: Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then SenderInfo: type: object properties: phoneNumber: type: string description: Phone number in E.164 (with '+' sign) format extensionNumber: type: string description: Extension number location: type: string description: Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers) name: type: string description: Symbolic name associated with a caller/callee. If the phone does not belong to the known extension, only the location is returned, the name is not determined then MessagingNavigationInfoURI: type: object properties: uri: type: string MessageSenderInfo: type: object properties: extensionNumber: type: string extensionId: type: string name: type: string MessageRecipientInfo: type: object properties: extensionNumber: type: string extensionId: type: string name: type: string GetRingOutStatusResponse: type: object properties: id: type: string description: Internal identifier of a RingOut call uri: type: string status: description: RingOut status information $ref: '#/definitions/RingOutStatusInfo' GetRingOutStatusResponseIntId: type: object properties: id: type: integer format: int64 description: Internal identifier of a RingOut call uri: type: string status: description: RingOut status information $ref: '#/definitions/RingOutStatusInfo' MakeRingOutRequest: type: object required: - from - to properties: from: description: Phone number of the caller. This number corresponds to the 1st leg of the RingOut call. This number can be one of user's configured forwarding numbers or arbitrary number $ref: '#/definitions/MakeRingOutCallerInfoRequestFrom' to: description: Phone number of the called party. This number corresponds to the 2nd leg of a RingOut call $ref: '#/definitions/MakeRingOutCallerInfoRequestTo' callerId: description: The number which will be displayed to the called party $ref: '#/definitions/MakeRingOutCallerInfoRequestTo' playPrompt: type: boolean description: The audio prompt that the calling party hears when the call is connected country: description: Optional. Dialing plan country data. If not specified, then extension home country is applied by default $ref: '#/definitions/MakeRingOutCoutryInfo' RingOutStatusInfo: type: object properties: callStatus: type: string description: Status of a call enum: - Invalid - Success - InProgress - Busy - NoAnswer - Rejected - GenericError - Finished - InternationalDisabled - DestinationBlocked - NotEnoughFunds - NoSuchUser callerStatus: type: string description: Status of a calling party enum: - Invalid - Success - InProgress - Busy - NoAnswer - Rejected - GenericError - Finished - InternationalDisabled - DestinationBlocked - NotEnoughFunds - NoSuchUser calleeStatus: type: string description: Status of a called party enum: - Invalid - Success - InProgress - Busy - NoAnswer - Rejected - GenericError - Finished - InternationalDisabled - DestinationBlocked - NotEnoughFunds - NoSuchUser MakeRingOutCallerInfoRequestFrom: type: object properties: phoneNumber: type: string description: Phone number in E.164 format forwardingNumberId: type: string description: Internal identifier of a forwarding number; returned in response as an 'id' field value. Can be specified instead of the phoneNumber attribute MakeRingOutCallerInfoRequestTo: type: object properties: phoneNumber: type: string description: Phone number in E.164 format MakeRingOutCoutryInfo: type: object properties: id: type: string description: Dialing plan country identifier ContactList: type: object properties: records: type: array description: List of personal contacts from the extension address book items: $ref: '#/definitions/PersonalContactResource' navigation: description: Information on navigation $ref: '#/definitions/UserContactsNavigationInfo' paging: description: Information on paging $ref: '#/definitions/UserContactsPagingInfo' PersonalContactRequest: type: object properties: firstName: type: string description: First name of the contact example: Charlie lastName: type: string description: Last name of the contact example: Williams middleName: type: string description: Middle name of the contact example: J nickName: type: string description: Nick name of the contact example: The Boss company: type: string description: Company name of the contact example: Example, Inc. jobTitle: type: string description: Job title of the contact example: CEO email: type: string description: Email of the contact example: charlie.williams@example.com email2: type: string description: 2nd email of the contact example: charlie-example@gmail.com email3: type: string description: 3rd email of the contact example: theboss-example@hotmail.com birthday: type: string format: date-time description: Date of birth of the contact webPage: type: string description: The contact home page URL example: http://www.example.com notes: type: string description: Notes for the contact example: '#1 Customer' homePhone: type: string description: Home phone number of the contact in e.164 (with "+") format example: "+15551234567" homePhone2: type: string description: 2nd home phone number of the contact in e.164 (with "+") format example: "+15551234567" businessPhone: type: string description: Business phone of the contact in e.164 (with "+") format example: "+15551234567" businessPhone2: type: string description: 2nd business phone of the contact in e.164 (with "+") format example: "+15551234567" mobilePhone: type: string description: Mobile phone of the contact in e.164 (with "+") format example: "+15551234567" businessFax: type: string description: Business fax number of the contact in e.164 (with "+") format example: "+15551234567" companyPhone: type: string description: Company number of the contact in e.164 (with "+") format example: "+15551234567" assistantPhone: type: string description: Phone number of the contact assistant in e.164 (with "+") format example: "+15551234567" carPhone: type: string description: Car phone number of the contact in e.164 (with "+") format example: "+15551234567" otherPhone: type: string description: Other phone number of the contact in e.164 (with "+") format example: "+15551234567" otherFax: type: string description: Other fax number of the contact in e.164 (with "+") format example: "+15551234567" callbackPhone: type: string description: Callback phone number of the contact in e.164 (with "+") format example: "+15551234567" homeAddress: $ref: '#/definitions/ContactAddressInfo' businessAddress: $ref: '#/definitions/ContactAddressInfo' otherAddress: $ref: '#/definitions/ContactAddressInfo' PersonalContactResource: type: object properties: uri: type: string description: Canonical URI of the contact example: https://platform.ringcentral.com/restapi/v1.0/account/230919004/extension/230919004/address-book/contact/623045004 availability: type: string description: This property has a special meaning only on Address Book Sync (e.g. a contact can be `Deleted`). For simple contact list reading it has always the default value - `Alive` enum: - Alive - Deleted - Purged email: type: string description: Email of the contact example: charlie.williams@example.com id: type: integer description: Internal identifier of the contact example: 623045004 notes: type: string description: Notes for the contact example: '#1 Customer' company: type: string description: Company name of the contact example: Example, Inc. firstName: type: string description: First name of the contact example: Charlie lastName: type: string description: Last name of the contact example: Williams jobTitle: type: string description: Job title of the contact example: CEO birthday: type: string format: date-time description: Date of birth of the contact webPage: type: string description: The contact home page URL example: http://www.example.com middleName: type: string description: Middle name of the contact example: J nickName: type: string description: Nick name of the contact example: The Boss email2: type: string description: 2nd email of the contact example: charlie-example@gmail.com email3: type: string description: 3rd email of the contact example: theboss-example@hotmail.com homePhone: type: string description: Home phone number of the contact in e.164 (with "+") format example: "+15551234567" homePhone2: type: string description: 2nd home phone number of the contact in e.164 (with "+") format example: "+15551234567" businessPhone: type: string description: Business phone of the contact in e.164 (with "+") format example: "+15551234567" businessPhone2: type: string description: 2nd business phone of the contact in e.164 (with "+") format example: "+15551234567" mobilePhone: type: string description: Mobile phone of the contact in e.164 (with "+") format example: "+15551234567" businessFax: type: string description: Business fax number of the contact in e.164 (with "+") format example: "+15551234567" companyPhone: type: string description: Company number of the contact in e.164 (with "+") format example: "+15551234567" assistantPhone: type: string description: Phone number of the contact assistant in e.164 (with "+") format example: "+15551234567" carPhone: type: string description: Car phone number of the contact in e.164 (with "+") format example: "+15551234567" otherPhone: type: string description: Other phone number of the contact in e.164 (with "+") format example: "+15551234567" otherFax: type: string description: Other fax number of the contact in e.164 (with "+") format example: "+15551234567" callbackPhone: type: string description: Callback phone number of the contact in e.164 (with "+") format example: "+15551234567" businessAddress: $ref: '#/definitions/ContactAddressInfo' homeAddress: $ref: '#/definitions/ContactAddressInfo' otherAddress: $ref: '#/definitions/ContactAddressInfo' AddressBookSync: type: object properties: uri: type: string format: uri records: type: array items: $ref: '#/definitions/PersonalContactResource' syncInfo: $ref: '#/definitions/SyncInfo' nextPageId: type: integer format: int64 nextPageUri: type: string format: uri ExtensionFavoritesEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/ExtensionFavoritesEventBody' FavoriteCollection: type: object properties: uri: type: string format: uri records: type: array items: $ref: '#/definitions/FavoriteContactResource' UserContactsNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/UserContactsNavigationInfoUri' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/UserContactsNavigationInfoUri' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/UserContactsNavigationInfoUri' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/UserContactsNavigationInfoUri' UserContactsPagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons ContactAddressInfo: type: object properties: street: type: string description: Street address example: 20 Davis Dr. city: type: string description: City name example: Belmont state: type: string description: State/province name example: CA zip: type: string description: Zip/Postal code example: "94002" SyncInfo: type: object properties: syncType: type: string enum: - FSync - ISync syncToken: type: string syncTime: type: string format: date-time olderRecordsExist: type: boolean default: false ExtensionFavoritesEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension ownerId: type: string description: Internal identifier of a subscription owner extension FavoriteContactResource: type: object properties: uri: type: string format: uri id: type: string extensionId: type: string contactId: type: string UserContactsNavigationInfoUri: type: object properties: uri: type: string DirectoryResource: type: object properties: paging: $ref: '#/definitions/CompanyContactsPagingInfo' records: type: array items: $ref: '#/definitions/ContactResource' ErrorResponse: type: object properties: errors: type: array description: Collection of all gathered errors readOnly: true items: $ref: '#/definitions/Error' description: Format of response in case that any error occured during request processing ContactResource: type: object properties: account: $ref: '#/definitions/AccountResource' department: type: string email: type: string extensionNumber: type: string firstName: type: string description: First name of a contact, for user extensions only lastName: type: string description: Last name of a contact, for user extensions only name: type: string description: Name of a contact, for non-user extensions id: type: string jobTitle: type: string phoneNumbers: type: array items: $ref: '#/definitions/PhoneNumberResource' profileImage: $ref: '#/definitions/AccountDirectoryProfileImageResource' site: $ref: '#/definitions/BusinessSiteResource' status: type: string type: type: string FederationResource: type: object properties: accounts: type: array items: $ref: '#/definitions/FederatedAccountResource' creationTime: type: string displayName: type: string id: type: string lastModifiedTime: type: string SearchDirectoryEntriesRequest: type: object properties: searchString: type: string description: 'String value to filter the contacts. The value specified is searched through the following fields: `firstName`, `lastName`, `extensionNumber`, `phoneNumber`, `email`' showFederated: description: If 'True' then contacts of all accounts in federation are returned. If 'False' then only contacts of the current account are returned, and account section is eliminated in this case default: true type: boolean extensionType: type: string description: Type of extension to filter the contacts enum: - User - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnly - ParkLocation - IvrMenu - Limited - ApplicationExtension - Site - Bot orderBy: type: array description: Sorting settings items: $ref: '#/definitions/OrderBy' page: type: integer perPage: type: integer BusinessSiteResource: type: object properties: id: type: string name: type: string code: type: string FederatedAccountResource: type: object properties: companyName: type: string conflictCount: type: integer format: int32 federatedName: type: string id: type: string linkCreationTime: type: string mainNumber: $ref: '#/definitions/PhoneNumberResource' OrderBy: type: object properties: index: type: integer description: Sorting priority index, starting from '1'. Optional if only one element in `orderBy` array is specified fieldName: type: string description: Field name by which to sort the contacts enum: - firstName - lastName - extensionNumber - phoneNumber - email direction: type: string description: Sorting direction enum: - Asc - Desc CompanyContactsPagingInfo: type: object properties: page: type: integer format: int32 totalPages: type: integer format: int32 perPage: type: integer format: int32 totalElements: type: integer format: int32 pageStart: type: integer format: int32 pageEnd: type: integer format: int32 Error: type: object properties: errorCode: type: string description: Code that characterizes this error. Code uniqly identifies the source of the error. readOnly: true enum: - ErrorCode{code='ADG-000', httpStatus=503, description='Service temporary unavailable.'} - ErrorCode{code='ADG-010', httpStatus=503, description='Federation data temporary unavailable.'} - ErrorCode{code='ADG-001', httpStatus=500, description='Service internal error.'} - ErrorCode{code='ADG-100', httpStatus=403, description='Insufficient permissions.'} - ErrorCode{code='ADG-101', httpStatus=403, description='Unauthorized access.'} - ErrorCode{code='ADG-102', httpStatus=405, description='Method not allowed.'} - ErrorCode{code='ADG-111', httpStatus=400, description='Need Content-Type header.'} - ErrorCode{code='ADG-112', httpStatus=400, description='Request body is invalid.'} - ErrorCode{code='ADG-121', httpStatus=400, description='Parameter [${paramName}] is invalid. ${additionalInfo:-}'} - ErrorCode{code='ADG-115', httpStatus=415, description='Unsupported Media Type.'} - ErrorCode{code='ADG-105', httpStatus=404, description='Current account is not linked to any federation.'} - ErrorCode{code='ADG-107', httpStatus=404, description='Account not found.'} - ErrorCode{code='ADG-122', httpStatus=404, description='Contact not found.'} - ErrorCode{code=''ADG-200'', httpStatus=404, description=''Invalid URI''} message: type: string description: Message that describes the error. This message can be used in UI. readOnly: true description: Description of an error occurred during request processing. This data type can be used only in readonly mode, no writing is allowed AccountResource: type: object properties: companyName: type: string federatedName: type: string id: type: string mainNumber: $ref: '#/definitions/PhoneNumberResource' PhoneNumberResource: type: object properties: formattedPhoneNumber: type: string phoneNumber: type: string type: type: string label: type: string description: Custom user name of a phone number, if any usageType: type: string enum: - MobileNumber - ContactNumber - DirectNumber - ForwardedNumber description: Usage type of a phone number AccountDirectoryProfileImageResource: type: object properties: etag: type: string uri: type: string DetailedExtensionPresenceWithSIPEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/DetailedExtensionPresenceWithSIPEventBody' PresenceInfoResource: type: object properties: userStatus: type: string enum: - Offline - Busy - Available dndStatus: type: string enum: - TakeAllCalls - DoNotAcceptDepartmentCalls - TakeDepartmentCallsOnly - DoNotAcceptAnyCalls - Unknown message: type: string minLength: 0 maxLength: 75 allowSeeMyPresence: type: boolean default: false ringOnMonitoredCall: type: boolean default: false pickUpCallsOnHold: type: boolean default: false activeCalls: type: array items: $ref: '#/definitions/ActiveCallInfo' IncomingCallEvent: type: object properties: aps: description: Apple Push Notification Service Info $ref: '#/definitions/APSInfo' event: type: string description: Event filter URI uuid: type: string description: Universally unique identifier of a notification subscriptionId: type: string description: Internal identifier of a subscription timestamp: type: string description: The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z format: date-time extensionId: type: string description: Internal identifier of an extension default: "~" action: type: string description: Calling action, for example 'StartRing' sessionId: type: string description: Identifier of a call session serverId: type: string description: Identifier of a server from: type: string description: Phone number of a caller. For GCM transport type '_from' property should be used fromName: type: string description: Caller name to: type: string description: Phone number of a callee toName: type: string description: Callee name sid: type: string description: Unique identifier of a session toUrl: type: string description: SIP proxy registration name srvLvl: type: string description: User data srvLvlExt: type: string description: User data recUrl: type: string description: File containing recorded caller name pn_ttl: type: integer description: Notification lifetime value in seconds, the default value is 30 seconds ownerId: type: string description: Internal identifier of a subscription owner extension ExtensionPresenceEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/ExtensionPresenceEventBody' DetailedExtensionPresenceEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/DetailedExtensionPresenceEventBody' MissedCallEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification pn_apns: description: APNS service info $ref: '#/definitions/APNSInfo' event: type: string description: Event filter URI subscriptionId: type: string description: Internal identifier of a subscription timestamp: type: string description: The datetime of a call action in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z format: date-time extensionId: type: string description: Internal identifier of an extension default: "~" action: type: string description: Calling action, for example 'StartRing' sessionId: type: string description: Identifier of a call session serverId: type: string description: Identifier of a server from: type: string description: Phone number of a caller. For GCM transport type '_from' property should be used fromName: type: string description: Caller name to: type: string description: Phone number of a callee toName: type: string description: Callee name sid: type: string description: Unique identifier of a session toUrl: type: string description: SIP proxy registration name srvLvl: type: string description: User data srvLvlExt: type: string description: User data recUrl: type: string description: File containing recorded caller name pn_ttl: type: integer description: Notification lifetime value in seconds, the default value is 30 seconds ownerId: type: string description: Internal identifier of a subscription owner extension GetPresenceInfo: type: object properties: uri: type: string description: Canonical URI of a presence info resource allowSeeMyPresence: type: boolean description: If 'True' enables other extensions to see the extension presence status dndStatus: type: string description: Extended DnD (Do not Disturb) status. Cannot be set for Department/Announcement/Voicemail (Take Messages Only)/Fax User/Shared Lines Group/Paging Only Group/IVR Menu/Application Extension/Park Location extensions. The 'DoNotAcceptDepartmentCalls' and 'TakeDepartmentCallsOnly' values are applicable only for extensions - members of a Department; if these values are set for department outsiders, the 400 Bad Request error code is returned. The 'TakeDepartmentCallsOnly' status can be set through the old RingCentral user interface and is available for some migrated accounts only. enum: - TakeAllCalls - DoNotAcceptAnyCalls - DoNotAcceptDepartmentCalls - TakeDepartmentCallsOnly extension: description: Information on extension, for which this presence data is returned $ref: '#/definitions/GetPresenceExtensionInfo' message: type: string description: Custom status message (as previously published by user) pickUpCallsOnHold: type: boolean description: If 'True' enables the extension user to pick up a monitored line on hold presenceStatus: type: string description: Aggregated presence status, calculated from a number of sources enum: - Offline - Busy - Available ringOnMonitoredCall: type: boolean description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing telephonyStatus: type: string description: Telephony presence status enum: - NoCall - CallConnected - Ringing - OnHold - ParkedCall userStatus: type: string description: User-defined presence status (as previously published by the user) enum: - Offline - Busy - Available meetingStatus: type: string description: RingCentral Meetings presence enum: - Connected - Disconnected activeCalls: type: array description: Information on active calls items: $ref: '#/definitions/ActiveCallInfo' AccountPresenceInfo: type: object properties: uri: type: string description: Canonical URI of account presence resource records: type: array description: List of Prompts items: $ref: '#/definitions/GetPresenceInfo' navigation: description: Information on navigation $ref: '#/definitions/PresenceNavigationInfo' paging: description: Information on paging $ref: '#/definitions/PresencePagingInfo' AccountPresenceEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/AccountPresenceEventBody' DetailedExtensionPresenceWithSIPEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension default: "~" telephonyStatus: type: string description: Telephony presence status. Returned if telephony status is changed. enum: - NoCall - CallConnected - Ringing - OnHold - ParkedCall activeCalls: type: array description: List of the latest 7 active calls on extension items: $ref: '#/definitions/ActiveCallInfo' sequence: type: integer description: Order number of a notification to state the chronology presenceStatus: type: string description: Aggregated presence status, calculated from a number of sources enum: - Offline - Busy - Available userStatus: type: string description: User-defined presence status (as previously published by the user) enum: - Offline - Busy - Available dndStatus: type: string description: Extended DnD (Do not Disturb) status enum: - TakeAllCalls - DoNotAcceptAnyCalls - DoNotAcceptDepartmentCalls - TakeDepartmentCallsOnly allowSeeMyPresence: type: boolean description: If 'True' enables other extensions to see the extension presence status ringOnMonitoredCall: type: boolean description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing pickUpCallsOnHold: type: boolean description: If 'True' enables the extension user to pick up a monitored line on hold totalActiveCalls: type: integer description: Total number of active calls on extension at the present moment ownerId: type: string description: Internal identifier of a subscription owner extension ActiveCallInfo: type: object properties: id: type: string direction: type: string enum: - Inbound - Outbound from: type: string description: Phone number or extension number of a caller. For GCM transport type '_from' property should be used fromName: type: string description: Name of a caller to: type: string description: Phone number or extension number of a callee toName: type: string description: Name of a callee startTime: type: string description: Time when the call is actually started telephonyStatus: type: string sipData: $ref: '#/definitions/DetailedCallInfo' sessionId: type: string terminationType: type: string ExtensionPresenceEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension. Optional parameter default: "~" telephonyStatus: type: string description: Telephony presence status. Returned if telephony status is changed. enum: - NoCall - CallConnected - Ringing - OnHold - ParkedCall sequence: type: integer description: Order number of a notification to state the chronology presenceStatus: type: string description: Aggregated presence status, calculated from a number of sources enum: - Offline - Busy - Available userStatus: type: string description: User-defined presence status (as previously published by the user) enum: - Offline - Busy - Available dndStatus: type: string description: Extended DnD (Do not Disturb) status enum: - TakeAllCalls - DoNotAcceptAnyCalls - DoNotAcceptDepartmentCalls - TakeDepartmentCallsOnly allowSeeMyPresence: type: boolean description: If 'True' enables other extensions to see the extension presence status ringOnMonitoredCall: type: boolean description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing pickUpCallsOnHold: type: boolean description: If 'True' enables the extension user to pick up a monitored line on hold ownerId: type: string description: Internal identifier of a subscription owner extension DetailedExtensionPresenceEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension default: "~" telephonyStatus: type: string description: Telephony presence status. Returned if telephony status is changed. enum: - NoCall - CallConnected - Ringing - OnHold - ParkedCall activeCalls: type: array description: List of the latest 7 active calls on extension items: $ref: '#/definitions/ActiveCallInfoWithoutSIP' sequence: type: integer description: Order number of a notification to state the chronology presenceStatus: type: string description: Aggregated presence status, calculated from a number of sources enum: - Offline - Busy - Available userStatus: type: string description: User-defined presence status (as previously published by the user) enum: - Offline - Busy - Available dndStatus: type: string description: Extended DnD (Do not Disturb) status enum: - TakeAllCalls - DoNotAcceptAnyCalls - DoNotAcceptDepartmentCalls - TakeDepartmentCallsOnly allowSeeMyPresence: type: boolean description: If 'True' enables other extensions to see the extension presence status ringOnMonitoredCall: type: boolean description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing pickUpCallsOnHold: type: boolean description: If 'True' enables the extension user to pick up a monitored line on hold totalActiveCalls: type: integer description: Total number of active calls on extension at the present moment ownerId: type: string description: Internal identifier of a subscription owner extension APNSInfo: type: object properties: aps: description: Notification priority data $ref: '#/definitions/APSInfo' GetPresenceExtensionInfo: type: object properties: id: type: string description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension extensionNumber: type: string description: Extension number (usually 3 or 4 digits) PresencePagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons APSInfo: type: object properties: content-available: type: integer description: If the value is '1' then notification is turned on even if the application is in background default: 1 PresenceNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/PresenceNavigationInfoURI' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/PresenceNavigationInfoURI' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/PresenceNavigationInfoURI' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/PresenceNavigationInfoURI' AccountPresenceEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension. Optional parameter default: "~" telephonyStatus: type: string description: Telephony presence status. Returned if telephony status is changed. enum: - NoCall - CallConnected - Ringing - OnHold - ParkedCall sequence: type: integer description: Order number of a notification to state the chronology presenceStatus: type: string description: Aggregated presence status, calculated from a number of sources enum: - Offline - Busy - Available userStatus: type: string description: User-defined presence status (as previously published by the user) enum: - Offline - Busy - Available dndStatus: type: string description: Extended DnD (Do not Disturb) status enum: - TakeAllCalls - DoNotAcceptAnyCalls - DoNotAcceptDepartmentCalls - TakeDepartmentCallsOnly allowSeeMyPresence: type: boolean description: If 'True' enables other extensions to see the extension presence status ringOnMonitoredCall: type: boolean description: If 'True' enables to ring extension phone, if any user monitored by this extension is ringing pickUpCallsOnHold: type: boolean description: If 'True' enables the extension user to pick up a monitored line on hold ownerId: type: string description: Internal identifier of a subscription owner extension PresenceNavigationInfoURI: type: object properties: uri: type: string DetailedCallInfo: type: object properties: callId: type: string toTag: type: string fromTag: type: string remoteUri: type: string localUri: type: string rcSessionId: type: string ActiveCallInfoWithoutSIP: type: object properties: id: type: string description: Internal identifier of a call direction: type: string description: Call direction enum: - Inbound - Outbound from: type: string description: Phone number or extension number of a caller. For GCM transport type '_from' property should be used fromName: type: string description: Name of a caller to: type: string description: Phone number or extension number of a callee toName: type: string description: Name of a callee startTime: type: string description: Time when the call is actually started telephonyStatus: type: string description: Telephony call status enum: - NoCall - CallConnected - Ringing - OnHold - ParkedCall sessionId: type: string description: Internal identifier of a call session terminationType: type: string description: Type of call termination. Supported for calls in 'NoCall' status. If the returned termination type is 'intermediate' it means the call is not actually ended, the connection is established on one of the devices enum: - final - intermediate GlipWebhookList: type: object properties: records: type: array items: $ref: '#/definitions/GlipWebhookInfo' GlipPatchTeamBody: type: object properties: public: type: boolean description: Team access level name: type: string description: Team name. Maximum number of characters supported is 250 description: type: string description: Team description. Maximum number of characters supported is 1000 GlipPostsList: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipPostInfo' description: List of posts navigation: $ref: '#/definitions/GlipNavigationInfo' GlipMessageAttachmentInfoRequest: type: object properties: type: type: string description: Type of attachment enum: - Card - Event - Note default: Card title: type: string description: Attachment title fallback: type: string description: Default message returned in case the client does not support interactive messages color: type: string description: Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card. The default color is 'Black' intro: type: string description: Introductory text displayed directly above a message author: description: Information about the author $ref: '#/definitions/GlipMessageAttachmentAuthorInfo' text: type: string description: Text of attachment (up to 1000 chars), supports GlipDown imageUri: type: string description: Link to an image displayed at the bottom of a message thumbnailUri: type: string description: Link to an image preview displayed to the right of a message (82x82) fields: type: array description: Individual subsections within a message items: $ref: '#/definitions/GlipMessageAttachmentFieldsInfo' footnote: description: Message footer information $ref: '#/definitions/GlipMessageAttachmentFootnoteInfo' startTime: type: string description: Datetime of starting an event endTime: type: string description: Datetime of ending an event allDay: type: boolean description: Indicates whether an event has some specific time slot or lasts for the whole day(s) default: false recurrence: type: string description: 'Event recurrence settings. For non-periodic events the value is ''None''. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year' enum: - None - Day - Weekday - Week - Month - Year endingCondition: type: string description: Condition of ending an event GlipEveryoneInfo: type: object properties: id: type: string description: Internal identifier of a chat type: type: string enum: - Everyone description: Type of a chat name: type: string description: Chat name description: type: string description: Chat description creationTime: type: string format: date-time description: Chat creation datetime in ISO 8601 format lastModifiedTime: type: string format: date-time description: Chat last change datetime in ISO 8601 format GlipCompany: type: object required: - id - creationTime - lastModifiedTime properties: id: type: string description: Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to name: type: string description: Name of a company domain: type: string description: Domain name of a company creationTime: type: string description: Datetime of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format lastModifiedTime: type: string description: Datetime of last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format GlipCreateGroup: type: object required: - type properties: type: type: string enum: - PrivateChat - Team description: Type of a group to be created. 'PrivateChat' is a group of 2 members. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user isPublic: type: boolean description: For 'Team' group type only. Team access level name: type: string description: For 'Team' group type only. Team name description: type: string description: For 'Team' group type only. Team description members: type: array items: type: string description: Identifier(s) of group members. For 'PrivateChat' group type 2 members only are supported GlipPatchPostBody: type: object properties: text: type: string description: Post text. GlipChatsList: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipChatInfo' description: List of chats navigation: $ref: '#/definitions/GlipNavigationInfo' GlipConversationsList: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipConversationInfo' description: List of conversations navigation: $ref: '#/definitions/GlipNavigationInfo' GlipChatsListWithoutNavigation: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipChatInfo' description: List of chats GlipEventCreate: type: object required: - title - startTime - endTime properties: id: type: string description: Internal identifier of an event creatorId: type: string description: Internal identifier of a person created an event title: type: string description: Event title startTime: type: string description: Datetime of starting an event endTime: type: string description: Datetime of ending an event allDay: type: boolean description: Indicates whether event has some specific time slot or lasts for whole day(s) default: false recurrence: type: string description: 'Event recurrence settings. For non-periodic events the value is ''None''. Must be greater or equal to event duration: 1- Day/Weekday; 7 - Week; 28 - Month; 365 - Year' enum: - None - Day - Weekday - Week - Month - Year endingCondition: type: string description: Condition of ending endingAfter: type: integer description: Count of iterations. For periodic events only. Value range is 1 - 10. Must be specified if 'endingCondition' is 'Count' endingOn: type: string enum: - None - Count - Date default: None description: Iterations end datetime for periodic events. color: type: string description: Color of Event title (including its presentation in Calendar) enum: - Black - Red - Orange - Yellow - Green - Blue - Purple - Magenta default: Black location: type: string description: Event location description: type: string description: Event details GlipPersonInfo: type: object required: - id properties: id: type: string description: Internal identifier of a user firstName: type: string description: First name of a user lastName: type: string description: Last name of a user email: type: string description: Email of a user avatar: type: string description: Photo of a user companyId: type: string description: Internal identifier of a company creationTime: type: string format: date-time description: Time of creation in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format lastModifiedTime: type: string format: date-time description: Time of the last modification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format GlipPreferencesInfo: type: object properties: chats: $ref: '#/definitions/GlipPreferencesChats' GlipGroupInfo: type: object properties: id: type: string description: Internal identifier of a group type: type: string description: Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user enum: - PrivateChat - Group - Team - PersonalChat isPublic: type: boolean description: For 'Team' group type only. Team access level name: type: string description: For 'Team' group type only. Team name description: type: string description: For 'Team' group type only. Team description members: type: array items: type: string description: Identifier(s) of group members creationTime: type: string format: date-time description: Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format lastModifiedTime: type: string format: date-time description: Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format CreateGlipConversationRequest: type: object required: - members properties: members: description: 'Identifier(s) of chat member(s). The maximum supported number of IDs is 15. User''s own ID is optional. If `members` section is omitted then ''Personal'' chat will be returned ' type: array items: type: object properties: id: type: string description: Internal identifier of a person email: type: string description: Email of a person GlipTeamsList: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipTeamInfo' description: List of teams navigation: $ref: '#/definitions/GlipNavigationInfo' GlipCreatePost: type: object properties: title: type: string description: Title of a message. (Can be set for bot's messages only). text: type: string description: Text of a post maximum: 1000 groupId: type: string description: Internal identifier of a group attachments: type: array items: $ref: '#/definitions/GlipMessageAttachmentInfoRequest' description: List of attachments to be posted GlipMessageAttachmentInfo: type: object properties: id: type: string description: Internal identifier of an attachment type: type: string description: Type of an attachment enum: - Card - Event - Note default: Card fallback: type: string description: A string of default text that will be rendered in the case that the client does not support Interactive Messages intro: type: string description: A pretext to the message author: description: Information about the author $ref: '#/definitions/GlipMessageAttachmentAuthorInfo' title: type: string description: Message title text: type: string description: A large string field (up to 1000 chars) to be displayed as the body of a message (Supports GlipDown) imageUri: type: string description: url used to display a single image at the bottom of a message thumbnailUri: type: string description: url used to display a thumbnail to the right of a message (82x82) fields: type: array description: Information on navigation items: $ref: '#/definitions/GlipMessageAttachmentFieldsInfo' footnote: description: Message Footer $ref: '#/definitions/GlipMessageAttachmentFootnoteInfo' creatorId: type: string description: Internal identifier of a person created an event startTime: type: string description: Datetime of starting an event endTime: type: string description: Datetime of ending an event allDay: type: boolean description: Indicates whether an event has some specific time slot or lasts for the whole day(s) default: false recurrence: type: string description: Event recurrence settings. enum: - None - Day - Weekday - Week - Month - Year endingCondition: type: string description: Condition of ending endingAfter: type: integer description: Count of iterations. For periodic events only endingOn: type: string enum: - None - Count - Date default: None description: Iterations end datetime for periodic events color: type: string description: Color of Event title, including its presentation in Calendar; or the color of the side border of an interactive message of a Card enum: - Black - Red - Orange - Yellow - Green - Blue - Purple - Magenta default: Black location: type: string description: Event location description: type: string description: Event details GlipEventInfo: type: object properties: id: type: string description: Internal identifier of an event creatorId: type: string description: Internal identifier of a person created an event title: type: string description: Event title startTime: type: string description: Datetime of starting an event endTime: type: string description: Datetime of ending an event allDay: type: boolean description: Indicates whether an event has some specific time slot or lasts for the whole day(s) default: false recurrence: type: string description: Event recurrence settings enum: - None - Day - Weekday - Week - Month - Year endingCondition: type: string description: Condition of ending endingAfter: type: integer description: Count of iterations. For periodic events only endingOn: type: string enum: - None - Count - Date default: None description: Iterations end datetime for periodic events color: type: string description: Color of Event title (including its presentation in Calendar) enum: - Black - Red - Orange - Yellow - Green - Blue - Purple - Magenta default: Black location: type: string description: Event location description: type: string description: Event details GlipGroupsEvent: type: object properties: id: type: string description: Internal identifier of a group type: type: string description: Type of a group. 'PrivateChat' is a group of 2 members. 'Group' is a chat of 2 and more participants, the membership cannot be changed after group creation. 'Team' is a chat of 1 and more participants, the membership can be modified in future. 'PersonalChat' is a private chat thread of a user enum: - PrivateChat - Group - Team - PersonalChat isPublic: type: boolean description: For 'Team' group type only. Team access level name: type: string description: For 'Team' group type only. Team name description: type: string description: For 'Team' group type only. Team description members: type: array description: Identifier(s) of group members items: type: string creationTime: type: string format: date-time description: Group creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format lastModifiedTime: type: string format: date-time description: Group last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format eventType: type: string description: Type of a group event. Only the person who joined/was added to a group will receive 'GroupJoined' notification. Only the person who left/was removed from a group will receive 'GroupLeft' notification enum: - GroupRenamed - GroupJoined - GroupLeft - GroupChanged EditGroupRequest: type: object properties: addedPersonIds: type: array items: type: string description: List of users to be added to a team addedPersonEmails: type: array items: type: string description: List of user email addresses to be added to a team (i.e. as guests) removedPersonIds: type: array items: type: string description: List of users to be removed from a team GlipPostTeamBody: type: object required: - name properties: public: type: boolean description: Team access level. name: type: string description: Team name. description: type: string description: Team description. members: description: Identifier(s) of team members. type: array items: type: object properties: id: type: string description: Internal identifier of a person email: type: string description: Email of a person GlipTeamInfo: type: object properties: id: type: string description: Internal identifier of a team type: type: string enum: - Team description: Type of a chat public: type: boolean description: Team access level name: type: string description: Team name description: type: string description: Team description status: type: string enum: - Active - Archived description: Team status creationTime: type: string format: date-time description: Team creation datetime in ISO 8601 format lastModifiedTime: type: string format: date-time description: Team last change datetime in ISO 8601 format UpdateGlipEveryoneRequest: type: object properties: name: type: integer description: Everyone chat name. Maximum number of characters supported is 250 description: type: string description: Everyone chat description. Maximum number of characters supported is 1000 GlipPostPostBody: type: object required: - text properties: text: type: string description: Post text. attachments: description: Identifier(s) of attachments. type: array items: type: object properties: id: type: string description: Internal identifier of an attachment type: type: string description: Attachment type GlipPosts: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipPostInfo' description: List of posts navigation: $ref: '#/definitions/GlipNavigationInfo' GlipWebhookInfo: type: object properties: id: type: string description: Internal identifier of a webhook creatorId: type: string description: Internal identifier of the user who created a webhook groupIds: type: array description: Internal identifiers of groups where a webhook has been created items: type: string creationTime: type: string description: Webhook creation time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format format: date-time lastModifiedTime: type: string description: Webhook last update time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format format: date-time uri: type: string description: Public link to send a webhook payload status: type: string description: Current status of a webhook enum: - Active - Suspended - Deleted GlipChatInfo: type: object properties: id: type: string description: Internal identifier of a chat type: type: string enum: - Everyone - Team - Group - Direct - Personal description: Type of a chat public: type: boolean description: For 'Team' chat type only. Team access level. name: type: string description: For 'Team','Everyone' chats types only. Chat name. description: type: string description: For 'Team','Everyone' chats types only. Chat description. status: type: string enum: - Active - Archived description: For 'Team' chat type only. Team status. creationTime: type: string format: date-time description: Chat creation datetime in ISO 8601 format lastModifiedTime: type: string format: date-time description: Chat last change datetime in ISO 8601 format members: type: array items: $ref: '#/definitions/GlipChatMemberInfo' GlipConversationInfo: type: object properties: id: type: string description: Internal identifier of a conversation type: type: string enum: - Direct - Personal - Group description: Type of a conversation creationTime: type: string format: date-time description: Conversation creation datetime in ISO 8601 format lastModifiedTime: type: string format: date-time description: Conversation last change datetime in ISO 8601 format members: type: array items: $ref: '#/definitions/GlipChatMemberInfo' GlipPostMembersIdsListBody: type: object required: - members properties: members: description: Identifier(s) of chat members. type: array items: type: object properties: id: type: string description: Internal identifier of a person GlipEventsInfo: type: object properties: records: type: array items: $ref: '#/definitions/GlipEventInfo' description: List of events created by the current user navigation: $ref: '#/definitions/GlipNavigationInfo' GlipGroupList: type: object required: - records properties: records: type: array items: $ref: '#/definitions/GlipGroupInfo' description: List of groups/teams/private chats navigation: $ref: '#/definitions/GlipNavigationInfo' GlipPostMembersListBody: type: object required: - members properties: members: description: Identifier(s) of chat member(s) type: array items: type: object properties: id: type: string description: Internal identifier of a person email: type: string description: Email of a person description: Conversation is opened GlipPostInfo: type: object properties: id: type: string description: Internal identifier of a post groupId: type: string description: Internal identifier of a group a post belongs to type: type: string enum: - TextMessage - PersonJoined - PersonsAdded description: Type of a post text: type: string description: For 'TextMessage' post type only. Text of a message creatorId: type: string description: Internal identifier of a user - author of a post addedPersonIds: type: array items: type: string description: For 'PersonsAdded' post type only. Identifiers of persons added to a group creationTime: type: string format: date-time description: Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format lastModifiedTime: type: string format: date-time description: Post last modification datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format attachments: type: array items: $ref: '#/definitions/GlipMessageAttachmentInfo' description: List of posted attachments mentions: type: array items: $ref: '#/definitions/GlipMentionsInfo' activity: type: string description: Label of activity type title: type: string description: Title of a message. (Can be set for bot's messages only) iconUri: type: string description: Link to an image used as an icon for this message iconEmoji: type: string description: Emoji used as an icon for this message GlipPostEvent: type: object properties: id: type: string description: Internal identifier of a post eventType: type: string description: Type of a post event enum: - PostAdded - PostChanged - PostRemoved groupId: type: string description: Internal identifier of a group a post belongs to type: type: string description: Type of a post. 'TextMessage' - an incoming text message; 'PersonJoined' - a message notifying that person has joined a conversation; 'PersonsAdded' - a message notifying that a person(s) were added to a conversation enum: - TextMessage - PersonJoined - PersonsAdded - Card text: type: string description: For 'TextMessage' post type only. Message text creatorId: type: string description: Internal identifier of a user - author of a post addedPersonIds: type: array description: For PersonsAdded post type only. Identifiers of persons added to a group items: type: string removedPersonIds: type: array description: For PersonsRemoved post type only. Identifiers of persons removed from a group items: type: string mentions: type: array description: List of at mentions in post text with names. items: $ref: '#/definitions/GlipMentionsInfo' creationTime: type: string format: date-time description: Post creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format lastModifiedTime: type: string format: date-time description: Post last change datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format GlipPreferencesChats: type: object properties: maxCount: type: integer default: 10 leftRailMode: type: string default: CombineAllChatTypes enum: - SeparateAllChatTypes - SeparateConversationsAndTeams - CombineAllChatTypes GlipChatMemberInfo: type: object properties: id: type: string description: Internal identifier of a user GlipMentionsInfo: type: object properties: id: type: string description: Internal identifier of a user type: type: string description: Type of mentions enum: - Person - Team - File - Link - Event - Task - Note - Card name: type: string description: Name of a user GlipNavigationInfo: type: object properties: prevPageToken: type: string description: Previous page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens nextPageToken: type: string description: Next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens GlipMessageAttachmentAuthorInfo: type: object properties: name: type: string description: Name of a message author uri: type: string description: Link to an author's name iconUri: type: string description: Link to an image displayed to the left of an author's name; sized 82x82px GlipMessageAttachmentFieldsInfo: type: object properties: title: type: string description: Title of an individual field value: type: string description: Value of an individual field (supports Markdown) style: type: string description: Style of width span applied to a field default: Short enum: - Short - Long GlipMessageAttachmentFootnoteInfo: type: object properties: text: type: string description: Text of a footer iconUri: type: string description: Link to an icon displayed to the left of a footer; sized 32x32px time: type: string description: Message creation datetime in ISO 8601 format including timezone, for example *2016-03-10T18:07:52.534Z* format: date-time MeetingsResource: type: object properties: uri: type: string format: uri records: type: array items: $ref: '#/definitions/MeetingResponseResource' paging: $ref: '#/definitions/MeetingsPagingInfo' navigation: $ref: '#/definitions/MeetingsNavigationInfo' MeetingRequestResource: type: object properties: topic: type: string meetingType: type: string schedule: $ref: '#/definitions/MeetingScheduleResource' password: type: string host: $ref: '#/definitions/HostInfoRequest' allowJoinBeforeHost: type: boolean default: false startHostVideo: type: boolean default: false startParticipantsVideo: type: boolean default: false usePersonalMeetingId: type: boolean audioOptions: type: array items: type: string MeetingResponseResource: type: object properties: uri: type: string format: uri uuid: type: string id: type: string topic: type: string meetingType: type: string password: type: string h323Password: type: string status: type: string links: $ref: '#/definitions/MeetingLinks' schedule: $ref: '#/definitions/MeetingScheduleResource' host: $ref: '#/definitions/HostInfoRequest' allowJoinBeforeHost: type: boolean default: false startHostVideo: type: boolean default: false startParticipantsVideo: type: boolean default: false audioOptions: type: array items: type: string MeetingServiceInfoResource: type: object properties: uri: type: string format: uri supportUri: type: string intlDialInNumbersUri: type: string externalUserInfo: $ref: '#/definitions/MeetingExternalUserInfoResource' dialInNumbers: type: array items: $ref: '#/definitions/DialInNumberResource' AssistantsResource: type: object properties: records: type: array items: $ref: '#/definitions/AssistantResource' AssistedUsersResource: type: object properties: records: type: array items: $ref: '#/definitions/AssistedUserResource' AssistantResource: type: object properties: id: type: string name: type: string AssistedUserResource: type: object properties: id: type: string name: type: string MeetingsNavigationInfo: type: object properties: nextPage: $ref: '#/definitions/MeetingsNavigationInfoUri' previousPage: $ref: '#/definitions/MeetingsNavigationInfoUri' firstPage: $ref: '#/definitions/MeetingsNavigationInfoUri' lastPage: $ref: '#/definitions/MeetingsNavigationInfoUri' MeetingScheduleResource: type: object properties: startTime: type: string durationInMinutes: type: integer format: int32 timeZone: $ref: '#/definitions/TimezoneResource' HostInfoRequest: type: object properties: id: type: string description: Internal identifier of an extension which is assigned to be a meeting host. The default value is currently logged-in extension identifier DialInNumberResource: type: object properties: phoneNumber: type: string formattedNumber: type: string location: type: string country: $ref: '#/definitions/CountryResource' MeetingsPagingInfo: type: object properties: page: type: integer format: int32 totalPages: type: integer format: int32 perPage: type: integer format: int32 totalElements: type: integer format: int32 pageStart: type: integer format: int32 pageEnd: type: integer format: int32 MeetingLinks: type: object properties: startUri: type: string joinUri: type: string MeetingExternalUserInfoResource: type: object properties: uri: type: string format: uri userId: type: string accountId: type: string userType: type: integer format: int64 userToken: type: string hostKey: type: string personalMeetingId: type: string MeetingsNavigationInfoUri: type: object properties: uri: type: string format: uri TimezoneResource: type: object properties: uri: type: string format: uri id: type: string name: type: string description: type: string CountryResource: type: object properties: uri: type: string format: uri id: type: string name: type: string isoCode: type: string callingCode: type: string emergencyCalling: type: boolean default: false numberSelling: type: boolean default: false loginAllowed: type: boolean default: false CreateSubscriptionRequest: type: object required: - deliveryMode - eventFilters properties: eventFilters: type: array description: Collection of URIs to API resources. For APNS transport type only message event filter is available items: type: string deliveryMode: description: Notification delivery settings $ref: '#/definitions/NotificationDeliveryModeRequest' expiresIn: type: integer description: Subscription lifetime in seconds. Max value is 7 days (604800 sec). For *WebHook* transport type max value might be set up to 630720000 seconds (20 years) default: 604800 SubscriptionInfo: type: object required: - deliveryMode properties: id: type: string description: Internal identifier of a subscription uri: type: string description: Canonical URI of a subscription eventFilters: type: array description: Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is subscribed to items: type: string disabledFilters: type: array description: Collection of API resources (message-store/presence/detailed presence) corresponding to events the user is not subscribed to due to certain limitations items: $ref: '#/definitions/DisabledFilterInfo' expirationTime: type: string format: date-time description: Subscription expiration datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z expiresIn: type: integer description: Subscription lifetime in seconds default: 900 status: type: string description: Subscription status enum: - Active - Suspended - Blacklisted creationTime: type: string format: date-time description: Subscription creation datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example 2016-03-10T18:07:52.534Z deliveryMode: description: Delivery mode data $ref: '#/definitions/NotificationDeliveryMode' blacklistedData: $ref: '#/definitions/NotificationBlacklistedData' ModifySubscriptionRequest: type: object required: - eventFilters properties: eventFilters: type: array description: Collection of URIs to API resources items: type: string deliveryMode: description: Notification delivery settings $ref: '#/definitions/NotificationDeliveryModeRequest' expiresIn: type: integer description: Subscription lifetime in seconds. Max value is 7 days (604800 sec). For *WebHook* transport type max value might be set up to 630720000 seconds (20 years) default: 604800 RecordsCollectionResourceSubscriptionResponse: type: object properties: uri: type: string format: uri records: type: array items: $ref: '#/definitions/SubscriptionInfo' NotificationDeliveryMode: type: object properties: transportType: type: string description: Notifications transportation provider name. 'APNS' (Apple Push Notifications Service) enum: - PubNub - APNS - PubNub/APNS/VoIP encryption: type: boolean description: 'Optional parameter. Specifies if the message will be encrypted or not. For APNS transport type the value is always false ' address: type: string description: 'PubNub channel name. For APNS transport type - internal identifier of a device device_token ' subscriberKey: type: string description: PubNub subscriber credentials required to subscribe to the channel secretKey: type: string description: PubNub subscriber credentials required to subscribe to the channel. Optional (for PubNub transport type only) encryptionAlgorithm: type: string description: Encryption algorithm 'AES' (for PubNub transport type only) encryptionKey: type: string description: Key for notification message decryption (for PubNub transport type only) NotificationBlacklistedData: description: Returned if WebHook subscription is blacklisted type: object properties: blacklistedAt: type: string format: date-time description: Time of adding subscrition to a black list in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* reason: type: string description: Reason of adding subscrition to a black list NotificationDeliveryModeRequest: type: object properties: transportType: type: string description: Notifications transportation provider name. 'APNS' (Apple Push Notifications Service) enum: - PubNub - WebHook - APNS - PubNub/APNS - PubNub/GCM address: type: string description: Mandatory for 'APNS' and 'WebHook' transport types. For 'APNS' - internal identifier of a device 'device_token' for 'WebHook' - URL of a consumer service (cannot be changed during subscription update) encryption: type: boolean description: Optional parameter. Specifies if the message will be encrypted or not. If request contains any presence event filter the value by default is 'True' (even if specified as 'false'). If request contains only message event filters the value by default is 'False' certificateName: type: string description: For 'PubNub/APNS', 'APNS' and 'PubNub/GCM' transport types. Name of a certificate registrationId: type: string description: For 'PubNub/APNS' and 'PubNub/GCM' transport types. Identifier of a registration verificationToken: type: string description: For 'Webhook' transport type. Subscription verification key ensuring data security DisabledFilterInfo: type: object properties: filter: type: string description: Event filter that is disabled for the user reason: type: string description: Reason why the filter is disabled for the user message: type: string description: Error message AuthProfileCheckResource: type: object properties: uri: type: string format: uri successful: type: boolean default: false details: $ref: '#/definitions/ActivePermissionResource' AuthProfileResource: type: object properties: uri: type: string format: uri permissions: type: array items: $ref: '#/definitions/ActivePermissionResource' ActivePermissionResource: type: object properties: permission: $ref: '#/definitions/PermissionIdResource' effectiveRole: $ref: '#/definitions/RoleIdResource' scopes: type: array items: type: string RoleIdResource: type: object properties: uri: type: string format: uri id: type: string PermissionIdResource: type: object properties: uri: type: string format: uri id: type: string siteCompatible: type: string enum: - Compatible - Incompatible - Independent description: Site compatibility flag set for permission CustomUserGreetingInfo: type: object properties: uri: type: string description: Link to a custom user greeting id: type: string description: Internal identifier of a custom user greeting type: type: string description: Type of a custom user greeting enum: - Introductory - Announcement - ConnectingAudio - ConnectingMessage - Voicemail - Unavailable - HoldMusic contentType: type: string description: Content media type in WAV/MP3 format enum: - WAV - MP3 contentUri: type: string description: Link to a greeting content (audio file) answeringRule: description: Information on an answering rule that the greeting is applied to $ref: '#/definitions/CustomGreetingAnsweringRuleInfo' CallerBlockingSettingsUpdate: type: object description: Returns the lists of blocked and allowed phone numbers properties: mode: type: string enum: - Specific - All description: 'Call blocking options: either specific or all calls and faxes' noCallerId: description: Determines how to handle calls with no caller ID in 'Specific' mode type: string enum: - BlockCallsAndFaxes - BlockFaxes - Allow payPhones: type: string enum: - Block - Allow description: Blocking settings for pay phones greetings: type: array description: List of greetings played for blocked callers items: $ref: '#/definitions/BlockedCallerGreetingInfo' UpdateForwardingNumberRequest: type: object properties: phoneNumber: type: string description: Forwarding/Call flip phone number label: type: string description: Forwarding/Call flip number title flipNumber: type: string description: Number assigned to the call flip phone number, corresponds to the shortcut dial number type: type: string description: Forwarding phone number type enum: - Home - Mobile - Work - PhoneLine - Outage - Other UpdateAnsweringRuleRequest: type: object properties: forwarding: description: Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded $ref: '#/definitions/ForwardingInfoCreateRuleRequest' enabled: type: boolean description: Specifies if the rule is active or inactive. The default value is 'True' name: type: string description: Name of an answering rule specified by user callers: type: array description: Answering rule will be applied when calls are received from the specified caller(s) items: $ref: '#/definitions/CallersInfoRequest' calledNumbers: type: array description: Answering rules are applied when calling to selected number(s) items: $ref: '#/definitions/CalledNumberInfo' schedule: description: Schedule when an answering rule should be applied $ref: '#/definitions/ScheduleInfo' callHandlingAction: type: string description: Specifies how incoming calls are forwarded enum: - ForwardCalls - UnconditionalForwarding - AgentQueue - TransferToExtension - TakeMessagesOnly - PlayAnnouncementOnly unconditionalForwarding: description: Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction' $ref: '#/definitions/UnconditionalForwardingInfo' queue: description: Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action $ref: '#/definitions/QueueInfo' voicemail: description: Specifies whether to take a voicemail and who should do it $ref: '#/definitions/VoicemailInfo' greetings: type: array description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List items: $ref: '#/definitions/GreetingInfo' screening: type: string description: Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' enum: - "Off" - NoCallerId - UnknownCallerId - Always showInactiveNumbers: type: boolean description: Indicates whether inactive numbers should be returned or not. CompanyAnsweringRuleInfo: type: object properties: id: type: string description: Internal identifier of an answering rule uri: type: string description: Canonical URI of an answering rule enabled: type: boolean description: Specifies if the rule is active or inactive. The default value is 'True' default: true type: type: string description: Type of an answering rule enum: - BusinessHours - AfterHours - Custom default: Custom name: type: string description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number callers: type: array description: Answering rule will be applied when calls are received from the specified caller(s) items: $ref: '#/definitions/CompanyAnsweringRuleCallersInfoRequest' calledNumbers: type: array description: Answering rule will be applied when calling the specified number(s) items: $ref: '#/definitions/CompanyAnsweringRuleCalledNumberInfoRequest' schedule: description: Schedule when an answering rule should be applied $ref: '#/definitions/CompanyAnsweringRuleScheduleInfo' callHandlingAction: type: string description: Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass'] enum: - Operator - Disconnect - Bypass extension: description: Extension to which the call is forwarded in 'Bypass' mode $ref: '#/definitions/CompanyAnsweringRuleCallersInfoRequest' greetings: type: array description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List items: $ref: '#/definitions/GreetingInfo' CompanyAnsweringRuleList: type: object properties: uri: type: string description: Link to an answering rule resource records: type: array description: List of company answering rules items: $ref: '#/definitions/ListCompanyAnsweringRuleInfo' paging: description: Information on paging $ref: '#/definitions/CallHandlingPagingInfo' navigation: description: Information on navigation $ref: '#/definitions/CallHandlingNavigationInfo' AddBlockedAllowedPhoneNumber: type: object description: Updates either blocked or allowed phone number list with a new phone number. properties: phoneNumber: type: string description: A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format label: type: string description: Custom name of a blocked/allowed phone number status: type: string description: Status of a phone number enum: - Blocked - Allowed default: Blocked ForwardingNumberInfo: type: object properties: id: type: string description: Internal identifier of a forwarding/call flip phone number uri: type: string description: Canonical URI of a forwarding/call flip phone number phoneNumber: type: string description: Forwarding/Call flip phone number label: type: string description: Forwarding/Call flip number title features: type: array description: Type of option this phone number is used for. Multiple values are accepted items: type: string enum: - CallFlip - CallForwarding flipNumber: type: integer description: Number assigned to the call flip phone number, corresponds to the shortcut dial number type: type: string description: Forwarding phone number type enum: - Home - Mobile - Work - PhoneLine - Outage - Other CompanyAnsweringRuleUpdate: type: object properties: enabled: type: boolean description: Specifies if the rule is active or inactive. The default value is 'True' default: true name: type: string description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number callers: type: array description: Answering rule will be applied when calls are received from the specified caller(s) items: $ref: '#/definitions/CompanyAnsweringRuleCallersInfoRequest' calledNumbers: type: array description: Answering rule will be applied when calling the specified number(s) items: $ref: '#/definitions/CompanyAnsweringRuleCalledNumberInfo' schedule: description: Schedule when an answering rule should be applied $ref: '#/definitions/CompanyAnsweringRuleScheduleInfoRequest' callHandlingAction: type: string description: Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass'] enum: - Operator - Disconnect - Bypass extension: description: Extension to which the call is forwarded in 'Bypass' mode $ref: '#/definitions/CompanyAnsweringRuleCallersInfoRequest' greetings: type: array description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List items: $ref: '#/definitions/GreetingInfo' CallRecordingSettingsResource: type: object properties: onDemand: $ref: '#/definitions/OnDemandResource' automatic: $ref: '#/definitions/AutomaticRecordingResource' greetings: type: array description: Collection of Greeting Info items: $ref: '#/definitions/GreetingResource' CallRecordingCustomGreetings: type: object description: Returns data on call recording custom greetings. properties: records: type: array items: $ref: '#/definitions/CallRecordingCustomGreeting' UserBusinessHoursUpdateResponse: type: object properties: uri: type: string description: Canonical URI of a business-hours resource schedule: description: Schedule when an answering rule is applied $ref: '#/definitions/UserBusinessHoursScheduleInfo' ForwardingNumberResource: type: object properties: uri: type: string format: uri id: type: string phoneNumber: type: string label: type: string features: type: array items: type: string enum: - CallFlip - CallForwarding flipNumber: type: string pattern: '[1-8]' type: type: string description: Forwarding phone number type enum: - Home - Mobile - Work - PhoneLine - Outage - Other AnsweringRuleInfo: type: object properties: uri: type: string description: Canonical URI to an answering rule resource id: type: string description: Internal identifier of an answering rule type: type: string description: Type of an answering rule enum: - BusinessHours - AfterHours - Custom name: type: string description: Name of an answering rule specified by user enabled: type: boolean description: Specifies if an answering rule is active or inactive schedule: description: Schedule when an answering rule should be applied $ref: '#/definitions/ScheduleInfo' calledNumbers: type: array description: Answering rules are applied when calling to selected number(s) items: $ref: '#/definitions/CalledNumberInfo' callers: type: array description: Answering rules are applied when calls are received from specified caller(s) items: $ref: '#/definitions/CallersInfo' callHandlingAction: type: string description: Specifies how incoming calls are forwarded enum: - ForwardCalls - UnconditionalForwarding - AgentQueue - TransferToExtension - TakeMessagesOnly - PlayAnnouncementOnly forwarding: description: Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded $ref: '#/definitions/ForwardingInfo' unconditionalForwarding: description: Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction' $ref: '#/definitions/UnconditionalForwardingInfo' queue: description: Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action $ref: '#/definitions/QueueInfo' transfer: description: Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action $ref: '#/definitions/TransferredExtensionInfo' voicemail: description: Specifies whether to take a voicemail and who should do it $ref: '#/definitions/VoicemailInfo' greetings: type: array description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List items: $ref: '#/definitions/GreetingInfo' screening: type: string description: Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' enum: - "Off" - NoCallerId - UnknownCallerId - Always PromptInfo: type: object properties: uri: type: string description: Internal identifier of a prompt id: type: string description: Link to a prompt metadata contentType: type: string description: Type of a prompt media content contentUri: type: string description: Link to a prompt media content filename: type: string description: Name of a prompt CallRecordingExtensions: type: object properties: uri: type: string description: Link to call recording extension list resource records: type: array items: $ref: '#/definitions/CallRecordingExtensionInfo' navigation: description: Information on navigation $ref: '#/definitions/CallHandlingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/CallHandlingPagingInfo' CustomCompanyGreetingInfo: type: object properties: uri: type: string description: Link to an extension custom greeting id: type: string description: Internal identifier of an answering rule type: type: string description: Type of a company greeting enum: - Company - StartRecording - StopRecording - AutomaticRecording contentType: type: string description: Content media type in WAV/MP3 format enum: - WAV - MP3 contentUri: type: string description: Link to a greeting content (audio file) answeringRule: description: Information on an answering rule that the greeting is applied to $ref: '#/definitions/CustomGreetingAnsweringRuleInfo' language: description: Information on a greeting language. Supported for types 'StopRecording', 'StartRecording', 'AutomaticRecording' $ref: '#/definitions/CustomCompanyGreetingLanguageInfo' GetUserBusinessHoursResponse: type: object properties: uri: type: string description: Canonical URI of a business-hours resource schedule: description: Schedule when an answering rule is applied $ref: '#/definitions/ScheduleInfoUserBusinessHours' example: uri: https.../restapi/v1.0/account/401800045008/extension/401800045008/business-hours schedule: weeklyRanges: wednesday: - from: "09:00" to: "18:00" friday: - from: "09:00" to: "18:00" tuesday: - from: "09:00" to: "18:00" monday: - from: "09:00" to: "18:00" thursday: - from: "09:00" to: "18:00" UserBusinessHoursUpdateRequest: type: object required: - schedule properties: schedule: description: Schedule when an answering rule is applied $ref: '#/definitions/UserBusinessHoursScheduleInfo' BlockedAllowedPhoneNumberInfo: type: object description: Information on a blocked/allowed phone number properties: uri: type: string description: Link to a blocked/allowed phone number id: type: string description: Internal identifier of a blocked/allowed phone number phoneNumber: type: string description: A blocked/allowed phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format label: type: string description: Custom name of a blocked/allowed phone number status: type: string description: Status of a phone number enum: - Blocked - Allowed GetExtensionForwardingNumberListResponse: type: object properties: records: type: array description: List of forwarding phone numbers items: $ref: '#/definitions/ForwardingNumberInfo' navigation: description: Information on navigation $ref: '#/definitions/CallHandlingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/CallHandlingPagingInfo' DictionaryGreetingList: type: object properties: uri: type: string description: Canonical URI of greetings list resource records: type: array description: List of greetings items: $ref: '#/definitions/DictionaryGreetingInfo' DictionaryGreetingInfo: type: object properties: id: type: string description: Internal identifier of a greeting uri: type: string description: Link to a greeting name: type: string description: Name of a greeting usageType: type: string description: Usage type of a greeting, specifying if the greeting is applied for user extension or department extension. enum: - UserExtensionAnsweringRule - ExtensionAnsweringRule - DepartmentExtensionAnsweringRule - CompanyAnsweringRule - CompanyAfterHoursAnsweringRule - VoicemailExtensionAnsweringRule - AnnouncementExtensionAnsweringRule text: type: string description: Text of a greeting, if any contentUri: type: string description: Link to a greeting content (audio file), if any type: type: string description: Type of a greeting, specifying the case when the greeting is played. enum: - Introductory - Announcement - ConnectingMessage - ConnectingAudio - Voicemail - Unavailable - InterruptPrompt - HoldMusic - Company category: type: string description: Category of a greeting, specifying data form. The category value 'None' specifies that greetings of a certain type ('Introductory', 'ConnectingAudio', etc.) are switched off for an extension = ['Music', 'Message', 'RingTones', 'None'] enum: - Music - Message - RingTones - None navigation: description: Information on navigation $ref: '#/definitions/CallHandlingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/CallHandlingPagingInfo' IVRMenuInfo: type: object properties: id: type: string description: Internal identifier of an IVR Menu extension uri: type: string description: Link to an IVR Menu extension resource name: type: string description: First name of an IVR Menu user extensionNumber: type: string description: Number of an IVR Menu extension prompt: description: Prompt metadata $ref: '#/definitions/IVRMenuPromptInfo' actions: type: array description: Keys handling settings items: $ref: '#/definitions/IVRMenuActionsInfo' BlockedAllowedPhoneNumbersList: type: object description: List of blocked or allowed phone numbers properties: uri: type: string description: Link to a list of blocked/allowed phone numbers resource records: type: array items: $ref: '#/definitions/BlockedAllowedPhoneNumberInfo' navigation: description: Information on navigation $ref: '#/definitions/CallHandlingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/CallHandlingPagingInfo' CreateAnsweringRuleRequest: type: object required: - name - type properties: enabled: type: boolean description: Specifies if the rule is active or inactive. The default value is 'True' type: type: string description: Type of an answering rule. The 'Custom' value should be specified name: type: string description: Name of an answering rule specified by user callers: type: array description: Answering rule will be applied when calls are received from the specified caller(s) items: $ref: '#/definitions/CallersInfoRequest' calledNumbers: type: array description: Answering rules are applied when calling to selected number(s) items: $ref: '#/definitions/CalledNumberInfo' schedule: description: Schedule when an answering rule should be applied $ref: '#/definitions/ScheduleInfo' callHandlingAction: type: string description: Specifies how incoming calls are forwarded enum: - ForwardCalls - UnconditionalForwarding - AgentQueue - TransferToExtension - TakeMessagesOnly - PlayAnnouncementOnly forwarding: description: Forwarding parameters. Returned if 'ForwardCalls' is specified in 'callHandlingAction'. These settings determine the forwarding numbers to which the call will be forwarded $ref: '#/definitions/ForwardingInfo' unconditionalForwarding: description: Unconditional forwarding parameters. Returned if 'UnconditionalForwarding' is specified in 'callHandlingAction' $ref: '#/definitions/UnconditionalForwardingInfo' queue: description: Queue settings applied for department (call queue) extension type, with the 'AgentQueue' value specified as a call handling action $ref: '#/definitions/QueueInfo' transfer: description: Transfer settings applied for department (call queue) extension type, with 'TransferToExtension' call handling action $ref: '#/definitions/TransferredExtensionInfo' voicemail: description: Specifies whether to take a voicemail and who should do it $ref: '#/definitions/VoicemailInfo' greetings: type: array description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List items: $ref: '#/definitions/GreetingInfo' screening: type: string description: Call screening status. 'Off' - no call screening; 'NoCallerId' - if caller ID is missing, then callers are asked to say their name before connecting; 'UnknownCallerId' - if caller ID is not in contact list, then callers are asked to say their name before connecting; 'Always' - the callers are always asked to say their name before connecting. The default value is 'Off' enum: - "Off" - NoCallerId - UnknownCallerId - Always CallerBlockingSettings: type: object description: Returns the lists of blocked and allowed phone numbers properties: mode: type: string enum: - Specific - All description: 'Call blocking options: either specific or all calls and faxes' noCallerId: description: ' Determines how to handle calls with no caller ID in ''Specific'' mode' type: string enum: - BlockCallsAndFaxes - BlockFaxes - Allow payPhones: type: string enum: - Block - Allow description: Blocking settings for pay phones greetings: type: array description: List of greetings played for blocked callers items: $ref: '#/definitions/BlockedCallerGreetingInfo' CreateForwardingNumberRequest: type: object properties: phoneNumber: type: string description: Forwarding/Call flip phone number label: type: string description: Forwarding/Call flip number title type: type: string description: Forwarding/Call flip phone type. If specified, 'label' attribute value is ignored. The default value is 'Other' enum: - PhoneLine - Home - Mobile - Work - Other device: description: Reference to the other extension device. Applicable for 'PhoneLine' type only. Cannot be specified together with 'phoneNumber' parameter. $ref: '#/definitions/CreateForwardingNumberDeviceInfo' UserAnsweringRuleList: type: object properties: uri: type: string description: Canonical URI of an answering rule list resource example: https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100 records: type: array description: List of answering rules items: $ref: '#/definitions/UserAnsweringRuleListRecord' paging: $ref: '#/definitions/UserAnsweringRuleListPaging' navigation: $ref: '#/definitions/UserAnsweringRuleListNavigation' BulkAccountCallRecordingsResource: type: object properties: addedExtensions: $ref: '#/definitions/CallRecordingExtensionResource' updatedExtensions: $ref: '#/definitions/CallRecordingExtensionResource' removedExtensions: $ref: '#/definitions/CallRecordingExtensionResource' CompanyBusinessHours: type: object properties: uri: type: string description: 'Canonical URI of a business-hours resource ' schedule: description: Schedule when an answering rule is applied $ref: '#/definitions/CompanyBusinessHoursScheduleInfo' example: uri: https.../restapi/v1.0/account/401800045008/business-hours schedule: weeklyRanges: wednesday: - from: "09:00" to: "18:00" friday: - from: "09:00" to: "18:00" tuesday: - from: "09:00" to: "18:00" monday: - from: "09:00" to: "18:00" thursday: - from: "09:00" to: "18:00" CompanyBusinessHoursUpdateRequest: type: object properties: schedule: description: Schedule when an answering rule is applied $ref: '#/definitions/CompanyBusinessHoursScheduleInfo' example: schedule: weeklyRanges: tuesday: - from: "09:00" to: "18:00" friday: - from: "09:00" to: "18:00" thursday: - from: "09:00" to: "18:00" wednesday: - from: "09:00" to: "18:00" monday: - from: "09:00" to: "18:00" CompanyAnsweringRuleRequest: type: object properties: name: type: string description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number enabled: type: boolean description: Specifies if the rule is active or inactive. The default value is 'True' default: true type: type: string description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom'] enum: - BusinessHours - AfterHours - Custom callers: type: array description: Answering rule will be applied when calls are received from the specified caller(s) items: $ref: '#/definitions/CompanyAnsweringRuleCallersInfoRequest' calledNumbers: type: array description: Answering rule will be applied when calling the specified number(s) items: $ref: '#/definitions/CompanyAnsweringRuleCalledNumberInfo' schedule: description: Schedule when an answering rule should be applied $ref: '#/definitions/CompanyAnsweringRuleScheduleInfoRequest' callHandlingAction: type: string description: Specifies how incoming calls are forwarded. The default value is 'Operator' 'Operator' - play company greeting and forward to operator extension 'Disconnect' - play company greeting and disconnect 'Bypass' - bypass greeting to go to selected extension = ['Operator', 'Disconnect', 'Bypass'] enum: - Operator - Disconnect - Bypass extension: description: Extension to which the call is forwarded in 'Bypass' mode $ref: '#/definitions/CompanyAnsweringRuleCallersInfoRequest' greetings: type: array description: Greetings applied for an answering rule; only predefined greetings can be applied, see Dictionary Greeting List items: $ref: '#/definitions/GreetingInfo' IVRPrompts: type: object properties: uri: type: string description: Link to prompts library resource records: type: array description: List of Prompts items: $ref: '#/definitions/PromptInfo' navigation: description: Information on navigation $ref: '#/definitions/CallHandlingNavigationInfo' paging: description: Information on paging $ref: '#/definitions/CallHandlingPagingInfo' ForwardingInfoCreateRuleRequest: type: object properties: notifyMySoftPhones: type: boolean description: Specifies if the first ring on desktop/mobile apps is enabled. The default value is 'True' notifyAdminSoftPhones: type: boolean description: Specifies if the administrator's softphone (desktop application) is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'True' softPhonesRingCount: type: integer default: 1 description: Specifies delay between ring on apps and starting of a call forwarding ringingMode: type: string description: Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ringing all at the same time. The default value is 'Sequentially' enum: - Sequentially - Simultaneously rules: type: array description: Information on a call forwarding rule items: $ref: '#/definitions/RuleInfoCreateRuleRequest' mobileTimeout: type: boolean description: Specifies if mobile timeout is activated for the rule CompanyAnsweringRuleCalledNumberInfoRequest: type: object properties: id: type: string description: Internal identifier of an account phone number CompanyAnsweringRuleCalledNumberInfo: type: object properties: id: type: string description: Internal identifier of an account phone number UserAnsweringRuleListPaging: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) example: 1 totalPages: type: integer description: The total number of pages in a dataset. example: 1 perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied example: 100 totalElements: type: integer description: The total number of elements in a dataset. example: 1 pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty example: 0 pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty example: 0 CompanyBusinessHoursScheduleInfo: type: object properties: weeklyRanges: $ref: '#/definitions/WeeklyScheduleInfo' UserBusinessHoursScheduleInfo: type: object properties: weeklyRanges: description: Weekly schedule $ref: '#/definitions/WeeklyScheduleInfo' ForwardingInfo: type: object properties: notifyMySoftPhones: type: boolean description: Specifies if the user's softphone(s) are notified before forwarding the incoming call to desk phones and forwarding numbers notifyAdminSoftPhones: type: boolean description: Specifies if the administrator's softphone is notified before forwarding the incoming call to desk phones and forwarding numbers. The default value is 'False' softPhonesRingCount: type: integer description: Number of rings before forwarding starts ringingMode: type: string description: Specifies the order in which forwarding numbers ring. 'Sequentially' means that forwarding numbers are ringing one at a time, in order of priority. 'Simultaneously' means that forwarding numbers are ring all at the same time enum: - Sequentially - Simultaneously rules: type: array description: Information on a call forwarding rule items: $ref: '#/definitions/RuleInfo' mobileTimeout: type: boolean description: Specifies if mobile timeout is activated for the rule UserAnsweringRuleListRecord: type: object properties: uri: type: string description: Canonical URI to an answering rule resource example: https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule/business-hours-rule id: type: string description: Internal identifier of an asnwering rule example: business-hours-rule type: type: string description: Type of an answering rule enum: - BusinessHours - AfterHours - Custom name: type: string description: Name of an answering rule specified by user enabled: description: Specifies if an answering rule is active or inactive type: boolean CallRecordingExtensionInfo: type: object properties: id: type: string description: Internal identifier of an extension uri: type: string description: Link to an extension resource extensionNumber: type: string description: Number of an extension name: type: string description: Name of an extension CustomCompanyGreetingLanguageInfo: type: object properties: id: type: string description: Internal identifier of a greeting language uri: type: string description: Link to a greeting language name: type: string description: Name of a greeting language localeCode: type: string description: Locale code of a greeting language UnconditionalForwardingInfo: type: object properties: phoneNumber: type: string description: Phone number to which the call is forwarded CallHandlingPagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons AutomaticRecordingResource: type: object properties: enabled: type: boolean description: Flag for controling Automatic Call Recording settings outboundCallTones: type: boolean description: Flag for controlling 'Play Call Recording Announcement for Outbound Calls' settings outboundCallAnnouncement: type: boolean description: Flag for controlling 'Play periodic tones for outbound calls' settings allowMute: type: boolean description: Flag for controlling 'Allow mute in auto call recording' settings extensionCount: type: integer description: Total amount of extension that are used in call recordings CallRecordingExtensionResource: type: object properties: id: type: string description: Internal identifier of an extension uri: type: string extensionNumber: type: string type: type: string callDirection: type: string description: Direction of call enum: - Outbound - Inbound - All VoicemailInfo: type: object properties: enabled: type: boolean description: If 'True' then voicemails are allowed to be received recipient: description: Recipient data $ref: '#/definitions/RecipientInfo' IVRMenuPromptInfo: type: object properties: mode: type: string description: 'Prompt mode: custom media or text' enum: - Audio - TextToSpeech audio: description: For 'Audio' mode only. Prompt media reference $ref: '#/definitions/PromptLanguageInfo' text: type: string description: For 'TextToSpeech' mode only. Prompt text language: description: For 'TextToSpeech' mode only. Prompt language metadata $ref: '#/definitions/AudioPromptInfo' IVRMenuActionsInfo: type: object properties: input: type: string description: 'Key. The following values are supported: numeric: ''1'' to ''9'' Star Hash NoInput ' action: type: string description: Internal identifier of an answering rule enum: - Connect - Voicemail - DialByName - Transfer - Repeat - ReturnToRoot - ReturnToPrevious - Disconnect extension: description: For 'Connect' or 'Voicemail' actions only. Extension reference $ref: '#/definitions/IVRMenuExtensionInfo' phoneNumber: type: string description: For 'Transfer' action only. PSTN number in E.164 format OnDemandResource: type: object properties: enabled: type: boolean description: Flag for controlling OnDemand Call Recording settings ScheduleInfoUserBusinessHours: type: object properties: weeklyRanges: description: Weekly schedule $ref: '#/definitions/WeeklyScheduleInfo' CallersInfoRequest: type: object properties: callerId: type: string description: Phone number of a caller name: type: string description: Contact name of a caller ScheduleInfo: type: object properties: weeklyRanges: description: Weekly schedule $ref: '#/definitions/WeeklyScheduleInfo' ranges: description: Specific data ranges type: array items: $ref: '#/definitions/RangesInfo' ref: type: string description: The user's schedule specified for business hours or after hours; it can also be set/retrieved calling the corresponding method enum: - BusinessHours - AfterHours QueueInfo: type: object properties: transferMode: type: string description: Specifies how calls are transferred to group members enum: - Rotating - Simultaneous - FixedOrder fixedOrderAgents: type: array description: Information on a call forwarding rule items: $ref: '#/definitions/FixedOrderAgents' holdAudioInterruptionMode: type: string description: Connecting audio interruption mode enum: - Never - WhenMusicEnds - Periodically holdAudioInterruptionPeriod: type: integer description: Connecting audio interruption message period in seconds agentTimeout: type: integer description: Maximum time in seconds to wait for a call queue member before trying the next member wrapUpTime: type: integer description: Minimum post-call wrap up time in seconds before agent status is automatically set holdTime: type: integer description: Maximum hold time in seconds to wait for an available call queue member maxCallers: type: integer description: Maximum count of callers on hold maxCallersAction: type: string description: Action which should be taken if count of callers on hold exceeds the maximum enum: - Voicemail - Announcement CallersInfo: type: object properties: callerId: type: string description: Phone number of a caller name: type: string description: Contact name of a caller CreateForwardingNumberDeviceInfo: type: object properties: id: type: string description: Internal identifier of the other extension device UserAnsweringRuleListNavigation: type: object properties: firstPage: $ref: '#/definitions/UserAnsweringRuleListNavigationPage' nextPage: $ref: '#/definitions/UserAnsweringRuleListNavigationPage' previousPage: $ref: '#/definitions/UserAnsweringRuleListNavigationPage' lastPage: $ref: '#/definitions/UserAnsweringRuleListNavigationPage' CalledNumberInfo: type: object properties: phoneNumber: type: string description: Called phone number CompanyAnsweringRuleCallersInfoRequest: type: object properties: callerId: type: string description: Phone number of a caller name: type: string description: Displayed name for a caller ID GreetingResource: type: object properties: type: type: string enum: - StartRecording - StopRecording - AutomaticRecording mode: type: string enum: - Default - Custom description: '''Default'' value specifies that all greetings of that type (in all languages) are default, if at least one greeting (in any language) of the specified type is custom, then ''Custom'' value is returned.' TransferredExtensionInfo: type: object properties: extension: $ref: '#/definitions/ExtensionInfo' BlockedCallerGreetingInfo: type: object properties: type: type: string description: Type of a greeting preset: $ref: '#/definitions/PresetInfo' ListCompanyAnsweringRuleInfo: type: object properties: id: type: string description: Internal identifier of an answering rule uri: type: string description: Canonical URI of an answering rule enabled: type: boolean description: Specifies if the rule is active or inactive. The default value is 'True' default: true type: type: string description: Type of an answering rule, the default value is 'Custom' = ['BusinessHours', 'AfterHours', 'Custom'] enum: - BusinessHours - AfterHours - Custom name: type: string description: Name of an answering rule specified by user. Max number of symbols is 30. The default value is 'My Rule N' where 'N' is the first free number CompanyAnsweringRuleScheduleInfoRequest: type: object properties: weeklyRanges: description: Weekly schedule. If specified, ranges cannot be specified $ref: '#/definitions/CompanyAnsweringRuleWeeklyScheduleInfoRequest' ranges: description: Specific data ranges. If specified, weeklyRanges cannot be specified type: array items: $ref: '#/definitions/RangesInfo' ref: type: string description: Reference to Business Hours or After Hours schedule enum: - BusinessHours - AfterHours CallHandlingNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/CallHandlingNavigationInfoUri' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/CallHandlingNavigationInfoUri' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/CallHandlingNavigationInfoUri' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/CallHandlingNavigationInfoUri' CallRecordingCustomGreeting: type: object properties: type: type: string enum: - StartRecording - StopRecording - AutomaticRecording custom: description: Custom greeting data $ref: '#/definitions/CallRecordingCustomGreetingData' language: description: Custom greeting language $ref: '#/definitions/CallRecordingCustomGreetingLanguage' CustomGreetingAnsweringRuleInfo: type: object properties: uri: type: string description: Canonical URI of an answering rule id: type: string description: Internal identifier of an answering rule GreetingInfo: type: object properties: type: type: string description: Type of a greeting, specifying the case when the greeting is played. enum: - Introductory - Announcement - ConnectingMessage - ConnectingAudio - Voicemail - Unavailable - InterruptPrompt - HoldMusic - Custom - Company - BlockedCallersSpecific - BlockedCallersAll - BlockedNoCallerId - BlockedPayPhones - StartRecording - StopRecording - AutomaticRecording usageType: type: string description: Usage type of a greeting, specifying if the greeting is applied to user extension or department extension. enum: - UserExtensionAnsweringRule - ExtensionAnsweringRule - DepartmentExtensionAnsweringRule - CompanyAnsweringRule - CompanyAfterHoursAnsweringRule - VoicemailExtensionAnsweringRule - AnnouncementExtensionAnsweringRule preset: $ref: '#/definitions/PresetInfo' CompanyAnsweringRuleScheduleInfo: type: object properties: weeklyRanges: description: Weekly schedule. If specified, ranges cannot be specified $ref: '#/definitions/CompanyAnsweringRuleWeeklyScheduleInfoRequest' ranges: description: Specific data ranges. If specified, weeklyRanges cannot be specified type: array items: $ref: '#/definitions/RangesInfo' ref: type: string description: Reference to Business Hours or After Hours schedule = ['BusinessHours', 'AfterHours'] enum: - BusinessHours - AfterHours PresetInfo: type: object properties: uri: type: string description: Link to a greeting resource id: type: string description: Internal identifier of a greeting name: type: string description: Name of a greeting CompanyAnsweringRuleWeeklyScheduleInfoRequest: type: object properties: monday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' tuesday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' wednesday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' thursday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' friday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' saturday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' sunday: type: array description: Time interval for a particular day items: $ref: '#/definitions/CompanyAnsweringRuleTimeIntervalRequest' CallHandlingNavigationInfoUri: type: object properties: uri: type: string CallRecordingCustomGreetingData: type: object properties: uri: type: string description: Link to a custom company greeting id: type: string description: Internal identifier of a custom company greeting CallRecordingCustomGreetingLanguage: type: object properties: uri: type: string description: Link to a language id: type: string description: Internal identifier of a language name: type: string description: Language name localeCode: type: string description: Language locale code WeeklyScheduleInfo: type: object properties: monday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' tuesday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' wednesday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' thursday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' friday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' saturday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' sunday: type: array description: Time intervals for a particular day items: $ref: '#/definitions/TimeInterval' PromptLanguageInfo: type: object properties: uri: type: string description: Link to a prompt language id: type: string description: Internal identifier of a language name: type: string description: Language name localeCode: type: string description: Language locale code RuleInfoCreateRuleRequest: type: object properties: index: type: integer description: Forwarding number (or group) ordinal. Not returned for inactive numbers ringCount: type: integer description: Number of rings for a forwarding number (or group). For inactive numbers the default value ('4') is returned enabled: type: boolean description: Phone number status forwardingNumbers: type: array description: Forwarding number (or group) data items: $ref: '#/definitions/ForwardingNumberInfoRulesCreateRuleRequest' AudioPromptInfo: type: object properties: uri: type: string description: Link to an prompt audio file id: type: string description: Internal identifier of an prompt UserAnsweringRuleListNavigationPage: type: object properties: uri: type: string example: https://platform.ringcentral.com/restapi/v1.0/account/240913004/extension/240972004/answering-rule?page=1&perPage=100 RangesInfo: type: object properties: from: type: string description: Starting datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100* to: type: string description: Ending datetime in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), for example *2018-10-29T14:00:00*, *2018-10-29T14:00:00Z*, *2018-10-29T14:00:00+0100* FixedOrderAgents: type: object properties: extension: $ref: '#/definitions/ExtensionInfo' index: type: integer description: Ordinal of an agent (call queue member) IVRMenuExtensionInfo: type: object properties: uri: type: string description: Link to an extension resource id: type: string description: Internal identifier of an extension ExtensionInfo: type: object properties: id: type: string description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension extensionNumber: type: string description: Number of department extension partnerId: type: string description: For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension RuleInfo: type: object properties: index: type: integer description: Forwarding number (or group) ordinal ringCount: type: integer description: Number of rings for a forwarding number (or group) enabled: type: boolean description: Forwarding number status. Returned only if `showInactiveNumbers` is set to `true` forwardingNumbers: type: array description: Forwarding number (or group) data items: $ref: '#/definitions/ForwardingNumberInfoRules' RecipientInfo: type: object properties: uri: type: string description: Link to a recipient extension resource id: type: string description: Internal identifier of a recipient extension CompanyAnsweringRuleTimeIntervalRequest: type: object properties: from: type: string description: Time in format hh:mm to: type: string description: Time in format hh:mm TimeInterval: type: object properties: from: type: string description: Time in format hh:mm to: type: string description: Time in format hh:mm ForwardingNumberInfoRulesCreateRuleRequest: type: object properties: id: type: string description: Internal identifier of a forwarding number type: type: string description: Forwarding phone number type enum: - Home - Mobile - Work - PhoneLine - Outage - Other ForwardingNumberInfoRules: type: object properties: uri: type: string description: Link to a forwarding number resource id: type: string description: Internal identifier of a forwarding number phoneNumber: type: string description: Phone number to which the call is forwarded label: type: string description: Title of a forwarding number type: type: string description: Type of a forwarding number enum: - Home - Mobile - Work - PhoneLine - Outage - Other CreateSipRegistrationRequest: type: object required: - device - sipInfo properties: device: type: array description: Device unique description items: $ref: '#/definitions/DeviceInfoRequest' sipInfo: type: array description: SIP settings for device items: $ref: '#/definitions/SIPInfoRequest' CreateSipRegistrationResponse: type: object required: - sipFlags - sipInfo properties: pollingInterval: type: integer description: Suggested interval in seconds to periodically call SIP-provision API and update the local cache sipErrorCodes: type: array items: type: string sipInfo: type: array description: SIP settings for device items: $ref: '#/definitions/SIPInfoResponse' sipFlags: type: array description: SIP flags data items: $ref: '#/definitions/SIPFlagsResponse' DeviceInfoRequest: type: object properties: id: type: string description: Device unique identifier, retrieved on previous session (if any) appExternalId: type: string description: For iOS devices only Certificate name (used by iOS applications for APNS subscription) computerName: type: string description: For SoftPhone only Computer name SIPInfoRequest: type: object properties: transport: type: string description: Supported transport. SIP info will be returned for this transport if supported enum: - UDP - TCP - TLS - WS - WSS SIPInfoResponse: type: object properties: username: type: string description: User credentials password: type: string description: User password authorizationId: type: string description: Identifier for SIP authorization domain: type: string description: SIP domain outboundProxy: type: string description: SIP outbound proxy transport: type: string description: Preferred transport. SIP info will be returned for this transport if supported enum: - UDP - TCP - TLS - WS - WSS certificate: type: string description: For TLS transport only Base64 encoded certificate switchBackInterval: type: integer description: The interval in seconds after which the app must try to switch back to primary proxy if it was previously switched to backup. If this parameter is not returned, the app must stay on backup proxy and try to switch to primary proxy after the next SIP-provision call. SIPFlagsResponse: type: object properties: voipFeatureEnabled: type: string description: If 'True' VoIP calling feature is enabled enum: - "True" - "False" voipCountryBlocked: type: string description: If 'True' the request is sent from IP address of a country blocked for VoIP calling enum: - "True" - "False" outboundCallsEnabled: type: string description: If 'True' outbound calls are enabled enum: - "True" - "False" WirelessPointInfo: type: object properties: id: type: string description: Internal identifier of a wireless point bssid: type: string description: Unique 48-bit identifier of the wireless access point that follows MAC address conventions name: type: string description: Wireless access point name site: type: object $ref: '#/definitions/EmergencyAddressAutoUpdateSiteInfo' description: Site data (internal identifier and custom name of a site) emergencyAddress: type: object description: Emergency address assigned to the point $ref: '#/definitions/LocationUpdatesEmergencyAddressInfo' UpdateNetworkRequest: type: object properties: name: type: string site: type: string publicIpRanges: type: array items: $ref: '#/definitions/PublicIpRangeInfo' privateIpRanges: type: array items: $ref: '#/definitions/PrivateIpRangeInfo' UpdateMultipleSwitchesRequest: type: object properties: records: type: array items: $ref: '#/definitions/UpdateSwitchInfo' NotificationSettings: type: object properties: uri: type: string description: Canonical URI of notifications settings resource emailAddresses: type: array items: type: string description: List of notification recipient email addresses smsEmailAddresses: type: array items: type: string description: List of notification recipient email addresses advancedMode: type: boolean description: 'Specifies notifications settings mode. If ''True'' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If ''False'' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied ' voicemails: $ref: '#/definitions/VoicemailsInfo' inboundFaxes: $ref: '#/definitions/InboundFaxesInfo' outboundFaxes: $ref: '#/definitions/OutboundFaxesInfo' inboundTexts: $ref: '#/definitions/InboundTextsInfo' missedCalls: $ref: '#/definitions/MissedCallsInfo' GetLocationListResponse: type: object required: - navigation - paging properties: records: type: array description: List of locations items: $ref: '#/definitions/LocationInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' AssignMultipleDevicesAutomaticLocationUpdates: type: object properties: enabledDeviceIds: type: array items: type: string description: List of common devices for feature activation disabledDeviceIds: type: array items: type: string description: List of common devices for feature disabling UpdateMultipleWirelessPointsRequest: type: object properties: records: type: array items: $ref: '#/definitions/UpdateWirelessPoint' ValidateMultipleSwitchesRequest: type: object properties: records: type: array items: $ref: '#/definitions/SwitchInfo' GetCountryListResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of countries with the country data items: $ref: '#/definitions/GetCountryInfoDictionaryResponse' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' AccountPhoneNumbers: type: object properties: records: type: array description: List of account phone numbers items: $ref: '#/definitions/CompanyPhoneNumberInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' CallQueues: type: object required: - navigation - paging - records - uri properties: uri: type: string description: Link to a call queues resource records: type: array description: List of call queues items: $ref: '#/definitions/CallQueueInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' PagingOnlyGroupDevices: type: object properties: records: type: array description: List of paging devices assigned to this group items: $ref: '#/definitions/PagingDeviceInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' ExtensionInfoEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](shttps://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/ExtensionInfoEventBody' EmergencyAddressAutoUpdateUsersBulkAssignResource: type: object properties: enabledUserIds: type: array items: type: string disabledUserIds: type: array items: type: string CreateSwitchInfo: type: object required: - chassisId - emergencyAddress properties: chassisId: type: string description: 'Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)' name: type: string description: Name of a network switch site: description: Site data $ref: '#/definitions/SwitchSiteInfo' emergencyAddress: description: Emergency address assigned to the switch $ref: '#/definitions/LocationUpdatesEmergencyAddressInfo' CreateMultipleSwitchesResponse: type: object description: Information on the task for multiple switches creation properties: task: type: array items: $ref: '#/definitions/BulkTaskInfo' ModifyAccountBusinessAddressRequest: required: - businessAddress type: object properties: company: type: string description: Company business name email: type: string description: Company business email address businessAddress: description: Company business address $ref: '#/definitions/BusinessAddressInfo' ValidateMultipleWirelessPointsRequest: type: object properties: records: type: array items: $ref: '#/definitions/WirelessPointInfo' TemplateInfo: type: object properties: uri: type: string description: Link to a template id: type: string description: Internal identifier of a template type: type: string enum: - UserSettings - CallHandling name: type: string description: Name of a template creationTime: type: string description: Time of a template creation lastModifiedTime: type: string description: Time of the last template modification CallQueueMembers: type: object required: - navigation - paging - records - uri properties: uri: type: string description: Link to a call queue members resource records: type: array description: List of call queue members items: $ref: '#/definitions/CallQueueMemberInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' CallMonitoringGroup: type: object properties: id: type: string description: Internal identifier of a group name: type: string description: Name of a group SwitchInfo: type: object properties: id: type: string description: Internal identifier of a network switch chassisId: type: string description: Unique identifier of a network switch name: type: string description: Name of a network switch site: description: Site data $ref: '#/definitions/SwitchSiteInfo' emergencyAddress: description: Emergency address assigned to the switch $ref: '#/definitions/LocationUpdatesEmergencyAddressInfo' CreateMultipleSwitchesRequest: type: object properties: records: type: array items: $ref: '#/definitions/CreateSwitchInfo' GetServiceInfoResponse: type: object properties: uri: type: string description: Canonical URI of the account Service Info resource servicePlanName: type: string description: Account Service Plan name serviceFeatures: type: array description: Service features information, see Service Feature List items: $ref: '#/definitions/ServiceFeatureInfo' limits: description: Limits which are effective for the account $ref: '#/definitions/AccountLimits' GetCountryInfoDictionaryResponse: type: object properties: id: type: string description: Internal identifier of a country uri: type: string description: Canonical URI of a country callingCode: type: string description: Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) emergencyCalling: type: boolean description: Emergency calling feature availability/emergency address requirement indicator isoCode: type: string description: Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) name: type: string description: Official name of a country numberSelling: type: boolean description: Determines whether phone numbers are available for a country loginAllowed: type: boolean description: Specifies whether login with the phone numbers of this country is enabled or not signupAllowed: type: boolean description: Indicates whether signup/billing is allowed for a country freeSoftphoneLine: type: boolean description: Specifies if free phone line for softphone is available for a country or not ExtensionCreationRequest: type: object required: - type - contact properties: contact: description: Contact Information $ref: '#/definitions/ContactInfoCreationRequest' extensionNumber: type: string description: Number of extension password: type: string description: Password for extension. If not specified, the password is auto-generated references: type: array description: List of non-RC internal identifiers assigned to an extension items: $ref: '#/definitions/ReferenceInfo' roles: type: array items: $ref: '#/definitions/Roles' regionalSettings: description: Extension region data (timezone, home country, language) $ref: '#/definitions/RegionalSettings' setupWizardState: type: string description: Specifies extension configuration wizard state (web service setup). default: NotStarted enum: - NotStarted - Incomplete - Completed status: type: string description: Extension current state enum: - Enabled - Disabled - NotActivated - Unassigned statusInfo: description: Status information (reason, comment). For 'Disabled' status only $ref: '#/definitions/ExtensionStatusInfo' type: type: string description: Extension type enum: - User - VirtualUser - DigitalUser - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnlyGroup - ParkLocation hidden: type: boolean description: Hides extension from showing in company directory. Supported for extensions of User type only. For unassigned extensions the value is set to 'True' by default. For assigned extensions the value is set to 'False' by default ExtensionCreationResponse: type: object properties: id: type: integer format: int64 description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension contact: description: Contact detailed information $ref: '#/definitions/ContactInfo' extensionNumber: type: string description: Number of department extension name: type: string description: Extension user name partnerId: type: string description: For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension permissions: $ref: '#/definitions/ExtensionPermissions' profileImage: description: Information on profile image $ref: '#/definitions/ProfileImageInfo' references: type: array description: List of non-RC internal identifiers assigned to an extension items: $ref: '#/definitions/ReferenceInfo' roles: type: array items: $ref: '#/definitions/Roles' regionalSettings: description: Extension region data (timezone, home country, language) $ref: '#/definitions/RegionalSettings' serviceFeatures: type: array description: Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features items: $ref: '#/definitions/ExtensionServiceFeatureInfo' setupWizardState: type: string description: Specifies extension configuration wizard state (web service setup). The default value is 'NotStarted' enum: - NotStarted - Incomplete - Completed status: type: string description: Extension current state. If the status is 'Unassigned'. Returned for all extensions enum: - Enabled - Disabled - NotActivated - Unassigned statusInfo: description: Status information (reason, comment). Returned for 'Disabled' status only $ref: '#/definitions/ExtensionStatusInfo' type: type: string description: Extension type enum: - User - VirtualUser - DigitalUser - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnlyGroup - ParkLocation hidden: type: boolean description: Hides extension from showing in company directory. Supported for extensions of User type only ExtensionGrantListEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/ExtensionGrantListEventBody' CallMonitoringBulkAssign: type: object properties: updatedExtensions: type: array items: $ref: '#/definitions/CallMonitoringExtensionUpdate' UpdateWirelessPoint: type: object properties: id: type: string description: Internal identifier of a wireless point bssid: type: string description: 'Unique 48-bit identifier of wireless access point that follows MAC address conventions. Mask: XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F' name: type: string description: Wireless access point name site: type: object $ref: '#/definitions/EmergencyAddressAutoUpdateSiteInfo' description: Site data. If multi-site feature is turned on for the account, then internal identifier of a site must be specified. To assign the wireless point to the main site (company) set site ID to `main-site` emergencyAddress: type: object $ref: '#/definitions/LocationUpdatesEmergencyAddressInfo' ValidateMultipleSwitchesResponse: type: object properties: records: type: array items: $ref: '#/definitions/SwitchValidated' GetConferencingInfoResponse: type: object properties: uri: type: string description: Canonical URI of a conferencing allowJoinBeforeHost: type: boolean description: Determines if host user allows conference participants to join before the host hostCode: type: string description: Access code for a host user mode: type: string description: Internal parameter specifying conferencing engine participantCode: type: string description: Access code for any participant phoneNumber: type: string description: Primary conference phone number for user's home country returned in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format tapToJoinUri: type: string description: Short URL leading to the service web page Tap to Join for audio conference bridge phoneNumbers: type: array description: List of multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic items: $ref: '#/definitions/PhoneNumberInfoConferencing' LanguageList: type: object properties: uri: type: string description: Canonical URI of the language list resource records: type: array description: Language data items: $ref: '#/definitions/LanguageInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' DepartmentMemberList: type: object properties: records: type: array description: List of department members extensions items: $ref: '#/definitions/ExtensionInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' CreateWirelessPoint: type: object required: - bssid - name - emergencyAddress properties: bssid: type: string description: Unique 48-bit identifier of wireless access point that follows MAC address conventions. The Mask is XX:XX:XX:XX:XX:XX, where X can be a symbol in the range of 0-9 or A-F name: type: string description: Wireless access point name site: type: object $ref: '#/definitions/EmergencyAddressAutoUpdateSiteInfo' description: Site data. If multi-site feature is turned on for the account, then internal identifier of a site must be specified. To assign the wireless point to the main site (company) set site ID to `main-site` emergencyAddress: type: object $ref: '#/definitions/LocationUpdatesEmergencyAddressInfo' NotificationSettingsUpdateRequest: type: object properties: emailAddresses: type: array items: type: string description: List of notification recipient email addresses smsEmailAddresses: type: array items: type: string description: List of notification recipient email addresses advancedMode: type: boolean description: 'Specifies notifications settings mode. If ''True'' then advanced mode is on, it allows using different emails and/or phone numbers for each notification type. If ''False'' then basic mode is on. Advanced mode settings are returned in both modes, if specified once, but if basic mode is switched on, they are not applied ' voicemails: $ref: '#/definitions/VoicemailsInfo' inboundFaxes: $ref: '#/definitions/InboundFaxesInfo' outboundFaxes: $ref: '#/definitions/OutboundFaxesInfo' inboundTexts: $ref: '#/definitions/InboundTextsInfo' missedCalls: $ref: '#/definitions/MissedCallsInfo' GetStateListResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of states items: $ref: '#/definitions/GetStateInfoResponse' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' GetStateInfoResponse: type: object properties: id: type: string description: Internal identifier of a state uri: type: string description: Canonical URI of a state country: description: Information on a country the state belongs to $ref: '#/definitions/GetCountryInfoState' isoCode: type: string description: Short code for a state (2-letter usually) name: type: string description: Official name of a state PagingOnlyGroupUsers: type: object properties: records: type: array description: List of users allowed to page this group items: $ref: '#/definitions/PagingGroupExtensionInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' WirelessPointsList: type: object properties: uri: type: string description: Link to the wireless points resource records: type: array description: List of wireless points with assigned emergency addresses items: $ref: '#/definitions/WirelessPointInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' ListDevicesAutomaticLocationUpdates: type: object properties: uri: type: string description: Link to devices resource records: type: array description: List of users' devices with the current status of Emergency Address Auto Update Feature items: type: object $ref: '#/definitions/AutomaticLocationUpdatesDeviceInfo' navigation: $ref: '#/definitions/ProvisioningNavigationInfo' paging: $ref: '#/definitions/ProvisioningPagingInfo' CreateMultipleWirelessPointsResponse: type: object properties: task: description: Information on the task for multiple wireless points creation $ref: '#/definitions/BulkTaskInfo' CreateCallMonitoringGroupRequest: type: object required: - name properties: id: type: string description: Internal identifier of a group name: type: string description: Name of a group CallMonitoringGroups: type: object required: - navigation - paging - records - uri properties: uri: type: string description: Link to a call monitoring groups resource records: type: array description: List of call monitoring group members items: $ref: '#/definitions/CallMonitoringGroup' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' UpdateMultipleSwitchesResponse: type: object properties: task: description: Information on the task for multiple switches update $ref: '#/definitions/BulkTaskInfo' UpdateMultipleWirelessPointsResponse: type: object properties: task: description: Information on the task for multiple wireless points update $ref: '#/definitions/BulkTaskInfo' ValidateMultipleWirelessPointsResponse: type: object properties: records: type: array items: $ref: '#/definitions/WirelessPointValidated' GetExtensionListResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of extensions with extension information items: $ref: '#/definitions/GetExtensionInfoResponse' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' CallQueueBulkAssignResource: type: object properties: addedExtensionIds: type: array items: type: string removedExtensionIds: type: array items: type: string ExtensionUpdateRequest: type: object properties: status: type: string enum: - Disabled - Enabled - NotActivated statusInfo: $ref: '#/definitions/ExtensionStatusInfo' reason: type: string description: Type of suspension comment: type: string description: Free Form user comment extensionNumber: type: string description: Extension number available contact: $ref: '#/definitions/ContactInfoUpdateRequest' regionalSettings: $ref: '#/definitions/ExtensionRegionalSettingRequest' setupWizardState: type: string enum: - NotStarted - Incomplete - Completed partnerId: type: string description: ' Extension partner identifier' ivrPin: type: string description: IVR PIN password: type: string description: Password for extension callQueueInfo: $ref: '#/definitions/CallQueueInfoRequest' description: For Department extension type only. Call queue settings transition: type: array items: $ref: '#/definitions/UserTransitionInfo' description: For NotActivated extensions only. Welcome email settings ExtensionCallerIdInfo: type: object properties: uri: type: string description: Canonical URL of a caller ID resource byDevice: type: array items: $ref: '#/definitions/CallerIdByDevice' description: Caller ID settings by device byFeature: type: array items: $ref: '#/definitions/CallerIdByFeature' description: Caller ID settings by feature extensionNameForOutboundCalls: type: boolean description: If 'True', then user first name and last name will be used as caller ID when making outbound calls from extension extensionNumberForInternalCalls: type: boolean description: If 'True', then extension number will be used as caller ID when making internal calls AccountBusinessAddressResource: type: object properties: uri: type: string format: uri businessAddress: $ref: '#/definitions/ContactBusinessAddressInfo' company: type: string email: type: string LanguageInfo: type: object properties: id: type: string description: Internal identifier of a language uri: type: string description: Canonical URI of a language greeting: type: boolean description: Indicates whether a language is available as greeting language formattingLocale: type: boolean description: Indicates whether a language is available as formatting locale localeCode: type: string description: Localization code of a language name: type: string description: Official name of a language ui: type: boolean description: Indicates whether a language is available as UI language GetTimezoneListResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of timezones items: $ref: '#/definitions/GetTimezoneInfoResponse' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' ExtensionListEvent: type: object properties: uuid: type: string description: Universally unique identifier of a notification event: type: string description: Event filter URI timestamp: type: string description: Datetime of sending a notification in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z* subscriptionId: type: string description: Internal identifier of a subscription body: description: Notification payload body $ref: '#/definitions/ExtensionListEventBody' GetExtensionGrantListResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of extension grants with details items: $ref: '#/definitions/GrantInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' UpdateConferencingInfoRequest: type: object properties: phoneNumbers: type: array items: $ref: '#/definitions/ConferencePhoneNumberInfo' description: Multiple dial-in phone numbers to connect to audio conference service, relevant for user's brand. Each number is given with the country and location information, in order to let the user choose the less expensive way to connect to a conference. The first number in the list is the primary conference number, that is default and domestic allowJoinBeforeHost: type: boolean description: Determines if host user allows conference participants to join before the host GetAccountInfoResponse: type: object properties: id: type: string description: Internal identifier of an account uri: type: string description: Canonical URI of an account mainNumber: type: string description: Main phone number of the current account operator: description: Operator's extension information. This extension will receive all calls and messages intended for the operator $ref: '#/definitions/GetExtensionInfoResponse' partnerId: type: string description: Additional account identifier, developed and applied by the client serviceInfo: description: Account service information, including brand, service plan and billing plan $ref: '#/definitions/ServiceInfo' setupWizardState: type: string description: Specifies account configuration wizard state (web service setup). The default value is 'NotStarted' enum: - NotStarted - Incomplete - Completed status: type: string description: Status of the current account enum: - Confirmed - Disabled statusInfo: description: Status information (reason, comment, lifetime). Returned for 'Disabled' status only $ref: '#/definitions/AccountStatusInfo' regionalSettings: description: Account level region data (web service Auto-Receptionist settings) $ref: '#/definitions/RegionalSettings' federated: description: Specifies whether an account is included into any federation of accounts or not type: boolean outboundCallPrefix: type: integer description: If outbound call prefix is not specified, or set to null (0), then the parameter is not returned; the supported value range is 2-9 cfid: type: string description: 'Customer facing identifier. Returned for accounts with the turned off PBX features. Equals to main company number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (without ''+'' sign)format ' limits: description: Limits which are effective for the account $ref: '#/definitions/AccountLimits' DepartmentBulkAssignResource: type: object properties: items: type: array items: $ref: '#/definitions/BulkAssignItem' SwitchesList: type: object properties: records: type: array description: Switches map items: $ref: '#/definitions/SwitchInfo' navigation: $ref: '#/definitions/ProvisioningNavigationInfo' paging: $ref: '#/definitions/ProvisioningPagingInfo' CompanyPhoneNumberInfo: type: object properties: id: type: string description: Internal identifier of a phone number country: description: Brief information on a phone number country $ref: '#/definitions/CountryInfo' extension: description: Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list $ref: '#/definitions/ExtensionInfo' label: type: string description: Custom user name of a phone number, if any location: type: string description: Location (City, State). Filled for local US numbers paymentType: type: string description: Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system enum: - External - TollFree - Local phoneNumber: type: string description: Phone number status: type: string description: Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral type: type: string description: Phone number type enum: - VoiceFax - FaxOnly - VoiceOnly usageType: type: string description: Usage type of a phone number enum: - MainCompanyNumber - AdditionalCompanyNumber - CompanyNumber - DirectNumber - CompanyFaxNumber - ForwardedNumber - ForwardedCompanyNumber - ContactCenterNumber - ConferencingNumber - MeetingsNumber GetExtensionInfoResponse: type: object required: - id - profileImage - status - type - uri properties: id: type: integer format: int64 description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension contact: description: Contact detailed information $ref: '#/definitions/ContactInfo' departments: type: array description: Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId items: $ref: '#/definitions/DepartmentInfo' extensionNumber: type: string description: Number of department extension name: type: string description: Extension user name partnerId: type: string description: For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension permissions: $ref: '#/definitions/ExtensionPermissions' profileImage: description: Information on profile image $ref: '#/definitions/ProfileImageInfo' references: type: array description: List of non-RC internal identifiers assigned to an extension items: $ref: '#/definitions/ReferenceInfo' roles: type: array items: $ref: '#/definitions/Roles' regionalSettings: description: Extension region data (timezone, home country, language) $ref: '#/definitions/RegionalSettings' serviceFeatures: type: array description: Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features items: $ref: '#/definitions/ExtensionServiceFeatureInfo' setupWizardState: type: string description: Specifies extension configuration wizard state (web service setup). default: NotStarted enum: - NotStarted - Incomplete - Completed status: type: string description: Extension current state. If the status is 'Unassigned'. Returned for all extensions enum: - Enabled - Disabled - NotActivated - Unassigned statusInfo: description: Status information (reason, comment). Returned for 'Disabled' status only $ref: '#/definitions/ExtensionStatusInfo' type: type: string description: Extension type enum: - User - FaxUser - VirtualUser - DigitalUser - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnlyGroup - IvrMenu - ApplicationExtension - ParkLocation callQueueExtensionInfo: description: For Department extension type only. Call queue settings $ref: '#/definitions/CallQueueExtensionInfo' hidden: type: boolean description: Hides extension from showing in company directory. Supported for extensions of User type only GetTimezoneInfoResponse: type: object properties: id: type: string description: Internal identifier of a timezone uri: type: string description: Canonical URI of a timezone name: type: string description: Short name of a timezone description: type: string description: Description of a timezone UserTemplates: type: object required: - navigation - paging - records properties: uri: type: string description: Link to user templates resource records: type: array description: List of user templates items: $ref: '#/definitions/TemplateInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' CallMonitoringGroupMemberList: type: object required: - navigation - paging - records - uri properties: uri: type: string description: Link to a call monitoring group members resource records: type: array description: List of a call monitoring group members items: $ref: '#/definitions/CallMonitoringGroupMemberInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' GetExtensionPhoneNumbersResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of phone numbers items: $ref: '#/definitions/UserPhoneNumberInfo' navigation: description: Information on navigation $ref: '#/definitions/ProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/ProvisioningPagingInfo' CreateMultipleWirelessPointsRequest: type: object properties: records: type: array items: $ref: '#/definitions/CreateWirelessPoint' EditPagingGroupRequest: type: object properties: addedUserIds: type: array description: List of users that will be allowed to page a group specified items: type: string removedUserIds: type: array description: List of users that will be unallowed to page a group specified items: type: string addedDeviceIds: type: array description: List of account devices that will be assigned to a paging group specified items: type: string removedDeviceIds: type: array description: List of account devices that will be unassigned from a paging group specified items: type: string UserPhoneNumberInfo: type: object properties: id: type: string description: Internal identifier of a phone number country: description: Brief information on a phone number country $ref: '#/definitions/CountryInfo' extension: description: Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list $ref: '#/definitions/ExtensionInfo' label: type: string description: Custom user name of a phone number, if any location: type: string description: Location (City, State). Filled for local US numbers paymentType: type: string description: Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system enum: - External - TollFree - Local phoneNumber: type: string description: Phone number status: type: string description: Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral type: type: string description: Phone number type enum: - VoiceFax - FaxOnly - VoiceOnly usageType: type: string description: Usage type of a phone number enum: - MainCompanyNumber - AdditionalCompanyNumber - CompanyNumber - DirectNumber - CompanyFaxNumber - ForwardedNumber - ForwardedCompanyNumber - ContactCenterNumber - ConferencingNumber features: type: array description: List of features of a phone number items: type: string enum: - CallerId - SmsSender - MmsSender - InternationalSmsSender - TollFreeSmsSender - Delegated CallerIdByDevice: type: object properties: device: $ref: '#/definitions/CallerIdDeviceInfo' callerId: $ref: '#/definitions/CallerIdByDeviceInfo' CallQueueExtensionInfo: type: object properties: slaGoal: type: integer description: Target percentage of calls that must be answered by agents within the service level time threshold slaThresholdSeconds: type: integer description: Period of time in seconds that is considered to be an acceptable service level includeAbandonedCalls: type: boolean description: If 'True' abandoned calls (hanged up prior to being served) are included into service level calculation abandonedThresholdSeconds: type: integer description: Period of time in seconds specifying abandoned calls duration - calls that are shorter will not be included into the calculation of service level.; zero value means that abandoned calls of any duration will be included into calculation EmergencyAddressAutoUpdateSiteInfo: type: object properties: id: type: string name: type: string PagingDeviceInfo: type: object properties: id: type: string description: Internal identifier of a paging device uri: type: string description: Link to a paging device resource name: type: string description: Name of a paging device ExtensionInfoEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension eventType: type: string description: Type of extension info change enum: - Update - Delete hints: type: array description: 'Returned for ''Update'' event type only. The possible values are: /nAccountInfo - change of account parameters/nExtensionInfo - change of contact info, service features, departments, status/nPhoneNumber - change of phone numbers/nRole - change of permissions/nProfileImage - change of profile image' items: type: string ownerId: type: string description: Internal identifier of a subscription owner extension ExtensionServiceFeatureInfo: type: object properties: enabled: type: boolean description: Feature status; shows feature availability for an extension featureName: type: string enum: - AccountFederation - Archiver - AutomaticCallRecordingMute - AutomaticInboundCallRecording - AutomaticOutboundCallRecording - BlockedMessageForwarding - Calendar - CallerIdControl - CallForwarding - CallPark - CallParkLocations - CallSupervision - CallSwitch - CallQualitySurvey - Conferencing - ConfigureDelegates - DeveloperPortal - DND - DynamicConference - EmergencyAddressAutoUpdate - EmergencyCalling - EncryptionAtRest - ExternalDirectoryIntegration - Fax - FaxReceiving - FreeSoftPhoneLines - HDVoice - HipaaCompliance - Intercom - InternationalCalling - InternationalSMS - LinkedSoftphoneLines - MMS - OnDemandCallRecording - Pager - PagerReceiving - Paging - PasswordAuth - PromoMessage - Reports - Presence - RCTeams - RingOut - SalesForce - SharedLines - SingleExtensionUI - SiteCodes - SMS - SMSReceiving - SoftPhoneUpdate - TelephonySessions - UserManagement - VideoConferencing - VoipCalling - VoipCallingOnMobile - Voicemail - VoicemailToText - WebPhone description: Feature name reason: type: string description: Reason for limitation of a particular service feature. Returned only if the enabled parameter value is 'False', see Service Feature Limitations and Reasons. When retrieving service features for an extension, the reasons for the limitations, if any, are returned in response VoicemailsInfo: type: object properties: notifyByEmail: type: boolean description: Email notification flag notifyBySms: type: boolean description: SMS notification flag advancedEmailAddresses: type: array description: List of recipient email addresses for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string advancedSmsEmailAddresses: type: array description: List of recipient phone numbers for voicemail notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string includeAttachment: type: boolean description: Indicates whether voicemail should be attached to email markAsRead: type: boolean description: Indicates whether email should be automatically marked as read ProvisioningPagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons ContactInfoCreationRequest: type: object required: - firstName - lastName - email properties: firstName: type: string description: For User extension type only. Extension user first name lastName: type: string description: For User extension type only. Extension user last name company: type: string description: Extension user company name jobTitle: type: string email: type: string description: Email of extension user businessPhone: type: string description: Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format mobilePhone: type: string description: Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format businessAddress: $ref: '#/definitions/ContactBusinessAddressInfo' emailAsLoginName: type: boolean description: ' If ''True'' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is ''False''' pronouncedName: $ref: '#/definitions/PronouncedNameInfo' department: type: string description: Extension user department, if any RegionalSettings: type: object properties: homeCountry: description: Extension country information $ref: '#/definitions/CountryInfo' timezone: description: Extension timezone information $ref: '#/definitions/TimezoneInfo' language: description: User interface language data $ref: '#/definitions/LanguageInfo' greetingLanguage: description: Information on language used for telephony greetings $ref: '#/definitions/GreetingLanguageInfo' formattingLocale: description: Formatting language preferences for numbers, dates and currencies $ref: '#/definitions/FormattingLocaleInfo' timeFormat: type: string description: Time format setting. The default value is '12h' = ['12h', '24h'] enum: - 12h - 24h PublicIpRangeInfo: type: object properties: id: type: string startIp: type: string endIp: type: string InboundFaxesInfo: type: object properties: notifyByEmail: type: boolean description: Email notification flag notifyBySms: type: boolean description: SMS notification flag advancedEmailAddresses: type: array description: List of recipient email addresses for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string advancedSmsEmailAddresses: type: array description: List of recipient phone numbers for inbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string includeAttachment: type: boolean description: Indicates whether fax should be attached to email markAsRead: type: boolean description: Indicates whether email should be automatically marked as read ProvisioningNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/ProvisioningNavigationInfoUri' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/ProvisioningNavigationInfoUri' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/ProvisioningNavigationInfoUri' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/ProvisioningNavigationInfoUri' BusinessAddressInfo: 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 ContactBusinessAddressInfo: type: object properties: country: type: string description: Country name of an extension user company state: type: string description: State/province name of an extension user company. Mandatory for the USA, UK and Canada city: type: string description: City name of an extension user company street: type: string description: Street address of an extension user company zip: type: string description: Zip code of an extension user company WirelessPointValidated: type: object properties: id: type: string description: Internal identifier of a wireless point bssid: type: string description: Unique 48-bit identifier of the wireless access point that follows MAC address conventions status: type: string enum: - Valid - Invalid description: Validation result status errors: type: array items: $ref: '#/definitions/ValidationError' ContactInfoUpdateRequest: type: object properties: firstName: type: string description: For User extension type only. Extension user first name lastName: type: string description: For User extension type only. Extension user last name company: type: string description: Extension user company name jobTitle: type: string email: type: string description: Email of extension user businessPhone: type: string description: Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format mobilePhone: type: string description: Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format businessAddress: $ref: '#/definitions/ContactBusinessAddressInfo' emailAsLoginName: type: boolean description: ' If ''True'' then contact email is enabled as login name for this user. Please note that email should be unique in this case. The default value is ''False''' pronouncedName: $ref: '#/definitions/PronouncedNameInfo' department: type: string description: Extension user department, if any GrantInfo: type: object properties: uri: type: string description: Canonical URI of a grant extension: description: Extension information $ref: '#/definitions/ExtensionInfoGrants' callPickup: type: boolean description: Specifies if picking up of other extensions' calls is allowed for the extension. If 'Presence' feature is disabled for the given extension, the flag is not returned callMonitoring: type: boolean description: Specifies if monitoring of other extensions' calls is allowed for the extension. If 'CallMonitoring' feature is disabled for the given extension, the flag is not returned callOnBehalfOf: type: boolean description: Specifies whether the current extension is able to make or receive calls on behalf of the user referenced in extension object callDelegation: type: boolean description: Specifies whether the current extension can delegate a call to the user referenced in extension object groupPaging: type: boolean description: Specifies whether the current extension is allowed to call Paging Only group referenced to in extension object CallQueueMemberInfo: type: object properties: uri: type: string description: Link to a call queue member id: type: string description: Internal identifier of a call queue member extensionNumber: type: string description: Extension number of a call queue member AccountLimits: type: object properties: freeSoftPhoneLinesPerExtension: type: integer description: Max number of free softphone phone lines per user extension meetingSize: type: integer description: Max number of participants in RingCentral meeting hosted by this account's user cloudRecordingStorage: type: integer description: Meetings recording cloud storage limitaion in Gb maxMonitoredExtensionsPerUser: type: integer description: Max number of extensions which can be included in the list of users monitored for Presence maxExtensionNumberLength: type: integer description: Max length of extension numbers of an account; the supported value is up to 8 symbols, depends on account type default: 5 siteCodeLength: type: integer description: Length of a site code shortExtensionNumberLength: type: integer description: Length of a short extension number Roles: type: object properties: uri: type: string id: type: string description: Internal identifier of a role ExtensionStatusInfo: type: object properties: comment: type: string description: A free-form user comment, describing the status change reason reason: type: string description: Type of suspension enum: - Voluntarily - Involuntarily SwitchValidated: type: object properties: id: type: string description: Internal identifier of a switch chassisId: type: string description: Unique identifier of a network switch status: type: string enum: - Valid - Invalid description: Validation result status errors: type: array items: $ref: '#/definitions/ValidationError' CallQueueInfoRequest: type: object properties: slaGoal: type: integer description: Target percentage of calls that must be answered by agents within the service level time threshold slaThresholdSeconds: type: integer includeAbandonedCalls: type: boolean abandonedThresholdSeconds: type: integer LocationInfo: type: object properties: uri: type: string description: Canonical URI of a location areaCode: type: string description: Area code of the location city: type: string description: Official name of the city, belonging to the certain state npa: type: string description: Area code of the location (3-digit usually), according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan nxx: type: string description: Central office code of the location, according to the NANP number format, that can be summarized as NPA-NXX-xxxx and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See for details North American Numbering Plan state: type: string description: ID and URI of the state this location belongs to, see State Info ProfileImageInfo: type: object required: - uri properties: uri: type: string description: Link to a profile image. If an image is not uploaded for an extension, only uri is returned etag: type: string description: Identifier of an image lastModified: type: string format: date-time description: The datetime when an image was last updated in ISO 8601 format, for example 2016-03-10T18:07:52.534Z contentType: type: string description: The type of an image scales: type: array items: $ref: '#/definitions/ProfileImageInfoURI' description: List of URIs to profile images in different dimensions GetCountryInfoState: type: object properties: id: type: string description: Internal identifier of a state uri: type: string description: Canonical URI of a state CallerIdByFeature: type: object properties: feature: type: string enum: - RingOut - RingMe - CallFlip - FaxNumber - AdditionalSoftphone - Alternate - CommonPhone - MobileApp - Delegated callerId: $ref: '#/definitions/CallerIdByFeatureInfo' UpdateSwitchInfo: type: object properties: id: type: string description: internal identifier of a switch chassisId: type: string description: 'Unique identifier of a network switch. The supported formats are: XX:XX:XX:XX:XX:XX (symbols 0-9 and A-F) for MAC address and X.X.X.X for IP address (symbols 0-255)' name: type: string description: Name of a network switch site: description: Site data $ref: '#/definitions/SwitchSiteInfo' emergencyAddress: description: Emergency address assigned to the switch $ref: '#/definitions/LocationUpdatesEmergencyAddressInfo' MissedCallsInfo: type: object properties: notifyByEmail: type: boolean description: Email notification flag notifyBySms: type: boolean description: SMS notification flag advancedEmailAddresses: type: array description: List of recipient email addresses for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string advancedSmsEmailAddresses: type: array description: List of recipient phone numbers for missed call notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string BulkTaskInfo: type: object properties: id: type: string description: Internal identifier of a task for multiple switches creation status: type: string enum: - Accepted - Failed description: Status of a task creationTime: type: string description: Task creation time lastModifiedTime: type: string description: Time of the task latest modification ExtensionPermissions: type: object description: Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling' properties: admin: description: Admin permission $ref: '#/definitions/PermissionInfo' internationalCalling: description: International Calling permission $ref: '#/definitions/PermissionInfo' ExtensionGrantListEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension ownerId: type: string description: Internal identifier of a subscription owner extension PagingGroupExtensionInfo: type: object properties: id: type: string description: Internal identifier of a paging group user extension uri: type: string description: Link to a paging group user extension extensionNumber: type: string description: Extension number of a paging group user name: type: string description: Name of a paging group user ExtensionRegionalSettingRequest: type: object properties: homeCountry: $ref: '#/definitions/ExtensionCountryInfoRequest' timezone: $ref: '#/definitions/ExtensionTimezoneInfoRequest' language: $ref: '#/definitions/ExtensionLanguageInfoRequest' greetingLanguage: $ref: '#/definitions/ExtensionGreetingLanguageInfoRequest' formattingLocale: $ref: '#/definitions/ExtensionFormattingLocaleInfoRequest' timeFormat: type: string enum: - 12h - 24h default: 12h description: Time format setting CallMonitoringExtensionUpdate: type: object properties: id: type: string description: 'Only the following extension types are allowed: User, DigitalUser, VirtualUser, FaxUser, Limited' permissions: description: Set of call monitoring group permissions granted to the specified extension. In order to remove the specified extension from a call monitoring group use an empty value type: array items: type: string enum: - Monitoring - Monitored AutomaticLocationUpdatesDeviceInfo: type: object properties: id: type: string description: Internal identifier of a device type: type: string description: Device type default: HardPhone enum: - HardPhone - SoftPhone - OtherPhone serial: type: string description: Serial number for HardPhone (is returned only when the phone is shipped and provisioned) featureEnabled: type: boolean description: Specifies if Automatic Location Updates feature is enabled name: type: string description: Device name model: description: HardPhone model information $ref: '#/definitions/AutomaticLocationUpdatesModelInfo' site: type: string description: Site data $ref: '#/definitions/AutomaticLocationUpdatesSiteInfo' phoneLines: description: Phone lines information type: array items: $ref: '#/definitions/AutomaticLocationUpdatesPhoneLine' ServiceInfo: type: object properties: uri: type: string description: Canonical URI of a service info resource billingPlan: description: Information on account billing plan $ref: '#/definitions/BillingPlanInfo' brand: description: Information on account brand $ref: '#/definitions/BrandInfo' servicePlan: description: Information on account service plan $ref: '#/definitions/ServicePlanInfo' targetServicePlan: description: Information on account target service plan $ref: '#/definitions/TargetServicePlanInfo' LocationUpdatesEmergencyAddressInfo: type: object properties: country: type: string description: Country name countryId: type: string description: Internal identifier of a country countryIsoCode: type: string description: ISO code of a country countryName: type: string description: Full name of a country state: type: string description: State/Province name. Mandatory for the USA, the UK and Canada stateId: type: string description: Internal identifier of a state stateIsoCode: type: string description: ISO code of a state stateName: type: string description: Full name of a state city: type: string description: City name street: type: string description: First line address street2: type: string description: Second line address (apartment, suite, unit, building, floor, etc.) zip: type: string description: Postal (Zip) code SwitchSiteInfo: type: object properties: id: type: string description: Internal identifier of a site. The company identifier value is 'main-site' name: type: string description: Name of a site PhoneNumberInfoConferencing: type: object properties: country: description: Information on a home country of a conference phone number $ref: '#/definitions/GetCountryInfoConferencing' default: type: boolean description: '''True'' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed' hasGreeting: type: boolean description: '''True'' if the greeting message is played on this number' location: type: string description: Location (city, region, state) of a conference phone number phoneNumber: type: string description: Dial-in phone number to connect to a conference AccountStatusInfo: type: object properties: comment: type: string description: A free-form user comment, describing the status change reason reason: type: string description: Type of suspension enum: - Voluntarily - Involuntarily till: type: string description: Date until which the account will get deleted. The default value is 30 days since current date CallMonitoringGroupMemberInfo: type: object properties: uri: type: string description: Link to a call monitoring group member id: type: string description: Internal identifier of a call monitoring group member extensionNumber: type: string description: Extension number of a call monitoring group member permissions: type: string enum: - Monitoring - Monitored description: | Call monitoring permission; mltiple values allowed: * "Monitoring" - User can monitor a group * "Monitored" - User can be monitored PrivateIpRangeInfo: type: object properties: id: type: string startIp: type: string endIp: type: string BulkAssignItem: type: object properties: departmentId: type: string addedExtensionIds: type: array items: type: string removedExtensionIds: type: array items: type: string DepartmentInfo: type: object properties: id: type: string description: Internal identifier of a department extension uri: type: string description: Canonical URI of a department extension extensionNumber: type: string description: Number of a department extension CallQueueInfo: type: object properties: uri: type: string description: Link to a call queue id: type: string description: Internal identifier of a call queue extensionNumber: type: string description: Extension number of a call queue name: type: string description: Name of a call queue ServiceFeatureInfo: type: object properties: featureName: type: string description: Feature name enum: - AccountFederation - Archiver - AutomaticCallRecordingMute - AutomaticInboundCallRecording - AutomaticOutboundCallRecording - BlockedMessageForwarding - Calendar - CallerIdControl - CallForwarding - CallPark - CallParkLocations - CallSupervision - CallSwitch - CallQualitySurvey - Conferencing - ConfigureDelegates - DeveloperPortal - DND - DynamicConference - EmergencyAddressAutoUpdate - EmergencyCalling - EncryptionAtRest - ExternalDirectoryIntegration - Fax - FaxReceiving - FreeSoftPhoneLines - HDVoice - HipaaCompliance - Intercom - InternationalCalling - InternationalSMS - LinkedSoftphoneLines - MMS - OnDemandCallRecording - Pager - PagerReceiving - Paging - PasswordAuth - PromoMessage - Reports - Presence - RCTeams - RingOut - SalesForce - SharedLines - SingleExtensionUI - SiteCodes - SMS - SMSReceiving - SoftPhoneUpdate - TelephonySessions - UserManagement - VideoConferencing - VoipCalling - VoipCallingOnMobile - Voicemail - VoicemailToText - WebPhone enabled: type: boolean description: Feature status, shows feature availability for the extension UserTransitionInfo: type: object properties: sendWelcomeEmailsToUsers: type: boolean description: Specifies if an activation email is automatically sent to new users (Not Activated extensions) or not sendWelcomeEmail: type: boolean description: Supported for account confirmation. Specifies whether welcome email is sent CountryInfo: type: object properties: id: type: string description: Internal identifier of a home country uri: type: string description: Canonical URI of a home country name: type: string description: Official name of a home country isoCode: type: string description: ISO code of a country callingCode: type: string description: Calling code of a country InboundTextsInfo: type: object properties: notifyByEmail: type: boolean description: Email notification flag notifyBySms: type: boolean description: SMS notification flag advancedEmailAddresses: type: array description: List of recipient email addresses for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string advancedSmsEmailAddresses: type: array description: List of recipient phone numbers for inbound text message notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string ContactInfo: type: object required: - firstName - email properties: firstName: type: string description: For User extension type only. Extension user first name lastName: type: string description: For User extension type only. Extension user last name company: type: string description: Extension user company name jobTitle: type: string email: type: string description: Email of extension user businessPhone: type: string description: Extension user contact phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format mobilePhone: type: string description: Extension user mobile (**non** Toll Free) phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format businessAddress: description: Business address of extension user company $ref: '#/definitions/ContactBusinessAddressInfo' emailAsLoginName: type: boolean description: If 'True' then contact email is enabled as login name for this user. Please note that email should be unique in this case. default: "False" pronouncedName: $ref: '#/definitions/PronouncedNameInfo' department: type: string description: Extension user department, if any OutboundFaxesInfo: type: object properties: notifyByEmail: type: boolean description: Email notification flag notifyBySms: type: boolean description: SMS notification flag advancedEmailAddresses: type: array description: List of recipient email addresses for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string advancedSmsEmailAddresses: type: array description: List of recipient phone numbers for outbound fax notifications. Returned if specified, in both modes (advanced/basic). Applied in advanced mode only items: type: string ReferenceInfo: type: object properties: ref: type: string description: Non-RC identifier of an extension type: type: string description: Type of external identifier enum: - PartnerId - CustomerDirectoryId ConferencePhoneNumberInfo: type: object properties: phoneNumber: type: string description: Dial-in phone number to connect to a conference default: type: boolean description: '''True'' if the number is default for the conference. Default conference number is a domestic number that can be set by user (otherwise it is set by the system). Only one default number per country is allowed' ExtensionListEventBody: type: object properties: extensionId: type: string description: Internal identifier of an extension eventType: type: string description: Type of extension info change enum: - Create - Update - Delete ownerId: type: string description: Internal identifier of a subscription owner extension AutomaticLocationUpdatesPhoneLine: type: object properties: lineType: type: string enum: - Unknown - Standalone - StandaloneFree - BlaPrimary - BlaSecondary - BLF phoneInfo: $ref: '#/definitions/AutomaticLocationUpdatesPhoneNumberInfo' ServicePlanInfo: type: object properties: id: type: string description: Internal identifier of a service plan name: type: string description: Name of a service plan edition: type: string description: Edition of a service plan FormattingLocaleInfo: type: object description: Official name of a formatting language properties: id: type: string description: Internal identifier of a formatting language localeCode: type: string description: Localization code of a formatting language name: type: string ProvisioningNavigationInfoUri: type: object properties: uri: type: string ValidationError: type: object properties: errorCode: type: string description: Error code message: type: string description: Error message parameterName: type: string description: Name of invalid parameter ExtensionCountryInfoRequest: type: object properties: id: type: string description: internal Identifier of a country ExtensionTimezoneInfoRequest: type: object properties: id: type: string description: internal Identifier of a timezone AutomaticLocationUpdatesSiteInfo: type: object properties: id: type: string description: Internal identifier of a site name: type: string description: Name of a site BrandInfo: type: object properties: id: type: string description: Internal identifier of a brand name: type: string description: 'Brand name, for example RingCentral UK , ClearFax ' homeCountry: description: Home country information $ref: '#/definitions/CountryInfo' TargetServicePlanInfo: type: object properties: id: type: string description: Internal identifier of a target service plan name: type: string description: Name of a target service plan CallerIdDeviceInfo: type: object properties: id: type: string description: Internal identifier of a device uri: type: string description: Link to a device resource phoneNumber: type: string description: Name of a device TimezoneInfo: type: object properties: id: type: string description: Internal identifier of a timezone uri: type: string description: Canonical URI of a timezone name: type: string description: Short name of a timezone description: type: string description: Meaningful description of the timezone GreetingLanguageInfo: type: object properties: id: type: string description: Internal identifier of a greeting language localeCode: type: string description: Localization code of a greeting language name: type: string description: Official name of a greeting language ExtensionFormattingLocaleInfoRequest: type: object properties: id: type: string description: Internal Identifier of a formatting language AutomaticLocationUpdatesModelInfo: type: object properties: id: type: string description: Device model identifier name: type: string description: Device name features: description: Device feature or multiple features supported type: array items: type: string enum: - BLA - Intercom - Paging - HELD BillingPlanInfo: type: object properties: id: type: string description: Internal identifier of a billing plan name: type: string description: Billing plan name durationUnit: type: string description: Duration period enum: - Month - Day duration: type: string description: Number of duration units type: type: string description: Billing plan type enum: - Initial - Regular - Suspended - Trial - TrialNoCC - Free CallerIdByDeviceInfo: type: object properties: type: type: string description: If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation'] phoneInfo: $ref: '#/definitions/CallerIdPhoneInfo' PronouncedNameInfo: type: object properties: type: type: string description: Voice name type. 'Default' - default extension name; first name and last name specified in user profile; 'TextToSpeech' - custom text; user name spelled the way it sounds and specified by user; 'Recorded' - custom audio, user name recorded in user's own voice (supported only for extension retrieval) enum: - Default - TextToSpeech - Recorded text: type: string description: Custom text ExtensionInfoGrants: type: object properties: id: type: string description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension extensionNumber: type: string description: Extension short number (usually 3 or 4 digits) type: type: string description: Extension type enum: - User - Fax User - VirtualUser - DigitalUser - Department - Announcement - Voicemail - SharedLinesGroup - PagingOnly - IvrMenu - ApplicationExtension - Park Location ProfileImageInfoURI: type: object properties: uri: type: string PermissionInfo: type: object properties: enabled: type: boolean description: Specifies if a permission is enabled or not ExtensionLanguageInfoRequest: type: object properties: id: type: string description: internal Identifier of a language CallerIdByFeatureInfo: type: object properties: type: type: string description: If 'PhoneNumber' value is specified, then a certain phone number is shown as a caller ID when using this telephony feature. If 'Blocked' value is specified, then a caller ID is hidden. The value 'CurrentLocation' can be specified for 'RingOut' feature only. The default is 'PhoneNumber' = ['PhoneNumber', 'Blocked', 'CurrentLocation'] phoneInfo: $ref: '#/definitions/CallerIdPhoneInfo' ExtensionGreetingLanguageInfoRequest: type: object properties: id: type: string description: internal Identifier of a greeting language GetCountryInfoConferencing: type: object properties: id: type: string description: Internal identifier of a country uri: type: string description: Canonical URI of a country callingCode: type: string description: Country calling code defined by ITU-T recommendations [E.123](https://www.itu.int/rec/T-REC-E.123-200102-I/en) and [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) emergencyCalling: type: boolean description: Emergency calling feature availability/emergency address requirement indicator isoCode: type: string description: Country code according to the ISO standard, see [ISO 3166](https://www.iso.org/iso-3166-country-codes.html) name: type: string description: Official name of a country AutomaticLocationUpdatesPhoneNumberInfo: type: object properties: id: type: integer description: Internal identifier of a phone number phoneNumber: type: string description: Phone number CallerIdPhoneInfo: type: object properties: id: type: string description: Internal identifier of a phone number uri: type: string description: Link to a phone number resource phoneNumber: type: string description: Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) (with '+' sign) format ParsePhoneNumberRequest: type: object properties: originalStrings: type: array description: Phone numbers passed in a string. The maximum value of phone numbers is limited to 64. The maximum number of symbols in each phone number in a string is 64 items: type: string ParsePhoneNumberResponse: type: object required: - homeCountry - phoneNumbers properties: uri: type: string description: Canonical URI of a resource homeCountry: type: array description: Information on a user home country items: $ref: '#/definitions/GetCountryInfoNumberParser' phoneNumbers: type: array description: Parsed phone numbers data items: $ref: '#/definitions/PhoneNumberInfoNumberParser' GetCountryInfoNumberParser: type: object properties: id: type: string description: Internal identifier of a country uri: type: string description: Canonical URI of a country callingCode: type: string description: Country calling code defined by ITU-T recommendations E.123 and E.164, see Calling Codes emergencyCalling: type: boolean description: Emergency calling feature availability/emergency address requirement indicator isoCode: type: string description: Country code according to the ISO standard, see ISO 3166 name: type: string description: Official name of a country PhoneNumberInfoNumberParser: type: object properties: areaCode: type: string description: Area code of location. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a specific geographic region/numbering area of the national numbering plan (NANP); that can be summarized as `NPA-NXX-xxxx` and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See [North American Numbering Plan] (https://en.wikipedia.org/wiki/North_American_Numbering_Plan) for details country: type: array description: Information on a country the phone number belongs to items: $ref: '#/definitions/GetCountryInfoNumberParser' dialable: type: string description: Dialing format of a phone number e164: type: string description: Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format formattedInternational: type: string description: International format of a phone number formattedNational: type: string description: Domestic format of a phone number originalString: type: string description: One of the numbers to be parsed, passed as a string in response special: type: boolean description: '''True'' if the number is in a special format (for example N11 code)' normalized: type: string description: Phone number [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format without plus sign ('+') tollFree: type: boolean description: Specifies if a phone number is toll free or not subAddress: type: string description: Sub-Address. The portion of the number that identifies a subscriber into the subscriber internal (non-public) network. subscriberNumber: type: string description: ' Subscriber number. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a subscriber in a network or numbering area.' dtmfPostfix: type: string description: DTMF (Dual Tone Multi-Frequency) postfix GetDeviceInfoResponse: type: object properties: id: type: string description: Internal identifier of a device uri: type: string description: Canonical URI of a device sku: type: string description: Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2' type: type: string description: Device type default: HardPhone enum: - SoftPhone - OtherPhone - HardPhone name: type: string description: 'Device name. Mandatory if ordering SoftPhone or OtherPhone . Optional for HardPhone . If not specified for HardPhone, then device model name is used as device name ' serial: type: string description: Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications computerName: type: string description: PC name for softphone model: description: HardPhone model information $ref: '#/definitions/ModelInfo' extension: description: This attribute can be omitted for unassigned devices $ref: '#/definitions/ExtensionInfoIntId' emergencyServiceAddress: description: Address for emergency cases. The same emergency address is assigned to all the numbers of one device $ref: '#/definitions/DeviceEmergencyAddressInfo' phoneLines: description: Phone lines information type: array items: $ref: '#/definitions/PhoneLinesInfo' shipping: description: Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer $ref: '#/definitions/ShippingInfo' boxBillingId: type: integer description: Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. EitherT? model structure, or boxBillingId must be specified forT?HardPhone useAsCommonPhone: type: boolean description: Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone. inCompanyNet: type: boolean description: Network location status. 'True' if the device is located in the configured corporate network (On-Net); 'False' for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined site: $ref: '#/definitions/DeviceSiteInfo' description: Site data lastLocationReportTime: type: string description: Datetime of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z GetExtensionDevicesResponse: type: object required: - navigation - paging - records properties: records: type: array description: List of extension devices items: $ref: '#/definitions/GetDeviceInfoResponse' navigation: description: Information on navigation $ref: '#/definitions/DeviceProvisioningNavigationInfo' paging: description: Information on paging $ref: '#/definitions/DeviceProvisioningPagingInfo' AccountDeviceUpdate: type: object properties: emergencyServiceAddress: description: Address for emergency cases. The same emergency address is assigned to all numbers of a single device $ref: '#/definitions/DeviceEmergencyAddressInfoRequest' extension: description: Information on extension that the device is assigned to $ref: '#/definitions/DeviceUpdateExtensionInfo' phoneLines: description: Information on phone lines added to a device $ref: '#/definitions/DeviceUpdatePhoneLinesInfo' useAsCommonPhone: type: boolean description: Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone. DeviceResource: type: object properties: id: type: string description: Internal identifier of a device uri: type: string format: uri description: Canonical URI of a device sku: type: string description: Device identification number (stock keeping unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC HardPhone, DV for all other devices including softphone); ID - device model ID; AT -addon type ID; AC - addon count (if any). For example 'HP-56-2-2' type: type: string description: Device type default: HardPhone enum: - HardPhone - SoftPhone - OtherPhone - Paging - WebPhone status: type: string description: Status of a device enum: - Online - Offline name: type: string description: Device name. Mandatory if ordering SoftPhone or OtherPhone . Optional for HardPhone . If not specified for HardPhone, then device model name is used as device name serial: type: string description: Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint_id for softphone and mobile applications computerName: type: string description: PC name for softphone model: description: HardPhone model information $ref: '#/definitions/ModelInfo' extension: description: This attribute can be omitted for unassigned devices $ref: '#/definitions/ExtensionResourceIntId' phoneLines: description: Phone lines information type: array items: $ref: '#/definitions/PhoneLineResource' emergencyServiceAddress: description: ' Address for emergency cases. The same emergency address is assigned to all numbers of a single device ,' $ref: '#/definitions/EmergencyServiceAddressResource' shipping: description: Shipping information, according to which devices (in case of HardPhone ) or e911 stickers (in case of SoftPhone and OtherPhone ) will be delivered to the customer $ref: '#/definitions/ShippingResource' boxBillingId: type: integer description: Box billing identifier of a device. Applicable only for HardPhones. It is an alternative way to identify the device to be ordered. Either model structure, or boxBillingId must be specified for HardPhone linePooling: type: string description: Pooling type of a deviceHost - device with standalone paid phone line which can be linked to Glip/Softphone instanceGuest - device with a linked phone lineNone - device without a phone line or with specific line (free, BLA, etc.) = ['Host', 'Guest', 'None'] enum: - Host - Guest - None useAsCommonPhone: type: boolean description: Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone. DeviceSiteInfo: type: object properties: id: type: string description: Internal identifier of a site name: type: string description: Name of a site DeviceUpdatePhoneLinesInfo: type: object properties: phoneLines: type: array description: Information on phone lines added to a device items: $ref: '#/definitions/UpdateDevicePhoneInfo' ExtensionResourceIntId: type: object properties: uri: type: string format: uri id: type: integer format: int64 partnerId: type: string minLength: 0 maxLength: 128 pattern: ^[\p{Alnum}\.\-_]*$ extensionNumber: type: string loginName: type: string contact: $ref: '#/definitions/ExtensionContactInfo' references: type: array items: $ref: '#/definitions/Reference' name: type: string type: type: string enum: - Unknown - User - Department - Announcement - Voicemail - DigitalUser - VirtualUser - FaxUser - PagingOnly - SharedLinesGroup - IvrMenu - ApplicationExtension - ParkLocation status: type: string enum: - Enabled - Disabled - Frozen - NotActivated - Unassigned statusInfo: $ref: '#/definitions/StatusInfo' departments: type: array items: $ref: '#/definitions/DepartmentResource' serviceFeatures: type: array items: $ref: '#/definitions/ServiceFeatureValue' regionalSettings: $ref: '#/definitions/RegionalSettingsInfo' setupWizardState: type: string enum: - NotStarted - Incomplete - Completed - Unknown permissions: $ref: '#/definitions/ExtensionPermissionsResource' password: type: string ivrPin: type: string profileImage: $ref: '#/definitions/ProfileImageResource' PhoneLineResource: type: object properties: lineType: type: string enum: - Unknown - Standalone - StandaloneFree - BlaPrimary - BlaSecondary - BLF phoneInfo: $ref: '#/definitions/PhoneNumberResourceIntId' emergencyAddress: $ref: '#/definitions/EmergencyAddress' PhoneLinesInfo: type: object properties: lineType: type: string description: Type of phone line enum: - Standalone - StandaloneFree - BlaPrimary - BlaSecondary phoneInfo: description: Phone number information $ref: '#/definitions/PhoneNumberInfoIntId' ShippingInfo: type: object required: - address - method properties: status: type: string description: Shipping status of the order item. It is set to 'Initial' when the order is submitted. Then it is changed to 'Accepted' when a distributor starts processing the order. Finally it is changed to Shipped which means that distributor has shipped the device. enum: - Initial - Accepted - Shipped carrier: type: string description: Shipping carrier name. Appears only if the device status is 'Shipped' trackingNumber: type: string description: Carrier-specific tracking number. Appears only if the device status is 'Shipped' method: description: Shipping method information $ref: '#/definitions/MethodInfo' address: description: Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case an order contains several devices, they can be delivered to different addresses $ref: '#/definitions/ShippingAddressInfo' DeviceProvisioningNavigationInfo: type: object properties: firstPage: description: Canonical URI for the first page of the list $ref: '#/definitions/DeviceProvisioningNavigationInfoUri' nextPage: description: Canonical URI for the next page of the list $ref: '#/definitions/DeviceProvisioningNavigationInfoUri' previousPage: description: Canonical URI for the previous page of the list $ref: '#/definitions/DeviceProvisioningNavigationInfoUri' lastPage: description: Canonical URI for the last page of the list $ref: '#/definitions/DeviceProvisioningNavigationInfoUri' DeviceProvisioningPagingInfo: type: object properties: page: type: integer description: The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) perPage: type: integer description: Current page size, describes how many items are in each page. Default value is 100. Maximum value is 1000. If perPage value in the request is greater than 1000, the maximum value (1000) is applied pageStart: type: integer description: The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty pageEnd: type: integer description: The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty totalPages: type: integer description: The total number of pages in a dataset. May be omitted for some resources due to performance reasons totalElements: type: integer description: The total number of elements in a dataset. May be omitted for some resource due to performance reasons DeviceEmergencyAddressInfoRequest: type: object properties: customerName: type: string description: Name of a customer street: type: string description: Street address, line 1 - street address, P.O. box, company name, c/o street2: type: string description: Street address, line 2 - apartment, suite, unit, building, floor, etc. city: type: string description: City name zip: type: string description: Zip code state: type: string description: State/province name country: type: string description: Country name DeviceUpdateExtensionInfo: type: object properties: id: type: string description: Internal identifier of an extension EmergencyServiceAddressResource: type: object properties: street: type: string street2: type: string city: type: string zip: type: string customerName: type: string state: type: string description: State/province name stateId: type: string description: Internal identifier of a state stateIsoCode: type: string description: ISO code of a state stateName: type: string description: Full name of a state countryId: type: string description: Internal identifier of a country countryIsoCode: type: string description: ISO code of a country country: type: string description: Country name countryName: type: string description: Full name of a country ShippingResource: type: object properties: address: $ref: '#/definitions/EmergencyServiceAddressResource' method: $ref: '#/definitions/MethodResource' status: type: string carrier: type: string trackingNumber: type: string ModelInfo: type: object required: - addons properties: id: type: string description: Addon identifier. For HardPhones of certain types, which are compatible with this addon identifier name: type: string description: Device name addons: description: Addons description type: array items: $ref: '#/definitions/AddonInfo' features: description: Device feature or multiple features supported type: array items: type: string enum: - BLA - Intercom - Paging - HELD ExtensionInfoIntId: type: object properties: id: type: integer format: int64 description: Internal identifier of an extension uri: type: string description: Canonical URI of an extension extensionNumber: type: string description: Number of department extension partnerId: type: string description: For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid = XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension DeviceEmergencyAddressInfo: type: object properties: customerName: type: string description: Name of a customer street: type: string description: Street address, line 1 - street address, P.O. box, company name, c/o street2: type: string description: Street address, line 2 - apartment, suite, unit, building, floor, etc. city: type: string description: City name zip: type: string description: Zip code state: type: string description: State/province name stateId: type: string description: Internal identifier of a state stateIsoCode: type: string description: ISO code of a state stateName: type: string description: Full name of a state countryId: type: string description: Internal identifier of a country countryIsoCode: type: string description: ISO code of a country country: type: string description: Country name countryName: type: string description: Full name of a country syncStatus: type: string description: Resulting status of emergency address synchronization. Returned for 'Get Device Info' request if `syncEmergencyAddress` parameter is set to 'True' enum: - Verified - Updated - Deleted - NotRequired - Unsupported - Failed UpdateDevicePhoneInfo: type: object properties: id: type: string description: Internal identifier of a phone number StatusInfo: type: object properties: reason: type: string till: type: string format: date-time comment: type: string RegionalSettingsInfo: type: object properties: timezone: $ref: '#/definitions/TimezoneResource' homeCountry: $ref: '#/definitions/CountryResource' language: $ref: '#/definitions/LanguageResource' greetingLanguage: $ref: '#/definitions/LanguageResource' formattingLocale: $ref: '#/definitions/LanguageResource' PhoneNumberResourceIntId: type: object properties: id: type: integer format: int64 description: Internal identifier of a phone number country: description: Brief information on a phone number country $ref: '#/definitions/CountryResource' extension: description: Information on an extension to which the phone number is assigned $ref: '#/definitions/PhoneNumberExtensionInfo' label: type: string description: Custom user name of a phone number, if any location: type: string description: Location (City, State). Filled for local US numbers paymentType: type: string description: Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system = ['External', 'TollFree', 'Local'], enum: - External - TollFree - Local phoneNumber: type: string description: Phone number minLength: 0 maxLength: 128 status: type: string description: Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral , usageType: type: string enum: - CompanyNumber - MainCompanyNumber - AdditionalCompanyNumber - DirectNumber - CompanyFaxNumber - ForwardedNumber - ForwardedCompanyNumber - ContactCenterNumber type: type: string description: Type of a phone number enum: - VoiceFax - FaxOnly - VoiceOnly reservationId: type: string description: Internal identifier of a phone number reservation; encoded data including reservation type (by brand, by account, by session), particular brand/account/session data, and reservation date and time MethodResource: type: object properties: id: type: string name: type: string AddonInfo: type: object properties: id: type: string name: type: string count: type: string format: int32 DepartmentResource: type: object properties: uri: type: string format: uri id: type: string extensionNumber: type: string EmergencyAddress: type: object properties: required: type: boolean description: ' ''True'' if specifying of emergency address is required' localOnly: type: boolean description: ' ''True'' if only local emergency address can be specified' DeviceProvisioningNavigationInfoUri: type: object properties: uri: type: string Reference: type: object properties: type: type: string enum: - PartnerId - CustomerDirectoryId ref: type: string PhoneNumberInfoIntId: type: object properties: id: type: integer format: int64 description: Internal identifier of a phone number country: description: Brief information on a phone number country $ref: '#/definitions/PhoneNumberCountryInfo' extension: description: Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list $ref: '#/definitions/ExtensionInfo' label: type: string description: Custom user name of a phone number, if any location: type: string description: Location (City, State). Filled for local US numbers paymentType: type: string description: Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system enum: - External - TollFree - Local phoneNumber: type: string description: Phone number status: type: string description: Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise it is an external number not yet ported to RingCentral type: type: string description: Phone number type enum: - VoiceFax - FaxOnly - VoiceOnly usageType: type: string description: Usage type of the phone number enum: - MainCompanyNumber - AdditionalCompanyNumber - CompanyNumber - DirectNumber - CompanyFaxNumber - ForwardedNumber - ForwardedCompanyNumber - ContactCenterNumber MethodInfo: type: object properties: id: type: string description: Method identifier. The default value is 1 (Ground) enum: - "1" - "2" - "3" name: type: string description: Method name, corresponding to the identifier enum: - Ground - 2 Day - Overnight ShippingAddressInfo: type: object properties: customerName: type: string description: Name of a receiver street: type: string description: Street address, line 1 - street address, P.O. box, company name, c/o street2: type: string description: Street address, line 2 - apartment, suite, unit, building, floor, etc. city: type: string description: City name state: type: string description: State/province name stateId: type: string description: Internal identifier of a state stateIsoCode: type: string description: ISO code of a state stateName: type: string description: Full name of a state countryId: type: string description: Internal identifier of a country countryIsoCode: type: string description: ISO code of a country country: type: string description: Country name countryName: type: string description: Full name of a country zip: type: string description: Zip code ExtensionContactInfo: type: object properties: firstName: type: string description: For User extension type only. Extension user first name lastName: type: string description: For User extension type only. Extension user last name company: type: string description: Extension user company name email: type: string description: Email of extension user businessPhone: type: string description: Extension user contact phone number businessAddress: description: Business address of extension user company $ref: '#/definitions/ContactAddressInfo' ServiceFeatureValue: type: object properties: featureName: type: string enabled: type: boolean default: false reason: type: string enum: - Available - AccountTypeLimitation - ExtensionTypeLimitation - AccountLimitation - ExtensionLimitation - InsufficientPermissions - ApplicationLimitation ExtensionPermissionsResource: type: object properties: uri: type: string format: uri admin: $ref: '#/definitions/Permission' internationalCalling: $ref: '#/definitions/Permission' freeSoftPhoneDigitalLine: $ref: '#/definitions/Permission' ProfileImageResource: type: object properties: uri: type: string format: uri etag: type: string contentType: type: string lastModified: type: string format: date-time scales: type: array items: $ref: '#/definitions/ScaledProfileImageResource' Permission: type: object properties: enabled: type: boolean default: false ScaledProfileImageResource: type: object properties: uri: type: string format: uri LanguageResource: type: object properties: id: type: string name: type: string localeCode: type: string PhoneNumberExtensionInfo: type: object properties: uri: type: string format: uri id: type: string partnerId: type: string minLength: 0 maxLength: 128 pattern: ^[\p{Alnum}\.\-_]*$ extensionNumber: type: string loginName: type: string contact: $ref: '#/definitions/ExtensionContactInfo' references: type: array items: $ref: '#/definitions/Reference' name: type: string type: type: string enum: - Unknown - User - Department - Announcement - Voicemail - DigitalUser - VirtualUser - FaxUser - PagingOnly - SharedLinesGroup - IvrMenu - ApplicationExtension - ParkLocation status: type: string enum: - Enabled - Disabled - Frozen - NotActivated - Unassigned statusInfo: $ref: '#/definitions/StatusInfo' departments: type: array items: $ref: '#/definitions/DepartmentResource' serviceFeatures: type: array items: $ref: '#/definitions/ServiceFeatureValue' regionalSettings: $ref: '#/definitions/RegionalSettingsInfo' setupWizardState: type: string enum: - NotStarted - Incomplete - Completed - Unknown permissions: $ref: '#/definitions/ExtensionPermissionsResource' password: type: string ivrPin: type: string profileImage: $ref: '#/definitions/ProfileImageResource' PhoneNumberCountryInfo: type: object properties: id: type: string description: Internal identifier of a home country uri: type: string description: Canonical URI of a home country name: type: string description: Official name of a home country UserPatch: type: object required: - Operations - schemas properties: Operations: type: array description: patch operations list items: $ref: '#/definitions/PatchOperation' schemas: type: array items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:PatchOp ServiceProviderConfig: type: object properties: authenticationSchemes: type: array items: type: object $ref: '#/definitions/AuthenticationScheme' bulk: $ref: '#/definitions/BulkSupported' changePassword: $ref: '#/definitions/Supported' etag: $ref: '#/definitions/Supported' filter: $ref: '#/definitions/FilterSupported' patch: $ref: '#/definitions/Supported' schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig sort: $ref: '#/definitions/Supported' xmlDataFormat: $ref: '#/definitions/Supported' UserSearchResponse: type: object properties: Resources: type: array description: user list items: $ref: '#/definitions/UserResponse' itemsPerPage: type: integer format: int64 schemas: type: array items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:ListResponse startIndex: type: integer format: int64 totalResults: type: integer format: int64 ScimErrorResponse: type: object properties: detail: type: string description: detail error message schemas: type: array items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:Error scimType: type: string description: bad request type when status code is 400 enum: - uniqueness - tooMany - mutability - sensitive - invalidSyntax - invalidFilter - invalidPath - invalidValue - invalidVers - noTarget status: type: string description: same as HTTP status code, e.g. 400, 401, etc. User: type: object required: - emails - name - schemas - userName properties: active: type: boolean description: user status default: false addresses: type: array items: $ref: '#/definitions/UserAddress' emails: type: array items: $ref: '#/definitions/Email' externalId: type: string description: external unique resource id defined by provisioning client id: type: string description: unique resource id defined by RingCentral name: $ref: '#/definitions/Name' phoneNumbers: type: array items: $ref: '#/definitions/PhoneNumber' photos: type: array items: $ref: '#/definitions/Photo' schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: $ref: '#/definitions/EnterpriseUser' userName: type: string description: MUST be same as work type email address UserResponse: type: object required: - emails - name - schemas - userName properties: active: type: boolean description: user status default: false addresses: type: array items: $ref: '#/definitions/UserAddress' emails: type: array items: $ref: '#/definitions/Email' externalId: type: string description: external unique resource id defined by provisioning client id: type: string description: unique resource id defined by RingCentral name: $ref: '#/definitions/Name' phoneNumbers: type: array items: $ref: '#/definitions/PhoneNumber' photos: type: array items: $ref: '#/definitions/Photo' schemas: type: array items: type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: $ref: '#/definitions/EnterpriseUser' userName: type: string description: MUST be same as work type email address meta: $ref: '#/definitions/Meta' SearchRequest: type: object properties: count: type: integer format: int32 description: page size filter: type: string description: only support 'userName' or 'email' filter expressions for now schemas: type: array items: type: string enum: - urn:ietf:params:scim:api:messages:2.0:SearchRequest startIndex: type: integer format: int32 description: start index (1-based) Photo: type: object required: - type - value properties: type: type: string enum: - photo value: type: string Meta: type: object properties: created: type: string format: date-time lastModified: type: string format: date-time location: type: string description: resource location URI resourceType: type: string enum: - User - Group description: resource metadata BulkSupported: type: object properties: maxOperations: type: integer format: int32 maxPayloadSize: type: integer format: int32 supported: type: boolean default: false UserAddress: type: object required: - type properties: country: type: string locality: type: string postalCode: type: string region: type: string streetAddress: type: string type: type: string enum: - work Name: type: object required: - familyName - givenName properties: familyName: type: string givenName: type: string FilterSupported: type: object properties: maxResults: type: integer format: int32 supported: type: boolean default: false Email: type: object required: - type - value properties: type: type: string enum: - work value: type: string PhoneNumber: type: object required: - type - value properties: type: type: string enum: - work - mobile - other value: type: string EnterpriseUser: type: object properties: department: type: string PatchOperation: type: object required: - op properties: op: type: string enum: - add - replace - remove path: type: string value: type: string description: corresponding 'value' of that field specified by 'path' AuthenticationScheme: type: object properties: description: type: string documentationUri: type: string name: type: string specUri: type: string primary: type: boolean Supported: type: object properties: supported: type: boolean default: false CallSessionObject: type: object properties: id: description: Internal identifier of a call session type: string origin: description: Initial data of a call session $ref: '#/definitions/OriginInfo' voiceCallToken: type: string description: For calls of 'Conference' type only parties: description: Information on a party of a call session $ref: '#/definitions/CallParty' creationTime: description: Date and time of the latest session update represented in Unix time format type: string CallPartyFlip: type: object properties: callFlipId: description: Call flip id type: string ForwardTarget: type: object properties: phoneNumber: description: Phone number type: string voicemail: description: VM owner's extension id type: string PartyUpdateRequest: type: object properties: party: description: Party update data $ref: '#/definitions/PartyUpdateInfo' CallRecordingUpdate: type: object properties: active: description: Recording status type: boolean CallRecording: type: object properties: id: type: string description: Internal identifier of a call recording active: description: Call recording status type: boolean MakeCallOutRequest: type: object required: - from - to properties: from: $ref: '#/definitions/MakeCallOutCallerInfoRequestFrom' to: $ref: '#/definitions/MakeCallOutCallerInfoRequestTo' CallSession: type: object properties: session: description: Call session information $ref: '#/definitions/CallSessionObject' CallParty: type: object properties: id: description: Internal identifier of a party type: string status: description: Status data of a call session $ref: '#/definitions/CallStatusInfo' muted: type: boolean description: Specifies if a call participant is muted or not standAlone: type: boolean description: If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session park: description: Call park information $ref: '#/definitions/ParkInfo' from: description: Data on a calling party $ref: '#/definitions/PartyInfo' to: description: Data on a called party $ref: '#/definitions/PartyInfo' owner: description: Data on a call owner $ref: '#/definitions/OwnerInfo' direction: description: Direction of a call type: string enum: - Inbound - Outbound conferenceRole: description: A party's role in the conference scenarios. For calls of 'Conference' type only type: string enum: - Host - Participant ringOutRole: description: A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringout' type only type: string enum: - Initiator - Target ringMeRole: description: A party's role in 'Ring Me'/'RingOut' scenarios. For calls of 'Ringme' type only type: string enum: - Initiator - Target recordings: description: Active recordings list type: array items: $ref: '#/definitions/RecordingInfo' TransferTarget: type: object properties: phoneNumber: description: Phone number type: string voicemail: description: VM owner's extension id type: string parkOrbit: description: Park orbit id type: string SuperviseCallSessionRequest: type: object required: - mode - deviceId - extensionNumber properties: mode: type: string description: Supervising mode enum: - Listen example: Listen deviceId: type: string description: Internal identifier of a supervisor's device example: "191888004" extensionNumber: type: string description: Extension number of a user that will be monitored example: "102" SuperviseCallSession: type: object properties: from: description: Information about a call party that monitors a call $ref: '#/definitions/PartyInfo' to: description: Information about a call party that is monitored $ref: '#/definitions/PartyInfo' direction: type: string description: Direction of a call enum: - Outbound - Inbound id: type: string description: Internal identifier of a party that monitors a call muted: type: boolean description: Specifies if a call party is muted owner: type: object description: Data on a call owner $ref: '#/definitions/OwnerInfo' standAlone: type: boolean description: If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session status: type: object $ref: '#/definitions/CallStatusInfo' MakeCallOutCallerInfoRequestFrom: type: object description: Instance id of the caller. It corresponds to the 1st leg of the CallOut call. properties: deviceId: description: Internal identifier of a device type: string example: "59474004" ParkInfo: type: object properties: id: type: string description: Call park identifier PartyInfo: type: object properties: phoneNumber: description: Phone number of a party type: string extensionId: description: Internal identifier of an extension type: string name: description: Displayed name of a party type: string deviceId: description: Internal identifier of a device type: string OwnerInfo: type: object properties: accountId: description: Internal identifier of an account type: string extensionId: description: Internal identifier of an extension type: string RecordingInfo: type: object properties: id: type: string description: Internal identifier of a Recording resource active: type: boolean description: True if the recording is active. False if the recording is paused. OriginInfo: type: object properties: type: description: Session origin type type: string enum: - RingOut - RingMe - Conference - GreetingRecording - VerificartionCall - Call PartyUpdateInfo: type: object properties: muted: description: If 'True' the party is muted type: boolean standAlone: description: If 'True' then the party is not connected to a session voice conference, 'False' means the party is connected to other parties in a session type: boolean MakeCallOutCallerInfoRequestTo: type: object description: Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call properties: phoneNumber: description: Phone number in E.164 format type: string example: "+16502223366" extensionNumber: type: string description: Extension number example: "103" CallStatusInfo: type: object properties: code: description: Status code of a call type: string enum: - Setup - Proceeding - Answered - Disconnected - Gone - Parked - Hold - VoiceMail - FaxReceive - Tds - VoiceMailScreening peerId: description: Peer session / party data. Valid in Gone state only $ref: '#/definitions/PeerInfo' reason: description: Reason of call termination. For 'Disconnected' code only type: string enum: - Pickup - Supervising - TakeOver - Timeout - BlindTransfer - RccTransfer - AttendedTransfer - CallerInputRedirect - CallFlip - ParkLocation - DtmfTransfer - AgentAnswered - AgentDropped - Rejected - Cancelled - InternalError - NoAnswer - TargetBusy - InvalidNumber - InternationalDisabled - DestinationBlocked - NotEnoughFunds - NoSuchUser - CallRedirected description: description: Optional message type: string PeerInfo: type: object description: Peer session / party data. Valid in Gone state only properties: sessionId: type: string partyId: type: string CreateDataExportTaskRequest: type: object properties: dateFrom: type: string description: Starting time for data collection. The default value is current time minus 24 hours. If `dateTo` is not specified then its value is set to `dateFrom` plus 24 hours. The specified time range should not be greater than 7 days dateTo: type: string description: Ending time for data collection. The default value is current time. If `dateFrom` is not specified then its value is set to `dateTo` minus 24 hours. The specified time range should not be greater than 7 days userIds: type: array description: 'List of users which data is collected. The following data will be exported: posts, tasks, events, etc. posted by the user(s); posts addressing the user(s) via direct and @Mentions; tasks assigned to the listed user(s). The list of 30 users per request is supported.' items: type: string chatIds: type: array description: List of chats from which the data (posts, files, tasks, events, notes, etc.) will be collected items: type: string DataExportTask: type: object properties: uri: type: string description: Canonical URI of a task id: type: string description: Internal identifier of a task creationTime: type: string description: Task creation datetime lastModifiedTime: type: string description: Task last modification datetime status: type: string description: Task status enum: - Accepted - InProgress - Completed - Failed result: type: array items: $ref: '#/definitions/ExportTaskResultInfo' description: Data collection archives. Returned by task ID ExportTaskResultInfo: type: object properties: size: type: integer description: Size of the collected data archive in bytes uri: type: string description: Canonical URI for downloading an archive CreateMessageStoreReportRequest: type: object properties: dateFrom: type: string description: Starting time for collecting messages. The default value equals to the current time minus 24 hours dateTo: type: string description: Ending time for collecting messages. The default value is the current time MessageStoreReport: type: object properties: id: type: string description: Internal identifier of a message store report task uri: type: string description: Link to a task status: description: Status of a message store report task type: string enum: - Accepted - Pending - InProgress - AttemptFailed - Failed - Completed - Cancelled accountId: type: string description: Internal identifier of an account extensionId: type: string description: Internal identifier of an extension creationTime: type: string description: Task creation time lastModifiedTime: type: string description: Time of the last task modification dateTo: type: string description: Ending time for collecting messages dateFrom: type: string description: Starting time for collecting messages MessageStoreReportArchive: type: object properties: records: type: array items: $ref: '#/definitions/ArchiveInfo' ArchiveInfo: type: object properties: size: type: integer description: Archive size in bytes uri: type: string description: Link for archive download TokenInfo: type: object properties: access_token: type: string description: Access token to pass to subsequent API requests example: U1BCMDFUMDRKV1MwMXxzLFSvXdw5PHMsVLEn_MrtcyxUsw expires_in: type: integer description: Issued access token TTL (time to live), in seconds example: 7199 refresh_token: type: string description: Refresh token to get a new access token, when the issued one expires example: U1BCMDFUMDRKV1MwMXxzLFL4ec6A0XMsUv9wLriecyxS_w refresh_token_expires_in: type: integer description: Issued refresh token TTL (time to live), in seconds example: 604799 scope: type: string description: List of permissions allowed with this access token, white-space separated example: AccountInfo CallLog ExtensionInfo Messages SMS token_type: type: string description: Type of token. The only possible value supported is Bearer. This value should be used when specifying access token in Authorization header of subsequent API requests example: bearer owner_id: type: string description: Extension identifier example: "256440016" endpoint_id: type: string description: Application instance identifier example: 8zXq6oaLT7WvwWITlGiA1A securityDefinitions: OAuth2: type: oauth2 flow: accessCode authorizationUrl: https://platform.ringcentral.com/restapi/oauth/authorize tokenUrl: https://platform.ringcentral.com/restapi/oauth/token api_key: type: apiKey name: api_key in: header