Данные об SMS партнёра с возможностью поиска по номеру абонента и текста SMS.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

datefrom - начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
all (необязательный) - 0/1, игнорирование ограничения поиска только за год
abonent (необязательный) - результирующий набор данных будет содержать строки только с номером абонента, указанного в этом параметре
smsbody (необязательный) - результирующий набор данных будет содержать строки, заключенное в текст SMS указанное в этом параметре значение
country (необязательный) - идентификатор страны
operator (необязательный) - идентификатор оператора
smsnums (необязательный) - результирующий набор данных будет содержать строки только с короткими номерами, указанного в этом параметре через запятую ","
status (необязательный) - результирующий набор данных будет содержать строки только с статусом оплаты SMS, указанного в этом параметре (по умолчанию 1): 1-оплачена, 3-претензия, 6-фрод
order (необязательный) - сортировка по полю (по умолчанию по created)
dir (необязательный) - 0/1, направление сортировки: 0 - по убыванию, 1 - по возрастанию (по умолчанию 0)
from (необязательный) - начиная с этого значения в наборе SMS партнёра
limit (необязательный) - количество подсчитываемых SMS партнёра

Структура данных результата:

массив:
- id - идентификатор SMS:
  - created - дата создания (целое значение UNIX_TIMESTAMP)
  - abonent - абонент, отправивший SMS
  - smsnumber - номер, на который был отправлен SMS
  - content - текст SMS
  - answer - ответное SMS абоненту
  - operator - название оператора
  - project - название проекта
  - summ - сумма

Пример запроса: http://api.goldfon.ru/php/sms/sms/stat/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975

Количество SMS партнёра с возможностью выборки по номеру абонента и текста SMS.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

datefrom - начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
all - 0/1, игнорирование ограничения поиска только за год
abonent (необязательный) - результирующий набор данных будет содержать строки только с номером абонента, указанного в этом параметре
smsbody (необязательный) - результирующий набор данных будет содержать строки, заключенное в текст SMS указанное в этом параметре значение
country (необязательный) - идентификатор страны
operator (необязательный) - идентификатор оператора
smsnums (необязательный) - результирующий набор данных будет содержать строки только с короткими номерами, указанного в этом параметре через запятую ","
status (необязательный) - результирующий набор данных будет содержать строки только с статусом оплаты SMS, указанного в этом параметре (по умолчанию 1): 1-оплачена, 3-претензия, 6-фрод
from (необязательный) - начиная с этого значения в наборе SMS партнёра
limit (необязательный) - количество подсчитываемых SMS партнёра

Результат:
Целое число

Пример запроса: http://api.goldfon.ru/php/sms/sms/count/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975

Статистика по SMS партнёра за последние N дней.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

count - количество дней, отсчитываемых от текущего дня.

Структура данных результата:

массив:
- date:
  - указывает день
- count:
  - количество SMS за соответствующий день
- summ:
  - денежная сумма за соответствующий день
- currency - название валюты, в которых идет расчёт

Пример запроса: http://api.goldfon.ru/php/sms/sms/summary/uid/99999/sid/xxxxxx/count/5

Данные о выплатах партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

datefrom - искать начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
status (необязательный) - статус выплаты, по умолчанию 1
from (необязательный) - начиная с этого значения в наборе выплат партнёра
limit (необязательный) - количество отображаемых выплат партнёра

Структура данных результата:

массив:
- id - идентификатор выплаты
- request_date - дата запроса на выплату партнёром (целое значение UNIX_TIMESTAMP)
- summ - сумма выплаты
- pay_date - дата выплаты партнёру (целое значение UNIX_TIMESTAMP)

Пример запроса: http://api.goldfon.ru/php/sms/pays/read/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975/status/1

Название валюты, в которых идёт расчёт.

Результат:
Строковое значение валюты

Пример запроса: http://api.goldfon.ru/php/sms/pays/currency

Расширенная статистика по SMS партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

