ASPSMS WebAPI – Python Code-Beispiele

Praktische Python-Beispiele fuer die ASPSMS WebAPI (https://webapi.aspsms.com). Die Gliederung entspricht der WebAPI-Uebersicht.

Inhalt
Voraussetzung: Python 3 + requests
pip install requests

1. SMS senden

Credentials pruefen

import requests

def check_credentials(userkey: str, password: str):
    url = "https://webapi.aspsms.com/CheckUserCredentials"
    r = requests.get(url, params={"Userkey": userkey, "Password": password})
    return r.json()

Guthaben abfragen

def get_credits(userkey: str, password: str):
    url = "https://webapi.aspsms.com/ASPSMSCredits"
    r = requests.get(url, params={"Userkey": userkey, "Password": password})
    return r.json()

Credits schaetzen

def estimate_credits(userkey: str, password: str, msisdns: list[str]):
    # z.B. ["+41791111111", "+41792222222,2"]  # ,2 = zweimal senden
    url = "https://webapi.aspsms.com/ASPSMSEstimateCreditConsumption"
    r = requests.post(url, params={"Userkey": userkey, "Password": password}, json=msisdns)
    return r.json()

Einfache SMS (GET)

def send_simple_sms(userkey, password, msisdn, message, originator):
    url = "https://webapi.aspsms.com/SendSimpleSMS"
    params = {
        "Userkey": userkey, "Password": password, "MSISDN": msisdn,
        "Operation": "SendTextSMS",  # Pflicht
        "MessageData": message, "Originator": originator
    }
    return requests.get(url, params=params).json()

Erweiterte SMS (POST)

def send_advanced_sms(userkey, password, message, originator, recipients):
    url = "https://webapi.aspsms.com/ASPSMSSendSMS"
    payload = {
        "Operation": "SendTextSMS",
        "Originator": originator,
        "MessageData": message,
        "Recipients": recipients
    }
    r = requests.post(url, params={"Userkey": userkey, "Password": password}, json=payload)
    return r.json()

Personalisierte SMS mit RecipientsEx

Gleicher Absender fuer alle, individueller Text (und optional TRN / zeitversetzter Versand) pro Empfaenger.

def send_personalized_sms(userkey, password, originator, messages: list[dict]):
    # messages z.B.:
    # [
    #   {"PhoneNumber": "+41791111111", "TransactionReferenceNumber": "ORDER-1001",
    #    "MessageData": "Hallo Anna, deine Bestellung #1001 ist unterwegs."},
    #   {"PhoneNumber": "+41792222222", "TransactionReferenceNumber": "ORDER-1002",
    #    "MessageData": "Hallo Bruno, deine Bestellung #1002 ist unterwegs.",
    #    "DeferredDeliveryTime": "2026-10-20T08:00:00"}  # optional pro Empfaenger
    # ]
    url = "https://webapi.aspsms.com/ASPSMSSendSMS"
    payload = {
        "Operation": "SendTextSMS",
        "Originator": originator,   # gleich fuer alle
        "RecipientsEx": messages    # individueller MessageData pro Empfaenger
    }
    r = requests.post(url, params={"Userkey": userkey, "Password": password}, json=payload)
    return r.json()

Ausstehende SMS stornieren

def deactivate_by_msisdn(userkey, password, msisdns: list[str]):
    url = "https://webapi.aspsms.com/ASPSMSDeactivatePendingSMSWithMSISDN"
    r = requests.post(url, params={"Userkey": userkey, "Password": password}, json=msisdns)
    return r.json()

def deactivate_by_trn(userkey, password, trns: list[str]):
    url = "https://webapi.aspsms.com/ASPSMSDeactivatePendingSMSWithTransactionReferenceNumber"
    r = requests.post(url, params={"Userkey": userkey, "Password": password}, json=trns)
    return r.json()

2. Delivery-Webhooks

Webhooks werden ausschliesslich per HTTP GET aufgerufen. Platzhalter: <SCTS>, <DSCTS>, <RSN>, <DST>, <TRN>, <RCPNT>, <CREDITS> (max. 200 Zeichen pro URL).
def send_sms_with_webhooks(userkey, password, message, originator, recipients):
    url = "https://webapi.aspsms.com/ASPSMSSendSMS"
    payload = {
        "Operation": "SendTextSMS",
        "Originator": originator,
        "MessageData": message,
        "Recipients": recipients,
        "URLBufferedMessageNotification":
            "https://deine-domain.ch/hook/buffered?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&RCPNT=<RCPNT>",
        "URLDeliveryNotification":
            "https://deine-domain.ch/hook/delivered?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&RCPNT=<RCPNT>",
        "URLNonDeliveryNotification":
            "https://deine-domain.ch/hook/failed?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&RCPNT=<RCPNT>"
    }
    r = requests.post(url, params={"Userkey": userkey, "Password": password}, json=payload)
    return r.json()

Delivery Status (DST)

WertBedeutung
-1Noch nicht eingereicht / abgelehnt
0Delivered
1Buffered
2Not Delivered

Nach Status 1 (Buffered) kommt fast immer ein zweiter Aufruf mit 0 oder 2.

Haeufige Reason Codes (RSN)

CodeBedeutungTypische Ursache
000Unknown SubscriberNummer existiert nicht
103Call BarredGesperrt / leere Prepaid-Karte
107Absent SubscriberHandy aus / kein Netz
108Delivery FailSpeicher voll oder endgueltig fehlgeschlagen
110Protocol ErrorGeraeteprobleme
118System failSchwere Netz-/Geraeteprobleme

3. Sendlog, Statistiken & Two-Way

Taeglicher Traffic

def get_traffic_stat(userkey, password, calculate_credits=True):
    url = "https://webapi.aspsms.com/TrafficStat01/Get"
    r = requests.get(url, params={"Userkey": userkey, "Password": password, "CalculateCredits": calculate_credits})
    return r.json()

Sendlog nach Datum

def get_sending_log(userkey, password, year, month=0, day=0):
    url = "https://webapi.aspsms.com/SendingStat01/Get"
    r = requests.get(url, params={"Userkey": userkey, "Password": password, "Year": year, "Month": month, "Day": day})
    return r.json()

Sendlog nach MSISDN / TRN / JobID

def get_log_by_msisdn(userkey, password, msisdn):
    url = "https://webapi.aspsms.com/SendingStat02/Get"
    return requests.get(url, params={"Userkey": userkey, "Password": password, "MSISDN": msisdn}).json()

def get_log_by_trn(userkey, password, trn):
    url = "https://webapi.aspsms.com/SendingStat03/Get"
    return requests.get(url, params={"Userkey": userkey, "Password": password, "TransactionReferenceNumber": trn}).json()

def get_log_by_job(userkey, password, job_id):
    url = "https://webapi.aspsms.com/SendingStat04/Get"
    return requests.get(url, params={"Userkey": userkey, "Password": password, "JobID": job_id}).json()

Inbox (eingehende SMS)

def get_received_sms(userkey, password, year=0, month=0, day=0, msisdn="", originator="", max_records=100):
    url = "https://webapi.aspsms.com/ReceivingStat01/Get"
    params = {"Userkey": userkey, "Password": password, "Year": year, "Month": month, "Day": day,
              "MSISDN": msisdn, "Originator": originator, "MaxRecords": max_records}
    return requests.get(url, params=params).json()

Receive URL (Push fuer eingehende SMS)

def get_receive_url(userkey, password):
    return requests.get("https://webapi.aspsms.com/ReceiveURL/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def set_receive_url(userkey, password, callback_url):
    return requests.get("https://webapi.aspsms.com/ReceiveURL/Set",
                        params={"Userkey": userkey, "Password": password, "URL": callback_url}).json()

def delete_receive_url(userkey, password):
    return requests.get("https://webapi.aspsms.com/ReceiveURL/Delete",
                        params={"Userkey": userkey, "Password": password}).json()

4. Zustellstatistik pro Empfaenger

def get_msisdn_dlr_stat(userkey, password):
    return requests.get("https://webapi.aspsms.com/MSISDNDLRStat/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def get_ignore_list(userkey, password):
    return requests.get("https://webapi.aspsms.com/IgnoreList/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def add_to_ignore_list(userkey, password, msisdns: list[str]):
    body = [{"MSISDN": m} for m in msisdns]
    return requests.post("https://webapi.aspsms.com/MSISDNDLRStatIgnoreListAdd/Post",
                         params={"Userkey": userkey, "Password": password}, json=body).json()

def remove_from_ignore_list(userkey, password, msisdns: list[str]):
    body = [{"MSISDN": m} for m in msisdns]
    return requests.post("https://webapi.aspsms.com/MSISDNDLRStatIgnoreListRemove/Post",
                         params={"Userkey": userkey, "Password": password}, json=body).json()

5. Telefonbuch

5.1 Telefonnummern

def get_phonebook(userkey, password, msisdn=None):
    params = {"Userkey": userkey, "Password": password}
    if msisdn: params["MSISDN"] = msisdn
    return requests.get("https://webapi.aspsms.com/PhoneNumbers/Read", params=params).json()

def add_phonebook_entries(userkey, password, entries, group=None):
    params = {"Userkey": userkey, "Password": password}
    if group: params["Group"] = group
    return requests.post("https://webapi.aspsms.com/PhoneNumbers/Add", params=params, json=entries).json()

def upsert_phonebook(userkey, password, entries):
    return requests.post("https://webapi.aspsms.com/PhoneNumbers/Upsert",
                         params={"Userkey": userkey, "Password": password}, json=entries).json()

def upsert_phonebook_ex(userkey, password, entries_with_groups):
    return requests.post("https://webapi.aspsms.com/PhoneNumbers/UpsertEx",
                         params={"Userkey": userkey, "Password": password}, json=entries_with_groups).json()

def delete_phonebook_entries(userkey, password, ids: list[int]):
    return requests.post("https://webapi.aspsms.com/PhoneNumbers/Delete",
                         params={"Userkey": userkey, "Password": password}, json=ids).json()

5.2 Gruppen

def get_groups(userkey, password):
    return requests.get("https://webapi.aspsms.com/Groups/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def upsert_groups(userkey, password, groups):
    return requests.post("https://webapi.aspsms.com/Groups/Upsert",
                         params={"Userkey": userkey, "Password": password}, json=groups).json()

def delete_groups(userkey, password, group_ids: list[int]):
    return requests.post("https://webapi.aspsms.com/Groups/Delete",
                         params={"Userkey": userkey, "Password": password}, json=group_ids).json()

5.3 Gruppen-Zuordnungen

def get_all_group_relations(userkey, password):
    return requests.get("https://webapi.aspsms.com/GroupRelationsAll/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def add_group_relations(userkey, password, relations):
    return requests.post("https://webapi.aspsms.com/GroupRelations/AddNewGroupRelations",
                         params={"Userkey": userkey, "Password": password}, json=relations).json()

6. Jobs

Versandaktionen dokumentieren. Beim Senden JobID mitgeben; spaeter per SendingStat04 abfragen.

def get_jobs(userkey, password):
    return requests.get("https://webapi.aspsms.com/Jobs/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def upsert_jobs(userkey, password, jobs):
    return requests.post("https://webapi.aspsms.com/Jobs/Upsert",
                         params={"Userkey": userkey, "Password": password}, json=jobs).json()

def delete_jobs(userkey, password, job_ids: list[int]):
    return requests.post("https://webapi.aspsms.com/Jobs/Delete",
                         params={"Userkey": userkey, "Password": password}, json=job_ids).json()

7. Templates

def get_templates(userkey, password):
    return requests.get("https://webapi.aspsms.com/Templates/Get",
                        params={"Userkey": userkey, "Password": password}).json()

def upsert_templates(userkey, password, templates):
    return requests.post("https://webapi.aspsms.com/Templates/Upsert",
                         params={"Userkey": userkey, "Password": password}, json=templates).json()

def delete_templates(userkey, password, template_ids: list[int]):
    return requests.post("https://webapi.aspsms.com/Templates/Delete",
                         params={"Userkey": userkey, "Password": password}, json=template_ids).json()