分配短信接口
更新时间:2023-08-4
1.功能说明
1.1.通过该接口可以给子账户分配短信,或者本账户不同产品之间进行转账;
1.2.接口调用地址:http(s)://api.guoyangyun.com/api/user/transfer.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式)。
1.5.汉字字符集:UTF-8,请注意参数的大小写。
1.2.接口调用地址:http(s)://api.guoyangyun.com/api/user/transfer.htm
1.4.请求方式:以HTTP POST请求的方式(推荐使用post方式)。
1.5.汉字字符集:UTF-8,请注意参数的大小写。
2.输入参数
参数 | 名称 | 类型 | 必须 | 描述 |
公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
quantity | 分配数量 | String | 是 | 分配的数量 |
ownerInstanceId | 原产品账户ID | String | 是 | 转出自产品账户 |
receiverInstanceId | 目标产品账户ID | String | 是 | 转入至产品账户 |
3.调用示例
http(s)://api.guoyangyun.com/api/user/transfer.htm?appkey=XXXXX&appsecret=XXXXX&username=guoyang001&quantity=XX&ownerInstanceId=XXXXXXXX&receiverInstanceId=XXXXXXX
4.Json返回
4.1.返回参数
参数 | 名称 | 类型 | 描述 |
code | 返回码 | String | 提交返回结果。0:表示成功,其他:失败。(状态码详见:《公共错误代码定义》) |
msg | 信息描述 | String | 返回码对应的中文描述。 |
data | 分配信息 | List | 返回分配详情 |
ownerBalance | 转出产品账户余额 | String | 转出产品账户的当前余额 |
receiverBalance | 转入产品账户余额 | String | 转入产品账户的当前余额 |
quantity | 分配数量 | String | 本次分配的数量 |
time | 操作时间 | String | 操作时间 |
4.2.调用成功样例
{
"msg":"成功",
"code":"0",
"data":{
"ownerBalance":552, //被转出产品账户的当前余额
"quantity":"10", //指定分配的数量
"receiverBalance":366, //被转入产品账户的当前余额
"time":"2023-06-28 18:08:57" //操作时间
}
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}