POST api/SMSMobility/SendVernacularSMS

Request Information

URI Parameters

None.

Body Parameters

SMSRequest
NameDescriptionTypeAdditional information
PhoneNumber

string

None.

TemplateId

string

None.

StaffId

string

None.

AppName

string

None.

DynamicVals

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PhoneNumber": "sample string 1",
  "TemplateId": "sample string 2",
  "StaffId": "sample string 3",
  "AppName": "sample string 4",
  "DynamicVals": "sample string 5"
}

application/xml, text/xml

Sample:
<SMSRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects">
  <AppName>sample string 4</AppName>
  <DynamicVals>sample string 5</DynamicVals>
  <PhoneNumber>sample string 1</PhoneNumber>
  <StaffId>sample string 3</StaffId>
  <TemplateId>sample string 2</TemplateId>
</SMSRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SendSMSResponseDTO
NameDescriptionTypeAdditional information
ResponseCode

string

None.

ResponseMsg

string

None.

CorrelationId

string

None.

ResponseDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": "sample string 1",
  "ResponseMsg": "sample string 2",
  "CorrelationId": "sample string 3",
  "ResponseDescription": "sample string 4"
}

application/xml, text/xml

Sample:
<SendSMSResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObjects">
  <CorrelationId>sample string 3</CorrelationId>
  <ResponseCode>sample string 1</ResponseCode>
  <ResponseDescription>sample string 4</ResponseDescription>
  <ResponseMsg>sample string 2</ResponseMsg>
</SendSMSResponseDTO>