TicketUserServices

<back to all web services

SendSmsRequest

Requires Authentication
Requires the role:AdminRequires the permission:ReadData
The following routes are available for this service:
POST/sms/sendms
GET POST/sms/sendsms/{FullPhoneNumber}/{Message}
import 'package:servicestack/servicestack.dart';

class SendSmsResult implements IConvertible
{
    int? statusCode;
    String? statusMessage;

    SendSmsResult({this.statusCode,this.statusMessage});
    SendSmsResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        statusCode = json['statusCode'];
        statusMessage = json['statusMessage'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'statusCode': statusCode,
        'statusMessage': statusMessage
    };

    getTypeName() => "SendSmsResult";
    TypeContext? context = _ctx;
}

class RequestSignature implements IConvertible
{
    String? systemId;
    String? systemSecret;
    String? signature;

    RequestSignature({this.systemId,this.systemSecret,this.signature});
    RequestSignature.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        systemId = json['systemId'];
        systemSecret = json['systemSecret'];
        signature = json['signature'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'systemId': systemId,
        'systemSecret': systemSecret,
        'signature': signature
    };

    getTypeName() => "RequestSignature";
    TypeContext? context = _ctx;
}

class SendSmsRequest implements IConvertible
{
    String? fullPhoneNumber;
    String? message;
    int? requestUnixUTCTimeStamp;
    RequestSignature? signature;

    SendSmsRequest({this.fullPhoneNumber,this.message,this.requestUnixUTCTimeStamp,this.signature});
    SendSmsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        fullPhoneNumber = json['fullPhoneNumber'];
        message = json['message'];
        requestUnixUTCTimeStamp = json['requestUnixUTCTimeStamp'];
        signature = JsonConverters.fromJson(json['signature'],'RequestSignature',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'fullPhoneNumber': fullPhoneNumber,
        'message': message,
        'requestUnixUTCTimeStamp': requestUnixUTCTimeStamp,
        'signature': JsonConverters.toJson(signature,'RequestSignature',context!)
    };

    getTypeName() => "SendSmsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'stubbur_app.azurewebsites.net', types: <String, TypeInfo> {
    'SendSmsResult': TypeInfo(TypeOf.Class, create:() => SendSmsResult()),
    'RequestSignature': TypeInfo(TypeOf.Class, create:() => RequestSignature()),
    'SendSmsRequest': TypeInfo(TypeOf.Class, create:() => SendSmsRequest()),
});

Dart SendSmsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /sms/sendms HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"fullPhoneNumber":"String","message":"String","requestUnixUTCTimeStamp":0,"signature":{"systemId":"String","systemSecret":"String","signature":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"statusCode":0,"statusMessage":"String"}