POST Api/V1/SMS/SendMultiSMS

Request Information

URI Parameters

None.

Body Parameters

MultiSMSRequest
NameDescriptionTypeAdditional information
Message

string

None.

Recipients

Collection of Dictionary of string [key] and string [value]

None.

GroupNumbers

Collection of integer

None.

ExcludedGroupNumbers

Collection of integer

None.

Settings

SmsSettings

None.

Request Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "Recipients": [
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  ],
  "GroupNumbers": [
    1,
    2
  ],
  "ExcludedGroupNumbers": [
    1,
    2
  ],
  "Settings": {
    "Sender": "sample string 1",
    "CampaignName": "sample string 2",
    "TimeToSend": "sample string 3",
    "DelayInSeconds": 1,
    "CustomerMessageID": "sample string 4",
    "CustomerParameter": "sample string 5",
    "DeliveryNotificationUrl": "sample string 6",
    "Priority": 1,
    "MaxSegments": 1,
    "IgnoreUnsubscribeCheck": true,
    "ExpireDate": "sample string 7",
    "IgnorePossibleSendingTime": true,
    "CheckTimeRestiction": true,
    "ShortenUrlEnable": true,
    "AllowDuplicates": true,
    "TrackPurchaseTData": true
  }
}

application/xml, text/xml

Sample:
<MultiSMSRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iCreate.API.Models.MessagingModels">
  <ExcludedGroupNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ExcludedGroupNumbers>
  <GroupNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </GroupNumbers>
  <Message>sample string 1</Message>
  <Recipients xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
    <d2p1:ArrayOfKeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 1</d2p1:Key>
        <d2p1:Value>sample string 2</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
      <d2p1:KeyValueOfstringstring>
        <d2p1:Key>sample string 3</d2p1:Key>
        <d2p1:Value>sample string 4</d2p1:Value>
      </d2p1:KeyValueOfstringstring>
    </d2p1:ArrayOfKeyValueOfstringstring>
  </Recipients>
  <Settings xmlns:d2p1="http://schemas.datacontract.org/2004/07/HDPro.Core.Manager">
    <d2p1:AllowDuplicates>true</d2p1:AllowDuplicates>
    <d2p1:CampaignName>sample string 2</d2p1:CampaignName>
    <d2p1:CheckTimeRestiction>true</d2p1:CheckTimeRestiction>
    <d2p1:CustomerMessageID>sample string 4</d2p1:CustomerMessageID>
    <d2p1:CustomerParameter>sample string 5</d2p1:CustomerParameter>
    <d2p1:DelayInSeconds>1</d2p1:DelayInSeconds>
    <d2p1:DeliveryNotificationUrl>sample string 6</d2p1:DeliveryNotificationUrl>
    <d2p1:ExpireDate>sample string 7</d2p1:ExpireDate>
    <d2p1:IgnorePossibleSendingTime>true</d2p1:IgnorePossibleSendingTime>
    <d2p1:IgnoreUnsubscribeCheck>true</d2p1:IgnoreUnsubscribeCheck>
    <d2p1:MaxSegments>1</d2p1:MaxSegments>
    <d2p1:Priority>1</d2p1:Priority>
    <d2p1:Sender>sample string 1</d2p1:Sender>
    <d2p1:ShortenUrlEnable>true</d2p1:ShortenUrlEnable>
    <d2p1:TimeToSend>sample string 3</d2p1:TimeToSend>
    <d2p1:TrackPurchaseTData>true</d2p1:TrackPurchaseTData>
  </Settings>
</MultiSMSRequest>

application/x-www-form-urlencoded

Sample:

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

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.