Développeurs

GET/tcr/v2/campaignBuilder/brand/{brand_id}

Vérifier les cas d’utilisation de campagne disponibles pour une marque

Consultez les cas d’utilisation de campagne proposés par le registre pour une marque existante de votre compte avant de demander à un client de configurer une campagne.

Sur cette page
  1. Sélectionnez une marque existante de votre compte
  2. Construisez la liste des cas d’utilisation à partir de ce résultat
  3. Chargez les exigences du cas d’utilisation sélectionné
  4. Examinez séparément les tarifs du compte
  5. Actualisez les données lorsque la marque ou le cas d’utilisation change
  6. Requête
  7. Réponse
  8. Erreurs
  9. Disponibilité et effets secondaires

Sélectionnez une marque existante de votre compte

Partez de l’identifiant de marque du registre déjà associé à votre compte MultiTEL. Cette recherche ne crée pas de marque et ne rattache pas la marque d’un tiers à votre compte. Le parcours client actuel vérifie l’appartenance de la marque avant de demander les informations d’éligibilité. Si la recherche renvoie 404, vérifiez le compte et la marque sélectionnés au lieu d’utiliser un identifiant de ligne local.

Construisez la liste des cas d’utilisation à partir de ce résultat

Le catalogue général des cas d’utilisation décrit les options du registre. Cette recherche propre à la marque fournit les choix disponibles pour la marque sélectionnée. Conservez chaque valeur de usecase renvoyée et associez-la au libellé d’affichage et à la description du catalogue. Ne proposez pas toutes les entrées du catalogue général comme si la marque y était éligible.

Le portail attend une liste JSON dans cette réponse. Si la réponse est absente, mal formée ou correspond à une erreur, conservez le formulaire du client et indiquez que les informations d’éligibilité n’ont pas pu être chargées. Ne l’interprétez pas silencieusement comme une approbation d’un cas d’utilisation par défaut. Le registre peut renvoyer des champs supplémentaires par rapport à l’exemple abrégé.

Chargez les exigences du cas d’utilisation sélectionné

Une fois que le client a choisi une valeur de cas d’utilisation renvoyée, envoyez une requête à /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} pour la même marque. Cette réponse fournit les limites applicables aux sous-cas d’utilisation et les exigences propres aux opérateurs. Utilisez-la pour recueillir des exemples de messages, le consentement et les autres déclarations requises. La liste d’éligibilité seule ne suffit pas à constituer un dossier complet d’enregistrement de campagne.

Examinez séparément les tarifs du compte

Les champs du fournisseur tels que monthlyFee, quarterlyFee ou annualFee, lorsqu’ils sont renvoyés, décrivent les métadonnées des frais du fournisseur. Ils ne remplacent ni le tarif du compte du client ni les conditions d’enregistrement. Le portail actuel récupère séparément les tarifs de vente des campagnes et les associe aux données d’éligibilité pour son écran de vérification. Ne déduisez pas les frais à facturer au client des prix codés en dur dans l’ancienne fonction utilitaire d’énumération.

Actualisez les données lorsque la marque ou le cas d’utilisation change

Lors d’un changement de marque, abandonnez les choix de la marque précédente et chargez les informations d’éligibilité de la nouvelle sélection. Actualisez les exigences du cas d’utilisation sélectionné avant l’envoi. Ces requêtes GET ne soumettent pas de demande d’enregistrement, n’activent pas de campagne et n’attribuent pas de numéros.

Requête

Utilisez un compte API activé via HTTPS, depuis une adresse IP source autorisée. La route actuelle prend en charge la politique d’authentification du compte, notamment l’authentification Basic et les comptes API activés utilisant un jeton porteur. N’utilisez pas les identifiants du fournisseur.

Requête GET avec l’identifiant de la marque dans le chemin de l’URL. Aucun corps de requête n’est requis.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"
Paramètres de chemin
NomTypeObligatoireDescription
brand_idchaîne de caractèresOuiL’identifiant de marque du registre associé à votre compte MultiTEL authentifié. Utilisez l’identifiant de la marque, et non un identifiant de ligne de la base de données locale, un identifiant de campagne ou un numéro fiscal d’entreprise. Encodez-le en un seul segment de chemin d’URL.

Réponse

La route TCR actuelle renvoie directement le corps JSON du registre et conserve son statut HTTP. Elle n’ajoute pas l’enveloppe status/response héritée de v3. L’exemple fictif abrégé n’est pas un résultat d’éligibilité obtenu en direct. Vérifiez le statut HTTP et la structure JSON attendue avant de l’utiliser. Le portail actuel attend une liste d’enregistrements d’éligibilité, chacun identifiant un usecase. Il associe ces enregistrements au catalogue usecase pour obtenir les libellés d’affichage et récupère séparément les tarifs de vente. Des champs supplémentaires du fournisseur peuvent être présents.

Structure de réponse fournie à titre d’exemple ; il ne s’agit ni de données de compte en direct ni d’un devis actuel.

[
  {
    "usecase": "2FA"
  }
]

Erreurs

  • 401: Échec de l’authentification du compte. Vérifiez les identifiants API, l’état d’activation et les restrictions applicables aux adresses IP sources.
  • 404: La marque n’est pas associée au compte authentifié, ou le fournisseur ne trouve pas la marque ou la sélection demandée. Un refus local lié à l’appartenance de la marque est renvoyé avant toute requête au fournisseur.
  • Autres erreurs du registre : le statut HTTP et le corps de réponse du service en amont sont conservés. Un cas d’utilisation non valide ou indisponible ne constitue pas une réponse réussie contenant un ensemble d’exigences vide.
  • 429: La limite de requêtes du compte ou la limite partagée du fournisseur est atteinte. Respectez Retry-After.
  • 502/503: Défaillance du transport ou indisponibilité du fournisseur ou du limiteur de débit. Conservez le formulaire et réessayez en espaçant progressivement les tentatives.

Disponibilité et effets secondaires

  • La requête GET examinée vérifie l’appartenance de la marque existante, contacte le registre et écrit des enregistrements d’audit des requêtes. Elle ne crée ni marque ni campagne et ne facture pas de frais d’enregistrement.
  • Les métadonnées des frais du fournisseur ne constituent pas un devis de vente destiné à un client MultiTEL. Le portail examine séparément les tarifs du compte avant une demande d’enregistrement ultérieure.
  • L’éligibilité et les exigences peuvent évoluer. Actualisez-les pour la marque et le cas d’utilisation sélectionnés avant l’envoi. Une recherche réussie ne vaut ni approbation de campagne, ni attribution de numéros, ni autorisation de commencer à envoyer des messages.