Push-Plan-API

Zuletzt aktualisiert：about 2 years ago

Die APIs in diesem Modul konzentrieren sich auf die Erstellung, Aktualisierung und Abfrage von Push-Plan-Kennungen.

Aufruf-Authentifizierung

Weitere Informationen finden Sie in der Beschreibung zur Authentifizierungsmethode in der REST-API-Übersicht.

Push-Plan erstellen und aktualisieren

Mit dieser Schnittstelle können Sie einen Push-Plan erstellen oder aktualisieren. Durch die Übergabe von plan_id und plan_description erstellt oder aktualisiert das System je nach Vorhandensein der plan_id den Push-Plan.

Endpunkt

POST v4/push_plan

              
              POST v4/push_plan

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
plan_id	string	Ja	Eindeutige Kennung des Push-Plans Formatregeln: Kombination aus Buchstaben (Groß- und Kleinschreibung wird unterschieden), Zahlen und Unterstrichen. Ein Unterstrich am Anfang ist nicht erlaubt. Längenbeschränkung: Maximal 50 Zeichen. Einzigartigkeitsvorgabe: Nach dem Setzen nicht mehr änderbar. Update-Strategie: Wird die plan_id bereits verwendet, wird die plan_description aktualisiert. Andernfalls wird ein neuer Plan erstellt.
plan_description	string	Ja	Beschreibung des Push-Plans Inhaltliche Anforderungen: Es müssen wichtige Geschäftsinformationen wie Push-Szenario, Zielnutzer und Push-Inhalt enthalten sein. Formatvorgabe: Unterstützt Chinesisch, Englisch, Zahlen und gängige Satzzeichen. Länge: Empfohlen maximal 128 Zeichen.

Beispielanfrage

