{第三方短信所有接口的url}timestamp=1631865523&nonce=2e6eceb5737b473284c930c8ef79090eHeader
说明
X-QA-Hmac-Signature
权鉴签名
开启权鉴时使用，权鉴方式见下文。
未开启权鉴时，该Header填空字符串""。
QuickAudience会根据用户填写的密钥与URL请求参数timestamp和nonce进行HmacSHA256Hex签名并生成signature，并将此signature通过RequestHeader传递。您的服务接收到请求后，同样根据URL参数与webhook通道配置的密钥进行HmacSHA256Hex算法加密。如果计算的值与从RequestHeader中传过来的signature相同，则可以确定是此请求是从QuickAudience发出的，鉴权成功。
参数
key
webhook配置的密钥
123456789
签名算法示例：
publicStringmakeSignature(Stringkey,Stringtimestamp,Stringnonce){Stringstr=generateStr(key,timestamp,nonce);returnHmacUtils.hmacSha256Hex(key,str.replaceAll("\\s+",""));}/***签名待处理的字符串拼接*/publicstaticStringgenerateStr(Stringkey,Stringtimestamp,Stringnonce){String[]array=newString[]{key,timestamp,nonce};StringBuffersb=newStringBuffer();//字符串排序Arrays.sort(array);for(inti=0;i<3;i++){sb.append(array[i]);}returnsb.toString();}
接口描述
短信模板审核
URL
${prefix}/sms/smsTemplatetimestamp=&nonce=
请求方式
post
请求类型
application/json
返回类型
*/*
参数名
数据类型
参数类型
是否必填
1.remark
string
body
是
短信模板申请说明。请在申请说明中描述您的业务使用场景，长度为1~100个字符。
2.templateContent
模板内容，长度为1~500个字符。
3.templateName
模板名称，长度为1~30个字符。
4.templateSubject
否
模板主题，长度为1~20个字符。
5.templateType
integer(int32)
短信类型。
状态码
描述
200
OK
请求成功。
401
Unauthorized
403
Forbidden
请求被拒绝。
404
NotFound
请求的资源不存在。
返回属性名
类型
1.platformName
短信服务方名称，与接口配置时填写的接口名称一致。
2.code
请求状态码，200或OK表示成功。
3.message
状态码描述。
4.requestId
请求ID。
5.templateCode
短信模板code，用于查看模板申请状态和结果。
请求参数
-d'{"remark":"string","templateContent":"string","templateName":"string","templateSubject":"string","templateType":0}'
返回值
{"platformName":"string","code":"string","templateCode":"string","message":"string","requestId":"string"}
短信模板修改
${prefix}/sms/smsTemplate/{templateCode}timestamp=&nonce=
put
短信签名审核状态查询
${prefix}/sms/smsSign/{signName}timestamp=&nonce=
get
1.signName
path
短信签名。
3.createDate
4.message
5.reason
审核备注。如果审核状态为审核通过或审核中，参数Reason显示为“无审核备注”；如果审核状态为审核未通过，参数Reason显示审核的具体原因。
6.requestId
7.signName
8.signStatus
签名审核状态。
无示例
{"reason":"string","code":"string","signName":"string","requestId":"string","signStatus":0,"platformName":"string","message":"string","createDate":"string"}
短信模板审核状态查询
1.templateCode
模板code。
服务方名称，与接口配置时填写的接口名称一致。
7.templateCode
8.templateContent
模板内容。
9.templateName
模板名称。
10.templateStatus
模板审核状态。
11.templateType
短信模板类型。
{"templateStatus":0,"templateType":0,"reason":"string","code":"string","templateName":"string","requestId":"string","templateContent":"string","platformName":"string","templateCode":"string","message":"string","createDate":"string"}
单条短信发送
${prefix}/sms/sendtimestamp=&nonce=
1.limit
integer(int64)
发送人数限制。
2.outId
外部流水扩展字段。
3.phoneNumbers
接收短信的手机号码。
国内短信：11位手机号码，例如159********；国际/中国香港、中国澳门和中国台湾消息：国际区号+号码，例如85200******。
4.signName
短信签名名称。
6.templateParam
短信模板变量对应的实际值，JSON格式。例如：[{"name":"TemplateParamJson","age":"age"}]，和phoneNumbers的数量保持一致，数量不一致会报错。
1.bizId
发送回执ID。
2.platformName
3.code
5.requestId
-d'{"limit":0,"outId":"string","phoneNumbers":"string","signName":"string","templateCode":"string","templateParam":"string"}'
{"bizId":"string","platformName":"string","code":"string","message":"string","requestId":"string"}
大量短信发送
${prefix}/sms/sendBatchtimestamp=&nonce=
3.phoneOssUrl
接收短信的手机号码文件所在的OSS路径。文件格式txt。
国内短信：11位手机号码，例如159********；国际/中国香港、中国澳门和中国台湾消息：国际区号+号码，例如85200******。每个号码一行。变量短信会在每行手机号后面加上变量名称与替换值内容。例如：{"name":"TemplateParamJson","age":"age"}
6.isVariable
是否是变量短信。
-d'{"limit":0,"outId":"string","phoneOssUrl":"string","signName":"string","templateCode":"string","isVariable":"string"}'
短信发送明细查询
${prefix}/sms/sendDetailstimestamp=&nonce=
1.outId
2.currentPage
分页查看发送记录，指定发送记录的当前页码。
3.pageSize
分页查看发送记录，指定每页显示的短信记录数量。取值范围为1~1000。
4.startDate
5.endDate
短信服务方名称，与接口配置时填写的接口名称一致
5.sendDetailDTOs
array:SmsSendDetailDTO
短信发送明细。
5.1.content
短信内容。
5.2.errCode
运营商短信状态码。短信发送成功：DELIVERED。短信发送失败：给出错误码。
5.3.outId
5.4.phoneNum
5.5.receiveDate
5.6.sendDate
5.7.sendStatus
短信发送状态。
5.8.templateCode
短信模板ID。
6.totalCount
短信发送总条数。
-d'{"outId":"string","currentPage":0,"pageSize":0,"startDate":"string","endDate":"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"}]}