文档首页/云客服/API参考/系统配置类接口参考（API Fabric）/通知功能集成/发送短消息 (sendShort)
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

发送短消息 (sendShort)

场景描述

发送华为云短信（必须使用模板，供其他模块使用）。调用该接口需要在“配置中心 > 接入配置 > 短信配置”中添加短信配置，短信配置相关信息需要购买华为云“消息&短信”服务获取。在“配置中心 > 工作台配置 > 管理员通知模板配置”创建模板类型是华为云短信的短信模板，相关配置需要跟之前在华为云上购买的“消息&短信 > 国内短信 > 模板管理”中添加模板生成的配置保持一致。

接口方法

POST

接口URI

https://域名/apiaccess/CCNOTIFICATION/rest/ccnotification/v1/sendmessage/sendShort

例如域名是service.besclouds.com。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

True

APPKey标识。从APP服务-APP管理中获取。

2

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。

3

X-tenantspaceId

string

False

租户标识。即配置短信模板的租间ID。从“配置中心 > 系统管理 > 租户信息”-中获取的租间ID。

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

body

object

True

请求体。

1.1

templateId

string

True

模板ID。从“配置中心 > 工作台配置 > 管理员通知模板配置”显示模板列表中的模板ID获取。

1.2

variables

array[string]

False

变量列表，最多支持10个变量。

1.3

receiverIds

array[string]

False

接收者列表，接收者加密存储在表中的总长度不能超过4000个字符，需要带国家码，+86。

1.4

sendTime

number

False

发送时间，不携带，则表示立即发送，携带即为指定时间发送，格式为时间戳。早于当前时间会报错。

1.5

isApifabric

string

True

是否是APIFabric接口。

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1

returnCode

string

False

返回码。0：表示成功；1：表示失败；3：表示发送消息同步表数据部分成功；4：表示时间参数小于当前时间；5：表示接收短信号码为空；8：表示短信配置为空；9：表示有收件人不存在；10：表示单位时间内短信或者邮件发送超过最大次数。

2

description

string

False

返回描述。

3

data

json

False

返回消息数据。

3.1

msgId

string

False

返回消息ID。

  • 响应状态码: 400
表4 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

错误的请求：请检查请求路径及参数。

  • 响应状态码: 401
表5 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404
表6 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500
表7 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

业务失败：请依次确认您请求中各参数的取值。

错误码

无

报文样例

  • 场景描述：发送华为云短信（必须使用模板，供其他模块使用）。调用该接口需要在“配置中心 > 接入配置 > 短信配置”中添加短信配置，短信配置相关信息需要购买华为云“消息&短信”服务获取。在“配置中心 > 工作台配置 > 管理员通知模板配置”中创建模板类型是华为云短信的短信模板，相关配置需要跟之前在华为云上购买的“消息&短信->国内短信->模板管理”中添加模板生成的配置保持一致。

    请求头:

    X-TenantSpaceID:202101134979  
Authorization:Bearer 3b5d****23c9  
X-app-key:b7bd****cb8c
    请求参数: 
    {
    "templateId": "1048269332823168026",
    "receiverIds": [
        "+8617248048759"
    ],
    "variables": [
        "variables one"
    ],
    "sentTime": 1628867100,
    "isApifabric": "true"
}

    响应参数:

    {
	"returnCode": "0",
	"description": "send SMS all Success"
}
父主题：通知功能集成