全部产品

三方短信邮件平台接口开发规范

更新时间:2020-09-02 15:12:23

接口公共参数

名称类型是否必须描述
AccountIdStringQA组织创建者账户ID。用户配置三方接口时QA测会显示出来,同时会返回签名秘钥,用于签名校验,请妥善保存。第三方需要根据该id映射自己平台内账户。
SignatureString签名结果串,关于签名的计算方法,请参见签名机制。
SignatureMethodString签名方式,目前支持 HMAC-SHA1。
TimestampString请求的时间戳。日期格式按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为YYYY-MM-DDThh:mm:ssZ。 例如,2015-11-23T04:00:00Z(为北京时间 2015 年 11 月 23 日 12 点 0 分 0 秒)。
SignatureNonceString唯一随机数,用于防止网络重放攻击。不同的请求要使用不同的随机数值。您可以使用UUID(随机串),也可以自定义。

1)添加邮件模板

邮件模板审核
接口描述添加邮件模板
URL${prefix}/email/emailTemplate
请求方式post
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:AddEmailTemplateModelbodyY模板信息
1.1.remarkstring Y模板申请说明。请在申请说明中描述您的业务使用场景,长度为1~100个字符
1.2.senderNamestring 发送人名称
1.3.templateContentstring 模板内容,限制28K
1.4.templateNamestring 模板名称,长度为1~30个字符
1.5.templateSubjectstring 模板标题
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.messagestring状态码描述
4.requestIdstring请求ID
5.templateCodestring模板CODE,用于查看模板申请状态和结果
示例
请求参数-d '{"remark":"string","senderName":"string","templateContent":"string","templateName":"string","templateSubject":"string"}'
返回值{"platformName":"string","code":"string","templateCode":"string","message":"string","requestId":"string"}

2)修改邮件模板

修改邮件模板
接口描述修改邮件模板
URL${prefix}/email/emailTemplate/{templateCode}
请求方式put
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:UpdateEmailTemplateModelbodyY模板信息
1.1.remarkstringN模板申请说明。请在申请说明中描述您的业务使用场景,长度为1~100个字符
1.2.senderNamestringN发送人名称
1.3.templateContentstringN模板内容,限制28K
1.4.templateNamestringN模板名称,长度为1~30个字符
1.5.templateSubjectstringN模板标题
状态码描述说明
200OK

201Created

401Unauthorized

403Forbidden

404Not Found

返回属性名类型说明
1.platformNamestring服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.messagestring状态码描述
4.requestIdstring请求ID
5.templateCodestring模板CODE,用于查看模板申请状态和结果
示例
请求参数-d '{"remark":"string","senderName":"string","templateContent":"string","templateName":"string","templateSubject":"string"}'
返回值{"platformName":"string","code":"string","templateCode":"string","message":"string","requestId":"string"}

3)邮件模板审核状态查询

邮件模板审核状态查询
接口描述邮件模板审核状态查询
URL${prefix}/email/emailTemplate/{templateCode}
请求方式get
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.templateCodestringpathY模板code
状态码描述说明
200OK 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.createDatestring模板的创建日期和时间,如:2019-01-08 16:44:13
4.messagestring状态码描述
5.reasonstring审核备注:如果审核状态为审核通过或审核中,参数Reason显示为“无审核备注”;如果审核状态为审核未通过,参数Reason显示审核的具体原因
6.requestIdstring请求ID
7.templateCodestring模板CODE
8.templateContentstring模板内容
9.templateNamestring模板名称
10.templateStatusinteger(int32)签名审核状态:0:审核中,1:审核通过,审核失败,请在返回参数Reason中查看审核失败原因
示例
请求参数 
返回值{"templateStatus":0,"reason":"string","code":"string","templateName":"string","requestId":"string","templateContent":"string","platformName":"string","templateCode":"string","message":"string","createDate":"string"}

4)邮件发送

大量邮件发送
接口描述大量邮件发送
URL${prefix}/email/sendBatch
请求方式post
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:SendBatchEmailModelbodyY邮件发送请求参数
1.1.accountNamestring Y发信地址
1.2.addressTypestring Y地址类型。取值:0:为随机账号 1:为发信地址
1.3.clickTracestring N0(默认):为关闭数据跟踪功能,1:为打开数据跟踪功能
1.4.fromAliasstring N发信人昵称,长度小于15个字符。 例如:发信人昵称设置为”小红”,发信地址为 test@example.com,收信人看到的发信地址为"小红"<test@example.com>
1.5.subjectstring N邮件主题
1.6.htmlBodystring N邮件 html 正文,限制28K
1.7.limitinteger(int64) N发送人数限制
1.8.outIdstring N外部流水扩展字段,标签于统计
1.9.receiversUrlstring Yoss上传的收件人地址文件url
1.10.templateCodestring N预先创建且通过审核的模板code,与4.5.6参数互斥,同时填写以模板内容为准
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.bizIdstring发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态
2.platformNamestring服务方名称,与接口配置时填写的接口名称一致
3.codestring请求状态码:返回OK代表请求成功,其他错误码
4.messagestring状态码描述
5.requestIdstring请求ID
示例
请求参数-d '{"accountName":"string","addressType":"string","clickTrace":"string","fromAlias":"string","htmlBody":"string","limit":0,"outId":"string","receiversUrl":"string","subject":"string","templateCode":"string"}'
返回值{"bizId":"string","platformName":"string","code":"string","message":"string","requestId":"string"}

5)邮件发送明细查询 

邮件发送明细查询
接口描述邮件发送明细查询
URL${prefix}/email/sendDetails
请求方式post
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:QuerySendDetailModelbodyY邮件发送明细查询请求参数
1.1.outIdstring Y外部流水扩展字段,可根据该ID在接口QuerySendDetails中查询具体的发送状态
1.2.currentPageinteger(int64) Y分页查看发送记录,指定发送记录的的当前页码
1.3.pageSizeinteger(int64) Y分页查看发送记录,指定每页显示的短信记录数量。 取值范围为1~1000
1.4.startDatestring Y起始时间,时间不能早于30日,格式yyyy-MM-dd HH:mm
1.5.endDatestring Y结束时间,和起始时间跨度不能超出30天, 格式yyyy-MM-dd HH:mm
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.messagestring状态码描述
4.requestIdstring请求ID
5.sendDetailDTOsarray:EmailSendDetailDTO发送明细
5.1.accountNamestring发信地址
5.2.codestring返回投递错误码
5.3.messagestring投递详情信息
5.4.outIdstring外部流水扩展字段
5.5.receiveTimestring接收日期和时间,10位时间戳
5.6.statusinteger(int32)投递状态
5.7.toAddressstring收信地址
6.totalCountinteger(int32)发送总条数
示例
请求参数-d '{"bizId":"string","currentPage":0,"pageSize":0,"startDate":"string","endDate":"string"}'
返回值{"platformName":"string","code":"string","message":"string","totalCount":0,"requestId":"string","sendDetailDTOs":[{"accountName":"string","code":"string","message":"string","outId":"string","receiveDate":"string","status":0,"toAddress":"string"}]}

6)邮件发件箱地址查询

邮件发件箱地址查询
接口描述邮件发件箱地址查询
URL${prefix}/email/thirdSender
请求方式get
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.addressstringqueryY发件箱地址
状态码描述说明
200OK

401Unauthorized

403Forbidden

404Not Found

返回属性名类型说明
1.accountNamestring发信地址
2.accountStatusinteger(int32)账号状态,冻结:1, 正常:0
3.platformNamestring服务方名称,与接口配置时填写的接口名称一致
4.codestring请求状态码:返回OK代表请求成功,其他错误码
5.createDatestring创建日期和时间,如:2019-01-08 16:44:13
6.mailAddressIdstring发信地址ID
7.messagestring状态码描述
8.requestIdstring请求ID
示例
请求参数address={email}
返回值{"accountStatus":0,"code":"string","accountName":"string","requestId":"string","platformName":"string","message":"string","mailAddressId":"string","createDate":"string"}

7)短信模板审核

短信模板审核
接口描述短信模板审核
URL${prefix}/sms/smsTemplate
请求方式post
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:AddSmsTemplateModelbodyY模板信息
1.1.remarkstring Y短信模板申请说明。请在申请说明中描述您的业务使用场景,长度为1~100个字符
1.2.templateContentstring Y模板内容,长度为1~500个字符
1.3.templateNamestring Y模板名称,长度为1~30个字符
1.4.templateSubjectstring N模板主题,长度为1~20个字符
1.5.templateTypeinteger(int32) Y短信类型:0:验证码,1:短信通知,2:推广短信,3:国际/港澳台消息
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring短信服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.messagestring状态码描述
4.requestIdstring请求ID
5.templateCodestring短信模板CODE,用于查看模板申请状态和结果
示例
请求参数-d '{"remark":"string","templateContent":"string","templateName":"string","templateSubject":"string","templateType":0}'
返回值{"platformName":"string","code":"string","templateCode":"string","message":"string","requestId":"string"}

8)短信模板修改

短信模板修改
接口描述短信模板修改
URL${prefix}/sms/smsTemplate/{templateCode}
请求方式put
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:AddSmsTemplateModelbodyY模板信息
1.1.remarkstring N短信模板申请说明。请在申请说明中描述您的业务使用场景,长度为1~100个字符
1.2.templateContentstring N模板内容,长度为1~500个字符
1.3.templateNamestring N模板名称,长度为1~30个字符
1.4.templateSubjectstring N模板主题,长度为1~20个字符
1.5.templateTypeinteger(int32) N短信类型:0:验证码,1:短信通知,2:推广短信,3:国际/港澳台消息
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring短信服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.messagestring状态码描述
4.requestIdstring请求ID
5.templateCodestring短信模板CODE,用于查看模板申请状态和结果
示例
请求参数-d '{"remark":"string","templateContent":"string","templateName":"string","templateSubject":"string","templateType":0}'
返回值{"platformName":"string","code":"string","templateCode":"string","message":"string","requestId":"string"}

9)短信签名审核状态查询

短信签名审核状态查询
接口描述短信签名审核状态查询
URL${prefix}/sms/smsSign/{signName}
请求方式get
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.signNamestringpathY短信签名
状态码描述说明
200OK 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring短信服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.createDatestring短信签名的创建日期和时间,如:2019-01-08 16:44:13
4.messagestring状态码描述
5.reasonstring审核备注:如果审核状态为审核通过或审核中,参数Reason显示为“无审核备注”;如果审核状态为审核未通过,参数Reason显示审核的具体原因
6.requestIdstring请求ID
7.signNamestring短信签名
8.signStatusinteger(int32)签名审核状态:0:审核中,1:审核通过,审核失败,请在返回参数Reason中查看审核失败原因
示例
请求参数 
返回值{"reason":"string","code":"string","signName":"string","requestId":"string","signStatus":0,"platformName":"string","message":"string","createDate":"string"}

10)短信模板审核状态查询

短信模板审核状态查询
接口描述短信模板审核状态查询
URL${prefix}/sms/smsTemplate/{templateCode}
请求方式get
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.templateCodestringpathY模板code
状态码描述说明
200OK 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.platformNamestring服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.createDatestring模板的创建日期和时间,如:2019-01-08 16:44:13
4.messagestring状态码描述
5.reasonstring审核备注:如果审核状态为审核通过或审核中,参数Reason显示为“无审核备注”;如果审核状态为审核未通过,参数Reason显示审核的具体原因
6.requestIdstring请求ID
7.templateCodestring模板CODE
8.templateContentstring模板内容
9.templateNamestring模板名称
10.templateStatusinteger(int32)签名审核状态:0:审核中,1:审核通过,审核失败,请在返回参数Reason中查看审核失败原因
11.templateTypeinteger(int32)短信模板类型:0:验证码,1:短信通知,2:推广短信,3:国际/港澳台消息;邮件忽略
示例
请求参数 
返回值{"templateStatus":0,"templateType":0,"reason":"string","code":"string","templateName":"string","requestId":"string","templateContent":"string","platformName":"string","templateCode":"string","message":"string","createDate":"string"}

