1. hapia接口说明

• 1. hapia接口说明
  • 1.1. 文档说明
  • 1.2. 修订记录
  • 1.3. 接口约定
  • 1.4. 响应说明
    • 1.4.1. 返回码
    • 1.4.2. 格式
  • 1.5. 接口详细
    • 1.5.1. Email（发送邮件）
    • 1.5.2. SMS（发送短信）
    • 1.5.3. APP（app推送）
    • 1.5.4. Wechat（发送公众号通知）

1.1. 文档说明

信使服务提供了发送邮件、发送短信、APP推送、微信公众号推送的能力

1.2. 修订记录

1.3. 接口约定

1.4. 响应说明

1.4.1. 返回码

1.4.2. 格式

1.单条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{}
}

2.多条记录

{
    "code":200,
    "msg":"success",
    "info":"",
    "result":{
        "page_index":1,
        "page_size":20,
        "total_pages":0,
        "total_records":0,
        "data":[]
    }
}

1.5. 接口详细

1.5.1. Email（发送邮件）

请求地址：

请求参数：

响应参数：

请求示例

curl -H "Content-Type: multipart/form-data" -X POST -F 'data={"project_id": 1, "email_group":{"EmailSubject":"邮件主题","EmailContent":"邮件文本","EmailFile":""},"send_user_group":["960647378@qq.com","3101979201@qq.com"],"object_id":1001}' "https://xxx.mixiot.top/api/send/send-email"

返回示例：

{
    "code": 200,
    "msg": "success",
    "mix_code": 130001,
    "mix_ext": "",
    "mix_msg": "",
    "result": {
        "class_id": "Email",
        "project_id": 1,
        "object_id": "1001",
        "value": {
            "request": {
                "project_id": "1",
                "email_group": "{\"EmailSubject\":\"邮件主题\",\"EmailContent\":\"邮件文本\",\"EmailFile\":\"\"}",
                "send_user_group": "[\"10001@qq.com\",\"10001@qq.com\"]",
                "object_id": "1001"
            },
            "response": [
                "QsVGKerfVcFzkot8NOGnf2P1chBb2VXd"
            ]
        },
        "created": "2020-10-16T08:06:40.844280Z",
        "is_available": 1,
        "id": 48
    }
}

1.5.2. SMS（发送短信）

请求地址：

请求参数：

响应参数：

请求示例

curl -H "Content-Type: multipart/form-data" -X POST -F 'data={"project_id": 2, "sms_group":{"msgdata":"自定义内容"},"send_user_group":["18102025228","18525541820"],"object_id":1001}' "https://xxx.mixiot.top/api/send/send-sms"

返回示例：

{
    "code": 200,
    "msg": "success",
    "mix_code": 130001,
    "mix_ext": "",
    "mix_msg": "",
    "result": ""
}

1.5.3. APP（app推送）

请求地址：

请求参数：

响应参数：

请求示例

curl -H "Content-Type: multipart/form-data" -X POST -F 'data={"project_id": 3, "android_msg_group":{"Body":{"Ticker":"测试提示文字2","Title":"通知标题","Text":"通知内容2","Remark":"通知内容32"},"AfterOpen":"go_app","Url":"","DesText":"xxxx"},"send_android_user_group":["AmoD88xCqmxUq1cL_5U0UtqrzcZcHMouknABykIYzQ0L"],"ios_msg_group":{"APS":{"AlertTitle":"通知标题","AlertSubtitle":"通知子标题","AlertBody":"通知文字描述"},"Extra":{"id":"1","type":"alert"},"DesText":"xxxx"},"send_ios_user_group":[],"id":1,"type":"alert","object_id":1001}' "https://xxx.mixiot.top/api/send/send-sms"

返回示例：

{
    "code": 200,
    "msg": "success",
    "mix_code": 130001,
    "mix_ext": "",
    "mix_msg": "",
    "result": ""
}

1.5.4. Wechat（发送公众号通知）

请求地址：

请求参数：

响应参数：

请求示例

curl -H "Content-Type: multipart/form-data" -X POST -F 'data={"project_id": 4, "data_msg":{"first":{"value":"对应first","color":"#173177"},"keyword1":{"value":"对应keyword1","color":"#173177"},"keyword2":{"value":"对应keyword2","color":"#173177"},↵    "keyword3":{"value":"对应keyword3","color":"#173177"},"keyword4":{"value":"对应keyword4", "color":"#173177"},"remark":{"value":"对应remark","color":"#173177"}},"open_ids":["ogUt6wFfrBiui..."],"object_id":1001}' "https://xxx.mixiot.top/api/send/send-sms"

返回示例：

{
    "code": 200,
    "msg": "success",
    "mix_code": 130001,
    "mix_ext": "",
    "mix_msg": "",
    "result": ""
}