POST api/Sms/SendMessages

Отправить сообщение

Request Information

URI Parameters

None.

Body Parameters

SendMessage
NameDescriptionTypeAdditional information
Text

Текст сообщения. Все сообщения должны передаваться в UTF-8

string

None.

Phones

Список номеров телефонов, которым нужно отправить сообщение в формате 380xxxyyyyyyy

Collection of string

None.

Type

ID типа. По этому параметру определяются такие параметры, как время доставки, приоритет и дефолтный сервер.

integer

None.

SendedAt

Время, когда когда отправлять сообщение. Если не указано - на отправку сразу же.

string

None.

Coding

Кодировка сообщения. Если не указано - определяется автоматически.

string

None.

Server

ID сервера. Если не указано - используется дефолтный для типа

integer

None.

ExpiredAt

Время, когда сообщение теряет актуальность. По умолчанию SendedAt + 1 день

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Text": "sample string 1",
  "Phones": [
    "sample string 1",
    "sample string 2"
  ],
  "Type": 2,
  "SendedAt": "sample string 3",
  "Coding": "sample string 4",
  "Server": 5,
  "ExpiredAt": "sample string 6"
}

application/xml, text/xml

Sample:
<SendMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Data.Models.dto">
  <Coding>sample string 4</Coding>
  <ExpiredAt>sample string 6</ExpiredAt>
  <Phones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Phones>
  <SendedAt>sample string 3</SendedAt>
  <Server>5</Server>
  <Text>sample string 1</Text>
  <Type>2</Type>
</SendMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SmsDetail
NameDescriptionTypeAdditional information
Id

ID сообщения

integer

None.

Created

Время создания сообщения

string

None.

Phone

Номер телефона

string

None.

Message

Сообщение

string

None.

Server

ID сервиса

integer

None.

MessageId

ID сообщения SMPP сервера

string

None.

Sended

Время отправки сообщения(без MessageId указывает, что агент забрал на отправку)

string

None.

DelivrdTime

Время отчета о доставке

string

None.

DelivrdStatus

Статус доставки

string

None.

Type

ID сервера

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Created": "sample string 2",
    "Phone": "sample string 3",
    "Message": "sample string 4",
    "Server": 5,
    "MessageId": "sample string 6",
    "Sended": "sample string 7",
    "DelivrdTime": "sample string 8",
    "DelivrdStatus": "sample string 9",
    "Type": 10
  },
  {
    "Id": 1,
    "Created": "sample string 2",
    "Phone": "sample string 3",
    "Message": "sample string 4",
    "Server": 5,
    "MessageId": "sample string 6",
    "Sended": "sample string 7",
    "DelivrdTime": "sample string 8",
    "DelivrdStatus": "sample string 9",
    "Type": 10
  }
]

application/xml, text/xml

Sample:
<ArrayOfSmsDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Data.Models.dto">
  <SmsDetail>
    <Created>sample string 2</Created>
    <DelivrdStatus>sample string 9</DelivrdStatus>
    <DelivrdTime>sample string 8</DelivrdTime>
    <Id>1</Id>
    <Message>sample string 4</Message>
    <MessageId>sample string 6</MessageId>
    <Phone>sample string 3</Phone>
    <Sended>sample string 7</Sended>
    <Server>5</Server>
    <Type>10</Type>
  </SmsDetail>
  <SmsDetail>
    <Created>sample string 2</Created>
    <DelivrdStatus>sample string 9</DelivrdStatus>
    <DelivrdTime>sample string 8</DelivrdTime>
    <Id>1</Id>
    <Message>sample string 4</Message>
    <MessageId>sample string 6</MessageId>
    <Phone>sample string 3</Phone>
    <Sended>sample string 7</Sended>
    <Server>5</Server>
    <Type>10</Type>
  </SmsDetail>
</ArrayOfSmsDetail>