tencent cloud

Tencent Push Notification Service

Release Notes
Announcements
Features
SDK for Android
SDK for iOS
SDK for macOS
Product Introduction
Overview
Strengths
Use Cases
Global Deployment
Purchase Guide
Billing Overview
Purchase Directions
Billing Modes
Free Trial
Payment Overdue
Getting Started
Creating Products and Applications
Quick Integration with Android
Quick Integration with iOS
Creating a Push Task
Querying Push Records
Guidelines for Push Testing Methods
Product Restrictions
Operation Guide
Push Management
Advanced Push Features
Practical Tutorial
iOS Badge Feature Practice
API Documentation
Overview
API Overview
Call Method
Push APIs
Tag APIs
Account APIs
Statistics APIs
User Attribute APIs
Server-Side Error Codes
Server SDKs
API (Java)
SDK Documentation
Android Integration Guide
iOS Integration Guide
Client Integration Plugin
macOS Integration Guide
Users and Permissions
Quick Configuration
Advanced Custom Configuration
Resource Tag
Service Agreement
Service Level Agreement
FAQs
iOS
Android
Flutter
Others
Tencent Push Notification Service Policy
Privacy Policy
Data Processing and Security Agreement
Developer Agreement
Contact Us
Glossary
DocumentationTencent Push Notification ServiceAPI DocumentationPush APIsCreating a Push Plan

Creating a Push Plan

PDF
Focus Mode
Font Size
Last updated: 2024-01-17 14:24:51

API Description

Request method: POST Request address:
Service address/v3/push/plan/add_plan_push
API service URLs correspond to service access points one to one. Please select the service URL corresponding to the service access point of your application.
Note:
Call rate limit: 200 calls/day.

Request Parameters

Parameter
Type
Required
Description
planName
string
Yes
Push plan name, which can contain up to 60 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

Examples

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
    }
}

Previous Topic: Push APINext Topic: Account Package Upload API

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback