华为云用户手册

修订记录 发布日期 修改记录 2024-12-30 第二十二次正式发布。 本次变更如下： 优化创建短信模板接口的“sign_id”、“template_type”和“universal_template”的字段描述。 2024-12-23 第二十一次正式发布。 本次变更如下： 修改短信模板接口“flow_status”字段新增枚举值“Disable”，表示流程停用状态。 接收状态报告、批量接收状态报告和接收上行短信接口的请求消息头新增“X-Sdk-Date”、“Authorization”字段。 新增推送AKSK验证章节内容。 2024-11-15 第二十次正式发布。 本次变更如下： 状态回执错误码章节新增GB:0014、S:43、908、SVC6001、SVC4001错误码。 2024-11-06 第十九次正式发布。 本次变更如下： 修改短信模板接口优化功能描述，并新增“flow_status”字段，表示流程状态。 API错误码（应用、签名、模板）章节新增MSG SMS .0186、MSGSMS.0187、MSGSMS.0188错误码。 2024-10-24 第十八次正式发布。 本次变更如下： 新增批量删除短信模板接口。 查询签名信息接口中请求参数“status”新增枚举值、新增“qualification_id”、“qualification_name”字段，表示资质ID和资质名。 创建短信签名/修改短信签名接口新增“qualification_id”字段，表示资质ID。 获取签名详情接口新增“qualification_id”、“qualification_name”字段，表示资质ID和资质名。 2024-08-23 第十七次正式发布。 本次变更如下： 下线批量删除短信模板接口。 发送短信/发送分批短信章节新增E000630错误码。 状态回执错误码（ 国内短信）章节新增E000632错误码。 2024-08-02 第十六次正式发布。 本次变更如下： 新增批量删除短信模板接口。 接收状态报告/批量接收状态报告接口新增请求参数statusDesc，表示错误码描述。 发送短信/发送分批短信/API错误码（发送短信）章节新增E000041、E000042、E000043、E000044、E000045错误码。 2024-07-15 第十五次正式发布。 本次变更如下： “API错误码（发送短信）”章节新增E000630错误码。 2024-07-03 第十四次正式发布。 本次变更如下： 下线“策略和授权项说明”章节内容。 2024-05-16 第十三次正式发布。 本次变更如下： 状态回执错误码（ 国内短信）新增E200047错误码。 2024-01-26 第十二次正式发布。 本次变更如下： 状态回执错误码（ 国内短信）新增UT:0023错误码。 2022-10-28 第十一次正式发布。 本次变更如下： API文档结构优化，新增“使用前必读”、“API概况”、“如何调用API”与“附录”等章节。 2022-7-21 第十次正式发布。 本次变更如下： 新增短信应用、模板和签名接口。 2019-10-16 第九次正式发布。 本次变更如下： 发送短信/发送分批短信：响应参数status新增取值E200041。 接收状态报告：请求参数status和orgCode状态码归一。具体变更如下： 请求参数status删除取值RTE_ERR。 请求参数orgCode取值合入status。其中，请求参数status新增取值E200018-E200027、E200032、E200034-E200036、E200038，删除原orgCode参数取值E200040、E200041、E200042、E200045。 2019-09-05 第八次正式发布。 本次变更如下： 接收状态报告接口：请求参数status新增取值SC:0016-SC:0018。 2019-06-30 第七次正式发布。 本次变更如下： 发送短信/发送分批短信接口：结果码E200037变更为E000510。 接收状态报告接口：请求参数status新增取值SC:0013-SC:0015。 2019-03-30 第六次正式发布。 本次变更如下： 接收状态报告接口： 请求参数source新增取值3。 请求参数status新增取值SC:0001-SC:0012。 2019-01-18 第五次正式发布。 本次变更如下： 接收状态报告接口：请求参数orgCode新增取值E200040、E200041、E200042、E200045。 2018-12-24 第四次正式发布。 本次变更如下： 发送短信/发送分批短信接口：新增请求参数signature，对应通用模板功能。 2018-09-30 第三次正式发布。 本次变更如下： 发送短信/发送分批短信接口：新增结果码E200037。 接收状态报告接口：请求参数orgCode新增取值E200038。 2018-08-17 第二次正式发布。 本次变更如下： 发送短信/发送分批短信接口： 新增请求参数extend。 响应参数status新增取值E200031。 新增结果码E000027。 接收状态报告接口： 新增请求参数extend、to。 请求参数orgCode新增取值E200034、E200035、E200036。 2018-01-01 第一次正式发布。

请求示例1（X-WSSE认证） POST /sms/batchSendDiffSms/v1 HTTP/1.1x-real-ip: 10.10.10.168x-real-port: 10443host: ompap.innercontent-length: 315date: Fri, 13 Apr 2018 06:48:35 GMTauthorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey"x-wsse: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="NDA1MWIwNjI2ZTkyNWFlM2FhMTE5NDE1YTk5NjU1YWE4NjNlZTY1MmRhYzkxZGViNzczZjdjMjkzZWQ4ZjAwNA==",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z"accept: application/jsoncontent-type: application/json{"from":"1069********0012","smsContent":[{"to":["+86155****5678","+86155****5679"],"templateId":"abcdefghabcdefghabcdefghabcdefgh","templateParas":["062569"]},{"to":["+86155****45680"],"templateId":"hgfedcbahgfedcbahgfedcbahgfedcba","templateParas":["605623"]}],"statusCallback":"http://205.145.111.168:9330/report"}

请求示例2（AK/SK认证） POST /sms/batchSendDiffSms/v1 HTTP/1.1Host: smsapi.cn-north-4.myhuaweicloud.com:443X-Sdk-Date: 20230519T005038ZAuthorization: SDK-HMAC-SHA256 Access=uxOF5yvM0H3C0t5G0xc272g7hA2I, SignedHeaders=content-type;host;x-sdk-date, Signature=082f05bcd561e291a7469939980c022f721a581967cc30eb3725c7aea4bd634dcontent-length: 315Content-Type: application/json {"from":"1069********0012","smsContent":[{"to":["+86155****5678","+86155****5679"],"templateId":"abcdefghabcdefghabcdefghabcdefgh","templateParas":["062569"]},{"to":["+86155****45680"],"templateId":"hgfedcbahgfedcbahgfedcbahgfedcba","templateParas":["605623"]}],"statusCallback":"http://205.145.111.168:9330/report"}

返回值 表8 响应结果码 响应码 结果码 英文描述 中文描述 处理方法 200 000000 Success. 发送请求成功。 无需处理。 400 E000000 System error. 系统异常。 请先对照代码样例检查templateParas参数设置是否正确。若排查代码后仍未解决问题，请联系管理员处理。 E000001 Authorization not contained in the HTTP header. HTTP消息头未找到Authorization字段。 请检查HTTP消息头中是否携带了Authorization字段。 E000002 realm not contained in Authorization. Authorization字段中未找到realm属性。 请检查Authorization字段中的是否携带了realm属性。 E000003 profile not contained in Authorization. Authorization字段中未找到profile属性。 请检查Authorization字段中的是否携带了profile属性。 E000004 The value of realm in Authorization must be SDP. Authorization中realm属性值应该为“SDP”。 请检查Authorization字段中的realm属性值是否为“SDP”。 E000005 The value of profile in Authorization must be UsernameToken. Authorization中profile属性值应该为“UsernameToken”。 请检查Authorization字段中的profile属性值是否为“UsernameToken”。 E000006 The value of type in Authorization must be app_key. Authorization中type属性值应该为“Appkey”。 请检查Authorization字段中的type属性值是否为“Appkey”。 E000007 type not contained in Authorization. Authorization字段中未找到type属性。 请检查Authorization字段中是否携带了type属性。 E000008 WSSE not contained in Authorization. Authorization中没有携带WSSE。 请检查Authorization字段中是否携带了WSSE。 E000020 X-WSSE not contained in the HTTP header. HTTP头未找到X-WSSE字段。 请检查HTTP消息头中是否携带了X-WSSE字段。 E000021 UserName not contained in X-WSSE. X-WSSE字段中未找到UserName属性。 请检查X-WSSE字段中的是否携带了UserName属性。 E000022 Nonce not contained in X-WSSE. X-WSSE字段中未找到Nonce属性。 请检查X-WSSE字段中的是否携带了Nonce属性。 E000023 Created not contained in X-WSSE. X-WSSE字段中未找到Created属性。 请检查X-WSSE字段中的是否携带了Created属性。 E000024 PasswordDigest not contained in X-WSSE. X-WSSE字段中未找到PasswordDigest属性。 请检查X-WSSE字段中的是否携带了PasswordDigest属性。 E000025 The format of Created is incorrect. Created属性格式错误。 请检查X-WSSE字段中的Created属性格式是否正确。 E000026 UsernameToken not contained in X-WSSE. X-WSSE字段中未找到UsernameToken属性。 请检查X-WSSE字段中的是否携带了UsernameToken属性。 E000027 Invalid request. 非法请求。 根据API接口文档的参数描述和要求，检查请求携带的参数是否都合法。 E000041 X-Sdk-Date header is empty. X-Sdk-Date为空 特殊AK/SK认证时，请检查HTTP消息头X-Sdk-Date的值。 E000042 The format of X-Sdk-Date header is invalid. X-Sdk-Date格式错误 特殊AK/SK认证时，请检查HTTP消息头X-Sdk-Date的格式，格式为：yyyyMMdd'T'HHmmss'Z' E000043 The format of Authorization header is incorrect. Authorization格式错误 特殊AK/SK认证时，请检查HTTP消息头Authorization格式。 E000044 X-Sdk-Date is expired. X-Sdk-Date过期 特殊AK/SK认证时，请检查HTTP消息头X-Sdk-Date的时间，不能与发送请求时的本地时间相差太大（15分钟内），否则会导致鉴权失败。 E000045 Authorization verify failed. Authorization校验失败 特殊AK/SK认证时，请检查HTTP消息头Authorization中的Signature字段。 E000503 The parameter format is incorrect. 参数格式错误。 请检查参数格式是否正确。 E000510 The SMS fails to be sent. For details, see status. 短信发送失败，描述见参数status。 查看响应参数中的status确认发送失败的原因，修改后重新发送。 401 E000101 Authentication failed. 鉴权失败。 请检查Authorization和X-WSSE参数的填写是否正确。 E000102 Invalid app_key. app_key无效。 请检查请求携带的app_key填写是否正确。 如app_key填写正确，建议检查app接入地址是否正确（从控制台“应用管理”获取）。 E000103 The status of the app_key is unavailable. app_key不可用。 请联系管理员确认该app_key状态是否正常。 E000104 Invalid app_secret. app_secret无效。 请检查请求携带的app_secret填写是否正确。 E000105 Invalid digest. PasswordDigest无效。 请检查请求携带的PasswordDigest填写是否正确。 E000106 The app_key is not allowed to invoke this API. app_key没有调用本API的权限。 请联系管理员确认该app_key是否具有“短信能力开放”能力。 E000109 The user status is deactivated. 用户状态未激活。 请联系管理员激活用户。 E000110 Time out limit. 时间超出限制。 请确认X-WSSE鉴权时，生成随机数的时间与发送请求时的本地时间不能相差太大（具体差值请与管理员确认）。 E000111 Incorrect username or password. 用户名或密码错误。 系统找不到app_key对应的用户信息，请联系管理员处理。 E000112 The subscriber status is frozen. 用户状态已冻结。 若是因账户欠费冻结，请参考华为云账户充值完成充值，到账后自动解冻。 若是因业务违规冻结，请整改业务后联系运营经理申请解冻。 403 E000620 The app client ip is not in ip white list. 对端app IP不在白名单列表中。 IP白名单配置生效约有10~15分钟的时延，未及时生效可能导致该报错。 IP白名单配置不正确。请前往控制台“应用管理”单击“修改”应用，检查并修改自行配置的IP白名单，或重新添加正确的IP白名单（IP白名单为平台管理员配置时）。 E000623 Number of SMSs sent by the SP reached the limit. SP短信发送量达到限额。 请联系运营经理协商调整SP短信发送量最大限额。 E000630 Number of SMSs sent by the SP reached the country/region limit. SP 发送量达到国家/地区级限额 设置流量阈值时，为该号码所属国家/地区设置了限额值。租户发往该国家/地区的短信数量累计 超过限额值导致短信发送失败。 请在控制台"通用设置"页面，修改/删除该号码所属国家/地区的限额值。详细操作请参见设置流量阈值。若限额值大小不满足需求，请联系运营经理协商调整SP短信发送量最大限额。

