import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
@DataContract(Namespace="http://schemas.datacontract.org/2004/07/PushSmsLib.Dto")
open class RestSmsRequest
{
/**
* API Username. Usually your customer id
*/
@DataMember(Name="Username")
@SerializedName("Username")
@ApiMember(DataType="string", Description="API Username. Usually your customer id", IsRequired=true, Name="Username", ParameterType="form")
@StringLength(MaximumLength=128)
open var username:Object? = null
/**
* API Password
*/
@DataMember(Name="Password")
@SerializedName("Password")
@ApiMember(DataType="string", Description="API Password", IsRequired=true, Name="Password", ParameterType="form")
@StringLength(MaximumLength=128)
open var password:String? = null
/**
* Collection of messages to send
*/
@DataMember(Name="Messages")
@SerializedName("Messages")
@ApiMember(Description="Collection of messages to send", IsRequired=true, Name="Messages", ParameterType="form")
open var messages:ArrayList<RestSmsMessageReq> = ArrayList<RestSmsMessageReq>()
}
@DataContract(Namespace="http://schemas.datacontract.org/2004/07/PushSmsLib.Dto")
open class RestSmsMessageReq
{
/**
* Gateway number. Default 99700999 for cross country delivery, non premium messages
*/
@DataMember(Name="Gateway")
@SerializedName("Gateway")
@ApiMember(DataType="integer", Description="Gateway number. Default 99700999 for cross country delivery, non premium messages", IsRequired=true, Name="Gateway", ParameterType="form")
open var gateway:Object? = null
/**
* Originator address. Defaults to gateway number if not set. Maximum 11 chars if using alphanumeric value. See documentation for full details.
*/
@DataMember(Name="OriginatorAddress")
@SerializedName("OriginatorAddress")
@ApiMember(DataType="string", Description="Originator address. Defaults to gateway number if not set. Maximum 11 chars if using alphanumeric value. See documentation for full details.", Name="OriginatorAddress", ParameterType="form")
open var originatorAddress:Object? = null
/**
* Destination address.The recipient of the message. Must be a valid MSISDN
*/
@DataMember(Name="DestinationAddress")
@SerializedName("DestinationAddress")
@ApiMember(DataType="integer", Description="Destination address.The recipient of the message. Must be a valid MSISDN", IsRequired=true, Name="DestinationAddress", ParameterType="form")
open var destinationAddress:Object? = null
/**
* Price to bill recipient. Premium messaging. Leave value to 0 if not using premium. Premium is only available on short number gateway number for each country available in documentation
*/
@DataMember(Name="Price")
@SerializedName("Price")
@ApiMember(DataType="integer", Description="Price to bill recipient. Premium messaging. Leave value to 0 if not using premium. Premium is only available on short number gateway number for each country available in documentation", IsRequired=true, Name="Price", ParameterType="form")
open var price:Object? = null
/**
* Message type according to documentation. Defaults to 00 if not set. If text length is above 160 chars, it defaults to value 11
*/
@DataMember(Name="MessageType")
@SerializedName("MessageType")
@ApiMember(DataType="string", Description="Message type according to documentation. Defaults to 00 if not set. If text length is above 160 chars, it defaults to value 11", Name="MessageType", ParameterType="form")
open var messageType:String? = null
/**
* Delivery expire timestamp (yyyymmddhhmmss) or relative value. See documentation and default value if not defined
*/
@DataMember(Name="ValidationPeriod")
@SerializedName("ValidationPeriod")
@ApiMember(DataType="string", Description="Delivery expire timestamp (yyyymmddhhmmss) or relative value. See documentation and default value if not defined", Name="ValidationPeriod", ParameterType="form")
open var validationPeriod:Object? = null
/**
* Your unique message id to track delivery status and response from sending process
*/
@DataMember(Name="MessageId")
@SerializedName("MessageId")
@ApiMember(DataType="string", Description="Your unique message id to track delivery status and response from sending process", Name="MessageId", ParameterType="form")
open var messageId:String? = null
/**
* GSM User Data Header (HEX)
*/
@DataMember(Name="UserDataHeader")
@SerializedName("UserDataHeader")
@ApiMember(DataType="string", Description="GSM User Data Header (HEX)", Name="UserDataHeader", ParameterType="form")
open var userDataHeader:String? = null
/**
* GSM User Data. Plain text or hex encoded. Depending on the used MessageType
*/
@DataMember(Name="UserData")
@SerializedName("UserData")
@ApiMember(DataType="string", Description="GSM User Data. Plain text or hex encoded. Depending on the used MessageType", IsRequired=true, Name="UserData", ParameterType="form")
open var userData:String? = null
/**
* Parameter to categorize messages on payment bill from Intele
*/
@DataMember(Name="Category")
@SerializedName("Category")
@ApiMember(DataType="string", Description="Parameter to categorize messages on payment bill from Intele", Name="Category", ParameterType="form")
open var category:String? = null
/**
* Custom key/value attributes for the Sms Text Message. See documentation for further details
*/
@DataMember(Name="CustomData")
@SerializedName("CustomData")
@ApiMember(DataType="string", Description="Custom key/value attributes for the Sms Text Message. See documentation for further details", Name="CustomData", ParameterType="form")
open var customData:HashMap<String,Object>? = null
/**
* Url where Intele should send delivery report. See documentation for url formatting
*/
@DataMember(Name="DeliveryReportUrl")
@SerializedName("DeliveryReportUrl")
@ApiMember(DataType="string", Description="Url where Intele should send delivery report. See documentation for url formatting", Name="DeliveryReportUrl", ParameterType="form")
open var deliveryReportUrl:String? = null
/**
* For Premium messaging only. See documentation for further details
*/
@DataMember(Name="ServiceCode")
@SerializedName("ServiceCode")
@ApiMember(DataType="string", Description="For Premium messaging only. See documentation for further details", Name="ServiceCode", ParameterType="form")
open var serviceCode:String? = null
/**
* For Premium messaging only. See documentation for further details
*/
@DataMember(Name="ServiceDescription")
@SerializedName("ServiceDescription")
@ApiMember(DataType="string", Description="For Premium messaging only. See documentation for further details", Name="ServiceDescription", ParameterType="form")
open var serviceDescription:String? = null
}
@DataContract(Namespace="http://schemas.datacontract.org/2004/07/PushSmsLib.Dto")
open class RestSmsResponse
{
/**
* Overall status of processing the request. Each message will have it's own status. This value indicates if any other error occured or not
*/
@DataMember(Name="ProcessResult")
@SerializedName("ProcessResult")
@ApiMember(DataType="boolean", Description="Overall status of processing the request. Each message will have it's own status. This value indicates if any other error occured or not", IsRequired=true, Name="ProcessResult", ParameterType="form")
open var processResult:Boolean? = null
/**
* Description of any error occured, if ProcessResult equals false
*/
@DataMember(Name="ProcessResultDescription")
@SerializedName("ProcessResultDescription")
@ApiMember(DataType="string", Description="Description of any error occured, if ProcessResult equals false", Name="ProcessResultDescription", ParameterType="form")
@StringLength(MaximumLength=2048)
open var processResultDescription:String? = null
/**
* Collection of messages sent or failed
*/
@DataMember(Name="Messages")
@SerializedName("Messages")
@ApiMember(Description="Collection of messages sent or failed", Name="Description", ParameterType="form")
open var messages:ArrayList<RestSmsMessageResp> = ArrayList<RestSmsMessageResp>()
}
@DataContract(Namespace="http://schemas.datacontract.org/2004/07/PushSmsLib.Dto")
open class RestSmsMessageResp
{
/**
* Result of sending message. 0 if success. See documentation for full list of codes
*/
@DataMember(Name="StatusCode")
@SerializedName("StatusCode")
@ApiMember(DataType="integer", Description="Result of sending message. 0 if success. See documentation for full list of codes", IsRequired=true, Name="StatusCode", ParameterType="form")
open var statusCode:Int? = null
/**
* Describes the result of sending Sms text message
*/
@DataMember(Name="StatusDescription")
@SerializedName("StatusDescription")
@ApiMember(DataType="string", Description="Describes the result of sending Sms text message", IsRequired=true, Name="StatusDescription", ParameterType="form")
open var statusDescription:String? = null
/**
* Your unique message id from send request message item. Will be empty if you did not provide any id in the request item.
*/
@DataMember(Name="MessageId")
@SerializedName("MessageId")
@ApiMember(DataType="string", Description="Your unique message id from send request message item. Will be empty if you did not provide any id in the request item.", Name="MessageId", ParameterType="form")
open var messageId:String? = null
/**
* Unique transaction id from server
*/
@DataMember(Name="TransactionId")
@SerializedName("TransactionId")
@ApiMember(DataType="string", Description="Unique transaction id from server", IsRequired=true, Name="TransactionId", ParameterType="form")
open var transactionId:String? = null
/**
* Key/Value attributes returned from server. E.g. subnumref and the server name that processed the message. Eg. subnumref=19331234567891,server=smsgw1
*/
@DataMember(Name="ExtraInfo")
@SerializedName("ExtraInfo")
@ApiMember(DataType="string", Description="Key/Value attributes returned from server. E.g. subnumref and the server name that processed the message. Eg. subnumref=19331234567891,server=smsgw1", Name="ExtraInfo", ParameterType="form")
open var extraInfo:HashMap<String,String>? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsonl/reply/RestSmsRequest HTTP/1.1
Host: smsgw.intele.no
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Username":{},"Password":"String","Messages":[{"Gateway":{},"OriginatorAddress":{},"DestinationAddress":{},"Price":{},"MessageType":"String","ValidationPeriod":{},"MessageId":"String","UserDataHeader":"String","UserData":"String","Category":"String","CustomData":{"String":{}},"DeliveryReportUrl":"String","ServiceCode":"String","ServiceDescription":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"ProcessResult":false,"ProcessResultDescription":"String","Messages":[{"StatusCode":0,"StatusDescription":"String","MessageId":"String","TransactionId":"String","ExtraInfo":{"String":"String"}}]}