group (необязательный) - значение может быть равным "project","operator","country","smsnumber","abonents","abonents_count","contents","contents_count","refferals","refferals_count", "fraud", "fraud_count", "blacklist", "blacklist_count". Группировка данных по проектам, операторам, странам, коротким номерам, абонентам, контенту, реффералам, фродовым абонентским номерам или номерам в черном списке. При этом только параметры "project","operator","country","smsnumber", указаные через запятую "," могут образовывать различные сочетания для мультигруппировки данных.
groupdate (необязательный) - значение может быть равным 'auto' - автоматически в зависимости от периода dateto-datefrom, 'hour' - почасово, 'day' - посуточно, 'weekday' - по дням недели, 'month' - помесячно, 'year' - по годам.
total (необязательный) - если указан, то подсчитывается общее количество сгруппированных данных мультигруппировки
order (необязательный) - сортировка по полю
dir (необязательный) - 0/1, направление сортировки: 0 - по убыванию, 1 - по возрастанию
from (необязательный) - начиная с этой строчки в наборе данных
limit (необязательный) - количество отображаемых строчек набора данных результата
datefrom - искать начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
фильтры:
project (необязательный) - идентификатор проекта для вывода статистики по проектам
abonent (необязательный) - результирующий набор данных будет содержать строки только с номером абонента, указанного в этом параметре
smsbody (необязательный) - результирующий набор данных будет содержать строки, заключенное в текст SMS указанное в этом параметре значение
country (необязательный) - идентификатор страны
operator (необязательный) - идентификатор оператора
smsnums (необязательный) - результирующий набор данных будет содержать строки только с короткими номерами, указанного в этом параметре через запятую ","
status (необязательный) - результирующий набор данных будет содержать строки только с статусом оплаты SMS, указанного в этом параметре (по умолчанию 1): 1-оплачена, 3-претензия, 6-фрод

Структура данных результата при значениях (group="project","operator","country","smsnumber" в любой комбинации или groupdate не равный пустому значению) И total=1:

count - общее количество сгруппированных данных мультигруппировки без учёта from,limit,order,dir

Структура данных результата при указанном параметре group=project:

массив:
- id_project - идентификатор проекта
- title_project - название проекта
- count - количество SMS
- summ - сумма

Структура данных результата при указанном параметре group=operator:

массив:
- id_operator - идентификатор оператора
- parent - идентификатор оператора-родителя
- title_operator - название оператора
- count - количество SMS
- summ - сумма

Структура данных результата при указанном параметре group=country:

массив:
- id_country - идентификатор страны
- title_country - название страны
- count - количество SMS
- summ - сумма

Структура данных результата при указанном параметре group=smsnumber:

массив:
- smsnumber - короткий номер
- count - количество SMS
- summ - сумма

Структура данных результата при указанном параметре group=abonents:

массив:
- data:
  - id - номер телефона абонента, начинающийся на "+"
    - count - количество SMS
    - summ - сумма
- currency - название валюты, в которых идет расчёт

Результат при указанном параметре group=abonents_count:
Целое число - общее количество абонентов, т.е. строк при запросе group=abonents без учёта from,limit,order,dir

Структура данных результата при указанном параметре group=contents:

массив:
- data:
  - id - текст SMS
    - count - количество SMS
    - count_abonents - количество абонентов, приславших SMS с данным текстом
    - summ - сумма
- currency - название валюты, в которых идет расчёт

Результат при указанном параметре group=contents_count:
Целое число - общее количество сгруппированных префиксов в тексте SMS, т.е. строк при запросе group=contents без учёта from,limit,order,dir

Структура данных результата при указанном параметре group=refferals:

массив:
- data:
  - id - цифровой идентификатор рефферала
    - count - количество SMS
    - summ - сумма
- currency - название валюты, в которых идет расчёт

Результат при указанном параметре group=refferals_count:
Целое число - общее количество реффералов, т.е. строк при запросе group=refferals без учёта from,limit,order,dir

Структура данных результата при указанном параметре group=fraud (выборка фродовых абонентских номеров):

массив:
- data:
  - id - номер телефона абонента, начинающийся на "+"
    - count - количество SMS
    - summ - сумма
- currency - название валюты, в которых идет расчёт

Результат при указанном параметре group=fraud_count:
Целое число - общее количество абонентов, т.е. строк при запросе group=fraud без учёта from,limit,order,dir

Структура данных результата при указанном параметре group=blacklist (выборка абонентских номеров со статусом "Блэклист"):