响应示例 HTTP/1.1 200 OKDate: Fri, 13 Apr 2018 06:46:04 GMTServer: WebServerContent-Type: application/json;charset=UTF-8Content-Length: 622{"result":[{"originTo":"+86155****5678","createTime":"2018-05-25T16:34:34Z","from":"1069********0012","smsMsgId":"5963c5be-f189-4c0c-ab2e-7cab0c42c798_52","status":"000000","countryId":"CN","total":2},{"originTo":"+86155****5679","createTime":"2018-05-25T16:34:34Z","from":"1069********0012","smsMsgId":"5963c5be-f189-4c0c-ab2e-7cab0c42c798_53","status":"000000","countryId":"CN","total":2},{"originTo":"+86155****5680","createTime":"2018-05-25T16:34:34Z","from":"1069********0012","smsMsgId":"5963c5be-f189-4c0c-ab2e-7cab0c42c798_54","status":"000000","countryId":"CN","total":2}],"code":"000000","description":"Success"}

响应参数 表6 响应结果参数 参数名称 是否必选 参数类型 默认值 说明 code 是 String(1-7) 无 请求返回的结果码。 description 是 String(1-512) 无 请求返回的结果码描述。 result 否 SmsID[] 无 短信结构体，当返回响应出现异常时不包含此字段。 表7 SmsID定义 参数名称 是否必选 参数类型 默认值 说明 smsMsgId 是 String(1-50) 无 短信的唯一标识。 from 是 String(1-21) 无 短信发送方的号码。 originTo 是 String(1-21) 无 短信接收方的号码。 status 是 String(1-7) 无 短信状态码。以下举例状态码及其说明，具体处理建议请参考API错误码。 000000：短信平台处理请求成功 E200015：待发送短信数量太大 E200028：模板变量校验失败 E200029：模板类型校验失败 E200030：模板未激活 E200031：协议校验失败 E200033：模板类型不正确 E200041：同一短信内容接收号码重复 createTime 是 String(1-20) 无 短信资源的创建时间，即短信平台接收到用户发送短信请求的时间，为UTC时间。 格式为：yyyy-MM-dd'T'HH:mm:ss'Z'。 countryId 否 String(1-3) 无 短信接收方号码的国家码。 total 否 int 无 短信拆分条数。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name 是 String 应用名称 create_sign_and_template 否 Boolean 是否创建测试签名和模板。只有地域为国内时，该字段有效 true：是 false：否 enterprise_project_id 否 String 企业项目ID，默认为0 enterprise_project_name 否 String 企业项目名称，默认为default region 是 String 地域 cn：国内 intl：国际 up_link_addr 否 String 上行回调地址。只有地域为国内时，该字段有效

