登录 注册

飞鸽API文档

API:文字短信

文字短信概括

文字短信API是 飞鸽传书（上海）信息科技有限公司针对短信开放出的接口

采用 HTTP POST 发送模式， 飞鸽API 主要针对用户为需要传送自定义内容以及号码的需求，即通过传递真实内容模板和短信内容以及短信签名实现短信发送

请求URL

http://api.feige.ee/SmsService/Send

请求参数

  • 参数 类型 是否可空 默认 描述 示例
  • Account
    string
    N
    无
    在飞鸽应用集成中创建的短信应用账号
  • Pwd
    string
    N
    无
    飞鸽应用集成中的短信请求接口密钥
    web平台：首页接口密钥
  • Content
    string
    N
    无
    用户发送的自定义短信内容，建议长度不要超过500字
    此处内容为自定义内容，如：您的验证码是123456
  • Mobile
    string
    N
    无
    用户发送的短信号码，多个号码以逗号分隔
  • SignId
    long
    N
    无
    短信签名建议2-8字符,id可在管理后台获取、添加、编辑
  • ExtNo
    long
    Y
    无
    用户定义扩展码，只能为正整数 建议1-3位

协议

HTTP  POST

编码模式

UTF-8

Content-Type

application/x-www-form-urlencoded

是否授权

是

参阅 API 授权和验证机制

错误代码

是

参阅 API 错误代码

返回值格式

json默认

{
  "Code":0,
  "Message":"OK",
  "SendId":"2016072909264497197473179",
  "InvalidCount":0,
  "SuccessCount":1,
  "BlackCount":0
}

返回值参数说明

  • 参数 描述 示例
  • SendId
    短信回执编号，为唯一识别码，用户可通过此编号获取记录详情
    默认格式如：2016080111261216589966449
  • InvalidCount
    无效号码数量
    可能是非手机号码如02161531765
  • SuccessCount
    有效号码数量
    一般为该批次计费条数
  • BlackCount
    黑名单号码数量
    黑名单号码数量
  • Code
    短信回执状态码，判断成功失败的标志
  • Message
    短信回执状态描述