{
  "opencollection": "1.0.0",
  "info": {
    "name": "RingCentral Adaptive Cards Call Handling Rules 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 Handling Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Company Call Handling Rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule",
            "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": "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"
              }
            ]
          },
          "docs": "Returns a list of company call handling rules."
        },
        {
          "info": {
            "name": "Create Company Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule",
            "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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates call handling rule on account level."
        },
        {
          "info": {
            "name": "Get Company Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule/:ruleId",
            "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": "ruleId",
                "value": "",
                "type": "path",
                "description": "Internal identifier of a call handling rule"
              }
            ]
          },
          "docs": "Returns a company call handling rule by ID."
        },
        {
          "info": {
            "name": "Update Company Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule/:ruleId",
            "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": "ruleId",
                "value": "",
                "type": "path",
                "description": "Internal identifier of a call handling rule"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a company call handling rule."
        },
        {
          "info": {
            "name": "Delete Company Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule/:ruleId",
            "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": "ruleId",
                "value": "",
                "type": "path",
                "description": "Internal identifier of a call handling rule"
              }
            ]
          },
          "docs": "Deletes a company custom call handling rule by a particular ID."
        },
        {
          "info": {
            "name": "Get Forward All Company Calls",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/forward-all-calls",
            "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"
              }
            ]
          },
          "docs": "Returns information about *Forward All Company Calls* feature setting."
        },
        {
          "info": {
            "name": "Update Forward All Company Calls",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/forward-all-calls",
            "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"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates *Forward All Company Calls* feature setting."
        },
        {
          "info": {
            "name": "List Call Handling Rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule",
            "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": "type",
                "value": "",
                "type": "query",
                "description": "Filters custom call handling rules of the extension"
              },
              {
                "name": "view",
                "value": "",
                "type": "query"
              },
              {
                "name": "enabledOnly",
                "value": "",
                "type": "query",
                "description": "If true, then only active call handling rules are returned"
              },
              {
                "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"
              }
            ]
          },
          "docs": "Returns call handling rules of an extension."
        },
        {
          "info": {
            "name": "Create Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule",
            "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": "Creates a custom call handling rule for a particular caller ID."
        },
        {
          "info": {
            "name": "Get Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule/:ruleId",
            "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": "ruleId",
                "value": "",
                "type": "path",
                "description": "Internal identifier of a call handling rule"
              },
              {
                "name": "showInactiveNumbers",
                "value": "",
                "type": "query",
                "description": "Indicates whether inactive numbers should be returned or not"
              }
            ]
          },
          "docs": "Returns a call handling rule by ID."
        },
        {
          "info": {
            "name": "Update Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule/:ruleId",
            "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": "ruleId",
                "value": "",
                "type": "path",
                "description": "Internal identifier of a call handling rule"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a custom call handling rule for a particular caller ID."
        },
        {
          "info": {
            "name": "Delete Call Handling Rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule/:ruleId",
            "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": "ruleId",
                "value": "",
                "type": "path",
                "description": "Internal identifier of a call handling rule"
              }
            ]
          },
          "docs": "Deletes a custom call handling rule by a particular ID."
        }
      ]
    }
  ],
  "bundled": true
}