Ontwikkelaars

DELETE/tcr/v2/brand/{brandId}

Een merk voor berichtenverkeer buiten gebruik stellen

Kies tussen gecoördineerd opschonen via het portaal en het rechtstreeks verwijderen van een merk. Controleer daarna de campagnes en nummertoewijzingen.

Op deze pagina
  1. Kies de werkwijze voor buitengebruikstelling
  2. Bekijk de gevolgen in het portaal
  3. Bereid een rechtstreekse verwijdering via de API voor
  4. Verwijder het gecontroleerde merk
  5. Controleer de buitengebruikstelling en stem gedeeltelijke resultaten op elkaar af
  6. Controleer de resterende accountkosten

Kies de werkwijze voor buitengebruikstelling

Stel een merk voor berichtenverkeer buiten gebruik wanneer het bedrijf die registratie niet meer nodig heeft. Hiermee stopt het gebruik van de bestaande registratie; er wordt geen vervangende registratie aangemaakt, er worden geen gehuurde telefoonnummers vrijgegeven en er worden geen identificatiegegevens van het bedrijf gecorrigeerd. Gebruik voor een correctie Een merk voor berichtenverkeer bijwerken.

De openbare DELETE-aanroep voor een merk en de actie Merk verwijderen in het portaal hebben een verschillende reikwijdte. De openbare aanroep verwijdert één merk uit het register. Het portaal coördineert het loskoppelen van nummers en het deactiveren van campagnes voordat het probeert het merk te verwijderen.

Opties om een merk buiten gebruik te stellen
WerkwijzeWat er gebeurt
Portaal: merk verwijderenToont de gekoppelde campagnes en toegewezen nummers, vereist de merk-ID als bevestiging en probeert vervolgens de bijbehorende onderdelen op te schonen voordat het merk wordt verwijderd. Eerdere stappen kunnen uitgevoerd blijven als een latere stap mislukt.
API: DELETE /tcr/v2/brand/{brandId}Vraagt uitsluitend om verwijdering van dit merk dat eigendom is van het account. Nummers worden niet automatisch losgekoppeld en de campagnes van het merk worden niet automatisch gedeactiveerd. Een actieve campagne kan de verwijdering verhinderen.

Bekijk de gevolgen in het portaal

Open de registratiepagina voor berichtenverkeer, zoek het juiste merk en kies Merk verwijderen. Controleer het aantal gekoppelde campagnes en toegewezen nummers. Voer de exacte merk-ID in om de definitieve actie beschikbaar te maken. Het klantformulier is alleen beschikbaar als het account toestemming heeft om registraties te beheren.

Het portaal verwerkt actieve campagnes achtereenvolgens: het probeert elk momenteel toegewezen nummer los te koppelen, deactiveert de campagne en verwijdert vervolgens het merk. Voor campagnes die al als verlopen of verwijderd zijn gemarkeerd, slaat het een nieuwe verwijdering in het externe systeem over. Nadat deze externe stappen zijn geslaagd, werkt het de lokale campagne- en nummergegevens bij in een databasetransactie.

Deze reeks vormt geen enkele atomaire transactie die het register, de telecomaanbieder en de lokale gegevens omvat. Een latere fout kan een nummer of campagne die extern al is gewijzigd niet herstellen. Bewaar de teruggestuurde gegevens over losgekoppelde nummers en gedeactiveerde campagnes als die beschikbaar zijn; controleer en stem de bijbehorende gegevens aan de hand van die identificatoren op elkaar af in plaats van nog een merk aan te maken.

Bereid een rechtstreekse verwijdering via de API voor

Gebruik een ingeschakeld API-account via HTTPS vanaf een toegestaan bron-IP-adres. Het merk moet eigendom zijn van dat account. Haal de ID en de huidige status op en bewaar deze. Controleer vervolgens de campagnes en nummertoewijzingen. Koppel de betreffende nummers los en deactiveer campagnes voordat u het merk verwijdert. Beschouw deze DELETE-aanroep niet als een cascadebewerking.

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

Verwijder het gecontroleerde merk

Voer het volgende alleen uit voor de beoogde buitengebruikstelling, nadat u de merk-ID hebt gecontroleerd en de voorgaande opschoonstappen hebt voltooid. Het verzoek heeft geen JSON-body.

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID"

Het gedocumenteerde succesvolle resultaat is HTTP 204 zonder antwoordbody. Vereis geen JSON-object dat succes aangeeft of de verouderde v3-envelop met status/response. Een afgewezen resultaat buiten de 2xx-reeks markeert het merk niet als verwijderd via het huidige synchronisatieproces van de API.

Gebruik één idempotentiesleutel voor het beoogde verzoek. Houd bij een herhaling de methode, het pad, de query en de bytes van de body ongewijzigd. De sleutel maakt het volledige opschoonproces in het portaal niet atomair en bewijst niet dat een nummer bij de telecomaanbieder is losgekoppeld. Een duplicaat van een verzoek dat nog wordt verwerkt, kan 409 met Retry-After teruggeven; bij voltooide verzoeken kan het opgeslagen antwoord opnieuw worden teruggegeven, inclusief een fout.

Controleer de buitengebruikstelling en stem gedeeltelijke resultaten op elkaar af

Controleer na de bewerking de lijsten met merken en campagnes in het portaal en de betreffende nummers. De synchronisatie na een succesvol resultaat van de openbare API markeert het afzonderlijke merk lokaal als verwijderd; andere campagnebronnen worden niet verwijderd en toewijzingen van gekochte nummers worden niet gewist. Controleer de status in het register, de toewijzing bij de telecomaanbieder en de lokale weergave afzonderlijk.

De huidige adapter voor telecomaanbieders in het portaal accepteert een succesvol HTTP-antwoord zonder elke bedrijfsstatuswaarde in de body afzonderlijk te valideren. Controleer daarom na het opschonen via het portaal aan welke campagnes de betreffende nummers daadwerkelijk zijn toegewezen, ook als het portaal succes heeft gemeld. Als een toewijzing of status niet overeenkomt, bewaart u de betreffende ID's en neemt u contact op met de ondersteuning voordat u berichten via de buiten gebruik gestelde configuratie verstuurt of die configuratie opnieuw aanmaakt.

Lees bij HTTP 400 de gedetailleerde foutmelding van het register, vooral als deze een beperking vanwege een actieve campagne betreft. Controleer bij 401, 403 of 404 de toegangsgegevens, het toegestane bron-IP-adres en of het merk eigendom is van het account. Volg bij 429 de aanwijzing in Retry-After. Een time-out, 500 of 502 kan optreden nadat een externe wijziging al is voltooid; controleer de bestaande registratie voordat u het verzoek herhaalt.

Controleer de resterende accountkosten

De huidige DELETE-service initieert geen onmiddellijke afschrijving voor merkregistratie. Het verwijderen van een merk geeft de gehuurde telefoonnummers niet vrij, leidt niet tot een terugbetaling en stelt het definitieve accountsaldo niet vast. Bekijk in het portaal alle bestaande campagneverplichtingen en de kosten voor nummerhuur en gebruik. Deze bewerking is geen prijsopgave voor die afzonderlijke diensten.