API метод отправки СМС сообщений
Описание
Постановка операции на рассылку смс по списку абонентов.
URL-дрес метода API
http://api.profisend.ru/delivery.sendSms
HTTP-параметры
| Имя параметра | Тип данных | Описание |
|---|---|---|
| pid | Integer | ID смс-сервиса (значение доступно в профиле). |
| sender | String | Имя отправителя. |
| to | String, Array | Список номеров абонентов получателей сообщения. Указываются через запятую или как массив списков (для больших списков рассылки). Формат номеров: номера телефонов в международном формате, без знака +. |
| text | String | Текст смс в кодировке utf-8. |
Формат ответных данных
В случае успеха API возвращает данные созданной рассылки.
| Имя параметра | Тип данных | Описание |
|---|---|---|
| tid | Integer | ID-рассылки. |
| uid | Integer | ID-клиента. |
| pid | Integer | ID смс-сервиса. |
| create_time | Datetime | Дата и время постановки рассылки в очередь. |
| update_time | Datetime | Дата и время последнего обновления сведений по рассылке. |
| type | Array | Способ постановки рассылки в очередь (web-интерфейс или http-api). |
| start_at | Datetime | Дата и время планировки (отложенная рассылка). |
| duration | Integer | Продолжительность рассылки в часах. При использовании функции распределения рассылки во времени. |
| sender | String | Имя отправителя. |
| current_progress | Integer | Обработанное число абонентских номеров. |
| success_count | Integer | Число успешно обработанных абонентских номеров. |
| count | Array | Массив данных с числом сообщений в рассылке сгруппированных по трем статусам: delivered, failed и not_delivered. |
| gids | Array | Список ID-групп контактов участвующих в рассылке. |
| to_count | Integer | Общее число абонентских номеров в операции. |
| cost | Float | Стоимость рассылки на момент исполнения операции (за обработанное число success_count абонентов). |
| status | Array | Статус выполнения операции. |
| ip | String | IP-адрес создавщего операцию. |
Пример отправки нескольких сообщений
<?php
/*
* В примере использован код php-класса SmsServiceApi.class.php для работы с API.
* Исходный код доступен на странице http://cabinet.profisend.ru/help/api/sample
*/
require_once 'SmsServiceApi.class.php';
// настройки API
define ('API_UID', 'ID-клиента');
define ('API_KEY', 'Ключ API');
define ('API_PID', 'ID смс-сервиса');
$Api = new SmsServiceApi(API_UID, API_KEY);
// параметры
$api_params = array(
'pid' => API_PID,
'sender' => 'test',
'to' => '79001000000,79002000000,79003000000,79004000000',
'text' => 'Тестовое смс'
);
// отправка
$result = $Api->send('delivery.sendSms', $api_params);
// результат
print_r($result);
?>