Recurring campaigns

Alle abrufen

Endpunkt

GET https://sms.hallo-webseite.de/api/recurring-campaigns/

Beispiel

curl --request GET \
--url 'https://sms.hallo-webseite.de/api/recurring-campaigns/' \
--header 'Authorization: Bearer {api_key}' \

Parameter	Details	Beschreibung
page	Optional Ganzzahl	Die Seitenzahl, von der Sie Ergebnisse erhalten möchten. Standardmäßig ist `1`.
results_per_page	Optional Ganzzahl	Wie viele Ergebnisse pro Seite möchten Sie. Zulässige Werte sind: `10` , `25` , `50` , `100` , `250` , `500` , `1000`. Standardmäßig ist `25`.

Beispielantwort

{
    "data": [
        {
            "id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "user_id": 1,
            "name": "Example",
            "content": "Sample message",
            "settings": {
                "frequency": "daily,
                "time": 10:25,
            },
            "segment": "all",
            "is_enabled": true,
            "total_sent_sms": 0,
            "total_pending_sms": 0,
            "total_failed_sms": 0,
            "last_sent_datetime": null,
            "last_datetime": null,
            "datetime": "2025-12-06 07:00:31",
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.hallo-webseite.de/api/recurring-campaigns?page=1",
        "last": "https://sms.hallo-webseite.de/api/recurring-campaigns?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.hallo-webseite.de/api/recurring-campaigns?page=1"
    }
}

Eins abrufen

Endpunkt

GET https://sms.hallo-webseite.de/api/recurring-campaigns/{recurring_campaign_id}

Beispiel

curl --request GET \
--url 'https://sms.hallo-webseite.de/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \

Beispielantwort

{
    "data": {
        "id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "user_id": 1,
        "name": "Example",
        "content": "Sample message",
        "settings": {
            "frequency": "daily,
            "time": 10:25,
        },
        "segment": "all",
        "is_enabled": true,
        "total_sent_sms": 0,
        "total_pending_sms": 0,
        "total_failed_sms": 0,
        "last_sent_datetime": null,
        "last_datetime": null,
        "datetime": "2025-12-06 07:00:31",
    }
}

Parameter	Details	Beschreibung
name	Erforderlich Zeichenkette	-
content	Erforderlich Zeichenkette	-
device_id	Erforderlich Ganzzahl	-
sim_subscription_id	Erforderlich Ganzzahl	-
frequency	Optional Zeichenkette	Zulässige Werte: `daily` , `weekly` , `monthly`
week_days	Optional Zeichenkette	Zulässige Werte: `1` , `2` , `3` , `4` , `5` , `6` , `7` Verfügbar wenn: frequency = weekly
month_days	Optional Zeichenkette	Zulässige Werte: `1` , `2` , `3` , `4` , `5` , `6` , `7` , `8` , `9` , `10` , `11` , `12` , `13` , `14` , `15` , `16` , `17` , `18` , `19` , `20` , `21` , `22` , `23` , `24` , `25` , `26` , `27` , `28` , `29` , `30` , `31` Verfügbar wenn: frequency = monthly
time	Optional Zeichenkette	HH:II
is_enabled	Optional Boolescher Typ	-

curl --request POST \
--url 'https://sms.hallo-webseite.de/api/recurring-campaigns' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \
--form 'frequency=daily' \
--form 'time=12:15' \

Beispielantwort

{
    "data": {
        "id": 1
    }
}

Aktualisieren

Endpunkt

POST https://sms.hallo-webseite.de/api/recurring-campaigns/{recurring_campaign_id}

Parameter	Details	Beschreibung
name	Optional Zeichenkette	-
content	Optional Zeichenkette	-
device_id	Optional Ganzzahl	-
sim_subscription_id	Optional Ganzzahl	-
frequency	Optional Zeichenkette	Zulässige Werte: `daily` , `weekly` , `monthly`
week_days	Optional Zeichenkette	Zulässige Werte: `1` , `2` , `3` , `4` , `5` , `6` , `7` Verfügbar wenn: frequency = weekly
month_days	Optional Zeichenkette	Zulässige Werte: `1` , `2` , `3` , `4` , `5` , `6` , `7` , `8` , `9` , `10` , `11` , `12` , `13` , `14` , `15` , `16` , `17` , `18` , `19` , `20` , `21` , `22` , `23` , `24` , `25` , `26` , `27` , `28` , `29` , `30` , `31` Verfügbar wenn: frequency = monthly
time	Optional Zeichenkette	HH:II
is_enabled	Optional Boolescher Typ	-

Beispiel

curl --request POST \
--url 'https://sms.hallo-webseite.de/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'segment=all' \

Beispielantwort

{
    "data": {
        "id": 1
    }
}

Löschen

Endpunkt

DELETE https://sms.hallo-webseite.de/api/recurring-campaigns/{recurring_campaign_id}

Beispiel

curl --request DELETE \
--url 'https://sms.hallo-webseite.de/api/recurring-campaigns/{recurring_campaign_id}' \
--header 'Authorization: Bearer {api_key}' \

Alle abrufen

Eins abrufen

Erstellen

Aktualisieren

Löschen