短信

提供单条、批量发送短信能力，支持配置短信签名、短信模板，满足短信消息、短信登录验证、下发验证码等使用场景。

  3 分钟阅读  

1、概述

提供单条、批量发送短信能力，支持配置短信签名、短信模板，满足短信消息、短信登录验证、下发验证码等使用场景。

2、预制厂商通道

厂商
致远互联
阿里云
腾讯云
LITECC
华为云

3、能力区隔

特征 API接口名称 用途说明 致远互联 阿里云 腾讯云 LITECC 华为云
发送短信 同步方式发送短信 通过手机号码实时发送短信 ✅ ✅ ✅ ✅ ✅
发送短信 异步批量多条内容发送短信 通过手机号码异步、批量发送短信 ✅ ✅ ✅ ✅ ✅
发送短信 异步方式发送短信 通过手机号码异步发送短信 ✅ ✅ ✅ ✅ ✅

4、接口清单

4.1、对内接口

适用场景：低代码应用通过【自定义服务】节点调用时

4.1.1、异步批量多条内容发送短信

请求参数

参数名称 是否必填 参数类型 参数描述
code true string 模版CODE
language false string 语种
paramsMap false map 短信模版参数
desPhone true string 手机号
appName true string 应用名称
debugging false boolean 是否开启沙箱模式true:开启

请求示例

{
            "paramsMap": "",
            "code": "5892855977121107819",
            "appName": "cip-capability",
            "debugging": "false",
            "language": "",
            "desPhone": "15652161982,15011561982"
        }

返回参数

参数名称 参数类型 参数描述
code string 响应码
message string 响应信息

返回示例

{
    "code": "200",
    "message": "成功"
}

4.1.2、同步方式发送短信

请求参数

参数名称 是否必填 参数类型 参数描述
appId true string 应用类型
code true string 模版CODE
desPhone true string 手机号
paramsMap false map 短信模版参数

请求示例

{
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    }

返回参数

参数名称 参数类型 参数描述
code string 响应码
message string 响应信息

返回示例

{
    "code": "200",
    "message": "成功"
}

4.1.3、异步方式发送短信

请求参数

参数名称 是否必填 参数类型 参数描述
appId true string 应用类型
code true string 模版CODE
desPhone true string 手机号
paramsMap false map 短信模版参数

请求示例

{
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    }

返回参数

参数名称 参数类型 参数描述
code string 响应码
message string 响应信息

返回示例

{
    "code": "200",
    "message": "成功"
}

4.2、对外接口

适用场景：三方异构系统通过开放平台调用时

4.2.1、异步批量多条内容发送短信

请求地址：/cip-capability/ShortMessageAppServiceImpl/sendShortMessageAsync

请求参数

参数名称 父节点 是否必填 参数类型 参数描述
requestId true string 请求流水号。同一接入应用下的流水号不要重复；最长32位，超过部分会被截断。
timestamp true int64 请求时间戳。请求时间和服务器时间不能相差过大，默认5分钟以内。
notifyUrl false string 异步回调URL。如果此参数非空，表示使用异步方式调用开放API，执行结果将通过此URL异步通知调用者。
data true array[SmsSendDto] 请求参数数据
code data true string 模版CODE
language data false string 语种
paramsMap data false map 短信模版参数
desPhone data true string 手机号
appName data true string 应用名称
debugging data false boolean 是否开启沙箱模式true:开启

请求示例

{
    "data": [
        {
            "paramsMap": "",
            "code": "5892855977121107819",
            "appName": "cip-capability",
            "debugging": "false",
            "language": "",
            "desPhone": "15652161982,15011561982"
        }
    ],
    "requestId": "-8361350560943291150",
    "notifyUrl": "",
    "timestamp": 1719476506062
}

返回参数

参数名称 父节点 参数类型 参数描述
code string 错误码
data SingleData 返回值数据
content data void 数据对象
message string 返回信息
status int32 状态

返回示例

{
    "code": "200",
    "data": {
        "content": ""
    },
    "message": "成功",
    "status": "FRONT"
}

4.2.2、同步方式发送短信

请求地址：/cip-capability/ShortMessageAppServiceImpl/sendSycShortMessage

请求参数

参数名称 父节点 是否必填 参数类型 参数描述
requestId true string 请求流水号。同一接入应用下的流水号不要重复；最长32位，超过部分会被截断。
timestamp true int64 请求时间戳。请求时间和服务器时间不能相差过大，默认5分钟以内。
notifyUrl false string 异步回调URL。如果此参数非空，表示使用异步方式调用开放API，执行结果将通过此URL异步通知调用者。
data true SmsSendDto 请求参数数据
appId data true string 应用类型
code data true string 模版CODE
desPhone data true string 手机号
paramsMap data false map 短信模版参数

请求示例

{
    "data": {
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    },
    "requestId": "1850710295428812002",
    "notifyUrl": "",
    "timestamp": 1719476506066
}

返回参数

参数名称 父节点 参数类型 参数描述
code string 错误码
data SingleData 返回值数据
content data SmsResponseDto 数据对象
code content string 响应码
message content string 响应信息
message string 返回信息
status int32 状态

返回示例

{
    "code": "200",
    "data": {
        "content": {
            "code": "capability-0000",
            "message": "模板不合法"
        }
    },
    "message": "成功",
    "status": "FRONT"
}

4.2.3、异步方式发送短信

请求地址：/cip-capability/ShortMessageAppServiceImpl/sendShortMessage

请求参数

参数名称 父节点 是否必填 参数类型 参数描述
requestId true string 请求流水号。同一接入应用下的流水号不要重复；最长32位，超过部分会被截断。
timestamp true int64 请求时间戳。请求时间和服务器时间不能相差过大，默认5分钟以内。
notifyUrl false string 异步回调URL。如果此参数非空，表示使用异步方式调用开放API，执行结果将通过此URL异步通知调用者。
data true SmsSendDto 请求参数数据
appId data true string 应用类型
code data true string 模版CODE
desPhone data true string 手机号
paramsMap data false map 短信模版参数

请求示例

{
    "data": {
        "paramsMap": "",
        "code": "",
        "appId": "cip-capability",
        "desPhone": "15652161982,15011561982"
    },
    "requestId": "1938010543906177955",
    "notifyUrl": "",
    "timestamp": 1719476506070
}

返回参数

参数名称 父节点 参数类型 参数描述
code string 错误码
data SingleData 返回值数据
content data void 数据对象
message string 返回信息
status int32 状态

返回示例

{
    "code": "200",
    "data": {
        "content": ""
    },
    "message": "成功",
    "status": "FRONT"
}

5、使用场景

5.1、登录场景-短信验证码

1719390002703

5.2、短信消息

1719390007257

5.3、BPM短信提醒

1719390012072

5.4、开放OpenAPI

1719390016916

最后修改 September 4, 2024: 修改路径名称为英文 (55b791f)