Entwickler

POST/tcr/v2/brand/nonBlocking

Eine Messaging-Marke registrieren

Registrieren Sie eine kontoeigene Geschäftsidentität, halten Sie Sandbox-Anfragen explizit und gleichen Sie Validierung und Gebühren ab.

Auf dieser Seite
  1. Registrieren Sie das Unternehmen hinter Ihren Nachrichten
  2. Beginnen Sie mit einer expliziten Sandbox-Anfrage
  3. Unternehmens- und Kontaktfelder
  4. Behalten Sie einen stabilen Idempotenzschlüssel bei
  5. Lesen Sie die Marke und ihren Status
  6. Produktionsgebühren
  7. Fehler behandeln, ohne die Marke zu duplizieren

Registrieren Sie das Unternehmen hinter Ihren Nachrichten

Eine Messaging-Marke identifiziert das Unternehmen, das in den USA Nachrichten über 10DLC versendet. Registrieren Sie die Marke, bevor Sie einen Kampagnen-Anwendungsfall wählen. Verwenden Sie die rechtlichen Angaben des Unternehmens und eine Kontaktperson, die jede erforderliche Validierung abschließen kann. Eine zurückgegebene Marken-ID ist für sich genommen keine Freigabe zum Versand von Nachrichten.

Verwenden Sie diese aktuelle kontoeigene Route über HTTPS mit einem aktivierten API-Konto und dessen zugelassener Quell-IP-Adresse. Übermitteln Sie weder user_id, username noch die Eigentümerkennung eines anderen Kunden. MultiTEL erfasst die Eigentümerschaft anhand des authentifizierten Kontos.

Beginnen Sie mit einer expliziten Sandbox-Anfrage

Das Portal setzt das Feld mode seines Formulars standardmäßig auf Sandbox; eine direkte API-Anfrage muss den JSON-Booleschen Wert mock: true explizit enthalten, wenn Sie eine Mock-Marke beabsichtigen. Das Weglassen dieses Flags ist keine Sandbox-Garantie und kann eine kostenpflichtige Produktionsregistrierung erzeugen. Das Feld mode des Portals ersetzt nicht das Feld mock der API.

Bereiten Sie eine lokale Datei brand.json mit den unten stehenden Feldern vor. Ersetzen Sie die Platzhalter durch geeignete Testangaben und aktuelle Katalogcodes. Dieses Beispiel ist ein gewinnorientiertes Privatunternehmen; andere Entitätstypen haben andere Anforderungen.

{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "Example business",
  "companyName": "Example legal business name",
  "ein": "YOUR_TAX_ID",
  "einIssuingCountry": "US",
  "phone": "+12025550123",
  "street": "123 Example Street",
  "city": "Example City",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "contact@example.invalid",
  "brandRelationship": "BASIC_ACCOUNT",
  "vertical": "CURRENT_VERTICAL_CODE",
  "referenceId": "your-business-reference",
  "mock": true
}

Unternehmen, Adresse, Telefonnummer und Kennung oben sind Platzhalter, keine registrierungsfertige Geschäftsidentität. Beziehen Sie aktuelle Werte für entityType, vertical, country, state, brandRelationship und andere Aufzählungen aus den Messaging-Katalogen.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @brand.json \
  'https://api.multitel.net/tcr/v2/brand/nonBlocking'

Unternehmens- und Kontaktfelder

