短信群发接口文档
666247 2025-01 中昱维信
1.批量群发
协议说明
Options:
- Url:
https://vip.veesing.com/smsApi/group
- Method:
post
- Content-Type:
application/x-www-form-urlencoded;charset=utf-8
请求参数
# | 参数 | 类型 | 必填 | 描述 | 示例 |
---|---|---|---|---|---|
1 | appId | String | 是 | 账户标识。平台分配给用户的接口调用账户标识,登录平台首页账号信息栏可查看。 | 2RYN7CQHL1M***** |
2 | appKey | String | 是 | 账户密钥。平台分配给用户的接口调用密钥,登录平台首页账号信息栏,校验身份后可查看。 | WVNA4A0***** |
3 | phone | String | 是 |
手机号码,多个手机号码用英文逗号 , 分隔。
|
156****1090,156****1091 |
4 | content | String | 是 | 短信内容。需包含短信签名。 (短信内容不支持插入表情符号) | 【云讯106】您的短信群发功能已开通,请在3个工作日之内至平台进行企业认证! |
5 | sendTime | String | 是 |
定时时间。留空则表示立即发送,时间格式为:yyyy-MM-dd
HH:mm:ss
|
2018-08-21 14:00:00 |
请求示例
正常响应
异常响应
2.回执/回复推送
触发条件
用户回复短信后,触发回复数据推送,每回复一条,则推送一条;运营商产生短信回执后,触发回执数据推送,每产生一条回执,则推送一条。
使用说明
回执回复数据,由短信平台主动推送到用户设置的地址上,数据格式需遵循标准化数据格式。
协议说明
Options:
- Url:
用户设置
- Method:
post
- Content-Type:
application/x-www-form-urlencoded;charset=utf-8
回执数据定义
# | 参数名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|---|
1 | mobile | String | 是 | 用户手机号码 | 1508092**** |
2 | taskid | String | 是 | 发送批次ID | 123 |
3 | status | String | 是 | 回执状态 1.发送成功 0.发送失败 | 1 |
4 | receivetime | String | 是 | 回执产生时间 yyyy-MM-dd HH:mm:ss | 2019-07-23 17:00:00 |
5 | code | String | 否 | 回执状态码 | DELIVRD |
用户接收推送成功,无需返回任何信息,彩信平台根据http_status=200自动判断
回复数据定义
# | 参数名称 | 类型 | 是否必填 | 描述 | 示例值 |
---|---|---|---|---|---|
1 | mobile | String | 是 | 用户手机号码 | 1508092**** |
2 | taskid | String | 是 | 发送批次ID | 123 |
3 | content | String | 是 | 回复内容 (用户回复的短信内容) | 收到 |
4 | receivetime | String | 是 | 回执产生时间 yyyy-MM-dd HH:mm:ss | 2019-07-23 17:00:00 |
用户接收推送成功,无需返回任何信息,彩信平台根据http_status=200自动判断
3.余额查询
协议说明
Options:
- url:
https://vip.veesing.com/smsApi/group/getBalance
- method:
get
请求参数
# | 参数 | 类型 | 必填 | 描述 | 示例 |
---|---|---|---|---|---|
1 | appId | String | 是 | 账户标识。平台分配给用户的接口调用账户标识,登录平台首页账号信息栏可查看。 | 2RYN7CQHL1M***** |
2 | appKey | String | 是 | 账户密钥。平台分配给用户的接口调用密钥,登录平台首页账号信息栏,校验身份后可查看。 | WVNA4A0***** |
请求示例
正常响应示例
异常响应示例
全局状态码
returnStatus | message |
---|---|
1 | 提交成功 |
0 | 账号或密码错误 |
0 | 缺少参数 |
0 | 您的账户已被锁定,请联系您的专属客服 |
0 | 未知原因,请联系客服 |
0 | IP受限 |