领网云通讯PaaS平台文档中心-API文档

调用说明
短信验证码接口文档下载: 点击下载
状态接口

URL地址为:http://124.128.153.30:8888/sms.aspx

参数定义
参数定义 参数 说明
userid 企业id 企业ID
account 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码 用户账号对应的密码
mobile 全部被叫号码 发信发送的目的号码.多个号码之间用半角逗号隔开
content 发送内容 短信的内容
sendTime 定时发送时间 为空表示立即发送,定时发送格式2010-10-24 09:08:10
action 发送任务命令 设置为固定的:send
checkcontent 是否检查内容包含非法关键字 当设置为1时表示需要检查,默认0为不检查
示例

action=send&userid=12&account=账号&password=密码

&mobile=15023239810,13527576163&content=内容&sendTime=&checkcontent=1

返回值

<?xmlversion="1.0"encoding="UTF-8"?>

<returnstatus>status</returnstatus>--返回状态值:成功返回Success 失败返回:Faild

<message>message</message>--返回信息:见下表

<remainpoint>remainpoint</remainpoint>--返回余额

<taskID>taskID</taskID>--返回本次任务的序列ID

<successCounts>successCounts</successCounts>--成功短信数:当成功后返回提交成功短信数

</returnsms>

返回信息提示
返回信息提示 说明
OK 提交成功
用户名或密码不能为空 提交的用户名或密码为空
发送内容包含sql注入字符 包含sql注入字符
用户名或密码错误 表示用户名或密码错误
短信号码不能为空 提交的被叫号码为空
包含非法字符: 表示检查到不允许发送的非法字符
对不起,您当前要发送的量大于您当前余额 当支付方式为预付费是,检查到账户余额不足
其他错误 其他数据库操作方面的错误
余额及已发送量查询接口

URL地址为:http://124.128.153.30:8888/sms.aspx

参数定义
参数定义 参数 说明
userid 企业id 企业ID
account 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:overage
示例

action=overage&userid=12&account=账号&password=密码

返回值

<?xmlversion="1.0"encoding="UTF-8"?>

<returnsms>

<returnstatus>status</returnstatus>--返回状态值:成功返回Success 失败返回:Faild

<message>message</message>--返回信息:见下表

<payinfo>payinfo</payinfo>--返回支付方式 后付费,预付费

<overage>overage</overage>--返回已发送条数

<sendTotal>successCounts</sendTotal>--返回总点数 当支付方式为预付费是返回总充值点数

</returnsms>

返回信息提示
返回信息提示 说明
OK 提交成功
返回空 查询成功将返回相应的支付方式、账户使用条数、总充值点数
用户名或密码不能为空 提交的用户名或密码为空
非法关键词查询

URL地址为:http://124.128.153.30:8888/sms.aspx

参数定义
参数定义 参数 说明
userid 企业id 企业ID
account 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:checkkeyword
content 检测发送内容 需要发送的内容
示例

action=checkkeyword&userid=12&account=账号&password=密码&content=内容

返回值

<?xmlversion="1.0"encoding="UTF-8"?>

<returnsms>

<message>message</message>--返回信息:见下表

</returnsms>

返回信息提示
返回信息提示 说明
用户名或密码不能为空 提交的用户名或密码为空
用户名或密码错误 示用户名或密码错误
包含非法字符 检查出来包含非法关键词
未包含非法字符 未检查出非法关键词
状态报告接口

URL地址为:http://124.128.153.30:8888/sms.aspx

参数定义
参数定义 参数 说明
userid 企业id 企业ID
account 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:query
示例

action=query&userid=12&account=账号&password=密码

返回值

<?xmlversion="1.0"encoding="UTF-8"?>

<returnsms>

<statusbox>

<mobile>15023239810</mobile>---对应的手机号码

<taskid>1212</taskid>---同一批任务ID

<status>10</status>---状态报告----10:发送成功,20:发送失败

<receivetime>10</receivetime>---接收时间

</statusbox>

</returnsms>

错误返回值——状态报告请求错误返回格式及对应值

<?xmlversion="1.0"encoding="UTF-8"?>

<returnsms>

<errorstatus>

<error>1</error>--错误码

<remark>用户名或密码不能为空</remark>---错误描述

</errorstatus>

</returnsms>

返回信息提示
错误码 说明
1 示用户名或不正确
2 示用户名或密码错误
3 该用户不允许查看状态报告
4 参数不正确