Devices
Catalog
POST Add device
Request path:
https://server.kahla.app/Devices/AddDevice
Request example:
https://server.kahla.app/Devices/AddDevice?Name=yourName&PushEndpoint=yourPushEndpoint&PushP256DH=yourPushP256DH&PushAuth=yourPushAuth
Request content type:
application/x-www-form-urlencoded
Form content example:
Name=yourName&PushEndpoint=yourPushEndpoint&PushP256DH=yourPushP256DH&PushAuth=yourPushAuth
Request form:
Name | Required | Type |
---|---|---|
Name | Required | Text |
PushEndpoint | Required | Text |
PushP256DH | Required | Text |
PushAuth | Required | Text |
Possible Response:
{
"value": 0,
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Update device
Request path:
https://server.kahla.app/Devices/UpdateDevice
Request example:
https://server.kahla.app/Devices/UpdateDevice?DeviceId=0&Name=yourName&PushEndpoint=yourPushEndpoint&PushP256DH=yourPushP256DH&PushAuth=yourPushAuth
Request content type:
application/x-www-form-urlencoded
Form content example:
DeviceId=0&Name=yourName&PushEndpoint=yourPushEndpoint&PushP256DH=yourPushP256DH&PushAuth=yourPushAuth
Request form:
Name | Required | Type |
---|---|---|
DeviceId | Required | Number |
Name | Required | Text |
PushEndpoint | Required | Text |
PushP256DH | Required | Text |
PushAuth | Required | Text |
Possible Response:
{
"value": {
"id": 0,
"name": "an example string.",
"ipAddress": "an example string.",
"userId": "an example string.",
"addTime": "2023-10-01T22:26:05.1733144Z"
},
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
GET My devices
Request path:
https://server.kahla.app/Devices/MyDevices
Request example:
https://server.kahla.app/Devices/MyDevices
Possible Response:
{
"items": [
{
"id": 0,
"name": "an example string.",
"ipAddress": "an example string.",
"userId": "an example string.",
"addTime": "2023-10-01T22:26:05.1770019Z"
}
],
"code": 0,
"message": "an example string.",
"protocolVersion": "0.0.0.0"
}
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Drop device
Request path:
https://server.kahla.app/Devices/DropDevice
Request example:
https://server.kahla.app/Devices/DropDevice?id=0
Request content type:
application/x-www-form-urlencoded
Form content example:
id=0
Request form:
Name | Required | Type |
---|---|---|
id | Required | Number |
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}
POST Push test message
Request path:
https://server.kahla.app/Devices/PushTestMessage
Request example:
https://server.kahla.app/Devices/PushTestMessage
Request content type:
application/x-www-form-urlencoded
Form content example:
Possible Response:
{
"code": -1,
"message": "Some error.",
"protocolVersion": "7.0.2.0"
}
Possible Response:
{
"items": [
"Some item is invalid!"
],
"code": -10,
"message": "Your input contains several errors!",
"protocolVersion": "7.0.2.0"
}