POST api/v1/sms/send

Request Information

URI Parameters

None.

Body Parameters

Sms

Name	Type	Additional information
ClientId	integer	None.
SendSms	boolean	None.
Recipients	Collection of Recipient	None.

Request Formats

application/json, text/json

Sample:

{
  "ClientId": 1,
  "SendSms": true,
  "Recipients": [
    {
      "RecipientNumber": "sample string 1",
      "Purpose": "sample string 2",
      "Function": "sample string 3",
      "TemplateData": {
        "Project": "sample string 1",
        "UnitNo": "sample string 2",
        "Currency": "sample string 3",
        "Price": "sample string 4",
        "AgentName": "sample string 5",
        "GivenDate": "sample string 6",
        "BuyerName": "sample string 7",
        "BuyerContact": "sample string 8",
        "Bank": "sample string 9",
        "BankerName": "sample string 10"
      }
    },
    {
      "RecipientNumber": "sample string 1",
      "Purpose": "sample string 2",
      "Function": "sample string 3",
      "TemplateData": {
        "Project": "sample string 1",
        "UnitNo": "sample string 2",
        "Currency": "sample string 3",
        "Price": "sample string 4",
        "AgentName": "sample string 5",
        "GivenDate": "sample string 6",
        "BuyerName": "sample string 7",
        "BuyerContact": "sample string 8",
        "Bank": "sample string 9",
        "BankerName": "sample string 10"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<SendSmsBO.Sms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HyperQB.SmsServiceAPI.ApiBo">
  <ClientId>1</ClientId>
  <Recipients>
    <SendSmsBO.Recipient>
      <Function>sample string 3</Function>
      <Purpose>sample string 2</Purpose>
      <RecipientNumber>sample string 1</RecipientNumber>
      <TemplateData>
        <AgentName>sample string 5</AgentName>
        <Bank>sample string 9</Bank>
        <BankerName>sample string 10</BankerName>
        <BuyerContact>sample string 8</BuyerContact>
        <BuyerName>sample string 7</BuyerName>
        <Currency>sample string 3</Currency>
        <GivenDate>sample string 6</GivenDate>
        <Price>sample string 4</Price>
        <Project>sample string 1</Project>
        <UnitNo>sample string 2</UnitNo>
      </TemplateData>
    </SendSmsBO.Recipient>
    <SendSmsBO.Recipient>
      <Function>sample string 3</Function>
      <Purpose>sample string 2</Purpose>
      <RecipientNumber>sample string 1</RecipientNumber>
      <TemplateData>
        <AgentName>sample string 5</AgentName>
        <Bank>sample string 9</Bank>
        <BankerName>sample string 10</BankerName>
        <BuyerContact>sample string 8</BuyerContact>
        <BuyerName>sample string 7</BuyerName>
        <Currency>sample string 3</Currency>
        <GivenDate>sample string 6</GivenDate>
        <Price>sample string 4</Price>
        <Project>sample string 1</Project>
        <UnitNo>sample string 2</UnitNo>
      </TemplateData>
    </SendSmsBO.Recipient>
  </Recipients>
  <SendSms>true</SendSms>
</SendSmsBO.Sms>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.