InteleServiceStack

RestSmsRequest

**RestSmsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Username	form	string	Yes	API Username. Usually your customer id
Password	form	string	Yes	API Password
Messages	form	RestSmsMessageReq[]	Yes	Collection of messages to send

**RestSmsMessageReq** Parameters:
Name	Parameter	Data Type	Required	Description
Gateway	form	integer	Yes	Gateway number. Default 99700999 for cross country delivery, non premium messages
OriginatorAddress	form	string	No	Originator address. Defaults to gateway number if not set. Maximum 11 chars if using alphanumeric value. See documentation for full details.
DestinationAddress	form	integer	Yes	Destination address.The recipient of the message. Must be a valid MSISDN
Price	form	integer	Yes	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
MessageType	form	string	No	Message type according to documentation. Defaults to 00 if not set. If text length is above 160 chars, it defaults to value 11
ValidationPeriod	form	string	No	Delivery expire timestamp (yyyymmddhhmmss) or relative value. See documentation and default value if not defined
MessageId	form	string	No	Your unique message id to track delivery status and response from sending process
UserDataHeader	form	string	No	GSM User Data Header (HEX)
UserData	form	string	Yes	GSM User Data. Plain text or hex encoded. Depending on the used MessageType
Category	form	string	No	Parameter to categorize messages on payment bill from Intele
CustomData	form	string	No	Custom key/value attributes for the Sms Text Message. See documentation for further details
DeliveryReportUrl	form	string	No	Url where Intele should send delivery report. See documentation for url formatting
ServiceCode	form	string	No	For Premium messaging only. See documentation for further details
ServiceDescription	form	string	No	For Premium messaging only. See documentation for further details

**RestSmsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ProcessResult	form	boolean	Yes	Overall status of processing the request. Each message will have it's own status. This value indicates if any other error occured or not
ProcessResultDescription	form	string	No	Description of any error occured, if ProcessResult equals false
Messages	form	RestSmsMessageResp[]	Yes	Collection of messages sent or failed

**RestSmsMessageResp** Parameters:
Name	Parameter	Data Type	Required	Description
StatusCode	form	integer	Yes	Result of sending message. 0 if success. See documentation for full list of codes
StatusDescription	form	string	Yes	Describes the result of sending Sms text message
MessageId	form	string	No	Your unique message id from send request message item. Will be empty if you did not provide any id in the request item.
TransactionId	form	string	Yes	Unique transaction id from server
ExtraInfo	form	string	No	Key/Value attributes returned from server. E.g. subnumref and the server name that processed the message. Eg. subnumref=19331234567891,server=smsgw1

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

HTTP + XML

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

POST /xml/reply/RestSmsRequest HTTP/1.1 
Host: smsgw.intele.no 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RestSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PushSmsLib.Dto">
  <Messages>
    <RestSmsMessageReq>
      <Category>String</Category>
      <CustomData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </CustomData>
      <DeliveryReportUrl>String</DeliveryReportUrl>
      <DestinationAddress />
      <Gateway />
      <MessageId>String</MessageId>
      <MessageType>String</MessageType>
      <OriginatorAddress />
      <Price />
      <ServiceCode>String</ServiceCode>
      <ServiceDescription>String</ServiceDescription>
      <UserData>String</UserData>
      <UserDataHeader>String</UserDataHeader>
      <ValidationPeriod />
    </RestSmsMessageReq>
  </Messages>
  <Password>String</Password>
  <Username />
</RestSmsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RestSmsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PushSmsLib.Dto">
  <Messages>
    <RestSmsMessageResp>
      <ExtraInfo xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </ExtraInfo>
      <MessageId>String</MessageId>
      <StatusCode>0</StatusCode>
      <StatusDescription>String</StatusDescription>
      <TransactionId>String</TransactionId>
    </RestSmsMessageResp>
  </Messages>
  <ProcessResult>false</ProcessResult>
  <ProcessResultDescription>String</ProcessResultDescription>
</RestSmsResponse>