短信管理 - Powered by MinDoc

短信模版列表

HTTP Request

GET /api/admin/sms_templates

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述
query	否	服务商模版id 或模版名称模糊匹配
page	否	页码
per_page	否	每页的数量

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "total_count": 3,
        "total_pages": 1,
        "next_page": null,
        "prev_page": null,
        "current_page": 1,
        "per_page": 15,
        "page": 1,
        "models": [
            {
                "id": 3,
                "service_template_id": "2215450", // 服务商模版id
                "name": "上海日用百货展早上开幕通知", // 模版名称
                "content": "早安，{1}！“上海日用百货展”今日9:00正式开幕，您可以凭身份证快速入场。新国际博览中心，浦东龙阳路2345，展馆见！", // 模版内容
                "created_at": "2024-07-17T14:21:05.106+08:00"
            },
            {
                "id": 2,
                "service_template_id": "2215447",
                "name": "上海日用百货展新国际博览中心开展通知",
                "content": "尊敬的{1}，7月18日“上海日用百货展”新国际博览中心开展在即，“请凭身份证快速入场”，地址：浦东龙阳路2345号。",
                "created_at": "2024-07-17T14:21:03.802+08:00"
            },
            {
                "id": 1,
                "service_template_id": "2215438",
                "name": "上海日用百货展开展通知",
                "content": "“上海日用百货展”将于本周四(7月18日)在浦东龙阳路2345号\"新国际博览中心\"开展，您已完成实名认证，“凭身份证可快速入场”。",
                "created_at": "2024-07-16T23:13:15.868+08:00"
            }
        ]
    }
}

短信任务列表

HTTP Request

GET /api/admin/sms_jobs

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述
query	否	任务名称模糊匹配
sms_template_id	否	短信模版ID
exhibition_id	否	展会ID
send_type	否	发送类型(按展会发送: exhibition, 按文件发送: upload_file)
category	否	人群类型(已实名：”realname”, 已留资未实名：”consult”, 注册信息完整： “complete”，注册信息不完整：”incomplete”)
status	否	状态(已创建：”initialized”，已启动：”started”，已暂停：”paused”，运行中：”proceed”，已完成：”finished”，已过期：”expired”)
created_at_gtq	否	创建时间左边界(>=)
created_at_ltq	否	创建时间右边界(<=)
send_at_gtq	否	发送时间左边界(>=)
send_at_ltq	否	发送时间右边界(<=)
page	否	页码
per_page	否	每页的数量

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "total_count": 1,
        "total_pages": 1,
        "next_page": null,
        "prev_page": null,
        "current_page": 1,
        "per_page": 15,
        "page": 1,
        "models": [
            {
                "id": 1,
                "title": "test", // 任务名称
                "sms_template_id": 1, // 对应短信模版ID
                "exhibition_id": 3, // 所属展会ID
                "category": "realname", // 人群类型
                "category_i18n": "已实名", // 人群类型i18n
                "send_at": "2024-07-16T22:44:49.096+08:00", // 发送时间
                "status": "expired", // 状态
                "status_i18n": "已过期", // 状态i18n
                "created_at": "2024-07-16T22:43:23.134+08:00",
                "updated_at": "2024-07-16T22:44:50.432+08:00",
                "can_start": false, // 是否可以启动
                "can_pause": false, // 是否可以暂停
                "can_edit": true, // 是否可以编辑
                "can_destroy": true, // 是否可以删除
                "exhibition": { // 所属展会信息
                    "id": 3,
                    "name": "2019中国国际消费电子博览会"
                },
                "template": { // 对应短信模版信息
                    "id": 1,
                    "name": "上海日用百货展开展通知"
                },
                "creator": { // 创建人信息
                    "id": 1,
                    "name": "lihui"
                }
            }
        ]
    }
}

创建短信任务

HTTP Request

POST /api/admin/sms_jobs

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述

Body Parameters

字段名	是否必填	描述
job	是	任务信息

// 按展会发送
{
    "job": {
        "sms_template_id": 1, // 对应短信模版ID
        "exhibition_id": 1, // 所属展会ID
        "title": "test", // 任务名称
        "category": "realname", // 人群类型(realname、consult)
        "send_at": "2024-07-17 12:30", // 发送时间,
        "send_type": "exhibition"
    }
}

// 按文件发送
{
    "job": {
        "sms_template_id": 1, // 对应短信模版ID
        "title": "test", // 任务名称
        "send_at": "2024-07-17 12:30", // 发送时间,
        "send_type": "upload_file",
        "file_url": "xxxx"
    }
}

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "id": 2,
        "title": "test",
        "sms_template_id": 1,
        "exhibition_id": 3,
        "send_type": "exhibition",
        "send_i18n": "按展会发送",
        "category": "realname",
        "category_i18n": "已实名",
        "send_at": "2024-07-17T20:30:00.000+08:00",
        "status": "initialized",
        "status_i18n": "已创建",
        "created_at": "2024-07-17T14:53:32.614+08:00",
        "updated_at": "2024-07-17T14:53:32.614+08:00",
        "can_start": true,
        "can_pause": false,
        "can_edit": true,
        "can_destroy": true,
        "exhibition": {
            "id": 3,
            "name": "2019中国国际消费电子博览会"
        },
        "template": {
            "id": 1,
            "name": "上海日用百货展开展通知"
        },
        "creator": {
            "id": 1,
            "name": "展二"
        }
    }
}

短信任务详情

HTTP Request

GET /api/admin/sms_jobs/:id

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述

Body Parameters

字段名	是否必填	描述

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "id": 2,
        "title": "test",
        "sms_template_id": 1,
        "send_type": "exhibition",
        "send_i18n": "按展会发送",
        "exhibition_id": 3,
        "category": "realname",
        "category_i18n": "已实名",
        "send_at": "2024-07-17T20:30:00.000+08:00",
        "status": "initialized",
        "status_i18n": "已创建",
        "created_at": "2024-07-17T14:53:32.614+08:00",
        "updated_at": "2024-07-17T14:53:32.614+08:00",
        "can_start": true,
        "can_pause": false,
        "can_edit": true,
        "can_destroy": true,
        "exhibition": {
            "id": 3,
            "name": "2019中国国际消费电子博览会"
        },
        "template": {
            "id": 1,
            "name": "上海日用百货展开展通知"
        },
        "creator": {
            "id": 1,
            "name": "展二"
        }
    }
}

更新短信任务

HTTP Request

PUT /api/admin/sms_jobs/:id

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述

Body Parameters

字段名	是否必填	描述
job	是	任务信息

{
    "job": {
        "sms_template_id": 1, // 对应短信模版ID
        "exhibition_id": 1, // 所属展会ID
        "title": "test", // 任务名称
        "category": "realname", // 人群类型(realname、consult)
        "send_at": "2024-07-17 12:30" // 发送时间
    }
}

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "id": 2,
        "title": "test",
        "sms_template_id": 1,
        "send_type": "exhibition",
        "send_i18n": "按展会发送",
        "exhibition_id": 3,
        "category": "realname",
        "category_i18n": "已实名",
        "send_at": "2024-07-17T20:30:00.000+08:00",
        "status": "initialized",
        "status_i18n": "已创建",
        "created_at": "2024-07-17T14:53:32.614+08:00",
        "updated_at": "2024-07-17T14:53:32.614+08:00",
        "can_start": true,
        "can_pause": false,
        "can_edit": true,
        "can_destroy": true,
        "exhibition": {
            "id": 3,
            "name": "2019中国国际消费电子博览会"
        },
        "template": {
            "id": 1,
            "name": "上海日用百货展开展通知"
        },
        "creator": {
            "id": 1,
            "name": "展二"
        }
    }
}

启动短信任务

HTTP Request

PUT /api/admin/sms_jobs/:id/start

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述

Body Parameters

字段名	是否必填	描述

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "id": 2,
        "title": "test",
        "sms_template_id": 1,
        "send_type": "exhibition",
        "send_i18n": "按展会发送",
        "exhibition_id": 3,
        "category": "realname",
        "category_i18n": "已实名",
        "send_at": "2024-07-17T20:30:00.000+08:00",
        "status": "initialized",
        "status_i18n": "已创建",
        "created_at": "2024-07-17T14:53:32.614+08:00",
        "updated_at": "2024-07-17T14:53:32.614+08:00",
        "can_start": true,
        "can_pause": false,
        "can_edit": true,
        "can_destroy": true,
        "exhibition": {
            "id": 3,
            "name": "2019中国国际消费电子博览会"
        },
        "template": {
            "id": 1,
            "name": "上海日用百货展开展通知"
        },
        "creator": {
            "id": 1,
            "name": "展二"
        }
    }
}

暂停短信任务

HTTP Request

PUT /api/admin/sms_jobs/:id/pause

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述

Body Parameters

字段名	是否必填	描述

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "id": 2,
        "title": "test",
        "sms_template_id": 1,
        "send_type": "exhibition",
        "send_i18n": "按展会发送",
        "exhibition_id": 3,
        "category": "realname",
        "category_i18n": "已实名",
        "send_at": "2024-07-17T20:30:00.000+08:00",
        "status": "initialized",
        "status_i18n": "已创建",
        "created_at": "2024-07-17T14:53:32.614+08:00",
        "updated_at": "2024-07-17T14:53:32.614+08:00",
        "can_start": true,
        "can_pause": false,
        "can_edit": true,
        "can_destroy": true,
        "exhibition": {
            "id": 3,
            "name": "2019中国国际消费电子博览会"
        },
        "template": {
            "id": 1,
            "name": "上海日用百货展开展通知"
        },
        "creator": {
            "id": 1,
            "name": "展二"
        }
    }
}

删除短信任务

HTTP Request

DELETE /api/admin/sms_jobs/:id

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述

Body Parameters

字段名	是否必填	描述

{
    "code": 0,
    "message": "success",
    "remark": "成功"
}

短信任务发送记录

HTTP Request

GET /api/admin/sms_job_details

HEADERS

字段名	是否必填	描述
ACCESS-TOKEN	true	授权token（aPaas提供）

URL Parameters

字段名	必填	描述
query	否	手机号模糊匹配
sms_job_id	否	短信任务ID
sms_template_id	否	短信模版ID
exhibition_id	否	展会ID
status	否	状态(已创建：”initialized”，运行中：”proceed”，成功：”success”，失败：”failure”)
page	否	页码
per_page	否	每页的数量

{
    "code": 0,
    "message": "success",
    "remark": "成功",
    "data": {
        "total_count": 3,
        "total_pages": 1,
        "next_page": null,
        "prev_page": null,
        "current_page": 1,
        "per_page": 15,
        "page": 1,
        "models": [
            {
                "id": 3,
                "phone": "17737530328",
                "status": "success",
                "status_i18n": "成功",
                "created_at": "2024-07-19T09:45:00.855+08:00",
                "updated_at": "2024-07-19T10:29:31.146+08:00",
                "exhibition": {
                    "id": 41296,
                    "name": "物联传媒测试"
                },
                "template": {
                    "id": 1,
                    "name": "测试模版"
                },
                "job": {
                    "id": 1,
                    "title": "测试模版"
                }
            },
            {
                "id": 2,
                "phone": "18616352386",
                "status": "success",
                "status_i18n": "成功",
                "created_at": "2024-07-19T09:45:00.852+08:00",
                "updated_at": "2024-07-19T10:29:31.140+08:00",
                "exhibition": {
                    "id": 41296,
                    "name": "物联传媒测试"
                },
                "template": {
                    "id": 1,
                    "name": "测试模版"
                },
                "job": {
                    "id": 1,
                    "title": "测试模版"
                }
            },
            {
                "id": 1,
                "phone": "13262902619",
                "status": "success",
                "status_i18n": "成功",
                "created_at": "2024-07-19T09:45:00.845+08:00",
                "updated_at": "2024-07-19T10:29:31.136+08:00",
                "exhibition": {
                    "id": 41296,
                    "name": "物联传媒测试"
                },
                "template": {
                    "id": 1,
                    "name": "测试模版"
                },
                "job": {
                    "id": 1,
                    "title": "测试模版"
                }
            }
        ]
    }
}

文档更新时间: 2025-04-09 17:20 作者：李辉