ASPSMS WebAPI – C# Code Examples

Practical C# examples for the ASPSMS WebAPI (https://webapi.aspsms.com). Structure matches the WebAPI overview.

Contents
Requirement: .NET 6+ · HttpClient + System.Text.Json

1. Sending SMS

Check credentials

using System.Net.Http;
using System.Text.Json;

public static async Task<string> CheckCredentialsAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync(
        $"https://webapi.aspsms.com/CheckUserCredentials?Userkey={userkey}&Password={password}");
}

Credit balance

public static async Task<string> GetCreditsAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync(
        $"https://webapi.aspsms.com/ASPSMSCredits?Userkey={userkey}&Password={password}");
}

Estimate credits

public static async Task<string> EstimateCreditsAsync(string userkey, string password, string[] msisdns)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ASPSMSEstimateCreditConsumption?Userkey={userkey}&Password={password}";
    var content = new StringContent(JsonSerializer.Serialize(msisdns), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync(url, content);
    return await response.Content.ReadAsStringAsync();
}

Simple SMS (GET)

public static async Task<string> SendSimpleSmsAsync(string userkey, string password, string msisdn, string message, string originator)
{
    using var client = new HttpClient();
    var q = $"Userkey={userkey}&Password={password}&MSISDN={Uri.EscapeDataString(msisdn)}"
          + $"&Operation=SendTextSMS&MessageData={Uri.EscapeDataString(message)}"
          + $"&Originator={Uri.EscapeDataString(originator)}";
    return await client.GetStringAsync($"https://webapi.aspsms.com/SendSimpleSMS?{q}");
}

Advanced SMS (POST)

public static async Task<string> SendAdvancedSmsAsync(string userkey, string password, string message, string originator, object[] recipients)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ASPSMSSendSMS?Userkey={userkey}&Password={password}";
    var payload = new { Operation = "SendTextSMS", Originator = originator, MessageData = message, Recipients = recipients };
    var content = new StringContent(JsonSerializer.Serialize(payload), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync(url, content);
    return await response.Content.ReadAsStringAsync();
}

Personalized SMS with RecipientsEx

Same originator for all, individual text (and optional TRN / deferred time) per recipient.

public static async Task<string> SendPersonalizedSmsAsync(string userkey, string password, string originator, object[] messages)
{
    // messages e.g.:
    // new object[] {
    //   new { PhoneNumber = "+41791111111", TransactionReferenceNumber = "ORDER-1001",
    //         MessageData = "Hi Anna, your order #1001 is on the way." },
    //   new { PhoneNumber = "+41792222222", TransactionReferenceNumber = "ORDER-1002",
    //         MessageData = "Hi Bruno, your order #1002 is on the way.",
    //         DeferredDeliveryTime = "2026-10-20T08:00:00" }  // optional per recipient
    // }
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ASPSMSSendSMS?Userkey={userkey}&Password={password}";
    var payload = new {
        Operation = "SendTextSMS",
        Originator = originator,   // same for all
        RecipientsEx = messages    // individual MessageData per recipient
    };
    var content = new StringContent(JsonSerializer.Serialize(payload), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync(url, content);
    return await response.Content.ReadAsStringAsync();
}

Deactivate pending SMS

public static async Task<string> DeactivateByMsisdnAsync(string userkey, string password, string[] msisdns)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ASPSMSDeactivatePendingSMSWithMSISDN?Userkey={userkey}&Password={password}";
    var content = new StringContent(JsonSerializer.Serialize(msisdns), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync(url, content);
    return await response.Content.ReadAsStringAsync();
}

public static async Task<string> DeactivateByTrnAsync(string userkey, string password, string[] trns)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ASPSMSDeactivatePendingSMSWithTransactionReferenceNumber?Userkey={userkey}&Password={password}";
    var content = new StringContent(JsonSerializer.Serialize(trns), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync(url, content);
    return await response.Content.ReadAsStringAsync();
}

2. Delivery Webhooks

Webhooks are called exclusively via HTTP GET. Placeholders: <SCTS>, <DSCTS>, <RSN>, <DST>, <TRN>, <RCPNT>, <CREDITS> (max. 200 chars per URL).
public static async Task<string> SendSmsWithWebhooksAsync(string userkey, string password, string message, string originator, object[] recipients)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ASPSMSSendSMS?Userkey={userkey}&Password={password}";
    var payload = new {
        Operation = "SendTextSMS", Originator = originator, MessageData = message, Recipients = recipients,
        URLBufferedMessageNotification = "https://your-domain.com/hook/buffered?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&RCPNT=<RCPNT>",
        URLDeliveryNotification = "https://your-domain.com/hook/delivered?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&RCPNT=<RCPNT>",
        URLNonDeliveryNotification = "https://your-domain.com/hook/failed?SCTS=<SCTS>&DSCTS=<DSCTS>&RSN=<RSN>&DST=<DST>&TRN=<TRN>&RCPNT=<RCPNT>"
    };
    var content = new StringContent(JsonSerializer.Serialize(payload), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync(url, content);
    return await response.Content.ReadAsStringAsync();
}

Delivery Status (DST)

ValueMeaning
-1Not yet submitted / rejected
0Delivered
1Buffered
2Not Delivered

After status 1 (Buffered) you almost always get a second call with 0 or 2.

Common Reason Codes (RSN)

CodeMeaningTypical cause
000Unknown SubscriberNumber does not exist
103Call BarredBlocked / empty prepaid
107Absent SubscriberPhone off / no network
108Delivery FailMemory full or final failure
110Protocol ErrorDevice problems
118System failSevere network/device issues

3. Sendlog, Statistics & Two-Way

Daily traffic

public static async Task<string> GetTrafficStatAsync(string userkey, string password, bool calculateCredits = true)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/TrafficStat01/Get?Userkey={userkey}&Password={password}&CalculateCredits={calculateCredits}";
    return await client.GetStringAsync(url);
}

