{ "opencollection": "1.0.0", "info": { "name": "RingCentral Adaptive Cards Call Blocking API", "version": "1.0.58-20240529-47eda8bd" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.ringcentral.com/restapi/oauth/authorize", "accessTokenUrl": "https://platform.ringcentral.com/restapi/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Call Blocking", "type": "folder" }, "items": [ { "info": { "name": "Get Caller Blocking Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns the current caller blocking settings of a user." }, { "info": { "name": "Update Caller Blocking Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the current caller blocking settings of a user." }, { "info": { "name": "List Blocked/Allowed Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "Returns the lists of blocked and allowed phone numbers." }, { "info": { "name": "Add Blocked/Allowed Number", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates either blocked or allowed phone number list with a new phone number." }, { "info": { "name": "Get Blocked/Allowed Number", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers/:blockedNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "blockedNumberId", "value": "", "type": "path", "description": "Internal identifier of a blocked number entry" } ] }, "docs": "Returns blocked or allowed phone number(s) by their ID(s). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Update Blocked/Allowed Number", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers/:blockedNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "blockedNumberId", "value": "", "type": "path", "description": "Internal identifier of a blocked number entry" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates blocked or allowed phone number(s) by their ID(s). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Delete Blocked/Allowed Number", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers/:blockedNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "blockedNumberId", "value": "", "type": "path", "description": "Internal identifier of a blocked number entry" } ] }, "docs": "Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported." } ] } ], "bundled": true }