Channel

Catalog


GET View my channels

Request path:

https://stargate.aiursoft.com/Channel/ViewMyChannels

Request example:

https://stargate.aiursoft.com/Channel/ViewMyChannels?AccessToken=yourAccessToken

Try

Request arguments:

Name Required Type
AccessToken Required Text

Possible Response:

{
  "appId": "an example string.",
  "channels": [
    {
      "lastAccessTime": "2020-01-28T21:00:37.1447358Z",
      "channel": {
        "id": 0,
        "description": "an example string.",
        "connectKey": "an example string.",
        "createTime": "2020-01-28T21:00:37.1447881Z",
        "appId": "an example string."
      },
      "connectedCount": 0
    }
  ],
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

GET Validate channel

Request path:

https://stargate.aiursoft.com/Channel/ValidateChannel

Request example:

https://stargate.aiursoft.com/Channel/ValidateChannel?Id=0&Key=yourKey

Try

Request arguments:

Name Required Type
Id Required Number
Key Not required Text

Possible Response:

{
  "value": "an example string.",
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Create channel

Request path:

https://stargate.aiursoft.com/Channel/CreateChannel

Request example:

https://stargate.aiursoft.com/Channel/CreateChannel?AccessToken=yourAccessToken&Description=yourDescription

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&Description=yourDescription 

Request form:

Name Required Type
AccessToken Required Text
Description Not required Text

Possible Response:

{
  "channelId": 0,
  "connectKey": "an example string.",
  "code": 0,
  "message": "an example string."
}

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Delete channel

Request path:

https://stargate.aiursoft.com/Channel/DeleteChannel

Request example:

https://stargate.aiursoft.com/Channel/DeleteChannel?AccessToken=yourAccessToken&ChannelId=0

Request content type:

application/x-www-form-urlencoded

Form content example:

AccessToken=yourAccessToken&ChannelId=0 

Request form:

Name Required Type
AccessToken Required Text
ChannelId Required Number

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}

POST Delete app

Request path:

https://stargate.aiursoft.com/Channel/DeleteApp

Request example:

https://stargate.aiursoft.com/Channel/DeleteApp?AppId=yourAppId&AccessToken=yourAccessToken

Request content type:

application/x-www-form-urlencoded

Form content example:

AppId=yourAppId&AccessToken=yourAccessToken 

Request form:

Name Required Type
AppId Required Text
AccessToken Required Text

Possible Response:

{
  "code": -1,
  "message": "Some error."
}

Possible Response:

{
  "items": [
    "Some item is invalid!"
  ],
  "code": -10,
  "message": "Your input contains several errors!"
}