POST api/InstantSMS
Send an SMS with a custom text.
URL request: http://login.sendservice.eu/MultiChannelAPI/Api/instantSMS/
1 SMS - 1 Request
Parameters
| Parameter | Description | Object / Right format | Required |
|---|---|---|---|
user | It represents required object for the authorization | "User": { "username": "your username","password": "your password" } | Yes |
| DateStartToSend | It represents date when you want to schedule your SMS | aaaa-MM-ggThh:mm:ss.SSS+UTC | Yes |
| Number | Number of the SMS reciever | String (you must add prefix f.e. 0039..) | Yes |
Text | Text of your SMS | String | Yes |
SmsProviderCode | Type of the SMS provider | Insert "high" as provider code | Yes |
| SmsSender | It represents the sender of your SMS | String (Max 11 characters) | yes |
| Firstname | Contact Firstname | String max 128 characters | no |
| LastName | Contact Lastname | String max 128 characters | no |
| CodeRequest | Unique Identification code for your request | better to send a GUID | no |
Example Application/Json, Text/json
Example Application/json, Text/json
{
"ListSms": [
{
"SMSText": "Hello, this is your SMS text!",
"Number": "0039.......",
"SmsProviderCode": "high",
"SMSSender": "Sendername",
"DateStartToSend": "2018-03-22T15:39:06.0554209+01:00",
"CodeRequest": ""
}
],
"User": {
"username": "your username",
"password": "your password"
}
}
Example Application/xml
Example Application/xml
<GlobalSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CodeRequest>sample string 9</CodeRequest>
<ContactId>1</ContactId>
<DateCreated>2018-04-11T11:40:55.437308+01:00</DateCreated>
<DateModify>2018-04-11T11:40:55.437308+01:00</DateModify>
<DateSent>2018-04-11T11:40:55.437308+01:00</DateSent>
<DateStartToSend>2018-04-11T11:40:55.437308+01:00</DateStartToSend>
<FirstName>sample string 3</FirstName>
<Id>1</Id>
<LastName>sample string 4</LastName>
<ListSms>
<SMS>
<CodeRequest>sample string 13</CodeRequest>
<ContactId>1</ContactId>
<DateCreated>2018-04-11T11:40:55.437308+02:00</DateCreated>
<DateModify>2018-04-11T11:40:55.437308+02:00</DateModify>
<DateSent>2018-04-11T11:40:55.437308+02:00</DateSent>
<DateStartToSend>2018-04-11T11:40:55.437308+02:00</DateStartToSend>
<FirstName>sample string 3</FirstName>
<Id>1</Id>
<LastName>sample string 4</LastName>
<Number>sample string 7</Number>
<Price>1</Price>
<SMSSender>sample string 12</SMSSender>
<SMSText>sample string 5</SMSText>
<SmsProviderCode>sample string 11</SmsProviderCode>
<Status>Unsent</Status>
</SMS>
</ListSms>
<Number>sample string 6</Number>
<Price>1</Price>
<SMSSender>sample string 8</SMSSender>
<SMSText>sample string 5</SMSText>
<SmsProviderCode>sample string 7</SmsProviderCode>
<User>
<password>sample string 2</password>
<username>sample string 1</username>
</User>
</GlobalSettings>
More SMS - 1 Request
Parameters
| Parameter | Description | Object / Right format | Required |
|---|---|---|---|
user | It represents required object for the authorization | "User": { "username": "your username","password": "your password" } | Yes |
| DateStartToSend | It represents date when you want to schedule your SMS | aaaa-MM-ggThh:mm:ss.SSS+UTC | replaced if exist in ListSMS |
| Number | Number of the SMS reciever | String (you must add prefix f.e. 0039..) | replaced if exist in ListSMS |
Text | Text of your SMS | String | replaced if exist in ListSMS |
SmsProviderCode | Type of the SMS provider | Insert "high" as provider code | replaced if exist in ListSMS |
| SmsSender | It represents the sender of your SMS | String (Max 11 characters) | replaced if exist in ListSMS |
| Firstname | Contact Firstname | String max 128 characters | replaced if exist in ListSMS |
| LastName | Contact Lastname | String max 128 characters | replaced if exist in ListSMS |
| CodeRequest | Unique Identification code for your request | better to send a GUID | replaced if exist in ListSMS |
| ListSMS | An array with SMS which have same parameters of one Sms | "ListSms": | yes |
Example Application/Json, Text/json
Example Application/json, Text/json
{
"SMSText": "Hello, this is your SMS text!",
"SmsProviderCode": "high",
"SMSSender": "SmsSender",
"DateStartToSend": "2018-03-22T15:39:06.0554209+01:00",
"ListSms": [
{
"Number": "first number",
"CodeRequest": ""
},
{
"Number": "second number",
"CodeRequest": ""
}
],
"User": {
"username": "username",
"password": "password"
}
}