Lees 'n handelsmerk se veldtogvereistes

Hou die handelsmerk en die gebruiksgeval bymekaar

Gebruik die handelsmerk-ID op jou rekening en 'n gebruiksgevalwaarde wat deur dieselfde handelsmerk se kwalifikasielys teruggestuur is. Die kliëntewerkvloei kontroleer eienaarskap vóór die versoek aan die diensverskaffer. Bevestig dat die teruggestuurde objek se usecase met die gekose waarde ooreenstem. 'n Navraag vir een handelsmerk of gebruiksgeval stel nie die vereistes vir 'n ander vas nie.

Lees die huidige vereistes

Pas die gekose operateurs se vereistes gesamentlik toe

Operateurs se vereistes kan verskil. Wanneer geen uitdruklike operateurslys verskaf word nie, neem die portaal al die operateurmetadata in die antwoord in ag; 'n lys wat nie leeg is nie, beperk die kontroles tot daardie gekose ID's. Moenie net die eerste operateur se aantal voorbeelde of verklarings gebruik nie. Kies operateurs uit die antwoord, kontroleer ondersteuning en kwalifikasie, voldoen aan die hoogste toepaslike minimum aantal voorbeelde en voldoen aan die vereiste opt-in-, opt-out- en hulpverklarings vir die hele keuse. Die portaal verwerp gekose operateur-ID's wat nie in die huidige antwoord voorkom nie, en verwerp 'n keuse waarin geen operateur kwalifiseer nie.

Die vereistes beskryf wat verskaf moet word; dit bewys nie dat die kliënt se toestemmingsproses of veldtoginhoud aan daardie vereistes voldoen nie. Versamel waarheidsgetroue, verteenwoordigende voorbeelde en verklarings. Moenie verklarings outomaties aanskakel bloot om 'n vorm te laat slaag nie.

Berei voorbeelde en antwoorde aan intekenaars voor

Die huidige veldtogvorm gebruik sample1 tot en met sample5 vir boodskapvoorbeelde. Indien die vereistes nie binne die beskikbare vorm nagekom kan word nie, staak en klaar die keuse met ondersteuning uit. Verskaf vir 'n geaktiveerde intekenaarverklaring die ooreenstemmende sleutelwoorde en antwoordteks: optinKeywords/optinMessage, optoutKeywords/optoutMessage, en helpKeywords/helpMessage. Hou die voorbeelde in ooreenstemming met die gekose gebruiksgeval en die kliënt se werklike boodskappe.

Gaan die besonderhede vóór enige registrasieversoek na

Verfris die vereistes wanneer die handelsmerk, gebruiksgeval of operateurkeuse verander. Die portaal valideer die gekose gebruiksgeval, aantal subgebruiksgevalle, operateurs se geskiktheid, voorbeelde en verklarings weer vóór skepping. Gaan die rekening se pryse en die registrasievoorwaardes afsonderlik na. Hierdie GET-versoek registreer of keur nie 'n veldtog goed nie, deel dit nie met die boodskapoperateur nie en ken nie 'n telefoonnommer toe nie. Skepping en voorsiening is afsonderlike bewerkings.

Hanteer 'n mislukte navraag oor vereistes

Indien die versoek misluk, onverwagte JSON terugstuur of nie met die gekose gebruiksgeval ooreenstem nie, hou die vorm onvoltooid en laat die kliënt weer probeer nadat die fout opgelos is. Moenie onbeskikbare vereistes met 'n leë objek vervang of aanvaar dat ontbrekende data beteken dat daar geen vereistes is nie. Hou by Retry-After en gebruik wagtye tussen herprobeerslae (backoff) vir tempobeperkings en beskikbaarheidsfoute.

Versoek

Gebruik 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate bron-IP-adres. Die huidige roete ondersteun die rekening se outentiseringsbeleid, insluitend Basic-outentisering en geaktiveerde bearer-API-rekeninge. Moenie die diensverskaffer se outentiseringsbesonderhede gebruik nie.

GET met die handelsmerk-ID en die gekose gebruiksgevalwaarde in die URL-pad. Geen versoekliggaam word vereis nie.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

Antwoord

Die huidige TCR-roete stuur die register se JSON-inhoud direk terug en behou die HTTP-status daarvan. Dit voeg nie die ou v3 status/response-omhulsel by nie. Die verkorte, fiktiewe voorbeeld is nie 'n werklike kwalifikasieresultaat nie. Kontroleer die HTTP-status en die verwagte JSON-struktuur voordat jy dit gebruik. Die portaal verwag 'n objek waarvan usecase met die gekose gebruiksgeval ooreenstem. Die operateurvereistes is onder mnoMetadata en gebruik die operateur-ID as sleutel. Die operateur-ID en vereistes in die voorbeeld is fiktief. Ander velde van die diensverskaffer kan ook teruggestuur word.

'n Illustratiewe antwoordstruktuur; nie werklike rekeningdata of 'n huidige pryskwotasie nie.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Foute

• 401: Rekeningoutentisering het misluk. Kontroleer die API-outentiseringsbesonderhede, die aktiveringstatus en die toepaslike bron-IP-beperkings.
• 404: Die handelsmerk is nie aan die geoutentiseerde rekening gekoppel nie, of die diensverskaffer kan nie die aangevraagde handelsmerk of keuse vind nie. 'n Plaaslike weiering op grond van eienaarskap word vóór enige versoek aan die diensverskaffer teruggestuur.
• Ander registerfoute: die HTTP-status en inhoud van die stroomopdiens word behou. 'n Ongeldige of onbeskikbare gebruiksgeval is nie 'n suksesvolle leë stel vereistes nie.
• 429: Die rekening of gedeelde diensverskaffer se versoeklimiet is bereik. Hou by Retry-After.
• 502/503: 'n Beskikbaarheidsfout by die transportlaag, diensverskaffer of tempobeperker. Behou die vorm en probeer weer met wagtye tussen herprobeerslae (backoff).

Beskikbaarheid en newe-effekte

• Die nagegane GET-versoek kontroleer bestaande eienaarskap van die handelsmerk, kontak die register en skryf versoekouditrekords. Dit skep nie 'n handelsmerk of veldtog nie en hef nie 'n registrasiefooi nie.
• Metadata oor die diensverskaffer se fooie is nie 'n kleinhandelpryskwotasie vir 'n MultiTEL-kliënt nie. Die portaal gaan die rekening se pryse afsonderlik na vóór 'n latere registrasieversoek.
• Kwalifikasie en vereistes kan verander. Verfris dit vir die gekose handelsmerk en gebruiksgeval vóór indiening. 'n Suksesvolle navraag is nie 'n veldtoggoedkeuring, nummertoekenning of toestemming om boodskappe te begin stuur nie.