短信接口Http_JSON

接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口。

post提交时候 头信息采用默认Content-Type=application/x-www-form-urlencoded

提交参数采用的key value形式,返回值是json


第一章  发送接口


1.1 请求地址


请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是

http://客户端地址/sms.aspx 对应UTF-8

http://客户端地址/smsGBK.aspx 对应GB2312

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户


1.2参数说明

http://客户端地址/sms.aspx

http://客户端地址/smsGBK.aspx


参数名称

含义

说明

userid

企业id

企业ID

account

发送用户帐号

用户帐号,由系统管理员

password

发送帐号密码

用户账号对应的密码

mobile

全部被叫号码

发信发送的目的号码.多个号码之间用半角逗号隔开

content

发送内容

短信的内容,内容需要UTF-8编码

sendTime

定时发送时间

为空表示立即发送,定时发送格式2010-10-24 09:08:10

action

发送任务命令

设置为固定的:send

extno

扩展子号

请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多10位数。

rt

接口类型

固定值 json,不填则为XML格式返回

例如:

action=send&rt=json&userid=12&account=账号&password=密码&mobile=15023239810,13527576163&content=内容&sendTime=&extno=


1.3返回值


在接收到客户端发送的http请求后,返回以json的方式返回处理结果。格式为:

{"ReturnStatus":"Success","Message":"ok","RemainPoint":109346,"TaskID":365,"SuccessCounts":2}


ReturnStatus ---------- 返回状态值:成功返回Success 失败返回:Faild

Message --------------- 返回信息:见下表

RemainPoint ---------- 返回余额

TaskID  --------------- 返回本次任务的序列ID

SuccessCounts -------- 成功短信数:当成功后返回提交成功短信数


返回信息提示

说明

ok

提交成功

用户名或密码不能为空

提交的用户名或密码为空

发送内容包含sql注入字符

包含sql注入字符

用户名或密码错误

表示用户名或密码错误

短信号码不能为空

提交的被叫号码为空

短信内容不能为空

发送内容为空

包含非法字符:

表示检查到不允许发送的非法字符

对不起,您当前要发送的量大于您当前余额

当支付方式为预付费是,检查到账户余额不足

其他错误

其他操作方面的错误


第二章 余额及已发送量查询接口


2.1 请求地址


请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

http://客户端地址/sms.aspx

http://客户端地址/smsGBK.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户


2.2参数说明


参数名称

含义

说明

userid

企业id

企业ID

account

用户帐号

用户帐号,由系统管理员

password

帐号密码

用户账号对应的密码

action

任务名称

设置为固定的:overage

rt

接口类型

固定值 json,不填则为XML格式返回


例如:

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


2.3返回值


{"ReturnStatus":"Success","Message":"","Payinfo":"后付费","Overage":109346,"SendTotal":1075}


ReturnStatus-------返回状态值:成功返回Success 失败返回:Faild

Message------------返回信息提示:见下表

Payinfo-------------返回支付方式  后付费,预付费

Overage------------返回余额

SendTotal----------返回总点数  当支付方式为预付费是返回总充值点数


返回信息提示

说明

返回空

查询成功

将返回相应的支付方式、账户使用条数、总充值点数

用户名或密码不能为空

提交的用户名或密码为空

用户名或密码错误

表示用户名或密码错误


第三章 非法关键词查询


3.1 请求地址


请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

http://客户端地址/sms.aspx

http://客户端地址/smsGBK.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户


3.2参数说明


参数名称

含义

说明

userid

企业id

企业ID

account

用户帐号

用户帐号,由系统管理员

password

帐号密码

用户账号对应的密码

action

任务名称

设置为固定的:checkkeyword

content

检测发送内容

需要发送的内容

rt

接口类型

固定值 json,不填则为XML格式返回

例如:

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


3.3返回值


{"ReturnStatus":"Success","Message":"没有包含屏蔽词","CheckCounts":"test"}


ReturnStatus---------返回状态值:成功返回Success 失败返回:Faild

Message--------------返回信息提示:见下表

CheckCounts---------提交内容

返回信息提示

说明

用户名或密码不能为空

提交的用户名或密码为空

用户名或密码错误

表示用户名或密码错误

包含非法字符

检查出来包含非法关键词

没有包含屏蔽词

未检查出非法关键词

第四章 状态报告接口


4.1 请求地址


请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

http://客户端地址/statusApi.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

注意:相同的状态报告,只能获取一次。


4.2参数说明


参数名称

含义

说明

userid

企业id

企业ID

account

用户帐号

用户帐号,由系统管理员

password

帐号密码

用户账号对应的密码

statusNum

每次取得号码数

必须为数字,默认4000,可不填

action

任务名称

设置为固定的:query

rt

