开放接口

Base URLs: http://127.0.0.1:9000

提示

开放接口由积墨布丁 提供支持

1. POST 短信发送开放接口

POST /v1/apis/jmSms.send

短信发送开放接口

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» appName	body	string	是	授权应用名称
» sendTaskName	body	string	否	发送任务名称
» templateCode	body	string	是	短信系统的短信模板code
» phones	body	Array of string	是	发送手机号列表

Body 请求参数示例

{
  "appName": "string",
  "sendTaskName": "string",
  "templateCode": "string",
  "phones": "Array of string"
}

成功响应体

名称	类型	说明
code	integer	请求响应码
msg	string	说明
data	object	响应结果
» sendTaskCode	string	发送任务名称
» sendTaskId	Long	唯一 发送任务回执id
» result	Array of Object	处理结果 异常时不返回
» » phone	string	发送手机号
» » status	string	发送状态
» » remark	string	备注

返回示例

{
    "code": "Integer",
    "msg": "string",
    "data": {
        "sendTaskCode": "string",
        "sendTaskId": "Long",
        "result": [
            {
                "phone": "string",
                "status": "string",
                "remark": "string"
            }
        ]
    }
}

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构

2. POST 定时短信发送开放接口

POST /v1/apis/jmSms.cronJob.send

定时短信发送开放接口

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» timing	body	long	是	定时时间（13位时间戳），精确到分钟，不得早于当前时间
» appName	body	string	是	授权应用名称
» sendTaskName	body	string	否	发送任务名称
» templateCode	body	string	是	短信系统的短信模板code
» phones	body	Array of string	是	发送手机号列表

Body 请求参数示例

{
  "timing": "long",
  "appName": "string",
  "sendTaskName": "string",
  "templateCode": "string",
  "phones": "Array of string"
}

成功响应体

名称	类型	说明
code	integer	请求响应码
msg	string	说明
data	object	响应结果
» sendCronJobId	Long	返回的任务id，错误时为null

返回示例

{
    "code": "Integer",
    "msg": "string",
    "data": {
        "sendCronJobId": "Long"
    }
}

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline
500	Error	定时错误	Inline

返回数据结构

3. POST 短信发送详情查询接口

POST /v1/apis/jmSms.details.get

短信发送详情查询接口

请求参数

名称	位置	类型	必选	说明
Authorization	header	string	是	none
body	body	object	否	none
» appName	body	string	是	授权应用名称
» sendCronJobId	body	Long	是	发送任务回执id

Body 请求参数示例

{
  "appName": "string",
  "sendCronJobId": "Long",
}

成功响应体

名称	类型	说明
code	integer	请求响应码
msg	string	说明
data	object	响应结果
» sendTaskCode	string	发送任务名称
» sendTaskId	string	唯一 发送任务回执id
» result	Array of Object	处理结果 异常时不返回
» » phone	string	发送手机号
» » status	string	发送状态
» » remark	string	备注

返回示例

{
    "code": "Integer",
    "msg": "string",
    "data": {
        "sendTaskCode": "string",
        "sendTaskId": "Long",
        "result": [
            {
                "phone": "string",
                "status": "string",
                "remark": "string"
            }
        ]
    }
}

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

返回数据结构