tencent cloud

API Description

Request method: POST.

Service URL/v3/device/set_custom_attribute

API service URLs correspond to service access points one by one. Please select the service URL corresponding to the service access point of your application.

Feature: this API is used to manage personalized attributes at the token level, including creation, deletion, update, and query operations.

Parameter Description

Request parameters

Response parameters

Samples

Adding an attribute

Sample request

Add three attributes to a token.

{
    "cmd": 1,
    "token": "04cac74a714f61bf089987a986363d88****",   
    "attributeInfo": {
         "attributeMap": {
            "age": "100",
            "name": "Ming",
            "high": "2.66"
        }
    }
}

Sample response

{
    "retCode": 0,
    "errMsg": "success",
    "invalidAttribute": [
        "high"   // The corresponding key value does not exist in the console
    ]
}

Updating an attribute

Sample request

Update the value of the name attribute to workman.

{
    "cmd": 2,    
    "token": "04cac74a714f61bf089987a986363d88****",
    "attributeInfo": {
         "attributeMap": {
            "name": "workman"   
        }
    }
}

Sample response

{
    "retCode": 0,
    "errMsg": "success"
}

Deleting an attribute

Sample request

Delete the workman value of the name attribute.

{
    "cmd": 3,    
    "token": "04cac74a714f61bf089987a986363d88****",
    "attributeInfo": {
         "attributeMap": {
            "name": "workman"  
        }
    }
}

Sample response

{
    "retCode": 0,
    "errMsg": "success"
}

Deleting all attributes

Sample request

Delete all attributes of a token.

{
    "cmd": 4,    
    "token": "04cac74a714f61bf089987a986363d88****"  

}

Sample response

{
    "retCode": 0,
    "errMsg": "success"
}

Querying attributes

Sample request

Query the attribute details of a token.

{
    "cmd": 5,    
    "token": "04cac74a714f61bf089987a986363d88****"

}

Sample response

{
    "retCode": 0,
    "errMsg": "success",
    "attributeInfo": {
        "attributeMap": {
            "nickname": "workman"
        }
    }
}