短信平台接口文档说明书
2018-06-18 20:05:09 作者:必到牌软件
瘦身必到牌软件短信平台接口说明
对接的时候有个参数userid 就是开账号前面的客户id
客户接口说明 1
第一章 发送接口 2
1.1 请求地址 2
1.2参数说明 2
1.3返回值 2
第二章 余额及已发送量查询接口 3
2.1 请求地址 3
2.2参数说明 3
2.3返回值 3
第三章 非法关键词查询 4
3.1 请求地址 4
3.2参数说明 4
3.3返回值 4
第四章 状态报告接口 5
4.1 请求地址 5
4.2参数说明 5
4.3返回值 5
4.4错误返回值——状态报告请求错误返回格式及对应值 6
第五章 上行接口 6
5.1 请求地址 6
5.2参数说明 6
5.3返回值 7
5.4错误返回值——回复请求错误返回格式及对应值 7
接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8
第一章 发送接口
1.1 请求地址
请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是
http://bidao123.com/sms.aspx 对应UTF-8
http://bidao123.com/smsGBK.aspx 对应GB2312
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
1.2参数说明
http://bidao123.com/sms.aspx
http://bidao123.com/smsGBK.aspx
参数名称 含义 说明
userid 企业id 企业ID
account 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码 用户账号对应的密码
mobile 全部被叫号码 发信发送的目的号码.多个号码之间用半角逗号隔开
content 发送内容 短信的内容,内容需要UTF-8编码
sendTime 定时发送时间 为空表示立即发送,定时发送格式2010-10-24 09:08:10
action 发送任务命令 设置为固定的:send
extno 扩展子号 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。
例如:
action=send&userid=12&account=账号&password=密码&mobile=15023239810&content=内容&sendTime=&extno=
1.3返回值
在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
status---------- 返回状态值:成功返回Success 失败返回:Faild
message---------- 返回信息:见下表
remainpoint---------- 返回余额
taskID----------- 返回本次任务的序列ID
successCounts--成功短信数:当成功后返回提交成功短信数
返回信息提示 说明
ok 提交成功
用户名或密码不能为空 提交的用户名或密码为空
发送内容包含sql注入字符 包含sql注入字符
用户名或密码错误 表示用户名或密码错误
短信号码不能为空 提交的被叫号码为空
短信内容不能为空 发送内容为空
包含非法字符: 表示检查到不允许发送的非法字符
对不起,您当前要发送的量大于您当前余额 当支付方式为预付费是,检查到账户余额不足
其他错误 其他数据库操作方面的错误
第二章 余额及已发送量查询接口
2.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/sms.aspx
http://bidao123.com/smsGBK.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
2.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:overage
例如:
action=overage&userid=12&account=账号&password=密码
2.3返回值
status-------返回状态值:成功返回Success 失败返回:Faild
message--------------返回信息提示:见下表
payinfo--------------返回支付方式 后付费,预付费
overage-------------返回余额
sendTotal----返回总点数 当支付方式为预付费是返回总充值点数
返回信息提示 说明
返回空 查询成功
将返回相应的支付方式、账户使用条数、总充值点数
用户名或密码不能为空 提交的用户名或密码为空
用户名或密码错误 表示用户名或密码错误
第三章 非法关键词查询
3.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/sms.aspx
http://bidao123.com/smsGBK.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
3.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:checkkeyword
content 检测发送内容 需要发送的内容
例如:
action=checkkeyword&userid=12&account=账号&password=密码&content=内容
3.3返回值
message--------------返回信息提示:见下表
返回信息提示 说明
用户名或密码不能为空 提交的用户名或密码为空
用户名或密码错误 表示用户名或密码错误
包含非法字符 检查出来包含非法关键词
未包含非法字符 未检查出非法关键词
第四章 状态报告接口
4.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/statusApi.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
4.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:query
例如:
action=query&userid=12&account=账号&password=密码
4.3返回值
15023239810-------------对应的手机号码
1212-------------同一批任务ID
10---------状态报告----10:发送成功,20:发送失败
2011-12-02 22:12:11-------------接收时间
MK:0011-------------状态返回值
15023239811
1212
20
2011-12-02 22:12:11
DELIVRD-------------状态返回值
4.4错误返回值——状态报告请求错误返回格式及对应值
1-------------错误码
用户名或密码不能为空-------------错误描述
1:用户名或密码不能为空
2:用户名或密码错误
3:该用户不允许查看状态报告
4:参数不正确
第五章 上行接口
5.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/callApi.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
5.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:query
例如:
action=query&userid=12&account=账号&password=密码
5.3返回值
15023239810-------------对应的手机号码
1212-------------同一批任务ID
你好,我不需要---------上行内容
2011-12-02 22:12:11-------------接收时间
15023239811
1212
你好,本次活动路线是怎么的
2011-12-02 22:12:11
5.4错误返回值——回复请求错误返回格式及对应值
1-------------错误码
用户名或密码不能为空-------------错误描述
1:用户名或密码不能为空
2:用户名或密码错误
3:该用户不允许查看状态报告
4:参数不正确
对接的时候有个参数userid 就是开账号前面的客户id
客户接口说明 1
第一章 发送接口 2
1.1 请求地址 2
1.2参数说明 2
1.3返回值 2
第二章 余额及已发送量查询接口 3
2.1 请求地址 3
2.2参数说明 3
2.3返回值 3
第三章 非法关键词查询 4
3.1 请求地址 4
3.2参数说明 4
3.3返回值 4
第四章 状态报告接口 5
4.1 请求地址 5
4.2参数说明 5
4.3返回值 5
4.4错误返回值——状态报告请求错误返回格式及对应值 6
第五章 上行接口 6
5.1 请求地址 6
5.2参数说明 6
5.3返回值 7
5.4错误返回值——回复请求错误返回格式及对应值 7
接口说明:客户接口部分提供http url方式的接口,根据客户需求可以提供相应接口,接口编码方式采用统一的UTF-8
第一章 发送接口
1.1 请求地址
请求地址是客户接口程序调用时请求的url地址,采用的是http post 接口,地址是
http://bidao123.com/sms.aspx 对应UTF-8
http://bidao123.com/smsGBK.aspx 对应GB2312
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
1.2参数说明
http://bidao123.com/sms.aspx
http://bidao123.com/smsGBK.aspx
参数名称 含义 说明
userid 企业id 企业ID
account 发送用户帐号 用户帐号,由系统管理员
password 发送帐号密码 用户账号对应的密码
mobile 全部被叫号码 发信发送的目的号码.多个号码之间用半角逗号隔开
content 发送内容 短信的内容,内容需要UTF-8编码
sendTime 定时发送时间 为空表示立即发送,定时发送格式2010-10-24 09:08:10
action 发送任务命令 设置为固定的:send
extno 扩展子号 请先询问配置的通道是否支持扩展子号,如果不支持,请填空。子号只能为数字,且最多5位数。
例如:
action=send&userid=12&account=账号&password=密码&mobile=15023239810&content=内容&sendTime=&extno=
1.3返回值
在接收到客户端发送的http请求后,返回以xml的方式返回处理结果。格式为:
status---------- 返回状态值:成功返回Success 失败返回:Faild
message---------- 返回信息:见下表
remainpoint---------- 返回余额
taskID----------- 返回本次任务的序列ID
successCounts--成功短信数:当成功后返回提交成功短信数
返回信息提示 说明
ok 提交成功
用户名或密码不能为空 提交的用户名或密码为空
发送内容包含sql注入字符 包含sql注入字符
用户名或密码错误 表示用户名或密码错误
短信号码不能为空 提交的被叫号码为空
短信内容不能为空 发送内容为空
包含非法字符: 表示检查到不允许发送的非法字符
对不起,您当前要发送的量大于您当前余额 当支付方式为预付费是,检查到账户余额不足
其他错误 其他数据库操作方面的错误
第二章 余额及已发送量查询接口
2.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/sms.aspx
http://bidao123.com/smsGBK.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
2.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:overage
例如:
action=overage&userid=12&account=账号&password=密码
2.3返回值
status-------返回状态值:成功返回Success 失败返回:Faild
message--------------返回信息提示:见下表
payinfo--------------返回支付方式 后付费,预付费
overage-------------返回余额
sendTotal----返回总点数 当支付方式为预付费是返回总充值点数
返回信息提示 说明
返回空 查询成功
将返回相应的支付方式、账户使用条数、总充值点数
用户名或密码不能为空 提交的用户名或密码为空
用户名或密码错误 表示用户名或密码错误
第三章 非法关键词查询
3.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/sms.aspx
http://bidao123.com/smsGBK.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
3.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:checkkeyword
content 检测发送内容 需要发送的内容
例如:
action=checkkeyword&userid=12&account=账号&password=密码&content=内容
3.3返回值
message--------------返回信息提示:见下表
返回信息提示 说明
用户名或密码不能为空 提交的用户名或密码为空
用户名或密码错误 表示用户名或密码错误
包含非法字符 检查出来包含非法关键词
未包含非法字符 未检查出非法关键词
第四章 状态报告接口
4.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/statusApi.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
4.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:query
例如:
action=query&userid=12&account=账号&password=密码
4.3返回值
15023239810-------------对应的手机号码
1212-------------同一批任务ID
10---------状态报告----10:发送成功,20:发送失败
2011-12-02 22:12:11-------------接收时间
MK:0011-------------状态返回值
15023239811
1212
20
2011-12-02 22:12:11
DELIVRD-------------状态返回值
4.4错误返回值——状态报告请求错误返回格式及对应值
1-------------错误码
用户名或密码不能为空-------------错误描述
1:用户名或密码不能为空
2:用户名或密码错误
3:该用户不允许查看状态报告
4:参数不正确
第五章 上行接口
5.1 请求地址
请求地址是客户接口程序调用的时候请求的url地址,采用的是http post接口,地址是
http://bidao123.com/callApi.aspx
入口地址一般不会发生变化,当发生变化的时候,会通知接口用户
5.2参数说明
参数名称 含义 说明
userid 企业id 企业ID
account 用户帐号 用户帐号,由系统管理员
password 帐号密码 用户账号对应的密码
action 任务名称 设置为固定的:query
例如:
action=query&userid=12&account=账号&password=密码
5.3返回值
15023239810-------------对应的手机号码
1212-------------同一批任务ID
你好,我不需要---------上行内容
2011-12-02 22:12:11-------------接收时间
15023239811
1212
你好,本次活动路线是怎么的
2011-12-02 22:12:11
5.4错误返回值——回复请求错误返回格式及对应值
1-------------错误码
用户名或密码不能为空-------------错误描述
1:用户名或密码不能为空
2:用户名或密码错误
3:该用户不允许查看状态报告
4:参数不正确
- 上一篇:会员短信营销广告话术模板怎么写?(精选6条) [2018-06-18]
- 下一篇:装饰公司营销短信话术模板如何写效果才好 [2018-06-18]