Creating Push Plan

Last updated: 2020-12-31 17:43:48

    API Description

    Request method: POST
    Request address:

    Service address/v3/push/plan/add_plan_push

    The API service address corresponds to the service access point one by one; therefore, please select the service address corresponding to your application service access point.

    Note:

    Call rate limit: 200 calls/day.

    Request Parameters

    Parameter Type Required Description
    planName string Yes Push plan name, which can contain up to 23 letters
    planDescribe string Yes Push plan description, which can contain up to 300 characters

    Response Parameters

    Parameter Type Required Description
    retCode string Yes Return status code
    errMsg string Yes Error message
    result object Yes Please see the description of PlanRecordData in the table below

    PlanRecordData

    Parameter Type Required Description
    planId string Yes Push plan ID generated by TPNS
    planName string Yes Push plan name, which can contain up to 23 letters
    planDescribe string Yes Push plan description, which can contain up to 300 characters
    planPushSource string Yes -
    createdAt uint32 Yes Creation time in timestamp format
    updateAt uint32 Yes Update time in timestamp format

    Samples

    Sample request

    {
                "planName":"TPNS_TEST123",
                "planDescribe":"plan_test"
    }

    Sample response

    {
        "retCode": 0,
        "ErrMsg": "save success",
        "result": {
            "planId": "48",
            "planName": "TPNS_TEST123",
            "planDescribe": "plan_test",
            "planPushSource": "api",
            "createdAt": 1593314408,
            "updateAt": 1593314408
        }
    }