请求示例 修改短信应用，请求方式：PUT，请求URI：/v2/{project_id}/msgsms/apps/{id}，路径参数：id，project_id；请求头参数：X-Auth-Token，Content-Type；请求体参数：app_name，region。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps/9e61f59c-1a6b-4ee5-9651-5bca450694b3 Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token:******Content-Length: 148 {"app_name":"auto_test7890","create_sign_and_template": 0,"enterprise_project_id":"0","enterprise_project_name":"default","region":"cn"}

请求示例 POST /smsRecive HTTP/1.1Host: 205.145.111.168:9330Content-Type: application/x-www-form-urlencodedAuthorization: SDK-HMAC-SHA256 Access=exampleAk,SignedHeaders=connection;content-length;content-type;host;x-sdk-date,Signature=765a365f3851fd1c96011a82b893266fb7b3e79b3002526c43199c97e61bb88bConnection: closePooltype: approxyOmpsid: 56514cc1880e40638f16c7c674265658TerminalIP: 205.141.112.17TrcModule: APUserTrace: applicationTraceHandle: DMZ_818405from=%2B86155****5172&to=201804131431201234&body=********&smsMsgId=9692b5be-c427-4525-8e73-cf4a6ac5b3f7

请求参数 表2 请求Headers参数 参数名称 是否必选 参数类型 默认值 说明 Content-Type 是 String 无 固定填application/x-www-form-urlencoded。 X-Sdk-Date 否 String 无 签名时间戳，开启推送AKSK鉴权后携带。 格式为：yyyyMMdd'T'HHmmss'Z' Authorization 否 String 无 用于消息鉴权的哈希码，开启推送AKSK鉴权后携带。 格式为：SDK-HMAC-SHA256 Access= app_key的值, SignedHeaders=参与签名的头域（小写）, Signature=经过签名算法计算得到的值 具体计算方式请参考添加签名信息到请求头。 AKSK说明请参考认证鉴权，验证方法请参考推送AKSK验证。 表3 请求Body参数说明 参数名称 是否必选 参数类型 默认值 说明 smsMsgId 是 String(1-50) 无 上行短信的唯一标识。 from 是 String(1-21) 无 上行短信发送方的号码。 to 是 String(1-21) 无 上行短信接收方的号码。 body 是 String(1-160) 无 上行短信发送的内容。 createTime 否 String(1-20) 无 上行短信创建时间，即短信平台接收到用户发送的上行短信的时间（采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中的时间格式转换方式不同，部分语言可参考表 不同编程语言的时间格式）。 在控制台创建应用时，配置需要“接收上行短信回复时间”后（缓存原因，配置后需等待5分钟左右生效），平台才会在Body中附带此字段，该字段只对http协议的短信生效。

接口类型 表1 接口类型说明 请求方法 POST 访问URI 用户接收上行短信的地址。 通信协议 HTTPS/HTTP 回调接口使用HTTPS协议时，服务端需支持TLS1.2，加密套件需支持TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256，TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384，TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256，TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384中的一种或多种。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 是 String 应用主键ID，参考表5 响应SmsAppQueryResp参数中的ID brackets 否 String 中括号类型。支持枚举值： CN：中文类型：【】 GB：英文类型： [] 须知： 默认值为：CN 输入值不在上述枚举值范围内的，也按CN处理。 只有地域为国内时，该字段有效。 region 是 String 地域 cn：国内 intl：国际 send_country 否 Array of Integers 发送国家ID列表，只有地域为国际时，该字段有效 sign_id 否 String 签名ID，对应表5 响应SmsSignatureResp参数中的ID。只有地域为国内时，该字段有效 template_content 是 String 模板内容 template_desc 否 String 模板描述 template_name 是 String 模板名称 template_type 是 String 模板类型。只有地域为国内时，该字段有效。支持枚举值： VERIFY_CODE_TYPE：验证码类 PROMOTION_TYPE：推广类 NOTIFY_TYPE：通知类 universal_template 否 Integer 是否为通用模板 0：非通用模板 1：通用模板 variable_attributes 否 Array of SmsTemplateVariableAttrReq objects 模板参数 flow_status 否 String 流程状态 Pending：待提交 Reviewing：待审核 Disable：停用 表4 SmsTemplateVariableAttrReq 参数 是否必选 参数类型 描述 variable_desc 否 String 变量说明，当变量类型为TEXT时，必填 variable_index 是 Integer 变量索引，对应模板内容变量索引 variable_type 是 String 变量类型，目前支持：PHONE|CHARDIGIT|DATETIME|MONEY|TEXT|NEWTEXT

