# Detect Receivers' Information
This API can be used to detect information required for performing "Soft Edge". After "Soft Edge" is enabled in the software, you should call this API at least once to ensure this API's accessibility.
# Request Path
{CLTPlatform-ip}:8086/advancedSeam/detectReceiversInfo
- Replace
{CLTPlatform-ip}with the corresponding IP address. - The request port is
8086.
# Protocol
HTTP
# Method
POST
# Request Parameters
- Set the
Content-Typeof the request body toapplication/json.
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | [string] | advancedSeam/detectReceiversInfo | ||
| data | Data | Yes | [object] | |||
| data>>processorIndex | Sender index (starts from 0) | Yes | [int] | |||
| data>>screenGroupID | Screen group index (starts from 0) | Yes | [int] |
# Request Example
{
"command": "advancedSeam/detectReceiversInfo",
"data": {
"processorIndex": 0,
"screenGroupID": 0
}
}
# Response
| Parameter Name | Description | Required | Type | Data Dictionary | Restriction | Example |
|---|---|---|---|---|---|---|
| command | Command type | Yes | [string] | advancedSeam/detectReceiversInfo | ||
| code | Status code | Yes | [int] | 20000 | ||
| message | Message | Yes | [string] | Common_Success | ||
| data | Data | Yes | [object] |
# Response Example
{
"command": "advancedSeam/detectReceiversInfo",
"code": 20000,
"message": "Common_Success",
"data": {}
}