github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagevoice_v3.0.0/openapi-spec_agent-groups.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":"Agents"
    12         }
    13      ],
    14      "paths":{
    15         "/admin/accounts/{accountId}/agentGroups":{
    16            "get":{
    17               "tags":[
    18                  "Agents"
    19               ],
    20               "summary":"Get Agent Groups",
    21               "description":"Returns a listing of agent groups for an account",
    22               "operationId":"getAgentGroups",
    23               "parameters":[
    24                  {
    25                     "name":"accountId",
    26                     "in":"path",
    27                     "required":true,
    28                     "schema":{
    29                        "type":"string"
    30                     }
    31                  }
    32               ],
    33               "responses":{
    34                  "200":{
    35                     "description":"Success",
    36                     "content":{
    37                        "application/json":{
    38                           "schema":{
    39                              "type":"array",
    40                              "items":{
    41                                 "$ref":"#/components/schemas/AgentGroup"
    42                              }
    43                           }
    44                        }
    45                     }
    46                  },
    47                  "500":{
    48                      "description":"Server Error",
    49                      "content":{
    50                         "application/json":{
    51                            "schema":{
    52                               "$ref":"#/components/schemas/Error"
    53                            }
    54                         }
    55                      }
    56                  }
    57               }
    58            }
    59         },
    60         "/admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents":{
    61          "get":{
    62              "tags":[
    63                 "Agents"
    64              ],
    65              "summary":"Returns a listing of agent groups for an account",
    66              "operationId":"getAgentGroups",
    67              "parameters":[
    68                 {
    69                    "name":"accountId",
    70                    "in":"path",
    71                    "required":true,
    72                    "schema":{
    73                       "type":"string"
    74                    }
    75                 }
    76              ],
    77              "responses":{
    78                 "200":{
    79                    "description":"Success",
    80                    "content":{
    81                       "application/json":{
    82                          "schema":{
    83                             "type":"array",
    84                             "items":{
    85                                "$ref":"#/components/schemas/AgentGroup"
    86                             }
    87                          }
    88                       }
    89                    }
    90                 },
    91                 "500":{
    92                     "description":"Server Error",
    93                     "content":{
    94                        "application/json":{
    95                           "schema":{
    96                              "$ref":"#/components/schemas/Error"
    97                           }
    98                        }
    99                     }
   100                 }
   101              }
   102           }
   103  
   104  
   105         }
   106      },
   107      "servers":[
   108         {
   109            "url":"https://portal.vacd.biz/api/v1"
   110         }
   111      ],
   112      "security":[
   113         {
   114           "ApiKeyAuth": []
   115         }
   116      ],
   117      "components":{
   118         "securitySchemes":{
   119            "ApiKeyAuth":{
   120               "type":"apiKey",
   121               "in":"header",
   122               "name":"X-Auth-Token"
   123            }
   124         },
   125         "schemas":{
   126          "Error":{
   127             "type":"object",
   128              "properties":{
   129                  "generalMessage":{
   130                      "type":"string"
   131                   },
   132                   "details":{
   133                      "type":"string"
   134                   },
   135                   "requestUri":{
   136                      "type":"string"
   137                   },
   138                  "timestamp":{
   139                     "type":"integer",
   140                     "format":"int64"
   141                  }
   142               }
   143            },
   144          
   145            "AgentGroup":{
   146              "type":"object",
   147              "description": "WIP: `permissions` is an array that needs definition",
   148               "properties":{
   149                  "agentGroupId":{
   150                     "type":"integer",
   151                     "format":"int64"
   152                  },
   153                  "groupName":{
   154                     "type":"string"
   155                  },
   156                  "isDefault":{
   157                      "type":"boolean"
   158                   }
   159               }
   160            }
   161         }
   162      }
   163   }