Отправить
Отправка email сообщения
POST https://do.freshoffice.ru/mail/send
Request Body
| Name | Type | Description |
|---|---|---|
| mail* | String | JSON |
200: OK Стандартный объект ответа
{
"status": "success",
"error": null,
"code": "0",
"rows": 1,
"pages": 1,
"page": 1,
"value": ""
}
JSON
Все доступны параметры нового объекта
- account_id - Код почтового аккаунта в системе (*обязательное)
- to_address - Кому (*обязательное)
- subject - Темы в формате ⚡️Base64 (*обязательное)
- body - Содержания письма в формате ⚡️Base64 (*обязательное)
- cc - Копия
- bcc - Скрытая копия
- company_id - Код контрагента, к которому будет повязано письма
- contact_id - Код контакта, к которому будет повязано письма
- deal_id - Код сделки, к которому будет повязано письма
{
"mail" : {
"account_id" : "4",
"to_address" : "hello@example.com",
"subject" : "SGFwcHkh",
"body" : "SGVsbG8h"
}
}
Примечание
Обязательные параметры
account_id (Можно взять в списке аккаунтов)
to_address
subject
body
Пример
cURL
PHP
NodeJS (Request)
url --location --request POST 'https://do.freshoffice.ru/mail/send' \
--header 'Authorization: Bearer XXXXXX.XXXXXXXX.XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
"mail" : {
"account_id" : "4",
"to_address" : "exemple@gmail.com",
"subject" : "SGFwcHkh",
"body" : "SGVsbG8h"
}
}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://do.freshoffice.ru/mail/send',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS =>'{
"mail" : {
"account_id" : "4",
"to_address" : "exemple@gmail.com",
"subject" : "SGFwcHkh",
"body" : "SGVsbG8h"
}
}',
CURLOPT_HTTPHEADER => array(
'Authorization: Bearer XXXXXX.XXXXXXXX.XXXXXXXX',
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://do.freshoffice.ru/mail/send',
'headers': {
'Authorization': 'Bearer XXXXXXXX.XXXXXXXXXXX.XXXXXXX',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"mail": {
"account_id": "4",
"to_address": "iskuzer@gmail.com",
"subject": "SGFwcHkh",
"body": "SGVsbG8h"
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
Ответ
{
"status": "success",
"error": null,
"code": "0",
"rows": 1,
"pages": 1,
"page": 1,
"value": ""
}