Zum Inhalt
HALOWERK

Identwerk

sms receive

Creates a five-minute inbound SMS lease through a configured licensed provider, polls received messages, and releases the number upstream on cancellation, expiry or failed x402 settlement. Twilio is supported directly; an HTTPS bearer-token lease provider can also implement the documented generic contract. Messages and lease metadata are removed after expiry.

POST https://ident.halowerk.com/v1/sms-receive

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
actionstringJa
modestringNein
lease_idstringNein
countrystringNein
servicestringNeinPurpose label forwarded to the configured provider; never used to bypass provider restrictions.
terms_confirmedbooleanNeinRequired for a live lease: confirms authorization and compliance with the third party and provider terms.
sandbox_otpstringNeinOptional synthetic OTP returned only by a sandbox lease.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "action"
  ],
  "additionalProperties": false,
  "properties": {
    "action": {
      "type": "string",
      "enum": [
        "lease",
        "poll",
        "cancel"
      ]
    },
    "mode": {
      "type": "string",
      "enum": [
        "live",
        "sandbox"
      ],
      "default": "live"
    },
    "lease_id": {
      "type": "string",
      "minLength": 10,
      "maxLength": 80
    },
    "country": {
      "type": "string",
      "pattern": "^[A-Z]{2}$",
      "default": "DE"
    },
    "service": {
      "type": "string",
      "minLength": 2,
      "maxLength": 80,
      "description": "Purpose label forwarded to the configured provider; never used to bypass provider restrictions."
    },
    "terms_confirmed": {
      "type": "boolean",
      "description": "Required for a live lease: confirms authorization and compliance with the third party and provider terms."
    },
    "sandbox_otp": {
      "type": "string",
      "pattern": "^\\d{4,8}$",
      "description": "Optional synthetic OTP returned only by a sandbox lease."
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "action": "lease",
  "mode": "sandbox",
  "country": "DE",
  "service": "integration-test",
  "sandbox_otp": "123456"
}

Ergebnis & Dokumentation

Veröffentlichtes Ergebnisschema anzeigen
{
  "$ref": "https://ident.halowerk.com/v1/sms-receive/schema#/outputSchema"
}

Veröffentlichtes Ergebnisbeispiel öffnen

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →