API: Message/multixsend  

 

   概览

 

message/multixsend 是 SUBMAIL 的短信一对多(即1条API请求发送多个号码,并可以灵活控制每个联系人的文本变量)和群发 API 。

 

message/xsend API 一样,message/multixsend  提供完整且强大的短信发送功能,message/multixsend 解决开发者在应用场景中的一对多或群发的需求,极大的提高 API 并发效率。

 

使用方法与 message/xsend 极为相似,不同的是 message/multixsend 去除了 tovars 参数将其整合到 multi 参数中,可以将联系人的手机号码,和不同的文本变量整合,实现一对多场景中灵活控制文本变量的功能。

 

开发者们可在提交 message/multixsend API 时,将 tovars 参数编码为 JSON 字符串格式添加到 multi 参数中提交,multi 参数的数据模型请参考以下示例:

 

 multi=[{
        "to":"15*********",
        "vars":{
            "name":"kevin",
            "code":123456
        }
    },{
        "to":"18*********",
        "vars":{
            "name":"jacky",
            "code":236554
        }
    },{
        "to":"13*********",
        "vars":{
            "name":"tom",
            "code":236554
        }]

 

 

完整的 message/multixsend  POST 请求请参考以下示例:

 

appid=your_app_id
project=EM9sd
multi=[{
    "to":"15*********",
    "vars":{
        "name":"kevin",
        "code":123456
    }
},{
    "to":"18*********",
    "vars":{
        "name":"jacky",
        "code":236554
    }
},{
    "to":"13*********",
    "vars":{
        "name":"tom",
        "code":236554
    }]
signature=your_app_key

 

   URL
<主> https://api.mysubmail.com/message/multixsend
<备> https://api.submail.cn/message/multixsend
   支持格式
json
https://api.mysubmail.com/message/multixsend.json
默认
xml
https://api.mysubmail.com/message/multixsend.xml
 
   请求参数
参数
类型
必需/可选
默认
描述

appid

string

必需

在 SUBMAIL 应用集成中创建的短信应用 ID

project

string

必需

项目标记 (ID)

在 SUBMAIL > Message >项目中查看你所创建的短信项目标记。请参见 获取项目或地址薄的开发者标识

multi

json string

必需

收件人 to 联系人参数和 vars 文本变量的整合模式,请将 to 和 vars 整合成 json 字符串格式提交(数据模型请参考本页概览页面提交打multi参数示例)

请注意:

multi 参数要求严格的 JSON 格式,以下是将参数转换为 JSON 格式的注意事项

  1. json 字符串必须以双引号包含
  2. json 字符串必须是 utf8 编码
  3. 不能有多余的逗号 如:[1,2,]
  4.  json 字符串首尾必须被大括号{}包含 

 

PS:大多数的语言都有专属的JSON解析器( ENCODING 和 DECODEING 方法)。如 PHP,首先将需要的变量以数组形式(如 $var[‘key’]=value) 创建后,使用 json_encode($var)方法创建 JSON 字符串;

timestamp

UNIX 时间戳

可选 参阅 API 授权与验证机制  >  Timestamp UNIX 时间戳

sign_type

string

可选

normal

API 授权模式(  md5 or sha1 or normal )

参阅 API 授权与验证机制  >  授权和验证方式

signature

string

必需

应用密匙 或 数字签名

参阅 API 授权与验证机制  >  授权和验证方式

   代码示例

发送一封测试短信


 
   返回码
 

 

注:message/multixsend API 中返回码将包含成功和失败的状态 ,API 在一条API中发起对多个号码的请求,所以返回状态也是按多条API计算的,例如:单次请求中包含3个联系人,其中2个联系人请求成功,1个联系人请求失败时,此时的API返回状态,将包含3条状态数组(即2条 status:success ,1条 status:error 的状态)

 

© 2014 SUBMAIL All Rights reserved. 保留所有权利

沪ICP备16035411号-1