github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagevoice_v3.0.0/openapi-spec_campaign-leads.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":"Campaign Leads"
    12         }
    13      ],
    14      "paths":{
    15          "/admin/accounts/{accountId}/campaignLeads/leadSearch":{
    16              "post":{
    17                 "tags":[
    18                    "Campaign Leads"
    19                 ],
    20                 "summary":"Search Leads",
    21                 "description":"Allows searching of campaign leads for a single campaign\n\nPermissions: READ on Account (Permission Override)",
    22                 "operationId":"searchLeads",
    23                 "parameters":[
    24                    {
    25                       "name":"accountId",
    26                       "in":"path",
    27                       "required":true,
    28                       "schema":{
    29                          "type":"string"
    30                       }
    31                    },
    32                    {
    33                      "name":"count",
    34                      "in":"query",
    35                      "required":false,
    36                      "schema":{
    37                         "type":"integer"
    38                      }
    39                   },
    40                   {
    41                      "name":"page",
    42                      "in":"query",
    43                      "required":false,
    44                      "schema":{
    45                         "type":"integer"
    46                      }
    47                   },
    48                   {
    49                     "name":"maxRows",
    50                     "in":"query",
    51                     "required":false,
    52                     "schema":{
    53                        "type":"integer"
    54                     }
    55                  }
    56                 ],
    57                 "requestBody":{
    58                  "required":true,
    59                  "content":{
    60                      "application/json":{
    61                          "schema":{
    62                              "$ref":"#/components/schemas/CampaignLeadSearchCriteria"
    63                          }
    64                      }
    65                  }
    66                 },
    67                 "responses":{
    68                    "200":{
    69                       "description":"Success",
    70                       "content":{
    71                          "application/json":{
    72                             "schema":{
    73                                "type":"array",
    74                                "items":{
    75                                   "$ref":"#/components/schemas/CampaignLeadSearchResultsView"
    76                                }
    77                             }
    78                          }
    79                       }
    80                    }
    81                 }
    82              }
    83           },
    84         "/admin/accounts/{accountId}/campaignLeads/leadStates":{
    85            "get":{
    86               "tags":[
    87                  "Campaign Leads"
    88               ],
    89               "summary":"Get Lead States",
    90               "description":"Returns a listing of all lead states for an account\n\nPermissions: READ on Account",
    91               "operationId":"getLeadStates",
    92               "parameters":[
    93                  {
    94                     "name":"accountId",
    95                     "in":"path",
    96                     "required":true,
    97                     "schema":{
    98                        "type":"string"
    99                     }
   100                  }
   101               ],
   102               "responses":{
   103                  "200":{
   104                     "description":"Success",
   105                     "content":{
   106                        "application/json":{
   107                           "schema":{
   108                              "type":"array",
   109                              "items":{
   110                                 "type":"string"
   111                              }
   112                           }
   113                        }
   114                     }
   115                  }
   116               }
   117            }
   118         },
   119         "/admin/accounts/{accountId}/campaignLeads/systemDispositions":{
   120           "get":{
   121              "tags":[
   122                 "Campaign Leads"
   123              ],
   124              "summary":"Get Systems Dispositions",
   125              "description":"Returns a listing of all system dispositions for an account\n\nPermissions: READ on Account",
   126              "operationId":"getSystemDispositions",
   127              "parameters":[
   128                 {
   129                    "name":"accountId",
   130                    "in":"path",
   131                    "required":true,
   132                    "schema":{
   133                       "type":"string"
   134                    }
   135                 }
   136              ],
   137              "responses":{
   138                 "200":{
   139                    "description":"Success",
   140                    "content":{
   141                       "application/json":{
   142                          "schema":{
   143                             "type":"array",
   144                             "items":{
   145                                "type":"string"
   146                             }
   147                          }
   148                       }
   149                    }
   150                 }
   151              }
   152           }
   153        }
   154      },
   155      "servers":[
   156         {
   157            "url":"https://portal.vacd.biz/api/v1"
   158         }
   159      ]
   160   }