github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagevoice_v3.0.0/openapi-spec_campaigns.json (about)

     1  {
     2      "openapi":"3.0.0",
     3      "info":{
     4         "description":"",
     5         "version":"1.0",
     6         "title":"RingCentral Engage Voice API",
     7         "termsOfService":"https://developers.ringcentral.com"
     8      },
     9      "tags":[
    10         {
    11            "name":"Campaigns"
    12         }
    13      ],
    14      "paths":{
    15         "/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns":{
    16            "get":{
    17               "tags":[
    18                 "Dial Groups"
    19               ],
    20               "operationId":"getCampaigns",
    21               "summary":"Get Campaigns",
    22               "description":"Returns a listing of campaigns for a dial group",
    23               "parameters":[
    24                  {
    25                     "name":"accountId",
    26                     "in":"path",
    27                     "required":true,
    28                     "schema":{
    29                        "type":"string"
    30                     }
    31                  },
    32                  {
    33                     "name":"dialGroupId",
    34                     "in":"path",
    35                     "required":true,
    36                     "schema":{
    37                        "type":"string"
    38                     }
    39                  }
    40               ],
    41               "responses":{
    42                  "200":{
    43                     "description":"Success",
    44                     "content":{
    45                        "application/json":{
    46                           "schema":{
    47                              "type":"array",
    48                              "items":{
    49                                 "$ref":"#/components/schemas/Campaign"
    50                              }
    51                           }
    52                        }
    53                     }
    54                  }
    55               }
    56            }
    57         },
    58         "/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache":{
    59           "post":{
    60              "tags":[
    61                "Dial Groups"
    62              ],
    63              "operationId":"clearCampaignCache",
    64              "summary":"Clear Campaign Cache",
    65              "description":"lears the cache for a campaign\n\nPermissions: READ on Campaign (Permission Override)",
    66              "parameters":[
    67                 {
    68                    "name":"accountId",
    69                    "in":"path",
    70                    "required":true,
    71                    "schema":{
    72                       "type":"integer",
    73                       "format":"int64"
    74                    }
    75                 },
    76                 {
    77                    "name":"dialGroupId",
    78                    "in":"path",
    79                    "required":true,
    80                    "schema":{
    81                       "type":"integer",
    82                       "format":"int64"
    83                    }
    84                 },
    85                 {
    86                    "name":"campaignId",
    87                    "in":"path",
    88                    "required":true,
    89                    "schema":{
    90                       "type":"integer",
    91                       "format":"int64"
    92                    }
    93                 }
    94              ],
    95              "requestBody":{
    96                 "required":true,
    97                 "description":"An `application/json` Content-Type header is required. Submit an empty body to trigger the header.",
    98                 "content":{
    99                     "application/json":{
   100                         "schema":{
   101                             "type":"object"
   102                         }
   103                     }
   104                 }
   105                },
   106              "responses":{
   107                 "201":{
   108                    "description":"Created"
   109                 }
   110              }
   111           }
   112        }
   113      },
   114      "servers":[
   115         {
   116            "url":"https://portal.vacd.biz/api/v1"
   117         }
   118      ],
   119      "components":{
   120         "securitySchemes":{
   121            "bearerAuth":{
   122               "type":"http",
   123               "scheme":"bearer"
   124            }
   125         },
   126         "schemas":{
   127            "Generic":{
   128               "properties":{
   129                  "id":{
   130                     "type":"integer",
   131                     "format":"int64"
   132                  },
   133                  "description":{
   134                     "type":"string"
   135                  }
   136               }
   137            },
   138            "Campaign":{
   139               "properties":{
   140                  "campaignId":{
   141                     "type":"integer",
   142                     "format":"int64"
   143                  },
   144                  "permissions":{
   145                     "type":"array",
   146                     "items":{
   147                        "type":"object"
   148                     }
   149                  },
   150                  "campaignName":{
   151                     "type":"string"
   152                  },
   153                  "campaignDesc":{
   154                     "type":"string"
   155                  },
   156                  "isActive":{
   157                     "type":"integer",
   158                     "format":"int64"
   159                  },
   160                  "dialGroup":{
   161                    "$ref": "#/components/schemas/Generic"
   162                  },
   163                  "script":{
   164                     "$ref": "#/components/schemas/Generic"
   165                  }
   166               }
   167            }
   168         }
   169      }
   170   }