请求示例 修改短信模板，请求方式：PUT ，请求URL：/v2/{project_id}/msgsms/templates/{id}，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type，请求体：app_id，region，template_content，template_name，template_type。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/c3f641aa-4e87-4a70-b84d-a2d685599072 HTTP/1.1Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token: ***Content-Length: 311 { "app_id": "******9c-1a6b-4ee5-9651-5bca450694b3", "brackets": "GB", "region": "cn", "sign_id": "******58-e866-4b30-9ca5-a476a00e8775", "template_content": "测试", "template_name": "auto_test000", "template_type": "NOTIFY_TYPE", "universal_template": 0}

API概况 消息&短信服务所提供的接口，根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API 可以实现查询签名信息、创建短信签名、获取签名详情、修改短信签名、删除短信签名、申请激活签名、查询申请文件、上传申请文件等操作。 短信模板API 可以实现查询发送国家、查询短信模板、创建短信模板、获取模板详情、修改短信模板、删除短信模板、查询模板变量、批量删除短信模板等操作。 发送接收短信API 发送短信API 向单个或多个用户发送相同内容的短信。 发送分批短信API 向多个用户发送不同内容的短信。 接收状态报告API 用于接收短信发送状态报告。 接收上行短信API 用于接收用户回复的短信。 如有任何疑问，请联系华为云智能客服，将有专人为您解答。

请求示例 修改短信签名详情，请求方式：PUT，请求URL：/v2/{project_id}/msgsms/signatures/{id}，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type；请求体参数：app_id，is_involved_third，signature_name，signature_source，signature_type、qualification_id。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures/eb55ddeb-76f3-4e07-94f4-9af775f8a9a7 Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token:******Content-Length: 245 {"app_id":"******9c-1a6b-4ee5-9651-5bca450694b3","apply_desc":"test","qualification_id":"******93-e9e4-4fa9-b9eb-6424f4974c4b","is_involved_third":"No","signature_name":"auto_test789","signature_source":"0","signature_type":"NOTIFY_TYPE"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json;charset=utf8 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 是 String 应用主键ID，参考表5 响应SmsAppQueryResp参数中的id apply_desc 否 String 申请说明 file_id 否 String 营业执照文件ID，表5的file_id is_involved_third 是 String 是否涉及第三方权益 Yes：是 No：否 power_attorney_fileid 否 String 授权委托书文件ID，表5的file_id signature_name 是 String 签名名称 signature_source 是 Integer 签名来源。支持枚举值： 0：企事业单位的全称或简称 1：工信部备案网站的全称或简称 2： APP应用的全称或简称 3：公众号或小程序的全称或简称 4：电商平台店铺名的全称或简称 5：商标名的全称或简称 signature_type 是 String 签名类型。支持枚举值： VERIFY_CODE_TYPE：验证码类 PROMOTION_TYPE：推广类 NOTIFY_TYPE：通知类 source_title_content 否 String 签名来源标题内容 qualification_id 是 String 资质ID，当前考虑存量应用的接口兼容性，代码未做强制校验，但修改签名时请务必携带资质ID，否则会导致资质审核失败

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

基本概念 概念 解释说明 账号 您注册公有云时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域 指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 公有云的区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中购买资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 项目隔离模型示意图 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理服务用户指南》。 父主题： 使用前必读

Token 认证 在计算机系统中，Token代表令牌（临时），拥有Token就代表拥有某种权限。Token认证就是调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 云服务存在两种部署方式： 项目级服务：项目级服务需要获取项目级别的Token，此时请求body中auth.scope的取值为project。 全局级服务：全局级服务需要获取全局级别的Token，此时请求body中auth.scope的取值为domain。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } }} 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

