Încărcarea cataloagelor pentru înregistrarea serviciilor de mesagerie

Încărcați opțiunile înainte de a construi un formular de înregistrare

Folosiți catalogul actual de înregistrare pentru mesagerie pentru a completa opțiunile, în loc să introduceți valorile registrului direct în cod. Pentru un formular de marcă, portalul încarcă cataloagele pentru tipul întreprinderii, sectorul de activitate, tipul identificatorului alternativ al întreprinderii, relația cu marca, țara, statul din SUA și bursa de valori. Pentru un formular de campanie, încarcă cazurile de utilizare, subcazurile de utilizare valide și partenerii de conectivitate. Păstrați fiecare valoare destinată prelucrării automate împreună cu eticheta sa de afișare; la construirea unei cereri ulterioare, folosiți valoarea, nu o etichetă tradusă.

Alegeți un catalog

Cataloage utilizate de portal
Nume	Scop
usecase	Definițiile cazurilor de utilizare pentru campanii. Adăugați validSubUsecase=true când încărcați opțiunile pentru subcazurile de utilizare.
entityType	Tipul întreprinderii sau al organizației pentru o marcă.
vertical	Opțiuni pentru sectorul de activitate al unei mărci.
altBusinessIdType	Categorii de identificatori alternativi ai întreprinderii.
brandRelationship	Opțiuni privind relația, utilizate de formularul de înregistrare.
country	Opțiunile de țară din registru; acestea sunt distincte de țările în care sunt disponibile numere de telefon.
usState	Opțiuni pentru statele din SUA pentru adresele de înregistrare.
stockExchange	Opțiuni pentru bursa de valori, atunci când tipul întreprinderii asociate mărcii le impune.
cnp	Identificatorii partenerilor de conectivitate. Alegeți partenerul acceptat de fluxul de lucru pentru campanii al contului dumneavoastră.

Prelucrați direct răspunsul TCR

Corpul răspunsului provine direct de la API TCR. Spre deosebire de multe puncte finale mai vechi /v3, acesta nu are un înveliș suplimentar status/response. Verificați starea HTTP înainte de a-l interpreta. Un catalog poate conține etichete sub formă de șiruri de caractere sau definiții structurate, așadar nu presupuneți că fiecare valoare are aceleași câmpuri. Dacă cererea HTTP reușește, dar corpul nu este un document JSON valid cu structura așteptată, raportați eșecul căutării în loc să îl înlocuiți în mod tacit cu o listă goală.

Separați opțiunile din cataloage de eligibilitate și de prețuri

Un catalog general de cazuri de utilizare nu indică pentru care dintre acestea este eligibilă o anumită marcă. Portalul actual verifică eligibilitatea specifică mărcii înainte de crearea campaniei și verifică cerințele operatorilor selectați. De asemenea, metadatele privind taxele unui furnizor nu reprezintă prețul final de vânzare pentru cont. Examinați separat prețul aplicabil contului și condițiile de înregistrare. Încărcarea unui catalog nu aprobă o marcă, o campanie sau un număr de mesagerie.

Gestionați cataloagele indisponibile

Păstrați datele introduse de client în formular dacă o căutare eșuează. Afișați eroarea, respectați Retry-After atunci când este returnat și folosiți întârzieri progresive între reîncercări. Nu reîncărcați în mod repetat toate cataloagele și nu tratați o eroare de limitare a frecvenței cererilor sau de transport ca pe un catalog valid gol. Această cerere GET nu necesită o cheie de idempotență și nu este redată din depozitul de idempotență al operațiilor de modificare.

Cerere

Folosiți un cont API activat, prin HTTPS, de la o adresă IP sursă permisă. Ruta actuală acceptă politica de autentificare a contului, inclusiv autentificarea Basic și conturile API activate cu autentificare prin token la purtător. Nu folosiți datele de autentificare ale furnizorului.

GET cu un nume de catalog acceptat în cale. Transmiteți filtrele de catalog aplicabile în șirul de interogare. Nu este necesar un corp al cererii.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/enum/usecase?validSubUsecase=true"

Parametri de cale
Nume	Tip	Obligatoriu	Descriere
`type`	șir de caractere	Da	Numele catalogului, cu majusculele și minusculele originale. Portalul utilizează usecase, entityType, vertical, altBusinessIdType, brandRelationship, country, usState, stockExchange și cnp. Acestea sunt nume de cataloage, nu identificatori de mărci sau de campanii.

Parametri de interogare
Nume	Tip	Obligatoriu	Descriere
`validSubUsecase`	valoare logică	Nu	Pentru catalogul usecase, portalul solicită valoarea true pentru a încărca opțiunile valide pentru subcazurile de utilizare. Omiteți parametrul când încărcați catalogul obișnuit de cazuri de utilizare. Disponibilitatea și definițiile sunt furnizate de registru.

Răspuns

Această rută TCR returnează direct corpul răspunsului registrului împreună cu starea sa HTTP. Nu folosește vechiul înveliș v3 status.code/status.msg/response. Structurile cataloagelor diferă: unele asociază valorile cu obiecte descriptive, iar altele cu șiruri de caractere. Păstrați cheile destinate prelucrării automate când trimiteți ulterior un formular. Exemplul fictiv prescurtat usecase ilustrează o mapare cu valori de tip obiect, nu un catalog în timp real sau o schemă garantat completă. Verificați atât starea HTTP, cât și structura JSON așteptată.

Structură ilustrativă a răspunsului; nu reprezintă date în timp real ale contului sau o ofertă de preț actuală.

{
  "2FA": {
    "displayName": "Authentication",
    "description": "Example authentication use case"
  }
}

Erori

401: Autentificarea contului a eșuat. Verificați datele de autentificare API, starea de activare și restricțiile aplicabile adresei IP sursă.
400/404 și alte erori ale registrului: catalog sau filtru nevalid ori indisponibil. Ruta actuală păstrează starea HTTP și corpul răspunsului de la serviciul din amonte; nu există un înveliș universal pentru erori v3.
429: A fost atinsă limita de cereri a contului sau limita comună a furnizorului. Respectați Retry-After și reîncercați cu întârzieri progresive.
502: Registrul nu a putut fi contactat. Disponibilitatea este necunoscută; nu înlocuiți rezultatul cu opțiuni goale prezentate ca rezultat reușit.
503: Mecanismul de limitare a cererilor sau serviciul din amonte este indisponibil. Examinați corpul răspunsului și orice antet Retry-After înainte de a reîncerca.

Disponibilitate și efecte secundare

Această cerere GET de catalog nu creează o marcă sau o campanie, nu trimite o înregistrare, nu rezervă o resursă și nu percepe o taxă de înregistrare pe traseul examinat. Ea contactează furnizorul și scrie înregistrări de audit ale cererilor.
Definițiile cataloagelor și orice metadate privind taxele furnizorului nu constituie o ofertă de preț de vânzare pentru client. Portalul actual obține separat prețurile de vânzare pentru campanii; funcția auxiliară veche getCampaignPrice și vechile adnotări de preț ale enumerărilor nu trebuie tratate ca specificația de preț a acestei rute.
O intrare acceptată în catalog nu dovedește că o anumită marcă este eligibilă pentru acel caz de utilizare. Finalizați verificarea eligibilității specifice mărcii, declarațiile, consimțământul și examinarea prețurilor contului înainte de o cerere ulterioară de înregistrare.