免费体验
开发前必读
短信API
富信API
DEMO下载

富信 - 模板

1 模版创建

请求Url: /v1/api/rich/template/create
Method: POST
接口描述: 
文本素材内容编码：utf-8 ,支持动态参数 使用${key} 占位，动态参数不超过30字符，最多三个占位符
图片类型 jpg ,png
视频类型 mp4,3gp
音频类型 mp3,amr,mid
参见 附录-素材要求

请求参数

Headers
参数名称参数值是否必须示例备注
Content-Typeapplication/jsonY  
Authorization参见 Authorization生成规则Yheader参数用于接口鉴权参见 Authorization生成规则
Body
名称类型是否必须备注其他信息
templateNamestringY模板名称模板名称
templateSignstringY模版签名 
titleStringY模版标题 
contentsListY模版内容TemplateContent实体描述参看下表，最多八帧内容
describes String Y 模版审核申请理由
timestampstringY时间戳yyyyMMddHHmmss 
noncestringY客户定义任意值 
signstringY签名 MD5（Nonce + timestamp + AppKey + AppSecret） 
appKeystringYAPPID访问 短信平台商户后台->业务配置->发送账号管理->APPID 中获取
TemplateContent 模版正文帧信息
名称类型是否必须备注其他信息
materialstringY帧内容文件信息时为文件URL地址
typeIntY类型类型可选值 0 文本 1 图片 2 视频 3 音频
siteStringY帧位置位置 1-2 表示第一页第2个位置
sizeintY帧内容大小提供material字段所占用字节大小

返回参数

名称类型是否必须备注其他信息
codestringY返回码200成功 其他失败
dataStringN模版唯一编码 
msgstringN返回描述 
requestIdstringNtranceId 

2 模版删除

请求Url: /v1/api/rich/template/delete
Method: POST

请求参数

Headers
参数名称参数值是否必须示例备注
Content-Typeapplication/jsonY  
Authorization参见 Authorization生成规则Yheader参数用于接口鉴权参见 Authorization生成规则
Body
名称类型是否必须备注其他信息
templateCodestringY模板唯一编码模板唯一编码
timestampstringY时间戳yyyyMMddHHmmss 
noncestringY客户定义任意值 
signstringY签名 MD5（Nonce + timestamp + AppKey + AppSecret） 
appKeystringYAPPID访问 短信平台商户后台->业务配置->发送账号管理->APPID 中获取

返回参数

名称类型是否必须备注其他信息
codestringY返回码200成功 其他失败
dataBooleanN模版删除是否成功 
msgstringN返回描述 
requestIdstringNtranceId 

3 模版审核回执通知

回调设置路径: 卓鹰短信平台商户后台 平台设置-->系统设置-->数据推送 配置客户自定义
Method: POST
接口描述：
若回调失败，最多重试10次。
当因为回调失败缺失了审核状态时，可以调用模板状态查询接口查询模板审核结果和状态。

请求参数

Headers
参数名称参数值是否必须示例备注
Content-Typeapplication/jsonY  
Body
名称类型是否必须备注其他信息
templateCodestringY模板唯一编码 
statusstringY模版审核状态0 审核成功 -1 审核失败
reasonstringY审核失败原因失败时必填
receivedTslongY审核回执时间时间戳
channelstringN通道编码固定RICH_ZY
appIdStringN模板appid用于区分模板提供给哪个卓鹰平台账号

返回参数

"SUCCESS"

4 模版状态查询

请求Url: /v1/api/rich/template/status/query
Method: POST

请求参数

Headers
参数名称参数值是否必须示例备注
Content-Typeapplication/jsonY  
Authorization参见 Authorization生成规则Yheader参数用于接口鉴权参见 Authorization生成规则
Body
名称类型是否必须备注其他信息
templateCodeListY模板唯一编码模板唯一编码
timestampstringY时间戳yyyyMMddHHmmss 
noncestringY客户定义任意值 
signstringY签名 MD5（Nonce + timestamp + AppKey + AppSecret） 
appKeystringYAPPID访问 短信平台商户后台->业务配置->发送账号管理->APPID 中获取

返回参数

名称类型是否必须备注其他信息
codestringY返回码200成功 其他失败
dataList[object]N模版审核状态 
|-- templateCodeStringY模版编码 
|-- receivedTslongN模版审核时间时间戳
|-- statusstringY模版审核状态 0 审核成功 -1 审核失败 1审核中 2已删除 
|--reasonStringN模版审核失败原因 
msgStringN返回描述 
requestIdstringNtranceId