首页 - 欢迎 登录  
欢迎使用 CentPBX 接口文档管理工具 v2.X版
什么是 CentPBX 接口文档管理工具?
    是一个关于"CentPBX"的API开发文档,其致力于为第三方应用快速接入"CentPBX"呼叫系统提供权威参考文档和接入代码例子。
        
接口基础规范说明
1)接口请求域名
    1.1 http接口请求域名暂时放到测试机服务器,域名为:http://demo.centpbx.com , 所有请求接口URL地址都需要附加此域名作为前缀。
2)请求说明
    2.1 一般支持常见的表单请求格式: 普通的get/post表单提交,请求头是: application/x-www-form-urlencoded
    2.2 部分接口也支持post json的请求格式: post提交json数据,请求头是: application/json
    2.3 基于安全的原因,默认情况下第三方应用调用电话相关接口需要携带token
      用户也可以在后台【服务器和系统】——【系统配置】——【系统参数设置】菜单的"接口安全设置"选项卡中关闭token校验
3)响应说明
    3.1 响应数据一般按照如下格式给出:
{result: "string", code: int, msg: "string", data: array/object/null} 例如: 错误的响应 { result: "error", ##优先用result字段来判断结果, success:成功,error: 错误 code: 500, ##参考了http的状态码,状态码为200表示成功,其它表示请求失败。仅供参考 msg: "响应消息,仅供参考", data: null ##如果接口请求成功,data字段包含请求的相关数据 }
例如: 正确的响应 { "result": "success", "code": 200, "msg": "登录成功!", "data": { "uid": 1, "username": "admin", "mobile": "", "email": "", "role_id": 1, "role_name": "超级管理员", "nick": "超级管理员", "token": "OJLAYYDRVYGYZ3QTBQMAEPGSPOX51IN6LFCJ050XI7L1WUKT" } }