массив:
- data:
  - id - номер телефона абонента, начинающийся на "+"
    - count - количество SMS
    - summ - сумма
- currency - название валюты, в которых идет расчёт

Результат при указанном параметре group=blacklist_count:
Целое число - общее количество абонентов, т.е. строк при запросе group=blacklist без учёта from,limit,order,dir

Структура данных результата для всего остального:

массив:
- date:
  - указывает часы, дни, месяцы в зависимости от диапазон dateto-datefrom
- data:
  - count - количество SMS
  - summ - сумма
- currency - название валюты, в которых идет расчёт

Пример запроса: http://api.goldfon.ru/php/sms/summary/count/uid/99999/sid/xxxxxx/group/country/datefrom/2356/dateto/345363
Пример запроса: http://api.goldfon.ru/php/sms/summary/count/uid/99999/sid/xxxxxx/group/project,country,smsnumber/groupdate/month/datefrom/2356/dateto/345363453

Данные о рассылках SMS партнёром с возможностью выборки по номеру получателя и текста SMS.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

datefrom - начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
all - 0/1, игнорирование ограничения поиска только за год
abonent (необязательный) - результирующий набор данных будет содержать строки только с номером получателя, указанного в этом параметре
smsbody (необязательный) - результирующий набор данных будет содержать строки, заключенное в текст SMS указанное в этом параметре значение
order (необязательный) - сортировка по полю (по умолчанию по created)
dir (необязательный) - 0/1, направление сортировки: 0 - по убыванию, 1 - по возрастанию (по умолчанию 0)
from (необязательный) - начиная с этого значения в наборе SMS-рассылок партнёра
limit (необязательный) - количество подсчитываемых SMS партнёра

Структура данных результата:

массив:
- created - дата создания (целое значение UNIX_TIMESTAMP)
- from_number - отправитель SMS-сообщения, высвечиваемый в SMS на телефоне получателя
- to_number - получатель SMS-сообщения
- content - текст SMS
- count - количество отправленных SMS
- summ - сумма, снимаемая с партнёра
- status - статус смс (cancel, sent, delivered)

Пример запроса: http://api.goldfon.ru/php/sms/delivery/stat/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975

Количество SMS, отправленных партнёром в рассылке с возможностью выборки по номеру получателя и текста SMS.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

datefrom - начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
all - 0/1, игнорирование ограничения поиска только за год
abonent (необязательный) - результирующий набор данных будет содержать строки только с номером получателя, указанного в этом параметре
smsbody (необязательный) - результирующий набор данных будет содержать строки, заключенное в текст SMS указанное в этом параметре значение
from (необязательный) - начиная с этого значения в наборе SMS партнёра
limit (необязательный) - количество подсчитываемых SMS партнёра

Результат:
Целое число

Пример запроса: http://api.goldfon.ru/php/sms/delivery/count/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975

Суммарное количество SMS, отправленных партнёром и соответствующая сумма, списаная с баланса партнёра при рассылке SMS с возможностью выборки по номеру получателя и текста SMS.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

datefrom - начиная с даты (целое значение UNIX_TIMESTAMP)
dateto - заканчивая датой (целое значение UNIX_TIMESTAMP)
all - 0/1, игнорирование ограничения поиска только за год
abonent (необязательный) - результирующий набор данных будет содержать строки только с номером получателя, указанного в этом параметре
smsbody (необязательный) - результирующий набор данных будет содержать строки, заключенное в текст SMS указанное в этом параметре значение
from (необязательный) - начиная с этого значения в наборе SMS партнёра
limit (необязательный) - количество подсчитываемых SMS партнёра

Результат:

count - cуммарное количество SMS, отправленных партнёром
summ - сумма, списаная с баланса партнёра при рассылке SMS

Пример запроса: http://api.goldfon.ru/php/sms/delivery/total/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975

Отправка\Рассылка смс партнёром

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

from - номер отправителя ('6005','6006','6152','6008','6952')
to - номера получателей через запятую
text - текст SMS
transliteration - 0/1, транслитировать текст SMS

Результат:

массив:
- accept - валидные номера
  - номер телефона, на который был отправлен SMS
массив:
- discard - отброшенные номера
  - номер телефона, на который отправить SMS не удалось