响应示例 { "create_time": "2022-08-12 07:14:18", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "id": "******bb-d48c-4c4d-b3da-baa8e4664852", "signature_name": "auto_test789", "signature_id": "******1-196f-495f-abbe-42240469b8fc", "signature_type": "NOTIFY_TYPE", "app_name": "auto_test7890", "apply_desc": "test", "channel_num": "******1733968", "file_id": "******ab-1390-4268-9463-73db98cdc2e1", "status": "PENDING_REVIEW", "signature_source": 0, "is_involved_third": "No", "urge_status": "NO", "app_key": "******3baZf4c856O4Qrbqvui3K2", "signature_usage": "COMMERCIAL"}

请求示例 获取签名详情，请求方式：GET，请求URL：/v2/{project_id}/msgsms/signatures/{id}，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures/07cfacbb-d48c-4c4d-b3da-baa8e4664852 Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token:******

响应参数 状态码： 200 表3 响应SmsSignatureResp参数 参数 是否必选 参数类型 描述 id 否 String 签名主键ID，用于获取、修改、删除、申请激活签名的唯一标识 create_time 否 String 创建时间[yyyy-MM-dd HH:mm:ss] update_time 否 String 更新时间[yyyy-MM-dd HH:mm:ss] customer_id 否 String 租户customer ID tentant 否 表4 TenantBasic - signature_name 否 String 签名名称 signature_id 否 String 签名ID signature_type 否 String 签名类型 app_name 否 String 应用名称 apply_desc 否 String 申请描述 channel_num 否 String 国内短信通道号，仅当签名审核成功，运营人员配置完成后返回。 review_desc 否 String 审核意见 file_id 否 String 文件ID status 否 String 状态 PENDING_REVIEW：待签名审核 PRO CES SING： 内容审核 通过，签名处理中 REVIEW_PASSED：处理完毕（待补充资质），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_NOT_PASS：审核不通过 TO_BE_ACTIVATED：待激活 PENDING_ACTIVATE：激活审核中 PENDING_QUALIFICATION_REVIEW：待资质审核，该状态下，用户不可发送短信 REAL_NAME_REGISTRATING：实名报备中 REVIEW_PASSED_QUALIFICATION_PROCESSING：处理完毕（资质审核中），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PASSED_REAL_NAME_REGISTRATING：处理完毕（实名报备中），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PASSED_REAL_NAME_REGISTRATE_FAIL：处理完毕（实名报备失败），该状态仅针对存量签名补充资质有效。在该状态下，用户可发送短信，但发送短信可能会由于运营商资质管控而失败 REVIEW_PROCESSING_COMPLETED：处理完毕 site 否 String 地域，取值范围：cn及hk ，当前该参数暂时不使用 signature_source 否 Integer 签名来源 is_involved_third 否 String 是否涉及第三方权益 power_attorney_file_id 否 String 授权委托书文件ID urge_status 否 String 催审说明 urge_time 否 String 催审时间 urge_desc 否 String 催审描述 app_key 否 String 应用key source_title_content 否 String 标题内容 signature_usage 否 String 签名用途 qualification_id 否 String 资质ID qualification_name 否 String 资质名 表4 TenantBasic 参数 是否必填 参数类型 描述 customer_id 否 String 租户custom id customer_name 否 String 租户custom name enterprise_name 否 String 租户企业名称

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2022-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "XXXXXX",...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error": { "code": "111400060", "message": "instance name exists." }}

