SmsCoin Instructions

**Это старая версия документа.** ----

====== Premium Short Code ====== ===== 1. Общая информация ===== Premium Short Code — это платформа для обработки и передачи сообщений, созданная для продвижения новых усовершенствованных услуг, в дополнение к проекту SmsCoin. Разработка платформы началась в 2007 году, и на данный момент она работает со многими услугами с большим объемом транзакций. Эта система способна распределять трафик по принципу разделения на короткие номера и префиксы. Активация большинства услуг происходит мгновенно. Premium Short Code предлагает следующие услуги: обычные MO и MT Премиум SMS- платежи, MO- и Web-инициируемые подписки, сессии и новую услугу Pay-By-Click (PBC), которая также известна как “Easy Billing”. Команда “STOP” доступна для тех партнеров, которые заинтересованы в этом дополнении. Для того, чтобы упростить работу разных видов услуг, размещённых на одной платформе, все предоставляемые сервисы настроены и работают таким образом, что со стороны партнера они выглядят как стандартный МО- и МТ-трафик. Такое решение позволяет использовать один простой протокол, описанный ниже, который работает со всеми доступными в системе услугами, независимо от страны, типа биллинга и самого сервиса. Для регистрации и работы с пользователями на web-инициируемых подписках и услуге Pay-By-Click предлагаются два дополнительных протокола. Оба протокола применимы только в том случае, если Вы намерены пользоваться данными услугами. ===== 2. Управление сервисом ===== ==== 2.1. Информация о провайдере ==== === 2.1.1 URL === **Предоставляется в момент создания сервиса** === 2.1.2 Параметры === ^ Параметр ^ Тип ^ Описание ^ | command | text | Устанавливается параметр '**check_phone**' | | sid | int | ID услуги (предоставляется отдельно) | | hash | int | Секретный код (предоставляется отдельно) | | phone | varchar(16) | Номер абонента в международном формате (без + или 00) | | ip | varchar(15) | IP-адрес пользователя | === 2.1.3 Формат ответа === Как правило, XML-ответ выглядит следующим образом. <code> <response> <code>0</ code> <desc>beeline</desc> </response> </code> === 2.1.4 Возможные ответы системы === ^ Тип ^ Статус ^ Описание ^ Объяснение ^ | OK | 0 | Beeline,mts.... |Название сотового оператора| | | | | | Обратите внимание, что статусы, описанные выше, это часть XML-ответа, а не статус HTTP. В любом случае статус HTTP должен быть 200. ==== 2.2 Проверка статуса номера ==== === 2.2.1 URL=== **Предоставляется в момент создания сервиса** === 2.2.2 Параметры === ^Параметр ^Тип ^Описание^ | command | text | Устанавливается параметр '**check_phone**' | | sid | int | ID услуги (предоставляется отдельно) | | hash | int | Секретный код (предоставляется отдельно) | | phone | varchar(16) | Номер абонента в международном формате (без + или 00)| | ip | varchar(15) | IP-адрес пользователя | | | | | === 2.2.3 Формат ответа === Как правило, XML-ответ выглядит следующим образом. <code> <response> <code>0</ code> <desc>code_created</desc> <extra>123</extra> </response> </code> === 2.2.4 Возможные ответы системы === ^Тип ^Статус ^ Описание^ Объяснение^ | **OK** | 0 | phone_good | Номер свободен, подписка может быть создана | | error | 1 | subs_not_supported_for_provider | Услуга не доступна для этого номера | | error | 2 | phone_blacklisted | Номер абонента находится в черном списке | | error | 3 | phone_have_active_subs_already | Услуга уже активирована | | error | 4 | too_much_subs_for_phone | Произошла внутренняя ошибка, слишком много запросов с данного номера | | error | 5 | too_much_subs_for_ip | Слишком много запросов с данного IP | | | | | | Обратите внимание, что статусы, описанные выше, это часть XML-ответа, а не статус HTTP. В любом случае статус HTTP должен быть 200. ==== 2.3 Создание подписки ==== === 2.3.1URL === **Предоставляется в момент создания сервиса* === 2.3.2 Параметры === ^ Параметр ^ Тип ^ Описание^ | command | text | Устанавливается параметр '**create**' | | sid | int | ID услуги (предоставляется отдельно) | | hash | int | Секретный код (предоставляется отдельно) | | phone | varchar(16) | Номер абонента в международном формате (без + или 00) | | ip | varchar(15) | IP-адрес пользователя | === 2.3.3 Формат ответа === Как правило, XML-ответ выглядит следующим образом. <code> <response> <code>0</ code> <desc>code_created</desc> <extra>123</extra> </response> </code> === 2.3.4 Возможные ответы системы === ^ Тип ^ Статус ^ Описание ^ Объяснение^ | OK | | 0 | code_created | | error | 1 | subs_not_supported_for_p rovider | Услуга не доступна для этого номера | | error | 2 | phone_blacklisted | Номер абонента находится в черном списке | | error | 3 | phone_have_active_subs_already | Услуга уже активирована | | error | 4 | too_much_subs_for_phone | Произошла внутренняя ошибка, слишком много запросов от номера | | error | 5 | too_much_subs_for_ip | Слишком много запросов с данного IP | | error | 6 | error_on_insert | Внутренняя ошибка. Пожалуйста, попробуйте еще раз. | | | | | | Обратите внимание, что статусы, описанные выше, это часть XML-ответа, а не статус HTTP. В любом случае статус HTTP должен быть 200. ==== 2.4 Проверка пароля ==== === 2.4.1 URL === **Предоставляется в момент создания сервиса** === 2.4.2 Параметры === ^ Параметр ^Тип ^ Описание ^ | command | string | Устанавливается параметр '**check_pin**' | | sid | int | ID услуги (предоставляется отдельно) | | hash | int | Секретный код (предоставляется отдельно) | | phone | varchar(16) | Номер абонента в международном формате (без + или 00) | | ip | varchar(15) | IP-адрес пользователя | | code| int| Код для проверки| === 2.4.3 Формат ответа === Как правило, XML-ответ выглядит следующим образом. <code> <response> <code>0</ code> <desc>pin_good</desc> </response> </code> === Возможные ответы системы === Как правило, XML-ответ выглядит следующим образом. ^Тип ^Статус ^Описание^Объяснение^ | **OK** | 0 | pin_good | Пароль корректный, услуга активирована | | error | 11 | active_code_phone_combination_not_found | Номер находится в черном списке | | error | 13 | code_retries_overlimit | Слишком много попыток ввести пароль. (массовая атака) | | | | | |