POST api/forms/simple/{form}/send

Send a simple form with the given information directly

Request Information

URI Parameters

Name	Description	Type	Additional information
form	Simple form ID	integer	Required

Body Parameters

Message to send

OutgoingSMSDTO

Name	Description	Type	Additional information
Numbers	Recipient phone numbers	Collection of string	None.
Contacts	Recipient contacts	Collection of integer	None.
Groups	Recipient groups	Collection of integer	None.
Parameters	Templating parameters	Dictionary of string [key] and Dictionary of string [key] and string [value] [value]	Link
Email	Whether to send SMS copies by email (for contacts with email addresses)	boolean	None.
Prio	SMS message priority, normal (1) or high (2)	integer	Deprecated: No longer makes a difference, use 1 if any Range: inclusive between 1 and 2
From	SMS message sender name or phone number	string	Required
Message	SMS message contents	string	Required

Request Formats

application/json, text/json

Sample:

{
  "Numbers": [
    "sample string 1",
    "sample string 2"
  ],
  "Contacts": [
    1,
    2
  ],
  "Groups": [
    1,
    2
  ],
  "Parameters": {
    "sample string 1": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "sample string 2": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "Email": true,
  "Prio": 1,
  "From": "sample string 2",
  "Message": "sample string 3"
}

Response Information

Resource Description

Sent messages

Collection of ProcessedOutgoingSMSDTO

Name	Description	Type	Additional information
ID	SMS message ID	integer	None.
BundleID	SMS bundle ID, if any	integer	None.
Status	SMS message status code	integer	None.
StatusDescription	SMS message status description	string	None.
To	Destination phone number	string	None.
CountryCode	Country code of destination phone number if To field is valid, otherwise null	string	None.
Currency	What currency the SMS was payed in. Is displayed as ISO 4217 Alphabetic code	Currency	None.
TotalPrice	The price for sending the entire message	decimal number	None.
Price	The price for sending each segment of the message	decimal number	None.
Encoding	Encoding in which the message was encoded	SmsEncoding	None.
Segments	The number of segments the message consists of	byte	None.
Prio	SMS message priority, normal (1) or high (2)	integer	Deprecated: No longer makes a difference, use 1 if any Range: inclusive between 1 and 2
From	SMS message sender name or phone number	string	Required
Message	SMS message contents	string	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "BundleID": 1,
    "Status": 2,
    "StatusDescription": "Invalid message content",
    "To": "sample string 3",
    "CountryCode": null,
    "Currency": "SEK",
    "TotalPrice": 4.0,
    "Price": 5.0,
    "Encoding": "GSM7",
    "Segments": 1,
    "Prio": 2,
    "From": "sample string 7",
    "Message": "sample string 8"
  },
  {
    "ID": 1,
    "BundleID": 1,
    "Status": 2,
    "StatusDescription": "Invalid message content",
    "To": "sample string 3",
    "CountryCode": null,
    "Currency": "SEK",
    "TotalPrice": 4.0,
    "Price": 5.0,
    "Encoding": "GSM7",
    "Segments": 1,
    "Prio": 2,
    "From": "sample string 7",
    "Message": "sample string 8"
  }
]