1. 首页
  2. 富媒体短信
  3. API接口
  4. API接口文档
菜单
本页目录

秒信通视频短信接口方式

视频短信对接秒信通有两种模式：

1.cmpp协议对接

2.https协议对接

一、CMPP对接模式

1.非变量模板发送方式
直接在短信内容中输入”【签名】模板号“进行发送

2.变量模板发送方式

直接在短信内容中输入”【签名】模板号#变量1#变量2“进行发送

示例：【xxx】123#东方店#0571-86xxxx1345

示例 说明
【xxx】 你要发送的视频短信的签名
123 已经报备并审核通过的模板号ID
#变量1#变量2 彩信内容是变量彩信，则根据内容中报备的变量数在彩信内容后追加实际变量，每个新变量以#开头.

二、https对接模式

1、签名报备

地址：123.207.108.11:9511/mms/sign

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数:

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是
sign 签名 测试签名 是

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 签名id {"sign_id":49}

2、获取签名审核状态

地址：123.207.108.11:9511/mms/sign-status

请求头求方式：Get 返回值：JSON

参数

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是
sign_id 签名id 22 是

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 审核状态0-待审核 1-审核通过 2-被驳回 {"status":"1"}

3、模板报备

地址：123.207.108.11:9511/mms/template

请求头Content-Typ值：JSON

参数

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是
title 彩信标题 测试 是
content 模版内容 详见格式说明 是
sign_id 报备的签名id 22 是
is_personality 是否是变量模版0-否 1-是 1 是
模版content格式说明

  1. 多个帧之间以英文;分隔

  2. 每一帧以"3,"开头,之后的数据用英文,分隔

  3. 数据用英文|分隔，|前是上传的文件类型，|后是文件的base64编码数据

  4. 如果是变量文本，则占位符是${Text},比如：尊敬的${Text}您好

  5. 支持格式txt, gif, jpg, mp3, mp4, 3gp

  6. 例：3,txt|5rWL6K+V5LiA5LiL;3,txt|5rWL6K+V5LiA5LiL,mp4|3i/Zy9/g1ttOfqUy0JRTw8YuI3CyKPV

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 模版id {"temp_id":49}

4、获取模版审核状态

地址：123.207.108.11:9511/mms/template-status

请求头Content-Type：application/x-www-form-urlencoded

请求方式：Get 返回值：JSON

参数

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是
temp_id 模版id 22 是

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 审核状态0-待审核 1-审核通过 2-被驳回 {"status":"1"}

5、普通视频短信发送(不带变量)

地址：123.207.108.11:9511/mms/send-temp

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是
temp_id 模版id 22 是
mobile 手机号（多个手机号以英文,分割） 136****1111,133****1112 是

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 任务ID {"task_id": 112}

6、个性视频短信发送(带变量)

地址：123.207.108.11:9511/mms/send-personal

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是
temp_id 模版id 22 是
mobile 手机号（多个手机号以英文,分割） 136****1111,133****1112 是
personality 变量json（如果是变量模版需要带上这个参数） {"13611111111":["参数1","参数2"],"13611111112":["参数1","参数2"]} 否

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 任务ID {"task_id": 112}

7、获取状态报告

地址：123.207.108.11:9511/mms/report

请求头Content-Type：application/x-www-form-urlencoded

请求方式：Get 返回值：JSON

参数

参数 参数介绍 示例 必填
account 产品(sp_id) 876252 是
password 密码(sp_id) 13e9bd7bebcba1f6c92363c8d7119006 是

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 任务ID [{"mobile":"18000000000","task_id":"103","status":"WL:CXQS","done_time":"2024-01-01 00:00:00"},{"mobile":"19100000000","task_id":"103","status":"WL:CXQS","done_time":"2024-01-01 00:00:00"}]

8、推送状态报告

INFO

注：每条短信仅推送一次

  • 注意事项：推送使用的是POST方式，utf8原始字节流

  • 推送格式：扩展号,调用发送接口返回的msg_id,手机号,状态,时间,售价 字段以,分隔 多条记录以|分隔

  • 内容示范：123,2,1762532xxxx,DELIVRD,2021-12-23 01:02:03,0.2|123,2,17862532xxxx,DELIVRD,2021-12-23 01:02:03,0.1

9、获取用户上行回复

INFO

注：比如退订等，每条短信状态仅可获取一次

地址：123.207.108.11:9511/api/get-reply

请求方式：GET 返回值：JSON

手机回复上行后，此接口就能拉取到上行数据，每个上行数据只能拉取到一次，所以调用者拉到上行后，需要将上行的内容存在本地，然后自行根据 msg_id,手机号 等信息匹配具体哪条短信产生的上行回复

参数

参数 参数介绍 示例 必填
sp_id 产品sp_id 876252 是
signature 签名（和密码二选一即可） a92569901189f2574effc957c096c432e2d47635 否
password 密码（和签名二选一即可）,通过sp_id的密码进行md5处理 13e9bd7bebcba1f6c92363c8d7119006 否

返回值

参数 参数介绍 示例
code 详情见错误表 0
msg 成功-success 错误-其他提示 success
data 上行内容 [{"dest_id": "411630","mobile": "15811423517","content": "R","task_id": "3","time": "2025-01-04 14:24:57"}]

10、推送用户上行回复

INFO

注：每条上行回复仅推送一次

  • 注意事项：推送的是POST方式，utf8原始字节流

  • 推送格式：urlencode后的内容,手机号,扩展号,时间 字段以,分隔多条记录以|分隔

  • 内容示范：R,15811423517,411630,20250104142457|TD,15811423518,411631,20250104142457

三、接口对接常见错误

code错误码

说明

10001

参数错误，请确认

10011

余额不足，请尽快充值

10102

密码错误，请确认

10201

手机号必须填写

10401

用户名或密码不能为空

10402

个性参数不能为空

10403

彩信模版不能为空

10404

彩信内容不能为空

10406

该产品不支持彩信发送

10407

标题不能为空

10408

状态报告未配置拉取，无法获取

10409

彩信模版不存在或还未审核通过

10410

接口使用错误，请确认接口地址

10411

彩信签名不能为空

10412

该产品下您已提交过该签名，请勿重复提交

10413

签名不能为空

10414

上传的文件过大，总体积请勿超过2M

10415

不支持该文件格式

10416

该签名不存在，请先报备签名

10417

个性彩信必须包含变量

上一篇 API接口