API文档

easy短信接口V1.0

1.0版本（domain：https://easy.enevia.net）

1. 发送短信接口

请求信息

URL	数据格式	http协议	请求方式
https://easy.enevia.net/api/v1/send	JSON	HTTPS	POST

请求参数

参数	参数说明	参数类型	是否必传
phone	手机号	String	是
secret	easy短信平台秘钥	String	是
content	短信内容	String	是
sign	短信签名	String	否
type	扩展字段	Integer	否

响应数据

{
    "code": 200,
    "msg": "success",
    "record": "2406044105071739（任务ID）",
    "count":9999(剩余可用数量)
}

2. 短信上行接口

请求信息

URL	数据格式	http协议	请求方式
https://easy.enevia.net/api/v1/callSms	JSON	HTTPS	POST

请求参数

参数	参数说明	参数类型	是否必传
clientId	easy短信平台秘钥	String	是

响应数据

{
    "code": 200,
    "msg": "success",
    "record": [
        {
                    "id": 1797851007540043778,
                    "clientId": "xxxxxx",
                    "mobile": 13331005208,
                    "taskId": 1912114154381323,
                    "content": "收到你的消息，谢谢",
                    "receiveTime": "2019-11-30 16:00:00",
                    "createTime": "2024-06-04 04:40:57",
                    "updateTime": null
                },
                {
                    "id": 1797851277728718849,
                    "clientId": "xxxxxx",
                    "mobile": 13331005208,
                    "taskId": 1912114154381323,
                    "content": "已收到消息，谢谢",
                    "receiveTime": "2019-11-30 16:00:00",
                    "createTime": "2024-06-04 04:42:02",
                    "updateTime": null
                } 
    ],
    "count": 2
}

字段说明

参数	参数说明
clientId	easy短信平台秘钥
mobile	手机号
taskId	任务id
content	回复内容
receiveTime	接收时间

3. 获取短信发送状态接口

请求信息

URL	数据格式	http协议	请求方式
https://easy.enevia.net/api/v1/statusSms	JSON	HTTPS	POST

请求参数

参数	参数说明	参数类型	是否必传
phone	手机号	String	是
clientId	easy短信平台秘钥	String	是
taskId	发送短信时返回的taskId	String	是

响应数据

		{
		    "code": 200,
		    "msg": "success",
		    "record": {
		        "id": 1797909922625744897,
		        "mobile": xxxxxxxx,
		        "taskId": 2406043953468493,
		        "receiveTime": "2023-06-04 02:53:49",
		        "status": 10,
			"errCode": "DELIVRD",
			"errMsg": "成功",
		        "createTime": "2023-06-04 03:35:04"
		    }
		}

字段说明

参数	参数说明
mobile	手机号
taskId	任务id
status	发送状态：10：成功 20：失败
errCode	运营商错误码参照
errMsg	运营商错误码对照信息
receiveTime	发送时间