云讯API索引

查询余额

xunzhong.queryBlance

返回当前特定账户的余额。

优先必读 公共参数 请求参数 响应参数 请求包头
报文示例 请求示例 响应示例 异常示例 错误码示例

优先必读

1: 用户账户Id(accountSID)和用户账户授权令牌(authToken)在哪获取？
提示: 用户登录平台，在导航菜单管理-控制台-开发者主账号下面,
或用户登录平台，在导航菜单管理-体验-功能体验-账号信息下面。(两种获取到账户信息是一样的)
2: 应用ID在哪获取？
提示: 1.如果使用沙箱环境http://sandbox.ytx.net，用户登录平台，在导航菜单管理-体验-功能体验-测试应用下面。
2.如果使用正式环境http://api.ytx.net，用户登录平台，在导航菜单管理-应用管理-应用列表下，若没有应用，需要创建应用。(注:应用上线后,应用ID才有效)
3: 状态回推的相关设置？
提示: (注:沙箱环境http://sandbox.ytx.net,没有相关设置)
在使用正式环境http://api.ytx.net下,用户登录平台，在导航菜单管理-应用管理-创建应用-设置相应的回调地址。
4: IP鉴权地址的相关配置？
提示: (注:沙箱环境http://sandbox.ytx.net,没有相关设置)
在使用正式环境http://api.ytx.net下,用户登录平台，在导航菜单管理-应用管理-创建应用-设置相应的IP白名单。
(注:如测试使用ip白名单,切记将测试主机ip加入到白名单中)
有需要对用户接口发送的服务器进行ip限制，就可以使用ip鉴权进行配置。多个ip使用英文,号分隔。配置空表示不鉴权。
5: 签名sign的加密格式是什么？
提示: MD5加密（账户Id + 账户授权令牌 +时间戳)，例如：Sign=AAABBBCCCDDDEEEFFFGGG *时间戳需与Authorization中时间戳相同(时间戳格式:yyyyMMddHHmmss) 注:MD5加密32位,无论大小写
6: 应用验证失败原因(-205)与解决办法？
提示: 1.应用ID与环境不匹配:
①体验里应用ID与沙箱环境http://sandbox.ytx.net使用  ②自己创建的应用的应用ID与正式环境http://api.ytx.net使用
2.设置ip白名单:
①去掉白名单在测试  ②将测试主机ip加入到白名单中
3.应用未开通相应的功能或应用没有上线。

公共参数

请求地址：

环境 HTTP请求地址
正式环境 http://api.ytx.net
沙箱环境 http://sandbox.ytx.net

公共请求参数：

名称 类型 是否必须 描述
accountSID string 是 云通信平台用户账户Id：对应管理控制台中的 ACCOUNT SID
authToken string 是 云通信平台用户账户授权令牌：对应管理控制台中的 AUTH TOKEN
version string 是 云通信API接口版本 目前可选版本：201612
func string 是 功能所属分类call【语音类】/sms【消息类】/traffic【流量类】/account【账户类】 当前功能属：account
funcURL string 是 业务功能的各类具体操作分支 当前功能属：getBlance.wx
Authorization string 是 云通信平台API接口，包头验证信息：base64加密(账户Id + "|" + 时间戳)  说明：时间戳有效时间为24小时 格式"yyyyMMddHHmmss"，如：20140416142030
Sign string 是 云通信平台API接口，API 验证参数 ：MD5加密（账户Id + 账户授权令牌 +时间戳)   *URL后必须带有Sign参数，例如：Sign=AAABBBCCCDDDEEEFFFGGG   *时间戳需与Authorization中时间戳相同  注:MD5加密32位,无论大小写

请求参数

名称 类型 是否必须 描述
action string 是 API接口名称，默认值：queryBlance（区分大小写）
appid string 是 沙箱环境调用沙箱环境的appid,正式环境调用正式环境的appid(注:在已上线应用中任选一个即可)。

响应参数

名称 类型 示例值 描述
AccountSID string 157ca25671d64d9e98fe47e956ca1e86 用户账户id
Blance double 1212 账户余额

请求包头

1 URL
2 /{version}/sid/{accountSID}/{func}/{funcURL}?Sign={Sign}
3 HTTP标准包头字段
4 Accept:application/json;
5 Content-Type:application/json;charset=utf-8;
6 Authorization:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

报文示例

JSON示例

1 POST /201612/sid/157ca25671d64d9e98fe47e956ca1e86/account/getBlance.wx?Sign=5af9c7fc79ebb0380fec
8a132a73a726 HTTP/1.1
2 Host:127.0.0.1:46376
3 content-length:80
4 Accept:application/json;
5 Content-Type:application/json;charset=utf-8;
6 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
7 {"action":"queryBlance","appid":"f3a1e85827d34072a7fcb16f70748cbb"}

请求示例

.Net

1 string jsonData = "{\"action\":\"queryBlance\",\"appid\":\"f3a1e85827d34072a7fcb16f70748cbb\"}";
2 string url = "/account/getBlance.wx";
3 string result = CommenHelper.SendRequest(url, jsonData);
4 备注： SendRequest方法在CommenHelper.cs文件里做了封装。详细介绍请点击这里；完整demo示例，下载。

PHP

1 $demo = new ytx();
2 $confid ="557896";
3 $ret = $demo->queryMeeting($confid);下载。

响应示例

JSON示例

1 HTTP/1.1 200 OK
2 Content-Length: 85
3 {"AccountSID":"157ca25671d64d9e98fe47e956ca1e86","Blance":1212.00}

异常示例

JSON示例

1 HTTP/1.1 200 OK
2 Content-Length: 61
3 {"statusCode":"-2","statusMsg":"缺少必要参数","requestId":""}

错误码示例

错误码 错误描述 解决方案
0 提交成功
-1 号码无效
-2 缺少必要参数 调用接口时，请传入足够的参数
-3 无效action 传入正确的action
-4 无效的JSON 请遵守正确json语法
-100 异常错误 异常错误
-101 参数不合法 传入符合要求的参数
-102 电话号码不合法 传入正确的电话号码
-200 无此用户 登录官网开通服务账号
-201 用户状态失效 登录官网重新激活服务账号
-202 包头验证信息错误 包头验证信息超时，默认有效时间十分钟，请在有效时间内完成请求
-203 AuthToken验证失败 登录官网获取正确的AuthToken
-204 账户余额不足 登录官网充值
-205 应用验证失败 详情请看[优先必读]
未知错误 联系客服，反应相关问题，促进更好的使用体验。