使用基于REST的API来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:其数据的用户ID进行更新

$user: 用户的数据

返回值

返回JSON编码的字符串包含用户数据,如果成功的话。否则,返回数组,含有虚假的价值。

User_Get

这个函数返回数据作为参数提供的用户ID。

参数

$user_id: 的用户的ID

$search: 搜索

$value: 值

返回值

返回JSON编码的字符串包含用户数据,如果成功的话。否则,返回数组,含有虚假的价值。

User_Delete

此功能删除一个用户,其ID。

参数

$user_id: 的用户的ID

返回值

返回true,如果删除成功,否则返回false。

User_Extension_Create

这个函数创建扩展为给定的用户。

参数

$user_id: 的用户的ID

$extension: 新扩展的数组,包含数据

返回值

返回JSON编码字符串,其中包含扩展数据,如果成功的。否则,返回数组,含有虚假的价值。

User_Role_List

这个函数返回所有可用的角色。

参数

返回值

返回包含用户的角色,如果成功的JSON编码的字符串。

User_Payment_Create

此功能增加了信贷的用户帐户

参数

$user_id:的用户的ID

$value: 支付的金额增加

$description: 简要说明

$type: 不同的付款

返回值

返回true,如果新增信贷成功,否则返回false.

User_Login

此功能在用户登录。

参数

$session_id: 会话ID

返回值

如果成功返回会话名称,否则返回false。

User_Logout

此功能破坏用户会话,以便登录他出去。

参数

$session_id: 会话ID

返回值

如果成功返回会话名称,否则返回false。

Campaign_Status

此功能提供的运动状态,给予其ID。

参数

$campaign_id: ID的运动,其状态是必需的

返回值

返回JSON编码字符串,其中包含运动状态数据,如果成功的话。

Campaign_Start

此功能启动竞选,给予其ID。

参数

$campaign_id: 在竞选的ID

返回值

返回JSON编码字符串,其中包含运动状态数据,如果成功的话。

Campaign_Stop

此功能将停止竞选,给予其ID。

参数

$campaign_id: 在竞选的ID

返回值

返回JSON编码字符串,其中包含运动状态数据,如果成功的话。

Campaign_Contact_Create

此功能增加了给定的接触将拨打ID给出的运动。

参数

$contact_id: 数组,包含将要创建的联系人数据。

$campaign_id: 在竞选的ID

返回值

返回JSON编码字符串,其中包含运动数据,如果成功。

Campaign_Summary

这个函数返回的运动总结。它会列出在竞选中的每个联系人的状态(忙,充血,无响应,失败)。

参数

$campaign_id: ID的运动,其状态是必需的

$usr_id: ID的用户拥有此活动

返回值

返回JSON编码字符串,其中包含运动数据,如果成功。

Campaign_Result

此功能更新的运动,其状态。

参数

$campaign_id: ID的运动,其状态是必需的

$status: 运动状态

$usr_id: ID的用户拥有此活动

返回值

返回JSON编码的字符串,包含运动数据,如果成功的话.

Contact_Create

这个函数创建一个新的联系人,在指定的组。

参数

$contact: 数组,其中包含联系人数据。

$contact_group_id: 接触组的ID.

返回值

返回JSON编码字符串,其中包含状态的接触,如果成功。

Contact_Delete

此功能消除了接触,给予其ID。

参数

$contact_id: 要删除的联系人的ID。

返回值

返回JSON编码字符串,其中包含状态的接触,如果成功。