POST api/Sms

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FromNumber	string	None.
TemplateName	string	Required
Recipients	Collection of RecipientDto	Required

Request Formats

application/json, text/json

Sample:

{
  "FromNumber": "sample string 1",
  "TemplateName": "sample string 2",
  "Recipients": [
    {
      "ToNumber": "sample string 1",
      "RecipientProperties": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "ToNumber": "sample string 1",
      "RecipientProperties": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ]
}

application/xml, text/xml

Sample:

<SmsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Sms.Models">
  <FromNumber>sample string 1</FromNumber>
  <Recipients>
    <RecipientDto>
      <RecipientProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </RecipientProperties>
      <ToNumber>sample string 1</ToNumber>
    </RecipientDto>
    <RecipientDto>
      <RecipientProperties xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </RecipientProperties>
      <ToNumber>sample string 1</ToNumber>
    </RecipientDto>
  </Recipients>
  <TemplateName>sample string 2</TemplateName>
</SmsDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.