POST api/Sms/SendSms

Request Information

URI Parameters

None.

Body Parameters

SmsViewModel
NameDescriptionTypeAdditional information
SmsSource

SmsSource

None.

SmsUserCode

string

None.

SmsUsername

string

None.

SmsPassword

string

None.

SmsOriginator

string

None.

Message

string

None.

Phones

Collection of string

None.

CompanyID

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "smsSource": 1,
  "smsUserCode": "sample string 1",
  "smsUsername": "sample string 2",
  "smsPassword": "sample string 3",
  "smsOriginator": "sample string 4",
  "message": "sample string 5",
  "phones": [
    "sample string 1",
    "sample string 2"
  ],
  "companyID": "cb867d4a-dd30-47f0-ba26-5c0a143b4bd8"
}

application/xml, text/xml

Sample:
<SmsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TP.TulTrack.Core.Models">
  <CompanyID>cb867d4a-dd30-47f0-ba26-5c0a143b4bd8</CompanyID>
  <Message>sample string 5</Message>
  <Phones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Phones>
  <SmsOriginator>sample string 4</SmsOriginator>
  <SmsPassword>sample string 3</SmsPassword>
  <SmsSource>NETGSM</SmsSource>
  <SmsUserCode>sample string 1</SmsUserCode>
  <SmsUsername>sample string 2</SmsUsername>
</SmsViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

text/html

Sample:
{"smsSource":1,"smsUserCode":"sample string 1","smsUsername":"sample string 2","smsPassword":"sample string 3","smsOriginator":"sample string 4","message":"sample string 5","phones":["sample string 1","sample string 2"],"companyID":"cb867d4a-dd30-47f0-ba26-5c0a143b4bd8"}

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, text/html

Sample:

Sample not available.