{ "plan_id": "push_20231001_001", "plan_description": "Push-Plan für die Double-11-Promotion, der alle Nutzer umfasst" }

              
              {
  "plan_id": "push_20231001_001",
  "plan_description": "Push-Plan für die Double-11-Promotion, der alle Nutzer umfasst"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Erfolgreiche Antwort

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlgeschlagene Antwort

{ "error": { "code": 27303, "message": "Leere plan_id" } }

              
              {
  "error": {
    "code": 27303,
    "message": "Leere plan_id"
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Push-Plan abfragen

Mit dieser Schnittstelle können Sie die Push-Plan-Liste paginiert abfragen. Es wird das Filtern nach Sendungsquelle sowie eine unscharfe Suche nach Planbeschreibung oder Plan-ID unterstützt.

Endpunkt

GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

              
              GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
page_index	int	Ja	Seitenindex für die Paginierung (Zählung beginnt bei `1`)
page_size	int	Ja	Anzahl der Datensätze pro Seite, maximal 100 Einträge pro Seite werden unterstützt
send_source	int	Nein	Kennung der Sendungsquelle: 0 – API, 1 – Web-Konsole
search_description	string	Nein	Unterstützt unscharfe Suche nach Planbeschreibung oder Plan-ID (Chinesisch, Englisch, Zahlen, Unterstriche)

Beispielanfrage

GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

              
              GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=Double 11

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Erfolgreiche Antwort

{ "push_plan_info": [ { "plan_id": "push_20231111", "plan_description": "Double 11 Gesamtpush-Plan", "count": 15, "create_time": "2023-11-01T10:00:00Z", "last_used_time": "2023-11-11T20:30:00Z" } ], "total": 1 }

              
              {
  "push_plan_info": [
    {
      "plan_id": "push_20231111",
      "plan_description": "Double 11 Gesamtpush-Plan",
      "count": 15,
      "create_time": "2023-11-01T10:00:00Z",
      "last_used_time": "2023-11-11T20:30:00Z"
    }
  ],
  "total": 1
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlgeschlagene Antwort

{ "error": { "code": 1003, "message": "Parameterwert ist ungültig" } }

              
              {
  "error": {
    "code": 1003,
    "message": "Parameterwert ist ungültig"
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Msgid basierend auf Push-Plan abfragen

Mit dieser Schnittstelle können Sie die zugehörigen Nachrichten-IDs des angegebenen Push-Plans innerhalb des letzten Monats abrufen. Die Batch-Abfrage der zugehörigen Nachrichtendaten mehrerer Pläne wird unterstützt.

Endpunkt

GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

              
              GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
plan_ids	string	Ja	Liste der Push-Plan-IDs, bei mehreren IDs durch englische Kommas getrennt. Es können maximal 1.000 IDs angegeben werden.
start_date	string	Ja	Startdatum (Format: `yyyy-MM-dd`). Das Startdatum muss innerhalb der letzten 30 Tage liegen, und das Enddatum darf nicht vor dem Startdatum liegen.
end_date	string	Ja	Enddatum (Format: `yyyy-MM-dd`). Das Intervall zwischen Start- und Enddatum darf maximal 31 Tage betragen.

Beispielanfrage

GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

              
              GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Erfolgreiche Antwort

{ "push_20231101": { "msg_ids": ["msg_001", "msg_002"] }, "push_20231102": { "msg_ids": ["msg_003"] } }

              
              {
  "push_20231101": {
    "msg_ids": ["msg_001", "msg_002"]
  },
  "push_20231102": {
    "msg_ids": ["msg_003"]
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlgeschlagene Antwort

{ "error": { "code": 21044, "message": "Das Zeitintervall überschreitet einen Monat." } }

              
              {
  "error": {
    "code": 21044,
    "message": "Das Zeitintervall überschreitet einen Monat."
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Push-Plan löschen

Diese API wird verwendet, um einen Push-Plan zu löschen. Durch die Übergabe der plan_id führt das System die Löschoperation je nach Existenz der plan_id aus.

Endpunkt

DELETE v4/push_plan/{plan_id}

              
              DELETE v4/push_plan/{plan_id}

Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Parametername	Typ	Erforderlich	Beschreibung
plan_id	string	Ja	Eindeutige Kennung des Push-Plans

Beispielanfrage

curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

              
              curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

Diesen Codeblock im schwebenden Fenster anzeigen

Rückgabeparameter-Beschreibung

Erfolgreiche Antwort

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlgeschlagene Antwort

{ "error": { "code": 27305, "message": "Plan-ID existiert nicht" } }

              
              {
  "error": {
    "code": 27305,
    "message": "Plan-ID existiert nicht"
  }
}

Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercode-Beschreibung

Fehlercode	Beschreibung	Vorgeschlagene Vorgehensweise
21015	Anfrageparameter für die Erstellung eines Push-Plans sind fehlerhaft	Prüfen Sie, ob die Typen von `plan_id` oder `plan_description` korrekt sind
27300	Die Push-Plan-Kennung ist ungültig	Prüfen Sie, ob `plan_id` den Namensregeln entspricht
27301	Die Push-Plan-Beschreibung ist ungültig	Prüfen Sie, ob `plan_description` den Vorgaben entspricht
27303	Die Push-Plan-Kennung ist leer	Geben Sie beim Erstellen eines Push-Plans eine gültige Kennung an
27304	Die Länge der Push-Plan-Kennung überschreitet das Limit	Stellen Sie sicher, dass die Länge der Push-Plan-Kennung unter 50 Zeichen liegt
21004	Berechtigungsprüfung für die Erstellung eines Push-Plans fehlgeschlagen	Prüfen Sie, ob der Aufrufer Zugriffsrechte auf die Schnittstelle hat
27000	Interner Serverfehler	Wenden Sie sich an den technischen Support oder versuchen Sie es erneut
1003	Die Abfrageparameter für den Push-Plan sind ungültig	Prüfen Sie, ob `page_index/page_size` größer als 0 sind
21004	Berechtigungsprüfung für die Abfrage des Push-Plans fehlgeschlagen	Prüfen Sie, ob der Aufrufer Zugriffsrechte auf die Schnittstelle hat
27302	Obergrenze der Push-Plan-Nutzung überschritten	Wenden Sie sich an den technischen Support, um das Limit zu erhöhen
21009	Interner Systemfehler, kein erneuter Versuch möglich	Wenden Sie sich an den technischen Support
23001	Berechtigungsprüfung für die Abfrage von Msgid nach Push-Plan fehlgeschlagen	Prüfen Sie, ob der Aufrufer Zugriffsrechte auf die Schnittstelle hat
3010	API-Aufrufvolumen der Abfrageschnittstelle überschreitet das Limit	Wenden Sie sich an den technischen Support
23002	Der übergebene pl-Parameter für die Msgid-Abfrage nach Push-Plan ist ungültig	Prüfen Sie die Gültigkeit der plan_ids oder ob Datumsparameter übergeben wurden
21003	Das übergebene Datum ist ungültig	Prüfen Sie die Gültigkeit des Datums
21044	Das Intervall zwischen Start- und Enddatum überschreitet einen Monat	Stellen Sie sicher, dass das Intervall weniger als einen Monat beträgt

Vertrieb kontaktieren