富信 - 概览

1 卓鹰平台对接视频短信发送功能流程

1. 创建卓鹰平台帐号
2. 联系客服开通富信功能并根据客服引导提供签名报备资质材料 获取 APPID 和 APPSecret
3. 富信-平台设置-系统设置-数据推送 中设置审核回执地址
4. 前置条件:签名审核通过,调用模版创建接口创建模版
5. 模版ID提供运营人员审核通过该模版,之后产生审核通知信息到 第3步 设置的回执地址中
6. 前置条件:模版审核通过,调用模版消息发送接口
7. 发送状态回执到 第3步 设置的回执地址中
8. 完成流程

2 SIGN 生成规则

sign=MD5(nonce+timestamp+appKey+appSecret)
注意事项:md5 32 位小写
参数定义:
nonce 用户自定义字符串
timestamp 时间戳转(yyyyMMddHHmmss)格式,如:20210601093004
appKey 平台提供
appSecret 平台提供
例如 : 
{"nonce":"shinx","timestamp":"20210727141938","appKey":"OiW6txJ8AZ1WkJPYFmxx","appSecret":"yVvXJM0SvFZuBRpCmGwK"}
    MD5("shinx20210727141938OiW6txJ8AZ1WkJPYFmxxyVvXJM0SvFZuBRpCmGwK)  
生成sign为: c0e6a1e4d125bf4cfc01a933ced8f5e5
            

3 Authorization生成规则

Authorization=SHA256(URI+sign)
注意事项:SHA256 使用 HmacSHA256 类型
参数定义:
URI    调用接口时不同接口使用不同uri  
sign  根据SIGN 生成规则生成
secret  卓鹰平台提供接口秘钥,值为 RICH_ZY   
例如:2.1 模版创建接口  则所需 加签字符为    
/v1/api/rich/template/createc0e6a1e4d125bf4cfc01a933ced8f5e5
​
加签后字符为  
YmRjMmVkNmZiODIyZTYxMjRhYzk4NjQ5NTY5MzM2MzkyNzc3OWNhMGRjY2NiMzQ5NThiYzc2NzllMGQwMzA1Mg%3D%3D
4 JAVA参考代码如下:
private static String byteToHex(byte[] bytes) {
    if (bytes == null)  return null;
    StringBuffer stringBuffer = new StringBuffer();
    String temp = null;
    for (int i = 0; i < bytes.length; i++) {
        temp = Integer.toHexString(bytes[i] & 0xff);
        if (temp.length() == 1) {
            stringBuffer.append("0");
        }
        stringBuffer.append(temp);
    }
    return stringBuffer.toString();
}
​
public static void main(String[] args) {
    try {
        String secret="RICH_ZY";
        String message="/v1/api/rich/template/createc0e6a1e4d125bf4cfc01a933ced8f5e5";
        Mac sha256_HMAC = Mac.getInstance("HmacSHA256");
        SecretKeySpec secretKey = new SecretKeySpec(secret.getBytes("utf-8"), "HmacSHA256");
        sha256_HMAC.init(secretKey);
        byte[] hash = sha256_HMAC.doFinal(message.getBytes("utf-8"));
        String SHA256 = byteToHex(hash);
        String encodeStr = Base64.getEncoder().encodeToString(SHA256.getBytes("utf-8"));
        String Authorization = URLEncoder.encode(encodeStr, "utf-8");
        System.out.println(Authorization);
    } catch (Exception e) {
​
    }
}
5 公共输入参数说明:
名称类型是否必须备注其他信息
AuthorizationHeader必须header参数用于接口鉴权参见 Authorization生成规则
Content-TypeHeader必须header参数请求体格式值为:application/json
appKeyString必须卓鹰平台AppID平台提供APPID
nonceString必须客户自定义唯一标识用户自定义 长度不超过32位
signString必须加签字符,32位小写MD5(nonce+timestamp+appKey+appSecret)MD5计算得出 该字符串小写
timestampString必须时间戳字符串(yyyyMMddHHmmss)例:20210601103030

6 附录

错误码表
错误码编码值编码描述
AUTH_API_ERROR830APP鉴权失败
SIGN_NAME_DUPLICATE1004签名名称重复
SIGN_UPDATE_ERROR1006该签名正在审核中或已审核,无法修改
SIGN_ENABLE_ERROR1007该签名还未审核通过,无法禁用
SIGN_EDIT_ERROR1009改签名已被使用,无法修改
SIGN_AUDIT_SP_WAIT1011运营商审核中,请等待结果
SIGN_AUDIT_SP_FAIL1012运营商审核失败
SIGN_AUDIT_SP_ERROR1013运营商通道异常
SIGN_AUDIT_SP_UNIQUE1014签名对应运营商签名不唯一
SIGN_NOT_FOUND1015签名不存在
PROVIDER_SIGN_AUDIT_ERROR1016服务商签名线下送审不合规
TEMPLATE_SIGN_FAIL2003模板签名添加失败
TEMPLATE_NAME_DUPLICATE2004模板名称重复
PARAM_ERROR2005参数校验失败
TEMPLATE_UPDATE_ERROR2006只可修改未审核通过的模板
CHANNEL_NOT_FOND2010通道不存在
TEMPLATE_NOT_EXIST2011模板不是待审核状态
TEMPLATE_DISABLE2013模板不可用
TEMPLATE_CODE_ERR2014模板CODE为空
INSTITUTION_ERR2015institutionId为空
FILE_NULL2016文件为空
CMCC_CHANNEL_NOT_FOND2019移动通道配置不存在
CUCC_CHANNEL_NOT_FOND2020联通通道配置不存在
CTCC_CHANNEL_NOT_FOND2021电信通道配置不存在
TEMPLATE_TYPE_NOT_SUPPORT2022模板类型不支持
TEMPLATE_TYPE_VERIFYCODE_NOT_SUPPORT2023模板类型-验证码类型不支持
CHANNEL_API_ERROR2041通道api调用错误
TEMPLATE_DYNAMIC_PARAM_ERROR2042动态模板参数校验异常
TEMPLATE_EDIT_ERROR2043该模板已被使用,无法修改
SEND_TEMPLATE_NOT_ENABLE3001模板不可用
SEND_BALANCE_SPENT3002用户余额不足
SEND_ISP_TEMPLATE_INFO_ERROR3003运营商模板信息不全
SEND_CHANNEL_INFO_ERROR3004通道信息不全
TASK_NAME_DUPLICATE3007任务名称重复
CHECK_ERROR3008任务不是待审核状态
TASK_UPDATE_ERROR3009只可撤销待发送或待审核任务
PHONE_ERR3010手机号格式有误
PHONE_SOURCE_ERR3011手机号码来源不存在
PHONE_NOT_EMPTY3012手机号列表不可为空
RECORD_QUERY_TIME_ERROR5000查询跨度超过3天
RECORD_QUERY_INSTITUTION_EMPTY5001商户ID为空
RECORD_QUERY_USER_EMPTY5002UserID为空
CHANNEL_SERVICE_NOT_EXIST8000指定通道不存在
TEMPLATE_CREATE_FAIL8001模板创建失败
SEND_CREATE_FAIL8002短信发送失败
SIGN_CREATE_FAIL8003签名送审失败
SEND_PHONE_EXIST8004发送手机号码不存在
RECEIPT_MSG_PHONE_MAPPING_ERROR8005回执任务ID对应手机号码解析错误
FILE_TYPE_NOT_SUPPORTED8100素材类型不支持
IMAGE_TYPE_NOT_SUPPORTED8101图片类型不支持
VIDEO_TYPE_NOT_SUPPORTED8102视频类型不支持
AUDIO_TYPE_NOT_SUPPORTED8103音频类型不支持
效果示例
素材要求
素材类型要求**(素材包组合不超过 1.9M)
文本文案主标题:20 字符以内,建议 15 字以内(简明扼要的标题党)
文案内容:文字+标点建议不超过 500个字符,附链接;
图片两个尺寸:640*640 / 640*360 格式:png/jpg
视频任选一尺寸:横 640*360(建议)/竖版 640*820, 单个模板视频类素材最多上传一个
音频建议大小不超过 1MB、60S