Добавить телефоны в адресную книгу
Для добавления телефона в адресную книгу отправляется POST запрос по ссылке
| https://api.sendpulse.com/sms/numbers |
Параметры запроса:
| addressBookId | идентификатор адресной книги (int) |
| phones | массив телефонов в json формате |
Пример ответа для информации по книге:
[
{
"result": true,
"counters": {
"added": 0,
"exceptions": 0,
"exists": 83
}
}
]
Обновить список переменных по телефонному номеру
Для обновления списка переменных по телефонному номеру отправляется PUT запрос по ссылке
| https://api.sendpulse.com/sms/numbers |
Параметры запроса:
| addressBookId | идентификатор адресной книги (int) |
| phones | массив телефонов в json формате |
| variables | массив переменных в json формате |
Пример ответа:
[
{
"result": true,
"counters": {
"updated": 4
}
}
]
Удалить телефоны из адресной книги
Для удаления телефона из адресной книги отправляется DELETE запрос по ссылке
| https://api.sendpulse.com/sms/numbers |
Параметры запроса:
| phones | список телефонов в json |
| addressBookId | id адресной книги |
Пример ответа:
[
{
"result": true,
"counters": {
"added": 0,
"exists": 3
}
}
]
Получить информацию о телефонном номере
Для получения информации о телефонном номере отправляется GET запрос по ссылке
| https://api.sendpulse.com/sms/numbers/info/{addressBookId}/{phoneNumber} |
Параметры запроса:
| phoneNumber | номер телефона |
| addressBookId | id адресной книги |
Пример ответа:
[
{
"result": true,
"data": {
"status": 1,
"variables": {
"test1": "2018-10-10 23:00:00",
"test2": "czxczxczx",
"test3": 12312312312
},
"added": "2017-02-21 13:19:47"
}
}
]
Добавить номер в черный список
Чтобы добавить телефон в черный список, отправляется POST запрос по ссылке
| https://api.sendpulse.com/sms/black_list |
Параметры запроса:
| phones | список телефонов в json |
| description | описание |
Пример ответа:
[
{
"result": true,
"counters": {
"added": 2,
"exists": 3
}
}
]
Удалить номер из черный список
Для удаления телефона из черного списка отправляется DELETE запрос по ссылке
| https://api.sendpulse.com/sms/black_list |
Параметры запроса:
| phones | список телефонов в json |
Пример ответа:
[
{
"result": true,
"counters": {
"removed": 3
}
}
]
Получить информацию по черному списку
Чтобы получить инфомрацию по черному листу, отправляется GET запрос по ссылке
| https://api.sendpulse.com/sms/black_list |
Пример ответа:
[
{
"result": true,
"data": [ {
"phone": 380506383302,
"description": "texst",
"add_date": "2017-02-27 10:48:22"
},
]
}
]
Получить информацию о телефонах в черном списке
Чтобы получить информацию о телефонах в черном списке, отправляется GET запрос по ссылке
| https://api.sendpulse.com/sms/black_list/by_numbers |
Параметры запроса:
| phones | список телефонов в json |
Пример ответа:
[
{
"result": true,
"data": [ {
"phone": 380506383302,
"description": "texst",
"add_date": "2017-02-27 10:48:22"
},
]
}
]
Создать кампанию
Чтобы создать кампанию, отправляется POST запрос по ссылке
| https://api.sendpulse.com/sms/campaigns |
Параметры запроса:
| sender | отправитель (опционально) |
| addressBookId | адресная книга |
| body | текст рассылки |
| date | дата рассылки в формате Y-m-d H:i:s (опционально) |
| transliterate | 1 или 0 , транслитерация тела |
Пример ответа:
[
{
"result": true,
"campaign_id": 2623084
}
]
Создать кампанию по телефонному списку
Чтобы создать кампанию по телефонному списку, отправляется POST запрос по ссылке
| https://api.sendpulse.com/sms/send |
Параметры запроса:
| sender | отправитель (опционально) |
| phones | список телефонов в json |
| body | текст рассылки |
| date | дата рассылки в формате Y-m-d H:i:s (опционально) |
| transliterate | 1 или 0 , транслитерация тела |
Пример ответа:
[
{
"result": true,
"campaign_id": 2623085,
"counters": {
"exceptions": 0,
"sends": 3
}
}
]
Получить список рассылок по датам
Чтобы получить список рассылок по датам, отправляется GET запрос по ссылке
| https://api.sendpulse.com/sms/campaigns/list |
Параметры запроса:
| dateFrom | дата от в формате Y-m-d H:i:s |
| dateTo | дата до в формате Y-m-d H:i:s |
Пример ответа:
[
{
"result": true,
"data": [ {
"id": 2136035,
"address_book_id": 0,
"company_price": 0.81,
"company_currency": "UAH",
"send_date": "2017-01-18 08:15:18",
"date_created": "2017-01-18 08:15:18",
"sender_mail_address": "",
"sender_mail_name": "",
"external_stat": []
},
{
"id": 2136036,
"address_book_id": 0,
"company_price": 0.27,
"company_currency": "UAH",
"send_date": "2017-01-18 11:59:52",
"date_created": "2017-01-18 11:59:52",
"sender_mail_address": "",
"sender_mail_name": "",
"external_stat": []
},
]
}
]
Получить информацию по рассылке
Чтобы получить информацию по рассылке, отправляется GET запрос по ссылке
| https://api.sendpulse.com/sms/campaigns/info/{id} |
Параметры запроса:
| {id} | id рассылки |
Пример ответа:
[
{
"result": true,
"data": {
"id": 2136035,
"address_book_id": 0,
"currency": "UAH",
"company_price": 0.81,
"send_date": "2017-01-18 08:15:18",
"date_created": "2017-01-18 08:15:18",
"sender_mail_address": "",
"sender_mail_name": "",
"external_stat": [],
"task_phones_info": [ {
"phone": 380632636296,
"money_spent": 0.27
}, {
"phone": 380632636298,
"money_spent": 0.27
}, {
"phone": 380632636299,
"money_spent": 0.27
}
]
}
}
]
Отменить кампанию (в случае, если кампания еще не стартовала)
Чтобы отменить кампанию, отправляется PUT запрос по ссылке
| https://api.sendpulse.com/sms/campaigns/cancel/{id} |
Параметры запроса:
| {id} | id рассылки |
Пример ответа:
[
{
"result": false
}
]
Получить стоимость кампании
Чтобы получить стоимость кампании, отправляется GET запрос по ссылке
| https://api.sendpulse.com/sms/campaigns/cost |
Если не указана адресная книга, то обязательно должен быть указан список телефонов и наоборот
Параметры запроса:
| addressBookId | id адресной книги (опционально) |
| sender | отправитель |
| phones | список телефонов в json (опционально) |
| body | тело сообщения |
Пример ответа:
[
{
"result": true,
"data": {
"price": 14.679,
"currency": "UAH"
}
}
]
Удалить кампанию
Чтобы удалить кампанию, отправляется DELETE запрос по ссылке
| https://api.sendpulse.com/sms/campaigns |
Параметры запроса:
| id | id кампании |
Пример ответа:
[
{
"result": false | true
}
]
или