查询余额

POST

https://api.4321.sh/balance/balance

查询余额API

余额查询API 是飞鸽传书（上海）信息科技有限公司针对短信开放出的接口
采用 HTTP POST 推送模式，飞鸽传书API 该接口主要用户主动查询当前余额开放的API

是否需要授权

是

参阅 API 授权和验证机制

错误代码

参阅 API 错误代码

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.4321.sh/balance/balance' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apikey": "string",
    "secret": "string"
}'

响应示例

{
  "code": 0,
  "msg": "OK",
  "balance": 10000.025
}

请求参数

Body 参数application/json

apikey

string

飞鸽传书平台任一产品Api接口账号

可选

secret

string

与Api接口账号对应的秘钥

可选

示例

返回响应

🟢200成功

application/json

Body

code

integer

接口回执状态码，判断成功失败的标志

必需

成功为0，其它请参考 API 错误代码

msg

string

接口回执状态码描述

必需

成功为OK，其它请参考 API 错误代码

balance

number

账户余额国际短信产品单位为元其他产品单位为条/次

必需

空号检测

Demo实例