|
Данные по смс, выплатам
Controller: sms
Содержание:
Method: stat
Данные об 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 партнёра Структура данных результата:
Пример запроса: http://api.goldfon.ru/php/sms/sms/stat/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975 Method: count
Количество 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 Method: summary
Статистика по SMS партнёра за последние N дней.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра count - количество дней, отсчитываемых от текущего дня. Структура данных результата:
Пример запроса: http://api.goldfon.ru/php/sms/sms/summary/uid/99999/sid/xxxxxx/count/5 Method: read
Данные о выплатах партнёра.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра datefrom - искать начиная с даты (целое значение UNIX_TIMESTAMP) dateto - заканчивая датой (целое значение UNIX_TIMESTAMP) status (необязательный) - статус выплаты, по умолчанию 1 from (необязательный) - начиная с этого значения в наборе выплат партнёра limit (необязательный) - количество отображаемых выплат партнёра Структура данных результата:
Пример запроса: http://api.goldfon.ru/php/sms/pays/read/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975/status/1 Method: currency
Название валюты, в которых идёт расчёт.
Результат: Строковое значение валюты Пример запроса: http://api.goldfon.ru/php/sms/pays/currency Method: count
Расширенная статистика по 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:
Структура данных результата при указанном параметре group=project:
Структура данных результата при указанном параметре group=operator:
Структура данных результата при указанном параметре group=country:
Структура данных результата при указанном параметре group=smsnumber:
Структура данных результата при указанном параметре group=abonents:
Результат при указанном параметре group=abonents_count: Целое число - общее количество абонентов, т.е. строк при запросе group=abonents без учёта from,limit,order,dir Структура данных результата при указанном параметре group=contents:
Результат при указанном параметре group=contents_count: Целое число - общее количество сгруппированных префиксов в тексте SMS, т.е. строк при запросе group=contents без учёта from,limit,order,dir Структура данных результата при указанном параметре group=refferals:
Результат при указанном параметре group=refferals_count: Целое число - общее количество реффералов, т.е. строк при запросе group=refferals без учёта from,limit,order,dir Структура данных результата при указанном параметре group=fraud (выборка фродовых абонентских номеров):
Результат при указанном параметре group=fraud_count: Целое число - общее количество абонентов, т.е. строк при запросе group=fraud без учёта from,limit,order,dir Структура данных результата при указанном параметре group=blacklist (выборка абонентских номеров со статусом "Блэклист"):
Результат при указанном параметре group=blacklist_count: Целое число - общее количество абонентов, т.е. строк при запросе group=blacklist без учёта from,limit,order,dir Структура данных результата для всего остального:
Пример запроса: 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 Method: stat
Данные о рассылках 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 партнёра Структура данных результата:
Пример запроса: http://api.goldfon.ru/php/sms/delivery/stat/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975 Method: count
Количество 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 Method: total
Суммарное количество SMS, отправленных партнёром и соответствующая сумма, списаная с баланса партнёра при рассылке 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/total/uid/99999/sid/xxxxxx/from/0/limit/20/datefrom/323765/dateto/2034975 Method: send
Отправка\Рассылка смс партнёром
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра from - номер отправителя ('6005','6006','6152','6008','6952') to - номера получателей через запятую text - текст SMS transliteration - 0/1, транслитировать текст SMS Результат:
Пример запроса: http://api.goldfon.ru/php/sms/delivery/send/uid/99999/sid/xxxxxx/from/6152/to/71234567890/text/Test Method: status
Проверка на возможность массовой рассылки SMS партнёром и доступные номера отправителей для SMS-рассылок.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра Результат:
Пример запроса: http://api.goldfon.ru/php/sms/delivery/status/uid/99999/sid/xxxxxx Method: groups
Группы контактов адресной книги партнёра.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра group (необязательный) - идентификатор группы, для получения контактов только этой группы. Структура данных результата:
Пример запроса: http://api.goldfon.ru/php/sms/delivery/groups/uid/99999/sid/xxxxxx/group/1 Method: group_create
Создание группы контактов адресной книги партнёра.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра title - название группы контактов. Результат: Целое число - идентификатор группы. Пример запроса: http://api.goldfon.ru/php/sms/delivery/group_create/uid/99999/sid/xxxxxx/title/Family Method: group_update
Редактирование группы контактов адресной книги партнёра.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра title - название группы контактов. group - идентификатор редактируемой группы. Результат: логический true/false Пример запроса: http://api.goldfon.ru/php/sms/delivery/group_update/uid/99999/sid/xxxxxx/title/Family/group/1 Method: group_delete
Удаление группы контактов из адресной книги партнёра.
ВНИМАНИЕ! В ходе удаления группы будут удалены также и контакты этой группы. Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра group - идентификатор удаляемой группы контактов. Результат: логический true/false Пример запроса: http://api.goldfon.ru/php/sms/delivery/group_delete/uid/99999/sid/xxxxxx/group/1 Method: persons
Контакты адресной книги партнёра.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра group (необязательный) - идентификатор группы, для получения данных контактов только этой группы. person (необязательный) - идентификатор контакта, для получения данных только этого контакта. Структура данных результата:
Пример запроса: http://api.goldfon.ru/php/sms/delivery/persons/uid/99999/sid/xxxxxx/group/1 Method: person_create
Создание контакта адресной книги партнёра.
Входные параметры: 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 Method: person_update
Редактирование контакта адресной книги партнёра.
Входные параметры: 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 Method: person_delete
Удаление контакта из адресной книги партнёра.
Входные параметры: uid - цифровой идентификатор партнёра sid - идентификатор сессии партнёра person - идентификатор удаляемого контакта. Результат: логический true/false Пример запроса: http://api.goldfon.ru/php/sms/delivery/person_delete/uid/99999/sid/xxxxxx/person/8 |