Skip to content

Afficher le statut du groupe d’abonnement de l’utilisateur

get

/subscription/status/get

Utilisez cet endpoint pour obtenir l’état d’abonnement d’un utilisateur dans un groupe d’abonnement.

Ces groupes seront disponibles sur la page Groupe d’abonnement. La réponse de cet endpoint inclura l’ID externe ainsi que le statut abonné, désabonné ou inconnu pour le groupe d’abonnement spécifique demandé dans l’appel d’API. Cela peut être utilisé pour mettre à jour l’état du groupe d’abonnement dans des appels d’API ultérieurs ou pour l’afficher sur une page web hébergée.

Si vous souhaitez voir des exemples ou tester cet endpoint pour les Groupes d’abonnement e-mail :

See me in Postman

Si vous souhaitez voir des exemples ou tester cet endpoint pour les Groupes d’abonnement SMS :

See me in Postman

Si vous souhaitez voir des exemples ou tester cet endpoint pour les groupes WhatsApp :

See me in Postman

Conditions préalables

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec l’autorisation subscription.status.get.

Limite de débit

La limite de débit par défaut de Braze de 250 000 requêtes par heure s’applique à cet endpoint, comme documenté dans Limites de débit de l’API.

Paramètres de requête

Paramètre Requis Type de données Description
subscription_group_id Requis Chaîne de caractères L’id de votre groupe d’abonnement.
external_id Requis* Chaîne de caractères L’external_id de l’utilisateur (doit inclure au minimum un et au maximum 50 external_ids).

Lorsqu’un external_id et un email/phone sont soumis, seul(s) le(s) external_id(s) fourni(s) seront appliqués à la requête.
email Requis* Chaîne de caractères L’adresse e-mail de l’utilisateur. Elle peut être transmise sous forme de tableau de chaînes de caractères avec un maximum de 50.

Soumettre à la fois une adresse e-mail et un numéro de téléphone (sans external_id) entraînera une erreur.
phone Requis* Chaîne de caractères au format E.164 Le numéro de téléphone de l’utilisateur. Si l’e-mail n’est pas inclus, vous devez fournir au moins un numéro de téléphone (avec un maximum de 50).

Soumettre à la fois une adresse e-mail et un numéro de téléphone (sans external_id) entraînera une erreur.
  • Pour les groupes d’abonnement SMS et WhatsApp, un external_id ou un phone est requis. Lorsque les deux sont soumis, seul l’external_id est utilisé pour l’interrogation et le numéro de téléphone est appliqué à cet utilisateur.
  • Pour les groupes d’abonnement e-mail, un external_id ou un email est requis. Lorsque les deux sont soumis, seul l’external_id est utilisé pour la requête et l’adresse e-mail est appliquée à cet utilisateur.

Exemple de requête

1

https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Réponse

Toutes les réponses réussies renverront Subscribed, Unsubscribed ou Unknown en fonction du statut et de l’historique de l’utilisateur avec le groupe d’abonnement.

1
2
3
4
5
6
7

{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
New Stuff!