1. 首页
  2. 秒信通MiCPaaS
  3. 🗊 视频短信
  4. 🗊 API接口文档
  5. 🗎 HTTP对接
菜单
本页目录

视频短信http/https对接

1、签名报备

1.1 请求地址

地址:https://ip_address:port/mms/sign

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

请求方式:POST 返回值:JSON

提示

秒信通视频短信多平台布署,对接前请联系秒信通客服索取IP地址/网址和端口号(ip_address:port)

1.2 请求参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

sign

签名

测试签名

1.3 请求响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

签名id

{"sign_id":49}

2、获取签名审核状态

2.1 请求地址

地址:https://ip_address:port/mms/sign-status

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

请求方式:Get 返回值:JSON

2.2 请示参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

sign_id

签名id

22

2.3 请示响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

审核状态0-待审核 1-审核通过 2-被驳回

{"status":"1"}

3、模板报备

3.1 请求地址:

地址:https://ip_address:port/mms/template

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

请求方式:POST 返回值:JSON

3.2 请求参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

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

3.3 请求响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

模版id

{"temp_id":49}


4、获取模版审核状态

4.1 请求地址

地址:https://ip_address:port/mms/template-status

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

请求方式:Get 返回值:JSON

4.2 请求参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

temp_id

模版id

22

4.3 请求响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

审核状态0-待审核 1-审核通过 2-被驳回

{"status":"1"}


5、模板视频短信发送

5.1 请求地址

地址:https://ip_address:port/mms/send-temp

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

请求方式:POST 返回值:JSON

5.2 请求参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

temp_id

模版id

12

mobile

手机号(多个手机号以英文,分割)

17611111111,17611111112

5.3 请求响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

任务id

{"task_id": 112}


6、变量模板视频短信发送

6.1 请求地址

地址:https://ip_address:port/mms/send-personal

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

请求方式:POST 返回值:JSON

6.2 请求参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

temp_id

模版id

12

mobile

手机号(多个手机号以英文,分割)

17611111111,17611111112

personality

变量json(如果是变量模版需要带上这个参数)

{"17611111111":["参数1","参数2"],"17611111112":["参数1","参数2"]}

6.3 请求响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

任务id

{"task_id": 112}


7、获取状态报告

7.1 请求地址

地址:https://ip_address:port/mms/report

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

请求方式:Get 返回值:JSON

7.2 请求参数

参数名

参数介绍

示例

是否必填

account

产品sp_id

743021

password

密码

6c4de706a2b728185246eb37e5014fbb

7.3 请求响应

参数名

参数介绍

示例

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、推送状态报告(每条短信仅推送一次)

注意事项:推送使用的是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、获取用户上行回复(比如退订等,每条短信状态仅可获取一次)

9.1 请求地址

地址:https://ip_address:port/api/get-reply

请求方式:GET 返回值:JSON

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

9.2 请求参数

参数名

参数介绍

示例

必填

sp_id

产品sp_id

743021

signature

签名(和密码二选一即可)

a92569901189f2574effc957c096c432e2d47635

password

密码(和签名二选一即可),通过sp_id的密码进行md5处理

6c4de706a2b728185246eb37e5014fbb

9.3 请求响应

参数名

参数介绍

示例

code

详情见错误表

0

msg

成功-success 错误-其他提示

success

data

上行内容

[{"dest_id": "411630","mobile": "15811423517","content": "R","task_id": "3","time": "2025-01-04 14:24:57"}]

10、推送用户上行回复(每条上行回复仅推送一次)

注意事项:推送的是POST方式,utf8原始字节流

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

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