Расширение для Yii Framework по работе с API сервиса LittleSMS.ru.
Актуальная версия всегда находится по адресу https://github.com/pavel-voronin/yii-littlesms/.
Требования ¶
- Yii Framework 1.1+
- PHP 5.3+ (анонимные функции)
- cURL (запросы к API)
Установка ¶
Загрузите yii-littlesms из этого репозитория на YiiFramework.com или с github:
cd protected/extensions
git clone git://github.com/pavel-voronin/yii-littlesms.git
В `
protected/config/main.php`
внесите следующие строки:
'components' => array
(
'sms' => array
(
'class' => 'application.extensions.yii-littlesms.LittleSMS',
'user' => 'acc-efc322bb', // Основной или дополнительный аккаунт
'apikey' => 'ttUfFhg2', // API-ключ аккаунта
'testMode' => true // Режим тестирования по умолчанию выключен, будьте внимательны
)
);
Использование ¶
Расширение поддерживает все вызовы API LittleSMS. Последнюю редакцию документации по вызовам вы можете найти на официальном сайте. Для лучшего понимания работы расширения просмотрите его код. Его немного и он достаточно документирован.
Базовый формат вызова: ¶
Yii::app()->sms->messageSend
(
array
(
'recipients' => array ( '+7(926)000-00-00', '89030000000' ),
// Допустим вариант со строкой и разделителем — запятой
// 'recipients' => '79260000000,7-903-000-00-00',
'message' => 'Hello, World!'
)
)
Имя вызова в формате `
componentFunction`
(см. официальную документацию). Единственный аргумент — массив параметров вызова.
Альтернативный формат вызова: ¶
Yii::app()->sms->messageSend ( '+7(926)000-00-00, 8-903-000-0000', 'Hello, World!', 'Santa Claus' );
Аргументы транслируются в параметры в соответствии с ключами `
requiredи
optionalв
LittleSMS.calls()`
.
В случае, если нужно передать редкий параметр, например lifetime в message/send, пользуйтесь базовым форматом.
Ответы API ¶
Вызовы в случае неудачи возвращают `
false`
, иначе либо `
true`
, либо значение ключа `
returnKey`
, определённого в `
LittleSMS.calls()`
. Полный ответ API находится в `
Yii::app()->sms->response`
.
Версия 1.0 ¶
- Первая версия
- Протестирована работа компонентов
`
userи
message`
. К тестированию и уточнению других в`
LittleSMS.calls()`
приглашаю всех желающих.
LittleSMS
Давно пользуюсь этим смс сервисом. Но руки до написания расширения не доходили. Спасибо, попробую в слудующим проекте!
If you have any questions, please ask in the forum instead.
Signup or Login in order to comment.