服务端接口文档
1 统一请求报头
1.1 Base URL
一键登录API引用的地址有Base URL。
生产环境的Base URL：
注意： 为了确保数据隐私，云通讯平台的 API是通过HTTPS方式请求。支持IP白名单功能，现需要联系商务经理配置ip白名单。
1.2 业务URL
Base URL与业务URL相拼接为完整请求URL
业务URL格式：
- /v1/account/{accountId}/mobile/verify?sig={SigParameter}
在URL格式中 {}内的内容表示为参数，非{}的内容固定不变。
Base URL与业务URL相拼接为完整请求URL，完整URL示例：
- https://aim-mobileauth.yuntongxun.com/v1/account/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/mobile/verify?sig=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1.3 HTTP标准包头字段
- Accept:application/xml;
- Content-Type:application/json;charset=utf-8;
- Authorization:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
属性说明:
| 属性 | 类型 | 约束 | 说明 |
| accountSid | String | 必选 | 账户Id。由32个英文字母和阿拉伯数字组成的账户唯一标识符 |
SigParameter | String | 必选 | 验证参数，请求URL必须带有此参数，生成规则： |
| Accept | String | 必选 | 客户端响应接收数据格式：application/json |
| Content-Type | String | 必选 | 类型：application/json;charset=utf-8 |
Authorization | String | 必选 | 验证信息，生成规则： 1.使用Base64编码（账户Id + 冒号 + 时间戳）其中账户Id根据url的验证级别对应主账户 2.冒号为英文冒号 3.时间戳是当前系统时间，格式"yyyyMMddHHmmss"，需与SigParameter中时间戳相同。 |
2 一键登录获取号码
2.1 请求地址
- POST /v1/account/{accountId}/mobile/login/query?sig={SigParameter}
2.2 参数说明
| 请求参数 | ||||
| 接口字段名 | 接口字段编码 | 约束 | 类型 | 备注 |
| 子账户Id | appId | 必填 | String | 由商务经理提供 |
| 取号令牌 | token | 必填 | String | APP端获取的运营商令牌 |
| 响应参数 | ||||
| 接口字段名 | 接口字段编码 | 约束 | 字段类型 | 备注 |
| 状态码 | statusCode | 必选 | String | 详见文档状态码部分 |
| 状态码描述 | statusMsg | 必选 | String | |
| 手机号 | mobile | 可选 | String | |
| 流水号 | msgId | 必选 | String |
2.3 请求示例
- POST https://aim-mobileauth.yuntongxun.com/v1/account/{accountId}/mobile/login/query?sig={SigParameter} HTTP/1.1
- Host:192.168.0.1:8883
- content-length: 139
- Accept:application/json;
- Content-Type:application/json;charset=utf-8;
- Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
- {“appId”:”xx”, “token”:”xx”}
2.4 响应示例
- HTTP/1.1 200 OK
- Content-Length: 641
- {"statusCode":"000000","statusMsg":"succ",”mobile”:”xx”, “seqId”:”xx”}
3 本机号码校验
3.1 请求地址
- POST /v1/account/{accountId}/mobile/verify?sig={SigParameter}
3.2 参数说明
| 请求参数 | ||||
| 接口字段名 | 接口字段编码 | 约束 | 类型 | 备注 |
| 子账户Id | appId | 必填 | String | 由商务经理提供 |
| 取号令牌 | token | 必填 | String | APP端获取的运营商令牌 |
| 手机号码 | mobile | 必填 | String | |
| 响应参数 | ||||
| 接口字段名 | 接口字段编码 | 约束 | 字段类型 | 备注 |
| 状态码 | statusCode | 必选 | String | 详见文档状态码部分 |
| 状态码描述 | statusMsg | 必选 | String | |
| 验证结果 | result | 可选 | int | 0:一致，1:不一致，2:未知 |
| 流水号 | msgId | 必选 | String |
3.3 请求示例
- POST https://aim-mobileauth.yuntongxun.com/v1/account/{accountId}/mobile/verify?sig={SigParameter} HTTP/1.1
- Host:192.168.0.1:8883
- content-length: 139
- Accept:application/json;
- Content-Type:application/json;charset=utf-8;
- Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
- {“appId”:”xx”, “token”:”xx”, “mobile”:”xx”}
3.4 响应示例
- HTTP/1.1 200 OK
- Content-Length: 641
- {"statusCode":"000000","statusMsg":"succ",”result”:0, “msgId”:”xx”}
4 状态码
| 状态码statusCode | 状态码描述 |
| 000000 | success |
| 590000 | 未知错误 |
| 590001 | BODY为空 |
| 590002 | 内部错误 |
| 590005 | 访问运营商异常 |
| 590006 | BODY格式有误 |
| 591001 | 请求参数subAccId为空 |
| 591002 | 请求参数bundleId为空 |
| 591003 | 请求参数appId为空 |
| 591004 | 请求参数token为空 |
| 591005 | 请求参数os为空 |
| 591006 | URI参数accountId为空 |
| 591007 | accountId不合法 |
| 591008 | subAccId不合法 |
| 591009 | 子帐号不属于主账号 |
| 591010 | 主账号状态不可用 |
| 591011 | 子账号状态不可用 |
| 591012 | 账户未在运营商报备 |
| 591013 | 运营商信息为空 |
| 591014 | 请求参数token不合法 |
| 591015 | 帐号不支持号码认证功能 |
| 591016 | 帐号余额不足 |
| 591017 | 请求参数packageName为空 |
| 591018 | 请求参数packageSign为空 |
| 591019 | 请求参数device为空 |
| 591020 | 请求参数version为空 |
| 591021 | 请求参数packageName或packageSign不合法 |
| 591022 | 请求参数bundleId不合法 |
| 591023 | 请求参数sign为空 |
| 591024 | 请求参数sign不合法 |
| 591025 | 请求参数random为空 |
| 591026 | 请求报头Content-Type为空 |
| 591027 | 不支持Chunked传输协议 |
| 591028 | 请求报头ContentLenth为空 |
| 591029 | 请求报头Authorization为空 |
| 591030 | 请求报头Authorization不合法 |
| 591031 | 请求报头Authorization中时间戳已过期 |
| 591032 | 请求报头Authorization中帐号ID和URL中帐号ID不同 |
| 591033 | 请求IP不在白名单内 |
| 591034 | 接口请求超过规定的并发数 |
| 591035 | 运营商应用状态不可用 |
| 591036 | 运营商状态不可用 |
| 592000 | 系统繁忙 |