Skip to main content

视频发送API

提示:#

  • 因为运营商政策,请先在后台完成企业认证、报备签名、模板及做相关设置,再开发 API。
  • 批量接口上限为1000。

HTTP 头信息(具体参考调用说明):#

    Accept:application/json;charset=utf-8;    Content-Type:application/json;charset=utf-8;    X-SIGNATURE: $signature;    X-APIKEY: $APIKEY;    X-TIMESTAMP: $timestamp;    X-NONCE: $nonce;

请求#

    URL:`https://gateway.yihuitong.top/openapi/sms/videoSend`    访问方式:POST

请求参数#

参数名类型是否必传是否默认开放描述示例
templateCodestring报备的模板编号,通过控制台视频模板报备列表获取111111
signatureNamestring报备的模板关联过的签名易荟通
mobilestring发送的手机号,多个号码用英文,号分割18111111111,18111111112
variablesmap变量,如果报备的模板是变量的这个是必传字段{"code","123456","name":"张三"}
callbackUrlstring短信发送后将向这个地址推送(运营商返回的)发送报告。 如推送地址固定,建议在"数据推送与获取”做批量设置。 如后台已设置地址,且请求内也包含此参数,将以请求内地址为准http://your_receive_url_address
busIdstring该条短信在您业务系统内的 ID,如订单号或者短信发送记录流水号。10001

响应参数#

名称类型描述
successboolean是否请求成功 false 为接口请求失败,请求失败 data 中无数据
errorCodestring错误码 200 代表成功
errorMessagestring错误提示
dataobject[]报告数据,是一个数组;格式参考下面

data 响应参数#

名称类型描述
totalCountinteger扣费条数,70 个字一条,超出 70 个字时按每 67 字一条计
totalFeedouble扣费金额,单位:元 类型:双精度浮点型/double
unitstring计费单位;例如:“RMB”
dataobject[]短信发送返回的数据

短信发送 data 响应参数#

名称类型描述
sidlong(64 位)短信 id,64 位整型, 对应 Java 和 C#的 long,不可用 int 解析
codestring00-提交中;01-提交失败;02-提交成功
errorCodestring提交失败错误码
countinteger发送成功短信的计费条数(计费条数:70 个字一条,超出 70 个字时按每 67 字一条计费)
feedouble扣费金额,单位:元,类型:双精度浮点型/double
mobilestring发送手机号
msgstring例如""发送成功"",或者相应错误信息
busIdstring该条短信在您业务系统内的 ID,如订单号或者短信发送记录流水号。
unitstring计费单位;例如:“RMB”

JSON 响应示例#

{     "success": true,    "errorCode": "200",    "errorMessage": "成功",    "data": {      "totalCount": 1,      "totalFee": 0.0500,      "unit": "RMB",      "data": [        {          "code": "02",          "errorCode": "",          "count": 1,          "fee": 0.05,          "unit": "RMB",          "mobile": "1234567890123456",          "msg": "",          "busId": "123456",          "sid": 42007252230        },        {          "code": "01",          "errorCode": "4404",          "count": 0,          "fee": 0,          "mobile": "15800000000",          "msg": "扣款失败",          "busId": "123456",          "sid": 0,          "unit": "RMB"        }      ]    }}

errorCode 状态码列表#

errorCode描述
4001用户信息不正确
4100参数错误
4300金额不足
4301账号未认证,请先认证通过后访问
4400短信签名错误
4401模板错误
4402提交失败
4404扣费失败
5000内部错误