Send log by date

public static async Task<string> GetSendingLogAsync(string userkey, string password, int year, int month = 0, int day = 0)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/SendingStat01/Get?Userkey={userkey}&Password={password}&Year={year}&Month={month}&Day={day}";
    return await client.GetStringAsync(url);
}

Send log by MSISDN / TRN / JobID

public static async Task<string> GetLogByMsisdnAsync(string userkey, string password, string msisdn)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/SendingStat02/Get?Userkey={userkey}&Password={password}&MSISDN={Uri.EscapeDataString(msisdn)}");
}

public static async Task<string> GetLogByTrnAsync(string userkey, string password, string trn)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/SendingStat03/Get?Userkey={userkey}&Password={password}&TransactionReferenceNumber={Uri.EscapeDataString(trn)}");
}

public static async Task<string> GetLogByJobAsync(string userkey, string password, int jobId)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/SendingStat04/Get?Userkey={userkey}&Password={password}&JobID={jobId}");
}

Inbox (received SMS)

public static async Task<string> GetReceivedSmsAsync(string userkey, string password, int year = 0, int month = 0, int day = 0, int maxRecords = 100)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/ReceivingStat01/Get?Userkey={userkey}&Password={password}&Year={year}&Month={month}&Day={day}&MaxRecords={maxRecords}";
    return await client.GetStringAsync(url);
}

Receive URL (push for inbound SMS)

public static async Task<string> GetReceiveUrlAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/ReceiveURL/Get?Userkey={userkey}&Password={password}");
}

public static async Task<string> SetReceiveUrlAsync(string userkey, string password, string callbackUrl)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/ReceiveURL/Set?Userkey={userkey}&Password={password}&URL={Uri.EscapeDataString(callbackUrl)}");
}

4. Delivery Statistics per Recipient

public static async Task<string> GetMsisdnDlrStatAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/MSISDNDLRStat/Get?Userkey={userkey}&Password={password}");
}

public static async Task<string> AddToIgnoreListAsync(string userkey, string password, string[] msisdns)
{
    using var client = new HttpClient();
    var body = msisdns.Select(m => new { MSISDN = m }).ToArray();
    var content = new StringContent(JsonSerializer.Serialize(body), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync($"https://webapi.aspsms.com/MSISDNDLRStatIgnoreListAdd/Post?Userkey={userkey}&Password={password}", content);
    return await response.Content.ReadAsStringAsync();
}

5. Phonebook

5.1 Phone numbers

public static async Task<string> GetPhonebookAsync(string userkey, string password, string msisdn = null)
{
    using var client = new HttpClient();
    var url = $"https://webapi.aspsms.com/PhoneNumbers/Read?Userkey={userkey}&Password={password}";
    if (!string.IsNullOrEmpty(msisdn)) url += $"&MSISDN={Uri.EscapeDataString(msisdn)}";
    return await client.GetStringAsync(url);
}

public static async Task<string> UpsertPhonebookAsync(string userkey, string password, object[] entries)
{
    using var client = new HttpClient();
    var content = new StringContent(JsonSerializer.Serialize(entries), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync($"https://webapi.aspsms.com/PhoneNumbers/Upsert?Userkey={userkey}&Password={password}", content);
    return await response.Content.ReadAsStringAsync();
}

5.2 Groups

public static async Task<string> GetGroupsAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/Groups/Get?Userkey={userkey}&Password={password}");
}

5.3 Group relations

public static async Task<string> GetAllGroupRelationsAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/GroupRelationsAll/Get?Userkey={userkey}&Password={password}");
}

6. Jobs

Document sending actions. Pass JobID when sending; query messages later via SendingStat04.

public static async Task<string> GetJobsAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/Jobs/Get?Userkey={userkey}&Password={password}");
}

public static async Task<string> UpsertJobsAsync(string userkey, string password, object[] jobs)
{
    using var client = new HttpClient();
    var content = new StringContent(JsonSerializer.Serialize(jobs), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync($"https://webapi.aspsms.com/Jobs/Upsert?Userkey={userkey}&Password={password}", content);
    return await response.Content.ReadAsStringAsync();
}

7. Templates

public static async Task<string> GetTemplatesAsync(string userkey, string password)
{
    using var client = new HttpClient();
    return await client.GetStringAsync($"https://webapi.aspsms.com/Templates/Get?Userkey={userkey}&Password={password}");
}

public static async Task<string> UpsertTemplatesAsync(string userkey, string password, object[] templates)
{
    using var client = new HttpClient();
    var content = new StringContent(JsonSerializer.Serialize(templates), System.Text.Encoding.UTF8, "application/json");
    var response = await client.PostAsync($"https://webapi.aspsms.com/Templates/Upsert?Userkey={userkey}&Password={password}", content);
    return await response.Content.ReadAsStringAsync();
}