Felder der Markenregistrierung
FelderWas anzugeben ist
entityType, displayNameAktueller Entitätstyp-Code und der erkennbare Markenname. Die maximalen Längen betragen 20 bzw. 255 Zeichen.
country, street, city, state, postalCodeDie tatsächliche Geschäftsadresse. Verwenden Sie den zweibuchstabigen Ländercode und, falls zutreffend, einen aktuellen Code eines US-Bundesstaats für state. Grenzen: street 255, city 100, state 20 und postalCode 10 Zeichen.
email, phoneEine funktionierende Kontakt-E-Mail-Adresse mit bis zu 100 Zeichen und eine Telefonnummer im internationalen Format mit +Ländervorwahl mit bis zu 20 Zeichen. Halten Sie die Unternehmensangaben in der gesamten Registrierung konsistent.
companyName, ein, einIssuingCountryGeben Sie für Organisationen den rechtlichen Firmennamen und die Steuerkennung des Unternehmens an. Das Ausstellungsland der Kennung ist ein separates zweibuchstabiges Feld. Grenzen: companyName 255 und ein 21 Zeichen. Ein Einzelunternehmer verwendet Felder für den persönlichen Namen anstelle der Steueridentität einer Organisation.
brandRelationship, verticalDie Beziehung zum Unternehmen und dessen Branche, unter Verwendung aktueller Katalogcodes. Organisationen benötigen diese; für Einzelunternehmer gelten andere Regeln. Ersetzen Sie API-Codes nicht durch übersetzte Anzeigebezeichnungen.
firstName, lastName, mobilePhoneErforderlich für einen Einzelunternehmer. Namensfelder erlauben jeweils bis zu 100 Zeichen. Geben Sie eine geeignete Mobilfunknummer für die erforderliche OTP-Validierung im internationalen Format an.
stockSymbol, stockExchange, website, businessContactEmailEin börsennotiertes Unternehmen benötigt zusätzlich sein Aktiensymbol/seine Börse, website und eine geeignete geschäftliche Kontakt-E-Mail-Adresse für den zusätzlichen Validierungsprozess. Grenzen: stockSymbol 10, website 255 und businessContactEmail 255 Zeichen.
altBusinessIdType, altBusinessIdOptionale alternative Unternehmenskennung. Geben Sie Typ und Wert zusammen an. Verwenden Sie den aktuellen Typkatalog; der Wert erlaubt bis zu 50 Zeichen.
referenceIdIhre Geschäftsreferenz mit bis zu 50 Zeichen. Geben Sie sie bei der Registrierung eines Einzelunternehmers gemäß den aktuellen entitätsspezifischen Anforderungen an. Sie ist ein Geschäftsmetadatum, nicht der Idempotenzschlüssel der Anfrage.
website, ipAddress, tagZusätzliche Website, Metadaten zur Ursprungs-IP und Tag-Werte, falls zutreffend. Diese begründen keine Kontoeigentümerschaft und ersetzen keine Identitätsprüfungen.
mockEin JSON-Boolescher Wert. Verwenden Sie true nur für den beabsichtigten Mock-Workflow; verwenden Sie false für eine ausdrücklich geprüfte Produktionsregistrierung. Senden Sie nicht die Zeichenkette "false" als Ersatz für einen JSON-Booleschen Wert.

Einzelunternehmer werden für Registrierungen in den USA oder Kanada unterstützt und benötigen vor der Kampagnenberechtigung eine OTP-Verifizierung. Börsennotierte Unternehmen können einen Validierungsschritt über den Geschäftskontakt erfordern. GOVERNMENT ist für in den USA ansässige Regierungsstellen vorgesehen; bestätigen Sie für andere Organisationen die richtige Entitätskategorie. Befolgen Sie die entitätsspezifischen Anforderungen sowie die zurückgegebenen Validierungsfehler.

Behalten Sie einen stabilen Idempotenzschlüssel bei

Erzeugen Sie einen Idempotency-Key für diese beabsichtigte Registrierung. Er muss 1–128 druckbare ASCII-Zeichen ohne Leerzeichen enthalten. Verwenden Sie denselben Schlüssel nur mit derselben HTTP-Methode, demselben Pfad, derselben Query-Zeichenkette und exakt denselben Bytes des Anfragetexts wieder. Eine Neuformatierung des JSON ändert den Fingerabdruck der Anfrage, selbst wenn sich seine Bedeutung nicht ändert.

Eine abgeschlossene Anfrage mit Schlüssel kann ihre gespeicherte Antwort erneut ausliefern, ohne dass eine weitere Registrierung eingereicht wird. Ein Duplikat, das noch verarbeitet wird, gibt HTTP 409 zurück und kann Retry-After enthalten. Eine geänderte Anfrage mit demselben Schlüssel führt zu einem Konflikt. Erzeugen Sie keinen neuen Schlüssel, nur weil eine Anfrage in eine Zeitüberschreitung gelaufen ist oder einen Fehler zurückgegeben hat: Das Unternehmen ist möglicherweise bereits registriert.

