POST api/SMSService/SendSMS

Documentation for 'SendSMS'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "ConceptId": 1,
  "SMSMessageCategory": 1,
  "SMSTo": "sample string 2",
  "SMSFrom": "sample string 3",
  "Message": "sample string 4",
  "CountryCode": 5,
  "UserID": 6
}

application/xml, text/xml

Sample:

<SendSMSRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.SMS">
  <ConceptId>1</ConceptId>
  <CountryCode>5</CountryCode>
  <Message>sample string 4</Message>
  <SMSFrom>sample string 3</SMSFrom>
  <SMSMessageCategory>DirectEnquiry</SMSMessageCategory>
  <SMSTo>sample string 2</SMSTo>
  <UserID>6</UserID>
</SendSMSRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'SendSMSRequest'.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "Message": {
    "HasSMSSent": true,
    "ErrorMessage": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ResponseBaseOfSendSMSResponseNZ4_SIqEP xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.SMS">
    <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    <d2p1:HasSMSSent>true</d2p1:HasSMSSent>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfSendSMSResponseNZ4_SIqEP>