SMS-Nutzung
Liefert die SMS-Nutzung des laufenden Kalendermonats über alle Kunden der Organisation hinweg, absteigend nach Nutzung sortiert.
GET /api/customers/sms-usage
Query-Parameter
organizationId(erforderlich): Die ID der Organisation.
Antwort
{
"total": 47,
"customers": [
{
"publicId": "6bfec6f6-245a-47ce-843b-157d97d56f88",
"name": "Kunde A GmbH",
"status": "active",
"smsUsageCurrentMonth": 32
},
{
"publicId": "9a1c3d2e-8f4b-42a1-b7c9-3e5f12d84a90",
"name": "StartUp XY",
"status": "active",
"smsUsageCurrentMonth": 15
},
{
"publicId": "2d7e5f1a-6c3b-4d9e-a2f8-1b4c7e9d3a56",
"name": "Inactive Corp",
"status": "inactive",
"smsUsageCurrentMonth": 0
}
]
}Felder
| Feld | Typ | Beschreibung |
|---|---|---|
total | number | Summe von smsUsageCurrentMonth über alle zurückgegebenen Kunden. |
customers[].publicId | string | Kunden-UUID. |
customers[].name | string | Anzeigename des Kunden. |
customers[].status | string | Kundenstatus: active, inactive, marked_for_cancellation oder cancelled. |
customers[].smsUsageCurrentMonth | number | Anzahl der für diesen Kunden im laufenden Monat versendeten SMS. Wird zu Beginn jedes Kalendermonats zurückgesetzt. |
Hinweise
- Der Nutzungszähler
smsUsageCurrentMonthwird zu Beginn jedes Kalendermonats zurückgesetzt. - Kunden ohne Nutzung sind in der Antwort enthalten.
- Die Sortierung erfolgt absteigend nach
smsUsageCurrentMonth(höchste Nutzung zuerst). - Das vollständige SMS-Kontingent und die Überschreitungen der gesamten Organisation stehen in der Abrechnungsübersicht.
Häufige Fehler
400Organization ID required401Unauthorized403Forbidden