Использование API REST на основе интеграции ICTBroadcast с третьей стороной применения и автоматизации автоматического дозвона на платные

Ниже представлен список API, мы предоставляем для интеграции с сторонними приложениями для достижения полной автоматизации и бесшовной функциональность.

REST API

Это REST API предоставляет внешний интерфейс вызывать некоторые важные функции ICTBroadcast. ICTBroadcast определяет 3 класса API_User, API_contact и API_Campaign в REST API, который определяет все функции, необходимые для доступа из вне сферы применения. Ниже приведен пример кода описывает, как вызывать эти функции:

User_Create

Эта функция создает нового пользователя в ICTBroadcast. Следующий код описывает, как вызвать эту функцию.

Параметры


$user: упорядоченный массив, содержащие пользовательские данные

Возвращаемое значение


Возвращает массив, содержащий данные пользователя в случае успеха. В противном случае возвращает массив, содержащий ложные ценности.

User_Update

Эта функция обновляет данные пользователей.

Параметры


$user_id: Идентификатор пользователя, данные которого в обновлении


$user: Данные пользователя

Возвращаемое значение


Возвращает строку в кодировке JSON, содержащие пользовательские данные в случае успеха. В противном случае возвращает массив, содержащий ложные ценности.

User_Get

Эта функция возвращает данные пользователя, идентификатор которого передан в качестве аргумента.

Параметры


$user_id: Идентификатор пользователя


$search: поиск


$value: значение

Возвращаемое значение


Возвращает строку в кодировке JSON, содержащие пользовательские данные в случае успеха. В противном случае возвращает массив, содержащий ложные ценности.

User_Delete

Эта функция удаляет пользователя, идентификатор которого передан.

Параметры


$user_id: Идентификатор пользователя

Возвращаемое значение


Возвращает истину, если удалить успешной противном случае возвращает ложь.

User_Extension_Create

Эта функция создает расширения для данного пользователя.

Параметры


$user_id: Идентификатор пользователя


$extension: массив, содержащий данные для нового расширения

Возвращаемое значение


Возвращает JSON закодированная строка содержащая данные расширения в случае успеха. В противном случае возвращает массив, содержащий ложные ценности.

User_Role_List

Эта функция возвращает все доступные роли.

Параметры


Ни один

Возвращаемое значение


Возвращает JSON закодированная строка содержащая ролей пользователей в случае успеха.

User_Payment_Create

Эта функция добавляет кредит в учетной записи пользователя

Параметры


$user_id: Идентификатор пользователя


$value: уплаченной суммы, чтобы добавить


$description: краткое описание


$type: тип оплаты

Возвращаемое значение


Возвращает истину, если добавить успешной кредитной противном случае возвращает ложь.

User_Login

Эта функция входит в систему пользователя.

Параметры


$session_id: ID сессии

Возвращаемое значение


Возвращает имя сеанса в случае успеха противном случае возвращает ложь.

User_Logout

Эта функция уничтожающих пользовательские сессии для того, чтобы войти его.

Параметры


$session_id: ID сессии

Возвращаемое значение


Возвращает имя сеанса в случае успеха противном случае возвращает ложь.

Campaign_Status

Эта функция выдает статус кампании, идентификатор которого дано.

Параметры


$campaign_id: ID кампании, состояние которого требуется

Возвращаемое значение


Возвращает JSON закодированная строка, содержащая данные статус кампании в случае успеха.

Campaign_Start

Эта функция начинает кампанию, идентификатор которого дано.

Параметры


$campaign_id: ID кампании

Возвращаемое значение


Возвращает JSON закодированная строка, содержащая данные статус кампании в случае успеха.

Campaign_Stop

Эта функция останавливает кампанию, идентификатор которого дано.

Параметры


$campaign_id: ID кампании

Возвращаемое значение


Возвращает JSON закодированная строка, содержащая данные статус кампании в случае успеха.

Campaign_Contact_Create

Данная функция предназначена для данного контакта, который будет набран в ходе кампании, идентификатор которого дано.

Параметры


$contact_id: Массив, содержащий контактную информацию, которая будет создана.


$campaign_id: ID кампании

Возвращаемое значение


Возвращает строку в кодировке JSON содержащие данные, если кампанию успешной.

Campaign_Summary

Эта функция возвращает резюме кампании. Это будет список статуса (занят, заторы, нет ответа, не удалось) каждого контакта в кампании.

Параметры


$campaign_id: ID кампании, состояние которого требуется


$usr_id: Идентификатор пользователя владеет этой кампании

Возвращаемое значение


Возвращает строку в кодировке JSON содержащие данные, если кампанию успешной.

Campaign_Result

Эта функция обновляет кампании, его статус.

Параметры


$campaign_id: ID кампании, состояние которого требуется


$status: Статус кампании


$usr_id: Идентификатор пользователя владеет этой кампании

Возвращаемое значение


Возвращает строку в кодировке JSON содержащие данные, если кампанию успешной.

Contact_Create

Эта функция создает новый контакт в указанную группу.

Параметры


$contact: Массив, содержащий контактные данные.


$contact_group_id: ID контактной группы.

Возвращаемое значение


Возвращает JSON кодируется строка, содержащая состояние контакта в случае успеха.

Contact_Delete

Эта функция удаляет контакт, ID дается.

Параметры


$contact_id: Идентификатор контакта удалить.

Возвращаемое значение


Возвращает JSON кодируется строка, содержащая состояние контакта в случае успеха.