1 平台概述
1.1 平台介绍
√ 容能云将专业的云服务能力打包成API/SDK，让App、Web端、企业系统轻松接入即时通讯、实时音视频、短信服务、通讯办公、流量/红包、云计算/存储等多种专业能力，提升开发和使用效率。
√ 容能云全面支持Android、iOS、Web、PC多平台，构建安全、稳定和技术领先的云通讯PaaS服务平台。
1.2 服务对象与应用场景
√ 个人开发者、初创企业、互联网公司
√ 软件开发商、软件服务提供商
√ 一定开发实力的企业用户
√ 其他云服务需求的用户
1.3 平台优势
√ 多能力接口支持
容能云提供丰富的云通信能力接口。
√ 定制化的营销能力
包括红包口令，注册奖励，签到奖励等丰富的营销推广能力
√ 多维度的大数据分析能力
容能云提供大数据分析能力
√ 多平台支持
包括 Server, iOS, androird, Windows,web, H5。
√ 快速接入
应用可以在两小时内接入容能云平台
√ 服务保障
丰富的技术文档，高效的在线技术服务，7x24小时在线，是你开发的坚强后盾
2 平台框架图
3 接入能力列表
| 能力编号 | 能力接入说明文档 | 能力接入demo | 备注 |
| 短信能力 | |||
| 流量能力 | |||
| 红包能力 | |||
| 语音能力 | |||
| 电话会议能力 | |||
| 音频能力 | |||
| 视频能力 | |||
| 直播能力 | |||
| im能力 | |||
| 用户能力 | |||
| 运营能力 | |||
| app快速接入 | |||
| 组织能力 | |||
| 用户关系能力 |
4 名词解释
| 名词 | 解释 | 备注 |
| App Id | 应用标识 | |
| App Key | 应用客户端使用的密钥 | |
| App Secret | 应用服务端使用的密钥 | 必须放在app server |
| App User Id | 应用访问用户id | |
| 完全托管 | 用户资料放在云通信平台上 | |
| 非托管 | 用户资料放在开发者自己的应用服务器上 |
5 状态码表
状态码下载：状态码.xlsx
| 所属模块 | 状态码编码 | 状态码含义 | |
| 全局 | 1000 | 成功 | |
| 1111 | 失败 | ||
| 2221 | 参数非法 | ||
| 2222 | 授权失败 | ||
| 9999 | 系统异常 | ||
| 鉴权中心 | 111001 | 签名无效 | |
| 111002 | token无效 | ||
| 111003 | 签名时间已过期 | ||
| 111004 | 应用被禁用 | ||
| 111005 | 应用不存在 | ||
| 111006 | 无响应能力权限 | ||
| 用户能力 | 140101 | 用户ID为空 | |
| 140102 | 用户不存在 | ||
| 140103 | 用户名为空 | ||
| 140104 | 密码为空 | ||
| 140105 | 原密码为空 | ||
| 140106 | 新密码为空 | ||
| 140107 | 密码错误 | ||
| 140108 | 原密码错误 | ||
| 140109 | 好友申请设置为空 | ||
| 140110 | 用户名已经存在 | ||
| 140111 | 手机号为空 | ||
| 140112 | 短信验证码为空 | ||
| 140113 | uuid为空 | ||
| 140114 | 短信验证失败 | ||
| 140115 | 邮箱为空 | ||
| 140116 | 邮箱和手机不能同时为空 | ||
| 140117 | 手机号已存在 | ||
| 140118 | 邮箱已存在 | ||
| 140119 | 手机号和邮箱不能同时为空 | ||
| 140120 | 搜索条件为空 | ||
| 140121 | 密码最多只能40个字符 | ||
| 短信能力 | 150101 | 应用ID为空 | |
| 150102 | 应用不存在或被禁用 | ||
| 150103 | 获取应用异常 | ||
| 150104 | 短信签名ID为空 | ||
| 150105 | 短信签名不存在 | ||
| 150106 | 短信模板Code为空 | ||
| 150107 | 短信模板不存在 | ||
| 150108 | 短信接收号码为空 | ||
| 150109 | 短信接收号码错误 | ||
| 150110 | 开发者ID为空 | ||
| 150111 | 开发者不存在 | ||
| 150112 | 获取开发者异常 | ||
| 150113 | 账户余额不足以支付 | ||
| 150114 | 暂不支持该国家/地区短信 | ||
| 150115 | 超出应用每天限制发送次数 | ||
| 150116 | 单位时间内请求过于频繁 | ||
| 150205 | 流量计费异常 | ||
| 150206 | 流量计费失败 | ||
| 150207 | 短信在调用计费接口前发现短信短信条数计算有误 | ||
| 150208 | 短信价格错误 | ||
| 150301 | 第三方发送短信异常 | ||
| 150302 | 第三方发送短信失败 | ||
| 150303 | 提交到运营商发送成功 | ||
| 150304 | 提交到运营商发送失败 | ||
| 150305 | 运营商报告发送失败 | ||
| 150306 | 未找到通道商 | ||
| 快速开发能力 | 160100 | 参数为空 | |
| 160101 | 应用id为空 | ||
| 160102 | 应用不存在 | ||
| 160201 | 开发者id为空 | ||
| 160202 | 开发者不存在 | ||
| 160301 | 电话为空 | ||
| 160302 | 电话格式错误 | ||
| 160401 | 验证码为空 | ||
| 160402 | 验证码错误 | ||
| 160403 | 验证码过期 | ||
| 160404 | uuid为空 | ||
| 160405 | 短信发送失败 | ||
| 160406 | 邮件地址为空 | ||
| 160407 | 邮件发送失败 | ||
| 160601 | 计费失败 | ||
| 运营能力 | 170100 | 参数为空 | |
| 170101 | 活动ID为空 | ||
| 170102 | 活动不存在 | ||
| 170103 | 活动暂停 | ||
| 170104 | 活动结束 | ||
| 170105 | 活动未开始 | ||
| 170106 | 已经领取过 | ||
| 170107 | 领取冻结需登录app领取 | ||
| 170108 | 领取已过期 | ||
| 170109 | 开发者id为空 | ||
| 170110 | 数据有误 | ||
| 170111 | 活动类型不匹配 | ||
| 170201 | 电话为空 | ||
| 170202 | 电话格式错误 | ||
| 170203 | 姓名为空 | ||
| 170204 | 验证码为空 | ||
| 170205 | 验证码错误 | ||
| 170206 | 验证码过期 | ||
| 170207 | uuid为空 | ||
| 170208 | 奖品已被领完 | ||
| 170209 | 领取电话已失效 | ||
| 170301 | 注册失败 | ||
| 170302 | appId为空 | ||
| 170303 | 领取码为空 | ||
| 170304 | 没有参与活动记录 | ||
| 170305 | 生产环境APPkey为空 | ||
| 170401 | 红包口令为空 | ||
| 170402 | 红包口令错误 | ||
| 170501 | 工具id不存在 | ||
| 170601 | 流量领取失败 | ||
| 170602 | 此号码已经注册过 | ||
| 流量能力 | 180101 | 应用ID为空 | |
| 180102 | 应用不存在 | ||
| 180103 | 应用不属于当前用户 | ||
| 180104 | 开发者ID为空 | ||
| 180105 | 开发者不存在 | ||
| 180201 | 获取账户异常 | ||
| 180202 | 账户余额不足 | ||
| 180203 | 获取押金异常 | ||
| 180204 | 尚未缴交押金 | ||
| 180205 | 流量计费异常 | ||
| 180206 | 流量计费失败 | ||
| 180301 | 手机号码为空 | ||
| 180302 | 移动套餐包不存在 | ||
| 180303 | 您的充值号码中包含移动号码，请选择移动流量套餐包 | ||
| 180304 | 联通套餐包不存在 | ||
| 180305 | 您的充值号码中包含联通号码，请选择联通流量套餐包 | ||
| 180306 | 电信套餐包不存在 | ||
| 180307 | 您的充值号码中包含电信号码，请选择电信流量套餐包 | ||
| 180401 | 手机号码为空 | ||
| 180402 | 流量接口未开通 | ||
| 180403 | 流量充值异常 | ||
| 180404 | 获取通道参数异常 | ||
| 180405 | 通道为空 | ||
| 组织架构 | 190101 | 用户ID为空 | |
| 190102 | 用户无访问权限 | ||
| 191101 | 公司ID为空 | ||
| 191102 | 公司不存在 | ||
| 191103 | 用户审核记录不存在 | ||
| 191104 | 用户已通过审核 | ||
| 191105 | 公司设置不存在 | ||
| 191106 | 公司名称为空 | ||
| 191107 | 最多只能创建3家公司 | ||
| 191201 | 部门ID为空 | ||
| 191202 | 部门不存在 | ||
| 191203 | 部门名称为空 | ||
| 191204 | 部门父节点不存在 | ||
| 191205 | 部门为根节点 | ||
| 191206 | 旧部门ID为空 | ||
| 191207 | 新部门ID为空 | ||
| 191208 | 部门根节点已存在 | ||
| 191209 | 部门父节点为空 | ||
| 191210 | 部门ID不能为自己以及子孙部门ID | ||
| 191301 | 岗位ID为空 | ||
| 191302 | 岗位不存在 | ||
| 191303 | 岗位名称为空 | ||
| 191304 | 岗位已存在 | ||
| 191401 | 部门员工ID为空 | ||
| 191402 | 部门员工不存在 | ||
| 191403 | 部门员工已存在 | ||
| 191501 | 部门岗位ID为空 | ||
| 191502 | 部门岗位不存在 | ||
| 191503 | 部门岗位已存在 | ||
| 192101 | 员工ID为空 | ||
| 192102 | 员工不存在 | ||
| 192102 | 员工不存在 | ||
| 192103 | 员工的手机号和邮箱同时为空 | ||
| 192104 | 员工的姓名为空 | ||
| 192105 | 员工已经存在 | ||
| 192201 | 员工ID为空 | ||
| 192202 | 员工不存在 | ||
| 192203 | 员工岗位已存在 | ||
| 用户关系能力 | 200101 | 用户ID为空 | |
| 200102 | 用户不存在 | ||
| 200103 | 好友申请设置为空 | ||
| 200301 | 黑名单用户ID为空 | ||
| 200302 | 黑名单用户不存在 | ||
| 200302 | 黑名单用户不存在 | ||
| 200401 | 好友用户ID为空 | ||
| 200402 | 好友用户不存在 | ||
| 200403 | 好友记录不存在 | ||
| 200404 | 好友关系已存在 | ||
| 200501 | 好友申请用户ID为空 | ||
| 200502 | 好友申请用户不存在 | ||
| 200503 | 好友申请记录不存在 | ||
| 200601 | 对方设置不允许任何人添加好友 | ||
| 文件能力 | 211001 | 文件大小限制 | |
| 211002 | 文件名长度限制 | ||
| Im能力 | 220001 | 非法数据包 | |
| 220002 | 系统内部错误 | ||
| 220003 | 非法用户 | ||
| 220004 | 其它错误 | ||
| 220005 | 非法接收方 | ||
| 221001 | 无法连接登录服务 | ||
| 221002 | 无法连接数据库服务 | ||
| 221003 | 无法连接路由服务 | ||
| 221004 | 无法连接推送服务 | ||
| 221005 | 用户重复登录 | ||
| 221006 | 非法时间戳 | ||
| 222001 | 非法会话 | ||
| 222002 | 非法会话类型 | ||
| 223001 | 非法群操作 | ||
| 223002 | 用户不是群主 | ||
| 223003 | 用户不是群成员 | ||
| 223004 | 用户不是管理员 | ||
| 223005 | 用户已经是群主 | ||
| 223006 | 用户已经是群成员 | ||
| 223007 | 用户已经是管理员 | ||
| 223008 | 没有新成员可加 | ||
| 223100 | 群其他错误 | ||
| 224001 | 获取消息信息失败 | ||
| 224002 | 删除所有会话失败 | ||
| 224003 | 删除用户会话失败 | ||
| 224004 | 获取消息失败 | ||
| 224005 | 非消息发送方 | ||
| 224006 | 消息状态不正确 | ||
| 224007 | 已超过两分钟，无法撤回 | ||
| 224008 | 非法的消息类型 | ||
| 224009 | 没有权限 | ||
| 224010 | 非法的关系ID | ||
| 224011 | 双方将彼此列入黑名单 | ||
| 224012 | 每分种发送消息数过多 | ||
| 224013 | 非法的消息 | ||
| 224014 | 您已被对方列入黑名单 | ||
| 224015 | 您已将对方列入黑名单 | ||
| 224016 | 您已被禁言 | ||
| 224017 | 该群已被禁言 | ||
| 224100 | 其它消息错误 | ||
| 220001 | 非法数据包 | ||
| 220002 | 系统内部错误 | ||
| 220003 | 非法用户 | ||
| 220004 | 其它错误 | ||
| 220005 | 非法接收方 | ||
| 音视频 | 235001 | 无效的安全令牌 | |
| 235002 | 没有路由服务器 | ||
| 235003 | 没有消息服务器 | ||
| 235004 | 没有UDP服务器 | ||
| 235005 | 创建音视频服务失败 | ||
| 235006 | 音视频服务被拒绝 | ||
| 235007 | 音视频服务超时 | ||
| 235008 | 没有音视频UDP服务器 | ||
| SDK | Android | 910001 | 未知错误 |
| 910002 | 服务器出错 | ||
| 910003 | 网络错误 | ||
| 910004 | 请求取消 | ||
| 910005 | 无效的状态码,服务端返回的状态码有误 | ||
| 910006 | 无效的PB数据，服务端返回数据错误 | ||
| 910007 | 超时 | ||
| iOS | 920001 | 参数错误 | |
| 920002 | 主机名错误 | ||
| 920003 | connect失败 | ||
| 920004 | 连接im返回失败 | ||
| 921001 | 错误的基数 | ||
| 921002 | 登录服务器返回消息错误 | ||
| 921003 | 消息服务器列表获取失败：返回的消息格式错误等 | ||
| 929999 | 网络请求返回未定义的错误 | ||
6 SDK
6.1 SDK下载
6.2 SDK-API
7 更新日志
7.1 Server
[1.0.0][发布] 2017年5月2日
Server端 短信能力上线 |
7.2 iOS
[1.0.0][新增] 2017年5月2日
iOS的sdk版本上线 |
7.3 Android
[1.0.0][新增] 2017年5月2日
Android的sdk版本上线 |
7.4 Windows
[1.0.0][新增] 2017年5月2日
Windows端文件上传能力上线 |
7.5 Web
[1.0.0][发布] 2017年5月2日
Web端 短信能力上线 |
8 常见问题
8.1 Server
8.2 iOS
8.3 Android
8.4 Windows
8.5 web
9 服务协议列表
√ 平台注册协议链接
√ 平台服务协议链接