接口类型

固定值 json,不填则为XML格式返回

例如:

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


4.3返回值


{"ReturnStatus":"Success","Message":"OK","Task":[{"Mobile":"15713093554","TaskID":"358","Status":"20","ReceiveTime":"2018-08-20 11:20:18","ErrorCode":"UNDELIVERED","ExtNo":""},{"Mobile":"15713093541","TaskID":"358","Status":"20","ReceiveTime":"2018-08-20 11:20:18","ErrorCode":"UNDELIVERED","ExtNo":""}]}


ReturnStatus--------------返回状态值:成功返回Success

Message-------------------描述

Task------------------------状态报告数组队列

Mobile---------------对应的手机号码

TaskID---------------同一批任务ID

Status----------------状态报告----10:发送成功,20:发送失败

ReceiveTime--------接收时间

ErrorCode-----------上级网关返回值,不同网关返回值不同,仅作为参考

ExtNo----------------子号,即自定义扩展号


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


{"ReturnStatus":"Faild","Message":"用户名或密码错误"}

ReturnStatus--------------返回状态值:失败返回Faild

Message-------------错误描述


1:用户名或密码不能为空

2:用户名或密码错误

3:该用户不允许查看状态报告

4:参数不正确


第五章 上行接口


5.1 请求地址


请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

http://客户端地址/callApi.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户

注意:相同的上行回复,只能获取一次。


5.2参数说明


参数名称

含义

说明

userid

企业id

企业ID

account

用户帐号

用户帐号,由系统管理员

password

帐号密码

用户账号对应的密码

action

任务名称

设置为固定的:query

ownExt

使用自有扩展号

可不填或为空。当该值为1时,返回的extno将剔除系统强制附加的子号,为客户自己提交的子号,前提是上级通道支持时。

rt

接口类型

固定值 json,不填则为XML格式返回

例如:

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


5.3返回值


{"ReturnStatus":"Success","Message":"OK","Task":[{"Mobile":"136","TaskID":"1","Content":"test","ReceiveTime":"2018-12-07 15:17:26","ExtNo":"251251"},{"Mobile":"136","TaskID":"1","Content":"test","ReceiveTime":"2018-12-07 15:17:26","ExtNo":"251251"}]}


ReturnStatus--------------返回状态值:成功返回Success

Message-------------------描述

Task------------------------上行数组队列

Mobile---------------对应的手机号码

TaskID---------------同一批任务ID

Content--------------上行内容

ReceiveTime--------接收时间

ExtNo----------------子号,即自定义扩展号


5.4错误返回值——回复请求错误返回格式及对应值


{"ReturnStatus":"Faild","Message":"用户名或密码错误"}


ReturnStatus--------------返回状态值:失败返回Faild

Message-------------错误描述


1:用户名或密码不能为空

2:用户名或密码错误

3:该用户不允许查看状态报告

4:参数不正确


第六章 密码修改接口


6.1 请求地址


请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是

http://客户端地址/sms.aspx

http://客户端地址/smsGBK.aspx

入口地址一般不会发生变化,当发生变化的时候,会通知接口用户


6.2参数说明

参数名称

含义

说明

userid

企业id

企业ID

account

用户帐号

用户帐号,由系统管理员

password

帐号密码

用户账号对应的密码

action

任务名称

设置为固定的:changespwd

newpwd

新密码


renewpwd

确认密码

确认密码是将新密码再次输入

rt

接口类型

固定值 json,不填则为XML格式返回

例如:

action= changespwd&rt=json&userid=12&account=账号&password=密码&newpwd=新密码&renewpwd=新密码


6.3返回值


{"ReturnStatus":"Success","Message":"密码修改成功","CheckCounts":""}


ReturnStatus---------返回状态值:成功返回Success 失败返回:Faild

Message--------------返回信息提示:见下表

CheckCounts---------预留字段


返回信息提示 说明

密码修改成功 密码修改成功

用户名或密码不能为空 提交的用户名或密码为空

用户名或密码错误 表示用户名或密码错误

其他 对应中文错误描述

短信快速通道,注册既享新用户礼包!
立即免费注册
  • 10余年行业经验
    满意度高达96%
    7x24小时售后支持
    40万用户共同选择
  • 开发中心

    接入指南

    API文档

    关注我们
    023-65222946
    咨询时间:9:00-23:00
    邮箱:cq106dxyx@163.com
    在线客服
    © 1997–2020 重庆天巧信息技术集团有限公司 天巧云 版权所有 备案号:渝ICP备18003837号 《中华人民共和国增值电信业务经营许可证》B2-20190567
    企业地址:中国(大陆)重庆市沙坪坝区三峡广场时代星空大厦2幢20层

    渝公网安备 50010602502744号