Пример запроса: http://api.goldfon.ru/php/sms/delivery/send/uid/99999/sid/xxxxxx/from/6152/to/71234567890/text/Test

Проверка на возможность массовой рассылки SMS партнёром и доступные номера отправителей для SMS-рассылок.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

Результат:

массив:
- can_send: -1 - для партнёра включена платная отправка\рассылка SMS
  0 - лимит бесплатных SMS для рассылки исчерпан
  больше 0 - количество бесплатных SMS для рассылки партнёром
- senders:
  - доступные номера отправителей для SMS-рассылок
- price - цена одного SMS-сообщения при подключенной платной рассылке SMS (can_send=-1)

Пример запроса: http://api.goldfon.ru/php/sms/delivery/status/uid/99999/sid/xxxxxx

Группы контактов адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

group (необязательный) - идентификатор группы, для получения контактов только этой группы.

Структура данных результата:

массив:
- id - идентификатор группы
- title - название группы
- count - количество контактов в группе

Пример запроса: http://api.goldfon.ru/php/sms/delivery/groups/uid/99999/sid/xxxxxx/group/1

Создание группы контактов адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

title - название группы контактов.

Результат:
Целое число - идентификатор группы.

Пример запроса: http://api.goldfon.ru/php/sms/delivery/group_create/uid/99999/sid/xxxxxx/title/Family

Редактирование группы контактов адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

title - название группы контактов.
group - идентификатор редактируемой группы.

Результат:
логический true/false

Пример запроса: http://api.goldfon.ru/php/sms/delivery/group_update/uid/99999/sid/xxxxxx/title/Family/group/1

Удаление группы контактов из адресной книги партнёра.
ВНИМАНИЕ! В ходе удаления группы будут удалены также и контакты этой группы.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

group - идентификатор удаляемой группы контактов.

Результат:
логический true/false

Пример запроса: http://api.goldfon.ru/php/sms/delivery/group_delete/uid/99999/sid/xxxxxx/group/1

Контакты адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

group (необязательный) - идентификатор группы, для получения данных контактов только этой группы.
person (необязательный) - идентификатор контакта, для получения данных только этого контакта.

Структура данных результата:

массив:
- id - идентификатор контакта
- group - идентификатор группы
- firstname - имя
- lastname - фамилия контакта
- patronymic - отчество
- sex - пол
- title - отображаемое имя
- phone - телефон
- date_birth - дата рождения
- comment - комментарий
- field1 - дополнительное поле1
- field2 - дополнительное поле2

Пример запроса: http://api.goldfon.ru/php/sms/delivery/persons/uid/99999/sid/xxxxxx/group/1

Создание контакта адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

group - идентификатор группы
firstname (необязательный) - имя
lastname (необязательный) - фамилия контакта
patronymic (необязательный) - отчество
sex (необязательный) - пол
title - отображаемое имя
phone - телефон
date_birth (необязательный) - дата рождения
comment (необязательный) - комментарий
field1 (необязательный) - дополнительное поле1
field2 (необязательный) - дополнительное поле2

Результат:
Целое число - идентификатор контакта.

Пример запроса: http://api.goldfon.ru/php/sms/delivery/person_create/uid/99999/sid/xxxxxx/title/contact1/group/1/phone/71234567890

Редактирование контакта адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

person - идентификатор контакта

Один или более параметров из:
group - идентификатор группы
firstname - имя
lastname - фамилия контакта
patronymic - отчество
sex - пол
title - отображаемое имя
phone - телефон
date_birth - дата рождения
comment - комментарий
field1 - дополнительное поле1
field2 - дополнительное поле2

Результат:
логический true/false

Пример запроса: http://api.goldfon.ru/php/sms/delivery/person_update/uid/99999/sid/xxxxxx/title/contact1/person/8/phone/71234567890

Удаление контакта из адресной книги партнёра.

Входные параметры:
uid - цифровой идентификатор партнёра
sid - идентификатор сессии партнёра

person - идентификатор удаляемого контакта.

Результат:
логический true/false

Пример запроса: http://api.goldfon.ru/php/sms/delivery/person_delete/uid/99999/sid/xxxxxx/person/8