API du Plan de Push

Dernière Mise à jour：about 2 years ago

Les API de ce module sont principalement axées sur les opérations de création, de modification et de consultation de l'identifiant du plan de push lui-même.

Vérification des appels

Pour plus de détails, veuillez vous référer à la description de la Méthode d'authentification dans l'Aperçu de l'API REST.

Créer et mettre à jour un plan de push

Cette interface permet de créer ou de mettre à jour un plan de push. En transmettant plan_id et plan_description, le système effectuera une opération de création ou de mise à jour selon l'existence du plan_id.

Adresse d'appel

POST v4/push_plan

              
              POST v4/push_plan

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Nom du paramètre	Type	Obligatoire	Description
plan_id	string	Oui	Identifiant unique du plan de push Règles de format : combinaison de lettres (sensible à la casse), chiffres et tirets bas. Il est interdit de commencer par un tiret bas. Limite de longueur : 50 caractères maximum. Contrainte d'unicité : ne peut pas être modifié après définition. Stratégie de mise à jour : si le plan_id existe déjà, met à jour le plan_description. Sinon, crée un nouveau plan.
plan_description	string	Oui	Informations de description du plan de push Exigences de contenu : doit inclure des informations clés telles que le scénario de push, les utilisateurs cibles et le contenu du push. Spécification de format : prend en charge le chinois, l'anglais, les chiffres et la ponctuation courante. Suggestion de longueur : pas plus de 128 caractères.

Exemple de requête

{ "plan_id": "push_20231001_001", "plan_description": "Plan de push pour la promotion du Double 11, couvrant tous les utilisateurs" }

              
              {
  "plan_id": "push_20231001_001",
  "plan_description": "Plan de push pour la promotion du Double 11, couvrant tous les utilisateurs"
}

Afficher ce bloc de code dans la fenêtre flottante

Description des paramètres de retour

Réponse réussie

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse échouée

{ "error": { "code": 27303, "message": "Identifiant de plan vide" } }

              
              {
  "error": {
    "code": 27303,
    "message": "Identifiant de plan vide"
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Rechercher un plan de push

Cette interface permet de consulter la liste des plans de push par pages, et prend en charge le filtrage par source d'envoi ainsi que la recherche floue sur la description/ID du plan.

Adresse d'appel

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

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Nom du paramètre	Type	Obligatoire	Description
page_index	int	Oui	Numéro de page pour la pagination (le comptage commence à `1`)
page_size	int	Oui	Nombre d'entrées de données par page, avec un maximum de `100` entrées
send_source	int	Non	Identifiant de la source d'envoi : `0`-API, `1`-Console Web
search_description	string	Non	Correspondance floue de la description ou de l'ID du plan (prend en charge le chinois, l'anglais, les chiffres et les tirets bas)

Exemple de requête

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

Afficher ce bloc de code dans la fenêtre flottante

Description des paramètres de retour

Réponse réussie

{ "push_plan_info": [ { "plan_id": "push_20231111", "plan_description": "Plan de push Double 11 sur tout le site", "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": "Plan de push Double 11 sur tout le site",
      "count": 15,
      "create_time": "2023-11-01T10:00:00Z",
      "last_used_time": "2023-11-11T20:30:00Z"
    }
  ],
  "total": 1
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse échouée

{ "error": { "code": 1003, "message": "La valeur du paramètre est invalide" } }

              
              {
    "error": {
        "code": 1003,
        "message": "La valeur du paramètre est invalide"
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Rechercher les Msgid selon le plan de push

Cette interface permet d'obtenir les identifiants de messages associés au plan de push spécifié au cours du dernier mois, et prend en charge la recherche groupée des données de messages associées à plusieurs plans.

Adresse d'appel

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

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Nom du paramètre	Type	Obligatoire	Description
plan_ids	string	Oui	Liste des identifiants de plans de push, séparés par des virgules anglaises pour plusieurs IDs, jusqu'à 1000 IDs maximum
start_date	string	Oui	Date de début (Format : `yyyy-MM-dd`), qui doit respecter : 1. Dans les 30 jours précédant la date actuelle 2. Date de fin >= date de début
end_date	string	Oui	Date de fin (Format : `yyyy-MM-dd`), qui doit respecter : 1. Intervalle entre la date de début et la date de fin ≤ 31 jours 2. Pas antérieure à la date de début

Exemple de requête

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

Afficher ce bloc de code dans la fenêtre flottante

Description des paramètres de retour

Réponse réussie

{ "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"]
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse échouée

{ "error": { "code": 21044, "message": "L'intervalle de temps dépasse un mois." } }

              
              {
    "error": {
        "code": 21044,
        "message": "L'intervalle de temps dépasse un mois."
    }
}

Afficher ce bloc de code dans la fenêtre flottante

Supprimer un plan de push

Cette API permet de supprimer un plan de push. En transmettant le plan_id, le système effectuera l'opération de suppression selon l'existence du plan_id.

Endpoint

POST v4/push_plan/{plan_id}

              
              POST v4/push_plan/{plan_id}

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de la requête

Nom du paramètre	Type	Obligatoire	Description
plan_id	string	Oui	Identifiant unique du plan de push

Exemple de requête

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"

Afficher ce bloc de code dans la fenêtre flottante

Description des paramètres de réponse

Réponse réussie

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse échouée

{ "error": { "code": 27305, "message": "L'identifiant du plan n'existe pas" } }

              
              {
  "error": {
    "code": 27305,
    "message": "L'identifiant du plan n'existe pas"
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Description des codes d'erreur

Code d'erreur	Description	Méthode de traitement suggérée
21015	Les paramètres de la requête pour la création d'un plan de push sont incorrects	Vérifiez si les types de `plan_id` ou `plan_description` sont corrects
27300	L'identifiant du plan de push est illégal	Vérifiez que le `plan_id` respecte les règles de nommage
27301	La description du plan de push est illégale	Vérifiez que le `plan_description` respecte les règles
27303	L'identifiant du plan de push est vide	Fournissez un identifiant de plan de push valide lors de la création
27304	La longueur de l'identifiant du plan de push dépasse la limite	Réduisez la longueur de l'identifiant à moins de 50 caractères
21004	Échec de la vérification des autorisations pour la création du plan de push	Vérifiez si l'appelant dispose des droits d'accès à l'interface
27000	Erreur interne du serveur	Contactez le support technique ou réessayez
1003	Les paramètres de la requête pour la consultation du plan de push sont illégaux	Vérifiez si `page_index/page_size` est supérieur à 0
21004	Échec de la vérification des autorisations pour la consultation du plan de push	Vérifiez si l'appelant dispose des droits d'accès à l'interface
27302	Limite supérieure d'utilisation des plans de push atteinte	Contactez le support technique pour augmenter la limite
21009	Erreur système interne, non réessayable	Contactez le support technique
23001	Échec de la vérification des autorisations pour la consultation des Msgid selon le plan de push	Vérifiez si l'appelant dispose des droits d'accès à l'interface
3010	Volume d'appels API de l'interface de consultation dépassé	Contactez le support technique
23002	Le paramètre pl transmis pour la consultation des Msgid selon le plan de push est incorrect	Vérifiez la validité des plan_ids ou si les paramètres de date sont transmis
21003	La date transmise est illégale	Vérifiez la validité de la date
21044	L'intervalle entre la date de début et la date de fin dépasse un mois	Réduisez l'intervalle à moins d'un mois