Lassen Sie brand.json unverändert, während Sie diese Anfrage klären. Ein zwischengespeicherter 500 oder 502 kann den ursprünglichen Fehler erneut ausliefern, statt die Registrierung zu wiederholen. Bewahren Sie jedes zurückgegebene brandId, requestId und die Korrelations-Header auf; gleichen Sie die bestehende Marke ab, bevor Sie eine andere Anfrage starten.

Lesen Sie die Marke und ihren Status

Diese API verwendet HTTP-Statuscodes und einen direkten JSON-Body statt der v3-Hülle aus status/response. Eine erfolgreiche Registrierung gibt ein Markenobjekt zurück, das brandId enthält. Speichern Sie diese Kennung und prüfen Sie den zurückgegebenen Validierungs- oder Identitätsstatus. Zusätzliche Felder hängen von der Entität und dem Registrierungszustand ab.

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

Lesen Sie nur eine Marke, die zu Ihrem Konto gehört. Ein 404 kann bedeuten, dass die Marke für dieses Konto nicht verfügbar ist. Schließen Sie jede erforderliche Validierung ab und verwenden Sie dann die Markenqualifizierung zum Auffinden ihrer verfügbaren Kampagnen-Anwendungsfälle. Mock-Ressourcen können nicht als für den Produktionsversand berechtigt angesehen werden.

Produktionsgebühren

Aktuell konfigurierte Gebühren für die Markenregistrierung
RegistrierungGebühr
Standardorganisation$5.00
Einzelunternehmer$4.45
Mock-MarkeKeine Abbuchung für die Markenregistrierung im Mock-Workflow

Diese Endkundenbeträge wurden am 24. Oktober 2026 mit der aktuellen Portalkonfiguration abgeglichen. Bestätigen Sie die aktuelle Gebühr im Portal vor der Produktionsregistrierung. Kampagnengebühren, zusätzliche Überprüfung und Messaging-Nutzung sind davon getrennt. Eine Produktionsregistrierung prüft vor der Einreichung die Kaufberechtigung und das verfügbare Guthaben; die erfolgreiche Anlage im Register und die lokale Abrechnung sind getrennte Verarbeitungsschritte, bewahren Sie daher die Ressourcen-ID auf und gleichen Sie die Transaktionen ab, falls ein Fehler oder ein Abrechnungsproblem auftritt.

Die Umstellung einer Mock-Marke auf Produktion ist ein separat bestätigter Workflow und kann eine neue Produktionsidentität und eine Abbuchung erzeugen. Gehen Sie nicht davon aus, dass das Ändern von mock auf false in einer späteren Anfrage die bestehende Marke umwandelt.

Fehler behandeln, ohne die Marke zu duplizieren

Registrierungsfehler
HTTP-ErgebnisWas zu prüfen ist
400Lesen Sie die Feldfehler. Validierungsfehler des Registers können ein Array aus Objekten mit code/description sein. Die lokale Validierung des Idempotenzschlüssels kann ebenfalls 400 zurückgeben.
401, 403 oder 404Prüfen Sie die API-Anmeldedaten, die zugelassene Quell-IP des API-Kontos, die Kundenberechtigungen und die Eigentümerschaft. Eine Antwort des Registers kann auch einen eigenen Autorisierungsfehler enthalten.
402Prüfen Sie Guthaben und Kaufberechtigung. Behandeln Sie eine nicht finanzierte Produktionsanfrage nicht als Sandbox-Test.
409Behalten Sie denselben Schlüssel und die unveränderte Anfrage bei, während Sie auf eine laufende Anfrage warten. Ein Konflikt durch geänderten Body/Schlüssel oder eine nicht wiederherstellbare frühere Antwort erfordert zuerst einen Abgleich.
429 oder eine Antwort, dass der Limiter nicht verfügbar istBeachten Sie Retry-After, falls vorhanden. Wiederholen Sie dieselbe beabsichtigte Anfrage mit demselben Schlüssel, nachdem die Begrenzung aufgehoben ist.
500 oder 502Der entfernte Vorgang wurde möglicherweise akzeptiert. Ein lokaler Verarbeitungsfehler kann requestId enthalten. Speichern Sie diese Kennung und prüfen Sie die bestehende Ressource; gehen Sie nicht davon aus, dass eine Ersatzregistrierung erforderlich ist.