11)短信发送

大量短信发送
接口描述大量短信发送
URL${prefix}/sms/sendBatch
请求方式post
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:SendBatchSmsModelbodyY短信发送请求参数
1.1.limitinteger(int64) N发送人数限制
1.2.outIdstring Y外部流水扩展字段
1.3.phoneOssUrlstring Y接收短信的手机号码文件所在的oss路径。文件格式txt 国内短信:11位手机号码,例如15951955195;国际/港澳台消息:国际区号+号码,例如85200000000;每个号码一行
1.4.signNamestring Y短信签名名称
1.5.templateCodestring Y模板CODE
1.6.templateParamstring N短信模板变量对应的实际值,JSON格式
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性名类型说明
1.bizIdstring发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态
2.platformNamestring服务方名称,与接口配置时填写的接口名称一致
3.codestring请求状态码:返回OK代表请求成功,其他错误码
4.messagestring状态码描述
5.requestIdstring请求ID
示例
请求参数-d '{"limit":0,"outId":"string","phoneOssUrl":"string","signName":"string","templateCode":"string","templateParam":"string"}'
返回值{"bizId":"string","channelName":"string","code":"string","message":"string","requestId":"string"}

12)短信发送明细查询

短信发送明细查
接口描述短信发送明细查询
URL${prefix}/sms/sendDetails
请求方式post
请求类型application/json
返回类型*/*
参数名数据类型参数类型是否必填说明
1.modelobject:QuerySendDetailModelbodyY短信发送明细查询请求参数
1.1.outIdstring Y外部流水扩展字段,可根据该ID在接口QuerySendDetails中查询具体的发送状态
1.2.currentPageinteger(int64) Y分页查看发送记录,指定发送记录的的当前页码
1.3.pageSizeinteger(int64) Y分页查看发送记录,指定每页显示的短信记录数量。 取值范围为1~1000
1.4.startDatestring Y起始时间,时间不能早于30日,格式yyyy-MM-dd HH:mm
1.5.endDatestring Y结束时间,和起始时间跨度不能超出30天, 格式yyyy-MM-dd HH:mm
状态码描述说明
200OK 
201Created 
401Unauthorized 
403Forbidden 
404Not Found 
返回属性类型说明
1.platformNamestring短信服务方名称,与接口配置时填写的接口名称一致
2.codestring请求状态码:返回OK代表请求成功,其他错误码
3.messagestring状态码描述
4.requestIdstring请求ID
5.sendDetailDTOsarray:SmsSendDetailDTO短信发送明细
5.1.contentstring短信内容
5.2.errCodestring运营商短信状态码。短信发送成功:DELIVERED。短信发送失败:给出错误码
5.3.outIdstring外部流水扩展字段
5.4.phoneNumstring接收短信的手机号码
5.5.receiveDatestring短信接收日期和时间
5.6.sendDatestring短信发送日期和时间
5.7.sendStatusinteger(int64)短信发送状态,包括:1:发送失败,2:发送成功
5.8.templateCodestring短信模板ID
6.totalCountinteger(int32)短信发送总条数
示例
请求参数-d '{"bizId":"string","currentPage":0,"pageSize":0,"sendDate":"string"}'
返回值{"platformName":"string","code":"string","message":"string","totalCount":0,"requestId":"string","sendDetailDTOs":[{"content":"string","errCode":"string","outId":"string","phoneNum":"string","receiveDate":"string","sendDate":"string","sendStatus":0,"templateCode":"string"}]}