POST api/Fcm/AddMessage
Отправить новое сообщение
Request Information
URI Parameters
None.
Body Parameters
MessageForId| Name | Description | Type | Additional information |
|---|---|---|---|
| ServiceId |
ID сервиса, от имени которого отправлять сообщения |
integer |
None. |
| UserLogins |
Список логинов, которым отправить сообщения(в случае с персоналом - ID сотрудника) |
Collection of string |
None. |
| Phones |
Номера телефонов, которым отправить данное сообщение (работает только для персонала компании) |
Collection of string |
None. |
| Body |
Тело сообщения, не более 250 символов |
string |
None. |
| Title |
Заголовок сообщения, не более 50 символов |
string |
None. |
| Click |
Ссылка на переход при клике на сообщение |
string |
None. |
| DelivrdTime |
Время на доставку сообщения в секундах , необязательное поле(стандартно 3600сек) |
integer |
None. |
| ExtraFields |
Дополнительные параметры для сообщения(используется при типе Android), необязательное поле |
string |
None. |
| SendAt |
Дата-время, когда сообщение нужно отправить(формат 2006-12-06 23:59:59), необязательное поле("сейчас" по-умолчанию) |
string |
None. |
| ExpiredAt |
Дата-время, когда сообщение становится неактуальным(формат 2006-12-06 23:59:59), необязательное поле(+сутки по-умолчанию) |
string |
None. |
Request Formats
application/json, text/json
{
"ServiceId": 1,
"UserLogins": [
"sample string 1",
"sample string 2"
],
"Phones": [
"sample string 1",
"sample string 2"
],
"Body": "sample string 2",
"Title": "sample string 3",
"Click": "sample string 4",
"DelivrdTime": 5,
"ExtraFields": "sample string 6",
"SendAt": "sample string 7",
"ExpiredAt": "sample string 8"
}
application/xml, text/xml
<MessageForId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Data.Models">
<Body>sample string 2</Body>
<Click>sample string 4</Click>
<DelivrdTime>5</DelivrdTime>
<ExpiredAt>sample string 8</ExpiredAt>
<ExtraFields>sample string 6</ExtraFields>
<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>
<SendAt>sample string 7</SendAt>
<ServiceId>1</ServiceId>
<Title>sample string 3</Title>
<UserLogins xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</UserLogins>
</MessageForId>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Collection of MessageStatusFCM| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| ServiceId | integer |
None. |
|
| DeviceId | integer |
None. |
|
| Login | string |
None. |
|
| Token | string |
None. |
|
| Created | string |
None. |
|
| Sended | string |
None. |
|
| Delivered | boolean |
None. |
|
| Read | boolean |
None. |
|
| MessageId | string |
None. |
|
| Title | string |
None. |
|
| Body | string |
None. |
|
| Click | string |
None. |
|
| SendAt | string |
None. |
|
| ExtraFields | string |
None. |
Response Formats
application/json, text/json
[
{
"Id": 1,
"ServiceId": 2,
"DeviceId": 1,
"Login": "sample string 3",
"Token": "sample string 4",
"Created": "sample string 5",
"Sended": "sample string 6",
"Delivered": true,
"Read": true,
"MessageId": "sample string 9",
"Title": "sample string 10",
"Body": "sample string 11",
"Click": "sample string 12",
"SendAt": "sample string 13",
"ExtraFields": "sample string 14"
},
{
"Id": 1,
"ServiceId": 2,
"DeviceId": 1,
"Login": "sample string 3",
"Token": "sample string 4",
"Created": "sample string 5",
"Sended": "sample string 6",
"Delivered": true,
"Read": true,
"MessageId": "sample string 9",
"Title": "sample string 10",
"Body": "sample string 11",
"Click": "sample string 12",
"SendAt": "sample string 13",
"ExtraFields": "sample string 14"
}
]
application/xml, text/xml
<ArrayOfMessageStatusFCM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Data.Models">
<MessageStatusFCM>
<Body>sample string 11</Body>
<Click>sample string 12</Click>
<Created>sample string 5</Created>
<Delivered>true</Delivered>
<DeviceId>1</DeviceId>
<ExtraFields>sample string 14</ExtraFields>
<Id>1</Id>
<Login>sample string 3</Login>
<MessageId>sample string 9</MessageId>
<Read>true</Read>
<SendAt>sample string 13</SendAt>
<Sended>sample string 6</Sended>
<ServiceId>2</ServiceId>
<Title>sample string 10</Title>
<Token>sample string 4</Token>
</MessageStatusFCM>
<MessageStatusFCM>
<Body>sample string 11</Body>
<Click>sample string 12</Click>
<Created>sample string 5</Created>
<Delivered>true</Delivered>
<DeviceId>1</DeviceId>
<ExtraFields>sample string 14</ExtraFields>
<Id>1</Id>
<Login>sample string 3</Login>
<MessageId>sample string 9</MessageId>
<Read>true</Read>
<SendAt>sample string 13</SendAt>
<Sended>sample string 6</Sended>
<ServiceId>2</ServiceId>
<Title>sample string 10</Title>
<Token>sample string 4</Token>
</MessageStatusFCM>
</ArrayOfMessageStatusFCM>