响应参数 状态码： 200 表3 响应Body参数 参数 是否必选 参数类型 描述 id 否 String 模板主键ID create_time 否 String 创建时间 update_time 否 String 更新时间[yyyy-MM-dd HH:mm:ss] customer_id 否 String 租户customer id tenant 否 TentantBasic - template_name 否 String 模板名称 template_id 否 String 模板ID 注：只有模板审核通过之后才有值，未审核通过时，该值为空 template_type 否 String 模板类型 app_name 否 String 应用名称 app_key 否 String 应用key sign_id 否 String 签名ID template_content 否 String 模板内容 has_variable 否 String 是否有变量 Yes：是 No：否 template_desc 否 String 申请描述 review_desc 否 String 审核意见 review_order 否 String 审核人账号 flow_status 否 String 流程状态 Adopted：通过 Reviewing：审核中 Reject：拒绝 Disable：停用 Pending：待提交 Adopted_inactive：审核通过-去激活 SignReviewing：待签名审核 universal_template 否 String 是否是通用模板 0：否 1：是 status 否 String 模板状态 Test：测试 Normal：正常 region 否 String 地域 1. cn：国内 2. intl：国际 brackets 否 String 中括号类型。支持枚举值： CN：中文类型：【】 GB：英文类型： [] 须知： 默认值为：CN 输入值不在上述枚举值范围内的，也按CN处理。 只有地域为国内时，该字段有效。 site 否 String 地域，取值范围：cn及hk ，当前该参数暂时不使用 urge_status 否 String 催审状态 Yes：已催审 No：无催审 urge_time 否 String 催审时间 urge_desc 否 String 催审描述 send_country1 否 Integer 发送国家1 send_country2 否 Integer 发送国家2 send_country3 否 Integer 发送国家3 is_support_multiomp 否 Boolean 是否支持多OMP country_name 否 String 国家

请求示例 获取模板详情，请求方式：GET ，请求URL：/v2/{project_id}/msgsms/templates/{id}，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/460a2427-37eb-4229-bee9-0eba4d8a897f Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token:******

响应示例 { "create_time": "2022-08-12 07:40:36", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "id": "******27-37eb-4229-bee9-0eba4d8a897f", "template_id":"********441aa84cb34849f84c3a" "template_type": "NOTIFY_TYPE", "template_name": "auto_test789", "app_key": "******3baZf4c856O4Qrbqvui3K2", "sign_id": "******b9-4141-4e2d-9838-14889c32a4bf", "template_content": "测试", "has_variable": "No", "flow_status": "Reviewing", "status": "Normal", "universal_template": 0, "urge_status": "NO",}

概述 欢迎使用消息&短信服务（Message & SMS）。消息&短信服务是华为云携手全球多家优质运营商和渠道，为企业用户提供的优质通信服务。它操作简单，使用灵活，为您提供一致、稳定的体验。企业调用API或使用群发助手，即可使用验证码、通知短信服务。 本文提供了消息&短信API的描述、参数说明及示例等内容，带您一步一步使用消息&短信服务API。 全部API操作指引，请参见API概况。 在调用API前，请确保您已经充分了解消息&短信相关概念，详细信息请参见消息&短信产品介绍。 如有任何疑问，请联系华为云智能客服，将有专人为您解答。 父主题： 使用前必读

请求示例 查询模板变量，请求方式：GET ，请求URL：/v2/{project_id}/msgsms/templates/{id}/varilable，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/f063a294-06ab-420e-90bc-0c4dd9aed540/varilable Host: 100.85.***.***:30300Content-Type: application/jsonX-Auth-Token:******

响应示例 { "results": [ { "id": 15003394, "temp_name": "测试", "variable_index": 1, "variable_type": "URL", "variable_length": 99, "variable_desc": "" } ], "total": 1}

响应参数 表3 响应Body参数 参数 参数类型 描述 results Array of ApiTemplateVariable 查询结果 total Long 总数 表4 ApiTemplateVariable 参数 是否必选 参数类型 描述 id 否 Integer 变量id User_name 否 String 用户名 temp_name 否 String 模板名称 variable_index 否 Integer 变量索引 variable_type 否 String 变量类型 variable_length 否 Integer 变量长度 variable_desc 否 String 变量描述