全部产品
-
产品介绍
-
服务规则
- 短信发送频率限制规则
- 短信封禁规则
- 模板数量限制规则
- 签名提交规则
- 通知短信&验...提交规则
- 营销推广短信...提交规则
- 短信发送时间限制规则
- 短信审核时间规则
- 短信内容长度计算规则
-
用户指南
- 短信功能操作指南
- 短信计价方式
- 短信使用规则
- 短信签名
- 短信管控
-
API开发指南
-
JAVA
- 短信发送API(SendSms)
- 短信查询API(QuerySms)
- 短信消息API---JAVA
- 短信发送状态回执码
- 短信接口调用状态码
-
消息通知服务
消息通知服务(SMN:Simple Message Notification)是可靠的、可扩展的、海量的消息处理服务。它大大简化系统耦合,能够根据用户的需求,向订阅终端主动推送消息。在SMN中有两种类型的客户端:发布者和订阅者。发布者通过创建消息并将消息发送至主题,主题是作为消息的集合,是一个逻辑访问点和通信渠道。SMN服务将消息推送给主题的订阅者,订阅者可以是电子邮件、短信、应用等等,在其订阅主题后通过所支持的其中一种通信协议接收消息。
短信发送频率限制规则
-
短信通知: 使用同一个签名和同一个短信模板ID,对同一个手机号码发送短信通知,支持100条/天(天的计算方式是一天24小时,也就是0时至24时,是否满100条)。如您是在发送时提示业务限流,建议您根据以上业务调整接口调用时间。
-
短信营销推广: 使用同一个签名和同一个短信模板ID,对同一个手机号码发送短信通知,支持100条/天(天的计算方式是一天24小时,也就是0时至24时,是否满100条)。如您是在发送时提示业务限流,建议您根据以上业务调整接口调用时间。
短信封禁规则
-
短信服务会针对用户发送的短信模板和短信签名进行审核,同时配合系统监控,防范在短信内容中出现的违反国家法律法规要求的相关内容。
-
发现违反规则的短信内容,视情节严重性,平台将会冻结短信服务甚至暂停账号,并视情况扣罚用户保证金或追究其责任。
-
冻结短信服务后,该用户无法继续使用短信服务;暂停账号后,如该账号中包含短信服务的资源包、优惠券等,也无法继续使用。如对业务进行整改,确认可以重新上线后,再开启短信服务以及账号。
模板数量限制规则
- 1.签名数量限制:企业用户可添加5个自定义签名。
- 2.模板数量限制:短信模板个数不限制。
签名提交规则
-
短信签名是作为短信内容属性的一种标识,签名必须用于标识公司或业务。
-
签名内容不能含有黄赌毒,宗教,党政等信息;
-
签名不支持中性化签名,需能辨别所属公司或公司归属的网站、产品、APP;
-
国内短信签名由【】及签名内容组成,签名内容要求3~8个字(由中英文,数字组成,不能包含其他特殊字符,如“+,@,|等”,国内短信签名内 容尽量使用中文);申请短信签名时只需要提交签名内容。
-
海外(或地区)短信签名由"[]"及签名内容组成,签名内容要求3~14个字,内容不包含[]。申请短信签名时只需要提交签名内容。
通知短信&验证码短信模板提交规则
最近更新时间:2017-12-29 11:40:55格式限制
- 1、不支持全变量和组合变量模板(全变量是指无法判断短信前后结构和使用场景,通知短信和验证码短信均不支持全变量和组合变量),建议在变量前后添加文字;验证码模场!);
- 2、不支持短连接拼接变量,例如:t.cn${code}为短连接拼接变量,t.cn为短连接,${code}为变量单位,且不支持变量内传入链接;
- 3、验证码模板不支持两个变量单位
- 4、鉴于特殊符号可能会导致短信出现乱码,不支持如¥、★、 ※、 →、 ●;等特殊符号。
- 5、【 】符号在模板内容中任意位置都不能使用, [ ]符号模板内容首尾不能使用,系统均会默认为签名,签名请单独申请,传参需传签名及短信模板ID;
内容限制
- 1、验证码模板内容必须含验证码,注册码,校验码,动态密码,动态码这4个词其中一个;
- 2、不支持营销内容;
- 3、禁止发送色情、赌博、毒品、党政、维权、众筹、慈善募捐、宗教、迷信、股票、移民、面试招聘、博彩、贷款、催款、信用卡提额、投资理财、中奖、抽奖、一元夺宝、一元秒杀、A货、整形、烟酒、交友、暴力、恐吓、色情、皮草、代开发票、代理注册、代办证件、装修行业、游戏、互金类、加群、加QQ或者加微信、贩卖个人信息、运营商策反、流量营销等类型的短信;另外房地产、教育、培训这三类(除验证码外均不支持发送)
- 4、不能发送未经许可的发送行为,主要指邀请注册、邀请成为会员的商业性信息;
营销推广短信模板提交规则
最近更新时间:2017-12-29 11:40:55格式限制
- 1、营销短信不支持加变量;
- 2、营销短信内容后面需要添加退订方式,“支持TD或T或N进行短信退订回复,其它回复参数不支持;
- 3、【 】符号在模板内容中任意位置都不能使用, [ ]符号模板内容首尾不能使用,系统均会默认为签名,签名请单独申请,传参需传签名及短信模板ID
- 4、鉴于特殊符号可能会导致短信出现乱码,不支持如¥ ★以及包含可通过按键录入的组合型特殊符号,如ヾ(●?▽`●)ノ , ^_^&,☞,√,※,→),●;
内容限制
- 1、禁止发送色情、赌博、毒品、党政、维权、众筹、慈善募捐、宗教、迷信、股票、移民、保险、房地产、教育、培训、面试招聘、博彩、贷款、催款、返利、信用卡提额、投资理财、中奖、抽奖、一元夺宝、一元秒杀、A货、整形、美容、医疗、会所、酒吧、足浴、助考、商标注册、装修、建材、家私、游戏、会展、车展、房展、烟酒、交友、暴力、恐吓、色情、皮草、代开发票、代理注册、代办证件、加群、加QQ或者加微信、贩卖个人信息、运营商策反、流量营销等类型的短信;
- 2、不能给非会员用户发送营销短信;
- 3、不能发送未经许可的发送行为,主要指邀请注册、邀请成为会员的商业性信息;如出现违法违规或者损害到相关他人权益的,平台将保留最终追究的权利!请各会员严格遵守规范要求,加强自身业务安全,健康发送短信。
短信发送时间限制规则
-
晚上22:00~次日7:00,营销推广短信、群发短信不支持发送,尽量避免夜间发送,减少用户投诉。通知类短信发送时间没有限制。
-
如确有紧急事务,需要在【PM22:00-AM7:00】的时间向用户发送信息,需确保相同内容发送的条数不超过100条。
短信审核时间规则
最近更新时间:2017-12-29 11:40:55短信接入初次审核
- 一般类短信通道预计1-2个工作日内审核完成,审核通过后可使用;特殊类以及优质类短信通道,如涉及政检法,银行等事业单位,会在5-7个工作日内审核完成(如出现多个工作日还未审核,请核实提供的固话是否正确)。为配合三大运营商的业务要求,同时也可以侧面保证用户品牌效应,短信在发送时,需签署已经备案的签名。
- 温馨提醒:鉴于政府企业身份的特殊性,所有涉及政企客户的签名均需联系固话进行核实,因此在提供固定电话时,请提供有效的号码,如多次联系无法接通您提供的电话我们会进行驳回处理。
短信签名审核(多次)
- 一般类短信通道预计1-2个工作日内审核完成,审核通过后可使用;特殊类以及优质类短信通道,如涉及政检法,银行等事业单位,会在5-7个工作日内审核完成(如出现多个工作日还未审核,请核实提供的固话是否正确)。为配合三大运营商的业务要求,同时也可以侧面保证用户品牌效应,短信在发送时,需签署已经备案的签名。
- 温馨提醒:鉴于政府企业身份的特殊性,所有涉及政企客户的签名均需联系固话进行核实,因此在提供固定电话时,请提供有效的号码,如多次联系无法接通您提供的电话我们会进行驳回处理。
短信模板审核(多次)
通知类模板预计8小时内审核完成,审核通过后可使用;营销类模板在1-2个工作日内审核完成(如出现多个工作日还未审核,请核实提供的固话是否正确)。短信内容长度计算规则
-
短信字数=短信模板内容字数 + 签名字数
-
短信字数 <=70个字数,按照70个字数一条短信计算
-
短信字数>70个字数,即为长短信,按照67个字数记为一条短信计算
注:在统计短信字数时,小数点、字母、汉字以及其他符号均按照一个字符位进行统计。最终按照实际发送成功的短信条数计费。
短信功能用户操作指南
最近更新时间:2018-07-31 14:57:30二.填写公司资料
点击 短信服务->免费开通

弹出 “短消息类服务接入信息审核表”,填写公司基本信息及短信需求。

若三证合一,只需在营业执照位置上传即可。
三.配置短信签名

点击左侧“签名管理”。

点击“添加签名”。

填写签名信息
所属用户组:
- 是表明该签名是用于那个用户组,公用则是所有用户组可用
签名名称:
- 由客户自主填写,随意,只是便于用户记忆
签名内容:
- 必须含中文,可以包含数字、英文
- 若签名/模版内容侵犯到第三方权益必须获得第三方真实授权
- 无需添加【】、()、[]符号,签名发送会自带【】符号,避免重复
四.添加模板

点击左侧“模板管理”

点击“添加模板”

填写模板信息,并保存。

点击右侧“报备申请材料”,下载excel

将此文件打印后签名盖章,然后发送至zhaop@53kf.com
五.添加联系人

点击左侧“联系人管理”,然后点击“添加联系人”。


添加联系人时可以选择单个添加或者批量上传excel。Excel样式参照联系人模板。
六.发送短信

点击左侧“发送平台”,添加联系人,选择短信类型,对应的模板,补充完整短信内容,点击发送即可。
短信计价方式
最近更新时间:2017-12-29 11:40:55短信长度计算规则?
短信字数=签名字数 + 短信模板内容字数;-
(1) ASCII编码纯英文(ASCII(0, "US-ASCII") char值 <127)的是150个字符;
(2) UCS2编码(UCS2(8, "UTF-16BE") char值) 66/67字符;
-
如长度超过该规定,对短信进行拆分后发送。
国内短信(CMPP)拆分原则:
加签名长度不超过70字符时做一条,超过70字符按长短信拆分,每个分片长度都是66个字符,字母、数字、标点符号和汉字一样占一个字符,第一条还需要扣除签名字符,最多可拆分5条。
-
国际短信(SMPP)拆分原则:
纯英文长度不超过150字符时做一条,超过150字符按长短信拆分,每个分片长度都是142个字符,字母、数字、英文标点符号等都占一个字符
含中文短信不超过67字符时做一条,超过67字符按长短信拆分,每个分片长度都是64个字符,字母、数字、标点符号和汉字一样占一个字符。
短信的计费模式?
-
若短信发送5分钟后还未返回状态,将先扣费,实际返回状态后根据失败条数进行短信量返补。
-
按阶梯计费,用的越多单价越低;月消费金额=月累计短信成功发送量所在的档位*月累计短信发送成功量;举例:1-10万单价是0.05元/条,10-30万单价是0.04元/条,若您当月累计用了15万,则消费金额为15万*0.04元/条
短信发送失败,还是会扣费吗?
接口调用失败及运营商返回失败状态,都不会扣费短信使用规则
最近更新时间:2017-12-29 11:40:55短信号码接入流程及申请?
-
注册账号、申请使用(官网)——>业务审核,商务洽谈——>合同签约,预付款充值——>开发测试,服务联调——>签名通道申请、业务配置——>上线商用
-
如果客户自带工信部备案的短信接入码,可以接入到海翕云短信平台,海翕云会协助落地;
-
如果客户无工信部备案的短信接入码,可以提供相关资料(授权书、营业执照复印盖章件、签名申请模板)委托海翕云代为申请短信接入码。
短信通道并发情况?
根据客户业务量灵活配置,最大每秒500并发,约一分钟3万条。短信发送范围及价格?
目前支持200多国家的1400多个运营商。-
支持国内短信发送,价格参照合同商务约定;
-
支持国内上行短信,功能免费,上行产生的通讯费,由运营商向终端用户收取。
-
支持国际短信发送,价格参照合同商务约定;
-
国际短信上行,根据国家不同具体情况具体分析。
短信显示号码及显号规则?
-
手机端接收显示的号码是106开头的正规号码
-
最大可支持客户自扩展到19位(手机显示问题超位可能会导致下发失败)。
-
显号规则:1. 号码=通道号+扩展码;2. 在通道不稳定、网络抖动及机房断电等不可抗拒的因素下,为确保到达率及到达时间,会自动切换通道,通道号会发生变化。
短信发送成功,但实际未能收到短信是什么原因?
-
手机是不是长时间不关机,可以关机重启下
-
手机收件箱是不是已满,删除一些看是否可以正常接收
-
手机是不是双卡双待的手机,把卡拿出来换一下卡槽
-
手机是不是安装了安全软件,安全软件有可能会进行拦截到垃圾信箱里
-
如若不行,请您将SIM卡换到其他手机上进行测试。
短信字数最多能发多少个字?
最大支持发送500个字以内的短信。(若长短信发送失败请联系技术支持)变量内传字符长度为多少个字?
验证码变量内参数长度限制在6个字符以内,短信通知的变量内参数长度限制在20个字符以内短信签名
最近更新时间:2017-12-29 11:40:55短信签名是什么?
短信签名是为客户提供一种快捷、方便的个性化签名方式。当客户发送短信时,短信平台会根据客户的设置,在短信内容里附加个性化签名,再发送给被叫手机客户。签名示例如下入驻企业为:浙江海翕信息技术有限公司
可以提交的签名为:【浙江海翕】或者可以提交公司英文名:【EiiSYS】
新签约企业报备签名所需材料?
- 新客户在完成商务合同、《华为平台短信能力使用承诺书》签署,API对接成功后,在预付款充值充足情况下,可申请报备签名通道。所需材料如下
- 1、商业企业请提供:“营业执照”盖章扫描件+《短消息类服务接入信息审核表》、《短信签名通道申请表》,预付款充足情况下,可申请使用短信具体可咨询合作经理;
- 2、机关事业单位请提供:“组织机构代码证”盖章扫描件+《短消息类服务接入信息审核表》、《短信签名通道申请表》,具体可咨询客户经理。
已签合同的老客户报备签名所需材料?
- 1、商业企业请提供:“营业执照”盖章扫描件+《短信签名通道申请表》;
- 2、机关事业单位请提供:“组织机构代码证”盖章扫描件+《短信签名通道申请表》
国内短信必须要申请报备签名吗?
是的。依据《深入治理垃圾短信息专项行动工作方案》运营商要求“谁使用,谁签名”,客户每次发送短信之前需提交短信签名,签名通道报备申请见《短信签名通道申请表》,具体可咨询客户经理。海外短信也需要申请签名吗?
仅国内短信需要申请签名后,才可发送短信。
海外短信仅需用户签约海外短信能力之后,即可发送短信。无需申请签名。
签名申请审核大约需要多长时间?
正常情况只需1-2个工作日,特殊情况需要1周左右。签名申请的审核规则?
- 1.由于短信签名需要在运营商备案,需要您提供企业的营业执照正本或副本复印件(要加盖企业公章);
- 2.签名为公司名称或简称,必须与上传的营业执照副本上的公司名称匹配;签名为产品名称或简称,必须备注提供任一应用商店的下载链接。签名为网站名称或简称,该签名必须为在工信部备案的网站名称的全称或简称。 签名为商标名称或简称,需要并提供商标注册证书。
短信管控
最近更新时间:2017-12-29 11:40:55哪些(行业类别)短信能发,哪些(行业类别)短信不能发?
- 1、验证码,通知生产类可以下发;
- 2、会员营销类要审核短信模板,模板中的可变内容用{***}代替,除此之外其余内容须与报备模板保持一致。其他盲发的营销短信不接受,
- 3、房产、教育、移民留学、P2P金融四大类内容不接受。敏感内容可咨询合作经理或者运营人员。根据国家法律法规受限制类信息内容禁止、根据公安部、信息产业部等明确的五类违规短消息、九不准信息禁止。
短信内容必须报备吗?
发送的短信内容模板必须提前报备,由海翕短信平台发送给华为侧进行审核,一旦审核通过后即可发送;模板中的可变内容用{***}代替,除此之外其余内容须与报备模板保持一致。
关于黑名单及解除方法?黑名单分两种
- 1.客户回复退订进行加黑。
- 2.客户通过拨打运营商热线电话或是通过12321进行投诉的平台也会加黑处理。解除方法:需要和客户确认不再投诉可以针对签名进行解除黑名单
关于短信内容中的网址及链接?
为了防止诈骗,盗发,不正规网址等我们会对带网址的内容会进行人工审核,审核没问题会对该网址进行免白,网址也可以先提供过来加白,加白之后可立即发送
违规行为定义及违规性质定级?
违规行为 | 违规定级 |
---|---|
下发短信中不含有签名,或与报备签名不符合 | 一般 |
非实时发送的业务,在每天21:00至次日7:00时间段内发送,且大于100条 | 一般 |
会员类信息,但未提供明确退订方式 | 严重 |
向用户提供行业短信服务前未经用户确认同意接受 | 严重 |
同时大面积或大量发生一般违规行为,或连续3次发生一般违规行为 | 严重 |
下发短信内容和报备内容不符 | 严重 |
用户明确表示退订某业务,但仍然发送到用户侧 | 重大 |
同时大面积或大量发生严重违规行为,或连续3次发生严重违规行为 | 重大 |
经查证发送内容为垃圾短信 | 重大 |
由于任何原因导致被投诉,且为有效投诉的 | 重大 |
违规投诉率及处理方式?
月投诉率 | 违规定级 | 处理方式 |
---|---|---|
无 | 一般 | 提醒沟通,及时修正 |
>=0.4% | 严重 | 警告并冻结对应服务端口部分预付款作为保证金,无继续投诉,将在下月释放 |
>=0.6% | 重大 | 暂停短信账号,对业务进行整改,确认可以重新上线后再开启 |
短信发送API(SendSms)---JAVA
最近更新时间:2018-09-27 14:01:35发送短信接口(SendSms)
-
步骤 1 创建海翕云账号
为了访问短信服务,您需要有一个海翕云账号。如果没有,可首先按照如下步骤创建海翕云账号:
1、访问海翕云 官方网站,单击页面上的注册按钮。注册的为53kf账号。
2、按照屏幕提示完成注册流程并进行实名认证,短信服务只支持实名认证用户使用。为了更好地使用海翕云服务,建议尽快完善企业信息,否则部分海翕云服务将无法使用。 -
步骤 2 获取海翕云访问密钥
为了使用短信发送API-JAVA SDK,您必须申请海翕云的访问密钥。
海翕云访问秘钥是海翕云为用户使用 API(非控制台`)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请 求内容以通过服务端的安全验证。
该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个海翕云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。
您可以通过海翕云控制台的短信服务-秘钥管理页面创建、管理所有的秘钥对,且保证它处于“启用”状态。由于访问 秘钥是海翕云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议 及时删除该秘钥对并生成新的替代秘钥对。
- 步骤 3 在控制台完成模板与签名的申请,获得调用接口必备的参数
短信签名
根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明,个人用户需要上传证明个人身份的证明。
注意:短信签名需要审核通过后才可以使用。
短信模板
短信模板,即具体发送的短信内容。
短信模板可以支持验证码、短信通知、推广短信、国际/港澳台消息四种模式。验证码和短信通知,通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。
短信模板需要审核通过后才可以使用。在控制台完成短信签名与短信模板的申请,获得调用接口必备的参数。
在“短信签名”页面完成签名的申请,获得短信签名的字符串。
在“短信模板”页面完成模板的申请,获得模板ID。
参数
入参列表参数列表 | 参数类型 | 必填与否 | 样例取值 | 参数说明 |
---|---|---|---|---|
appKey | String | 必填 | 412c971xxxxxxxxxxxxxxxx0858c | 接入使用的身份校验,可在www.eiisys.com上的 秘钥管理 中获得。注意:请勿随意删除或重置 |
appSecret | String | 必填 | 09b48xxxxxxxxxxxxx6423586d | 接入使用的身份校验,可在www.eiisys.com上的 秘钥管理 中获得。注意:请勿随意删除或重置 |
phones | String | 必填 | 13800000000 | 短信接收号码,支持以逗号分隔的形式进行批量调用,批量上限为1000个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式 |
signName | String | 必填 | 海翕云 | 短信签名 |
templateCode | String | 必填 | SMS_000810003_0000 | 短信模板ID |
templateParam | String | 可选 | {“name”:”xyz”,”code”:”123456”} | 短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议 |
CallBack | String | 可选 | http://********/receive/callback | 回调url,配置该参数时,会在短信接收报告生成时回调此地址。使用post方式,数据格式为json |
domain | String | 必填 | smsapi.eiisys.com | 短信服务的域名 |
出参名称 | 出参类型 | 样例取值 | 参数说明 | |
---|---|---|---|---|
code | String | 000000 | 状态码,短信接口调用状态码 | |
msg | String | OK | 状态码的描述 | |
resultList | List | 短信发送结果列表 |
出参名称 | 出参类型 | 参数说明 | |
---|---|---|---|
smsMsgId | String | 短信编号 | |
phoneFrom | String | 发送号码 | |
phoneTo | String | 接收号码 | |
status | String | 发送状态,详见短信发送状态回执码 | |
date | String | 发送时间 |
对接步骤
1:下载SDK工具包
SDK工具包中一共包含了1个类库,一个eiisys-sms-intracompany包。
SDK&DEMO[下载地址]
2: 编写样例程序
注:有备注无需修改的位置请勿改动。-
public static void main(String[] args) throws ClientException {
-
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
-
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
-
//appKey,appSecret,可在官网生成
-
IClientProfile profile = DefaultProfile.getProfile("你的appKey", "你的appSecret");
-
IAcsClient acsClient = new DefaultAcsClient(profile);
-
SendSmsRequest sendSmsRequest = new SendSmsRequest();
-
//电话号码,可用英文逗号分隔,最高一千电话号码
-
sendSmsRequest.setPhonesTo("135*********,136***********");
-
//服务器域名
-
sendSmsRequest.setDomain("smsapi.eiisys.com");
-
//短信模板code 您的${p1}于${p2},请${p3}查看。可在官网申请、查看
-
sendSmsRequest.setTemplateCode("SMS_**************");
-
//模板内参数,json字符串。
-
sendSmsRequest.setTemplateParam("{\"p1\":\"参数1\",\"p2\":\"参数2\",\"p3\":\"参数3\"}");
-
//使用的签名
-
//配置回调地址
-
sendSmsRequest.setBackUrl("http://192.168.10.81:8099/receive/callback");
-
sendSmsRequest.setSignName("你的短信签名");
-
//可能抛出异常,注意捕捉
-
SendSmsResponse sendSmsResponse = acsClient.getAcsResponse(sendSmsRequest);
-
}
短信查询API(QuerySendDetails)---JAVA
最近更新时间:2018-09-27 14:01:35短信发送记录查询接口(QuerySendDetails)
用于查询短信发送的状态,是否成功到达终端用户手机参数列表 | 参数类型 | 必填与否 | 举例取值 | 参数说明 |
---|---|---|---|---|
appKey | String | 必填 | 412c971xxxxxxxxxxxxxxxx0858c | 接入使用的身份校验,可在www.eiisys.com上的 秘钥管理 中获得。注意:请勿随意删除或重置 |
appSecret | String | 必填 | 09b48xxxxxxxxxxxxx6423586d | 接入使用的身份校验,可在www.eiisys.com上的 秘钥管理 中获得。注意:请勿随意删除或重置 |
sendDate | String | 必填 | 2018-08-08 | 短信发送的时间 |
smsMsgId | String | 必填 | 0000**********************695 | 在发送短信时的回执中可获得 |
domain | String | 必填 | smsapi.eiisys.com | 短信服务的域名 |
出参名称 | 出参类型 | 样例取值 | 参数说明 | |
---|---|---|---|---|
code | String | 000000 | 状态码,短信接口调用状态码 | |
msg | String | 操作成功 | 状态说明 | |
status | String | DELIVRD | 短信接收状态,详见短信发送状态回执 | |
sendTime | String | 2018-09-18 11:00:42 | 发送时间 | |
receiveTime | String | 2018-09-18 11:01:07 | 短信接收时间 | |
smsMsgId | String | 0000**********************695 | 短信唯一识别 | |
source | String | 2 | 短信状态报告来源: 1:短信平台自行产生的状态报告。 2:短信网关返回的状态报告。 |
|
orgCode | String | null |
透传南向网元返回的状态码。 SMPP:3位 CMPP:7位 短信平台:7位 −E200018:国内短信发送方通道校验失败 −E200019:国内短信发送方匹配通道失败 −E200020:国内短信签名通道校验失败 −E200021:国内短信签名匹配通道失败 −E200022:国内短信接收方通道校验失败 −E200023:国内短信接收方匹配通道失败 −E200024:没有国际短信能力 −E200025:国际短信接收方通道校验失败 −E200026:国际短信接收方匹 |
对接步骤
1:下载SDK工具包
SDK工具包中一共包含了1个类库,一个eiisys-sms-intracompany包。
SDK&DEMO[下载地址]
2: 编写样例程序
注:有备注无需修改的位置请勿改动。-
public static void main(String[] args) throws ClientException {
-
System.setProperty("sun.net.client.defaultConnectTimeout", "10000");
-
System.setProperty("sun.net.client.defaultReadTimeout", "10000");
-
//appKey,appSecret,可在官网生成
-
IClientProfile profile = DefaultProfile.getProfile("你的appKey", "你的appSecret");
-
IAcsClient acsClient = new DefaultAcsClient(profile);
-
QuerySendDetailsRequest sendDetailsRequest = new QuerySendDetailsRequest();
-
//短信发送时间
-
sendDetailsRequest.setSendDate("2018-08-08");
-
sendDetailsRequest.setDomain("smsapi.eiisys.com");
-
//短信发送时返回的唯一识别码
-
sendDetailsRequest.setSmsMsgId("0000**********************695");
-
//可能抛出异常,注意捕捉
-
QuerySendDetailsResponse acsResponse = acsClient.getAcsResponse(sendDetailsRequest);
-
}
短信消息API---JAVA
最近更新时间:2018-09-27 14:01:35短信消息API---JAVA
当您使用短信的API接口发送短信后,可以通过使用MNS的Queue模型来接收短信的回执消息,假如服务出现异常情况时(如网络问题),导致消息回执未成功获取,还可以通过短信发送记录查询API接口进行一定的补偿
出参名称 | 出参类型 | 样例取值 | 参数说明 | |
---|---|---|---|---|
status | String | DELIVRD | 短信接收状态,详见短信发送状态回执码 | |
sendTime | String | 2018-09-18 11:00:42 | 发送时间 | |
receiveTime | String | 2018-09-18 11:01:07 | 短信接收时间 | |
smsMsgId | String | 0000**********************695 | 短信唯一识别 | |
source | String | 2 | 短信状态报告来源: 1:短信平台自行产生的状态报告。 2:短信网关返回的状态报告。 |
|
orgCode | String | null |
透传南向网元返回的状态码。 SMPP:3位 CMPP:7位 短信平台:7位 −E200018:国内短信发送方通道校验失败 −E200019:国内短信发送方匹配通道失败 −E200020:国内短信签名通道校验失败 −E200021:国内短信签名匹配通道失败 −E200022:国内短信接收方通道校验失败 −E200023:国内短信接收方匹配通道失败 −E200024:没有国际短信能力 −E200025:国际短信接收方通道校验失败 −E200026:国际短信接收方匹 |
对接步骤
1:下载SDK工具包
SDK工具包中一共包含了1个类库,一个eiisys-sms-intracompany包。
SDK&DEMO[下载地址]
2: 编写样例程序
注:有备注无需修改的位置请勿改动。-
@RequestMapping("/callback")
-
@ApiOperation(value = "回调",httpMethod = "POST")
-
public String receive(@RequestBody SmsSendStatusReport smsSendStatusReport){
-
/*在此处插入你的处理逻辑*/
-
//返回ok表示正确接收到结果推送
-
return "ok";
-
}
短信发送状态回执码
最近更新时间:2018-09-27 14:01:35调用API接口会产生接口调用状态码,接口调用码详见API文档。
调用接口成功后,运营商异步返回的短信发送状态码如下:
status | 参数说明 | ||
---|---|---|---|
DELIVRD | 用户已成功收到短信 | ||
EXPIRED | 短信已超时 | ||
DELETED | 短信已删除 | ||
UNDELIV | 短信递送失败 | ||
ACCEPTD | 短信已接收 | ||
UNKNOWN | 短信状态未知 | ||
REJECTD | 短信被拒绝 | ||
E200003 | 找不到短信发送号或者短信发送号错误 | ||
E200005 | 合作伙伴没有权限给该号码所属的运营商发送短信 | ||
E200009 | 合作伙伴预授权受限 | ||
E200010 | 不支持给该号码所属运营商发送短信 | ||
E200011 | 号码格式错误 | ||
E200012 | 用户余额不足 | ||
E200013 | 短信内容格式不符 | ||
E200014 | 号码属于黑名单 | ||
E200015 | 发送短信数量太大 | ||
E200016 | 发送短信请求太快 |
短信接口调用状态码
最近更新时间:2018-09-27 14:01:35调用API接口会产生接口调用状态码,常见接口调用状态码请参考以下列表:
code | 参数说明 | ||
---|---|---|---|
400002 | 余额不足 | ||
400003 | 账号存在违规行为 | ||
700001 | 模板code不存在 | ||
700002 | 模板没有审核 | ||
700003 | 模板不能使用 | ||
700004 | 发送失败 | ||
700005 | 不在服务时间 | ||
E000000 | 系统异常 | ||
E000001~E000099 | HTTP头相关异常 | ||
E000001~E000019 | Authorization相关异常 | ||
E000001 | HTTP头未找到Authorization字段 | ||
E000002 | HTTP头未找到realm 字段 | ||
E000003 | HTTP头未找到profile字段 | ||
E000004 | Authorization中realm属性值应该为“SDP” | ||
E000005 | Authorization中profile属性值应该为“UsernameToken” | ||
E000006 | Authorization中type属性值应该为“Appkey” | ||
E000020~E000039 | X-WSSE相关异常 | ||
E000020 | HTTP头未找到X-WSSE字段 | ||
E000021 | X-WSSE字段中未找到UserName属性 | ||
E000022 | X-WSSE字段中未找到Nonce属性 | ||
E000023 | X-WSSE字段中未找到Created属性 | ||
E000024 | X-WSSE字段中未找到PasswordDigest属性 | ||
E000025 | Created属性格式错误 | ||
E000040~E000099 | HTTP头其他字段相关异常 | ||
E000100~E000299 | 合作伙伴鉴权异常 | ||
E000101 | 鉴权失败 | ||
E000500~E000699 | HTTP消息体相关异常 | ||
E000500 | HTTP消息体为空 | ||
E000501 | HTTP消息体非法 | ||
E000503 | 参数格式错误 | ||
E000504 | 参数长度超限 | ||
E000505 | 必选参数不存在 | ||
E200000~E299999 | SMS-related | ||
E200004 | 目标号码为空或格式错误 | ||
E200008 | 短信内容长度超限或为0 | ||
E200014 | 号码属于黑名单 | ||
E200015 | 发送短信数量太大 | ||
E200016 | 发送短信请求太快 |