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

     1    {
     2      "openapi":"3.0.0",
     3      "info":{
     4        "description":"",
     5        "version":"1.0",
     6        "title":"Engage Digital API",
     7        "termsOfService":"https://developer.ringcentral.com"
     8      },
     9      "tags":[
    10        {
    11          "name":"Channels"
    12        }
    13      ],
    14      "paths":{
    15        "/channels":{
    16          "get":{
    17            "tags":[
    18              "Channels"
    19            ],
    20            "summary":"Getting all channels",
    21            "operationId":"getAllChannels",
    22            "description":"This method renders all channels ordered by date of creation.",
    23            "parameters":[
    24              {
    25                "name":"offset",
    26                "in":"query",
    27                "description":"The record index to start. Default value is 0.",
    28                "required":false,
    29                "schema":{
    30                  "type":"integer",
    31                  "format":"int32"
    32                }
    33              },
    34              {
    35                "name":"limit",
    36                "in":"query",
    37                "description":"The max number of records to return. Default value is 30, max value is 150.",
    38                "required":false,
    39                "schema":{
    40                  "type":"integer",
    41                  "format":"int32"
    42                }
    43              }
    44            ],
    45            "responses":{
    46              "200":{
    47                "description":"Success",
    48                "content":{
    49                  "application/json":{
    50                    "schema":{
    51                      "$ref":"#/components/schemas/GetAllChannelsResponse"
    52                    }
    53                  }
    54                }
    55              }
    56            }
    57          }
    58        },
    59        "/channels/{channelId}":{
    60          "get":{
    61            "tags":[
    62              "Channels"
    63            ],
    64            "summary":"Getting a channel from its id",
    65            "operationId":"getChannel",
    66            "description":"This method renders a channel from given id.",
    67            "parameters":[
    68              {
    69                "name":"channelId",
    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                      "$ref":"#/components/schemas/Channel"
    84                    }
    85                  }
    86                }
    87              }
    88            }
    89          },
    90          "put":{
    91            "tags":[
    92              "Channels"
    93            ],
    94            "summary":"Updating a channel",
    95            "operationId":"updateChannel",
    96            "description":"This method updates an existing channel from given attributes and renders it in case of success.\n\nAuthorization​: only users that are able to update channels.",
    97            "parameters":[
    98              {
    99                "name":"channelId",
   100                "in":"path",
   101                "required":true,
   102                "schema":{
   103                  "type":"string"
   104                }
   105              },
   106              {
   107                "name":"name",
   108                "in":"query",
   109                "required":false,
   110                "description":"The name of the channel.",
   111                "schema":{
   112                  "type":"string"
   113                }
   114              },
   115              {
   116                "name":"source_ids",
   117                "in":"query",
   118                "required":false,
   119                "description":"An array containing id of each source assigned to a channel (multiple).",
   120                "schema":{
   121                  "type":"array",
   122                  "items":{
   123                    "type":"string"
   124                  }
   125                }
   126              },
   127              {
   128                "name":"soft_capability",
   129                "in":"query",
   130                "required":false,
   131                "description":"Number of tasks that can be assigned to agent by the routing before they are considered \"occupied\".",
   132                "schema":{
   133                  "type":"integer"
   134                }
   135              },
   136              {
   137                "name":"hard_capability",
   138                "in":"query",
   139                "required":false,
   140                "description":"M​aximum number of tasks that can be assigned to agents.",
   141                "schema":{
   142                  "type":"integer"
   143                }
   144              },
   145              {
   146                "name":"task_timeout_seconds",
   147                "in":"query",
   148                "required":false,
   149                "description":"this field defines the time before a task expires (in seconds).",
   150                "schema":{
   151                  "type":"integer"
   152                }
   153              }
   154            ],
   155            "responses":{
   156              "200":{
   157                "description":"Success",
   158                "content":{
   159                  "application/json":{
   160                    "schema":{
   161                      "$ref":"#/components/schemas/Channel"
   162                    }
   163                  }
   164                }
   165              }
   166            }
   167          }
   168        }
   169      },
   170      "servers":[
   171        {
   172          "url":"https://DOMAIN.api.engagement.dimelo.com/1.0"
   173        }
   174      ],
   175      "components":{
   176        "securitySchemes":{
   177          "bearerAuth":{
   178            "type":"http",
   179            "scheme":"bearer"
   180          }
   181        },
   182        "schemas":{
   183          "GetAllChannelsResponse":{
   184            "properties":{
   185              "count":{
   186                "type":"integer",
   187                "format":"int32"
   188              },
   189              "limit":{
   190                "type":"integer",
   191                "format":"int32"
   192              },
   193              "offset":{
   194                "type":"integer",
   195                "format":"int32"
   196              },
   197              "records":{
   198                "type":"array",
   199                "items":{
   200                  "$ref":"#/components/schemas/Channel"
   201                }
   202              }
   203            }
   204          },
   205          "Channel":{
   206            "properties":{
   207              "id":{
   208                "type":"string"
   209              },
   210              "created_at":{
   211                "type":"string",
   212                "format":"date-time"
   213              },
   214              "updated_at":{
   215                "type":"string",
   216                "format":"date-time"
   217              },
   218              "name":{
   219                "type":"string"
   220              },
   221              "label":{
   222                "type":"string"
   223              },
   224              "source_ids":{
   225                "type":"array",
   226                "items":{
   227                  "type":"string"
   228                }
   229              },
   230              "hard_capability":{
   231                "type":"integer"
   232              },
   233              "soft_capability":{
   234                "type":"integer"
   235              },
   236              "task_timeout_seconds":{
   237                "type":"integer"
   238              }
   239            }
   240          }
   241        }
   242      }
   243    }