华为云用户手册

请求示例 添加商品图像数据，使用图像BASE64编码 POST https://{endpoint}/v2/{project_id}/mms/{service_name}/data/add { "item_id" : "electronics_01", "image_base64" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAA...", "desc" : "天地纵横自然", "custom_tags" : { "brand" : "HUAWEI" }, "custom_num_tags" : { "year" : 2022 } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 删除数据完成返回success。 data DeleteRestInfo object 删除数据的相关信息，仅在条件删除时存在该字段。 表5 DeleteRestInfo 参数 参数类型 描述 items Array of items objects 删除数据列表。 delete_info DeleteInfo object 删除结果的相关信息。 表6 items 参数 参数类型 描述 id String 数据唯一ID。 表7 DeleteInfo 参数 参数类型 描述 total_num Integer 符合条件的结果总数。 delete_num Integer 本次删除的结果总数，目前一次请求最多删除100条结果。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

请求示例 更新数据 POST https://{endpoint}/v2/{project_id}/mms/{service_name}/data/update { "item_id" : "electronics_01", "desc" : "摄与山海之间，水天相接", "custom_tags" : { "brand" : "HUABAN" }, "custom_num_tags" : { "year" : 2023 } }

响应示例 状态码： 200 成功响应示例 { "result" : "success", "data" : { "existed" : true, "item_info" : { "desc" : "天地纵横自然", "custom_tags" : { "brand" : "HUAWEI" }, "custom_num_tags" : { "year" : 2022 } } } } 状态码： 400 失败响应示例 { "error_code" : "MMS.0003", "error_msg" : "Invalid parameter: item_id" }

请求示例 删除短信模板，请求方式：DELETE ，请求URL：/v2/{project_id}/msgsms/templates/{id}，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type。 DELETE /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates/c93e35f5-97c7-4954-b426-2cbf344a748f Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token: ****

响应示例 { "file_id": "******ab-1390-4268-9463-73db98cdc2e1", "module_type": 2, "operator": "******c55c3c4526b2ed7a0213bc9871", "file_type": 1, "file_name": "test.PNG", "file_size": 327, "file_ref": 1, "update_time": "2022-08-12 07:13:24" }

响应参数 状态码： 200 表4 响应Body参数 参数 是否必选 参数类型 描述 file_id 否 String 文件ID file_name 否 String 文件名称 file_ref 否 Integer 文件引用 file_size 否 Long 文件大小 file_type 否 Integer 文件类型 module_type 否 Integer 模块类型 operator 否 String 操作人 update_time 否 String 更新时间

请求示例 POST /report HTTP/1.1 Host: 205.145.111.168:9330 Content-Type: application/x-www-form-urlencoded Connection: close Pooltype: approxy Ompsid: 7f540777fe4b40dfb3c21d10f48781e3 TerminalIP: ****** TrcModule: AP UserTrace: application TraceHandle: DMZ_818405 sequence=1&total=1&orgCode=000&updateTime=2018-04-13T06%3A31%3A46Z&source=2&smsMsgId=b9d9b4fe-ad0e-4a2a-a2c7-445505b674ac_6&status=DELIVRD

接口类型 表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 请求Headers参数 参数名称 是否必选 参数类型 默认值 说明 Content-Type 是 String 无 固定填application/x-www-form-urlencoded。 表3 请求Body参数说明 参数名称 是否必选 参数类型 默认值 说明 smsMsgId 是 String(1-50) 无 发送短信成功时返回的短信唯一标识。 total 否 String(1-2) 无 长短信拆分后的短信条数。 当短信未拆分时该参数取值为1。 sequence 否 String(1-2) 无 长短信拆分后的短信序号，当total参数取值大于1时，该参数才有效。 当短信未拆分时该参数取值为1。 status 是 String(1-7) 无 短信状态报告枚举值，常见取值请参考表 Status常见取值，处理方法请参考状态报告错误码。 statusDesc 否 String(1-500) 无 错误码描述，常见取值请参考表 Status常见取值。 source 否 String(枚举) 无 短信状态报告来源： 1：短信平台自行产生的状态报告。 2：短信中心返回的状态报告。 3：华为平台产生的状态报告。 updateTime 否 String(1-20) 无 短信资源的更新时间，通常为短信平台接收短信状态报告的时间，为UTC时间，格式为：yyyy-MM-dd'T'HH:mm:ss'Z'，该时间会通过urlencode转义为%3a。 当短信平台未收到短信中心上报的状态报告时，会自行构造状态报告，该状态报告中不携带“updateTime”参数。 extend 否 String(1-128) 无 扩展字段，由用户在发送短信的请求中携带。若用户发送短信时未携带extend参数，则状态报告中也不会携带extend参数。 to 否 String(1-21) 无 本条状态报告对应的短信的接收方号码，仅当状态报告中携带了extend参数时才会同时携带该参数。 表4 Status常见取值 取值 含义 DELIVRD 用户已成功收到短信。 EXPIRED 短信已超时。 DELETED 短信已删除。 UNDELIV 短信递送失败。 ACCEPTD 短信已接收。 UNKNOWN 短信状态未知。 REJECTD 短信被拒绝。 E200018 国内短信发送方通道校验失败。 E200019 国内短信发送方匹配通道失败。 E200020 国内短信签名通道校验失败。 E200021 国内短信签名匹配通道失败。 E200022 国内短信接收方通道校验失败。 E200023 国内短信接收方匹配通道失败。 E200025 国际短信接收方通道校验失败。 E200026 国际短信接收方匹配通道失败。 E200027 匹配网关失败。 E200032 短信需要模板。 E200034 短信重传超时。 E200035 短信协议字段替换失败。 E200036 南向速率管控配置为0。 E200038 接收长短信超时。 MILIMIT 号码达到分钟下发限制。 LIMIT 号码达到下发限制。 BEYONDN KEYWORD 短信关键字拦截。 BLACK 号码黑名单。 MBBLACK DJ:0255 运营商拦截，一般是因为短信内容不允许发送。 1 此类错误码多为手机号码问题，如手机为空号，关机，停机等。 24 MK:xxxx MN:xxxx LT:0001 MA:xxxx SMS C未返回响应消息。 MB:xxxx SMSC返回错误响应消息。 MC:xxxx 未从SMSC处接收到状态报告。 CA:xxxx SCP未返回响应消息。 CB:xxxx SCP返回错误响应消息。 DA:xxxx DSMP未返回响应消息。 DB:xxxx DSMP返回错误响应消息。 SA:xxxx SP未返回响应消息。 SB:xxxx SP返回错误响应消息。 IA:xxxx 下一级ISMG未返回响应消息。 IB:xxxx 下一级ISMG返回错误响应消息。 IC:xxxx 没有从下一级ISMG处接收到状态报告。 SC:0001 人工审核拦截 SC:0002 人工审核告警拦截 SC:0003 黑名单拦截 SC:0004 红名单拦截 SC:0005 投诉黑名单 SC:0006 禁用关键字拦截 SC:0007 特征关键字拦截 SC:0008 管控关键字拦截 SC:0009 缺失必备关键字 SC:0010 短信超频拦截 SC:0011 时段管控拦截 SC:0012 人工审核超时处理 SC:0013 签名黑名单拦截 SC:0014 免审核模板匹配 SC:0015 拦截模板匹配 SC:0016 退订黑名单拦截 SC:0017 非报备模板拦截 SC:0018 非报备签名拦截

API请求地址 API请求地址不区分区域、省份，中国站-短信服务使用同一地址。API请求地址由“APP接入地址”和“访问URI”组成，数据来源如下： 参数 来源 示例 APP接入地址 登录管理控制台，从国内短信“应用管理”“应用管理”页面获取。 https://smsapi.cn-north-4.myhuaweicloud.com:443 访问URI 从发送短信API/发送分批短信API页面中的“接口类型”介绍部分获取。 发送短信：/sms/batchSendSms/v1 发送分批短信：/sms/batchSendDiffSms/v1 综上，API请求地址示例如下： 发送短信 https://smsapi.cn-north-4.myhuaweicloud.com:443/sms/batchSendSms/v1 发送分批短信 https://smsapi.cn-north-4.myhuaweicloud.com:443/sms/batchSendDiffSms/v1

请求示例 申请激活短信签名，请求方式：PUT ，请求URL：/v2/{project_id}/msgsms/signatures/{id}/active，路径参数：id，project_id，请求头参数：X-Auth-Token，Content-Type。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures/07cfacbb-d48c-4c4d-b3da-baa8e4664852/active Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******

响应示例 { "id": "9e61f59c-1a6b-4ee5-9651-5bca450694b3", "create_time": "2022-08-12 06:51:17", "update_time": "2022-08-12 06:51:17", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "resource_id": "******8a-a690-4e14-a1c7-2430937336d0", "developer_account": "****66_sms", "app_name": "auto_test789", "app_key": "******3baZf4c856O4Qrbqvui3K2", "status": "LAUNCHED", "region": "cn", "intl_channel_num": "******886739", "enterprise_project_id": "0", "enterprise_project_name": "default", "protocol": "HTTP", "platform": "NFV", }

请求示例 获取应用详情，返回应用详情信息，请求方式：GET，请求URI：/v2/{project_id}/msgsms/apps/{id}，路径参数id，project_id；请求头参数：X-Auth-Token，Content-Type。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps/9e61f59c-1a6b-4ee5-9651-5bca450694b3 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******

响应参数 状态码： 200 表3 响应Body参数 参数 是否必选 参数类型 描述 id 否 integer 应用主键ID create_time 否 string 创建时间 update_time 否 string 更新时间 customer_id 否 string 租户customer id resource_id 否 string 租户resource id developer_account 否 string 租户开发者账号 app_name 否 string 应用名称 omp_app_name 否 string omp应用名称 app_key 否 string 应用key up_link_addr 否 string 上行短信地址 status 否 string 应用状态 CREATED：待上线。应用暂未创建成功，请稍候。 SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停。 LAUNCHED：正常。应用添加成功，可以正常使用。 industry 否 integer 行业类型 region 否 string 地域 enterprise_project_id 否 string 企业项目ID enterprise_project_name 否 string 企业项目名称 ip_white_list 否 string IP白名单 app_access_addr 否 string 接入地址 protocol 否 string 协议 platform 否 string 平台 is_support_multiomp 否 boolean 是否支持多OMP tenant 否 TentantBasic -

请求示例 查询短信应用，请求方式：GET，请求URI：/v2/{project_id}/msgsms/apps，返回短信应用数据列表，传入参数projectId，limit，offset，region。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps?app_name=auto_test789 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 results Array of SmsAppQueryResp 查询结果 total Long 总数 表5 响应SmsAppQueryResp参数 参数 是否必选 参数类型 描述 id 否 String 应用主键ID，用于获取、修改应用的唯一标识 create_time 否 String 创建时间 update_time 否 String 更新时间 customer_id 否 String 租户customer id resource_id 否 String 租户resource id developer_account 否 String 租户开发者账号 app_name 否 String 应用名称 omp_app_name 否 String omp应用名称 app_key 否 String 应用key up_link_addr 否 String 上行短信地址 status 否 String 应用状态 CREATED：待上线。应用暂未创建成功，请稍候。 SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停。 LAUNCHED：正常。应用添加成功，可以正常使用。 industry 否 Integer 行业类型 region 否 String 地域 1. cn：国内 2. intl：国际 enterprise_project_id 否 String 企业项目ID enterprise_project_name 否 String 企业项目名称 ip_white_list 否 String IP白名单 app_access_addr 否 String 接入地址 protocol 否 String 协议 platform 否 String 平台 is_support_multiomp 否 boolean 是否支持多OMP tenant 否 TentantBasic - 表6 TentantBasic 参数 是否必选 参数类型 描述 customer_id 否 String 租户customer id customer_name 否 String 租户customer name enterprise_name 否 String 租户企业名称

响应示例 { "results": [ { "id": "9e61f59c-1a6b-4ee5-9651-5bca450694b3", "create_time": "2022-08-12 06:51:17", "update_time": "2022-08-12 06:51:17", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "resource_id": "******8a-a690-4e14-a1c7-2430937336d0", "developer_account": "****66_sms", "app_name": "auto_test789", "app_key": "******3baZf4c856O4Qrbqvui3K2", "status": "LAUNCHED", "region": "cn", "intl_channel_num": "******886739", "enterprise_project_id": "0", "enterprise_project_name": "default", "app_access_addr": "https://100.**.***.**:8443", "protocol": "HTTP", "platform": "NFV", } ], "total": 1 }

URI GET /v2/{project_id}/msgsms/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，参考“获取帐号、用户、项目的名称和ID” 表2 Query参数 参数 是否必选 参数类型 描述 app_name 否 String 应用名称 end_time 否 String 结束时间 limit 否 Integer 数量，默认值10 offset 否 Integer 偏移量 region 否 String 地域 cn：国内 intl：国际 sort_dir 否 String 排序方式 desc：降序 asc：升序 sort_key 否 String 排序字段，仅支持create_time start_time 否 String 开始时间 status 否 String 状态

请求示例1（X-WSSE认证） POST /sms/batchSendDiffSms/v1 HTTP/1.1 x-real-ip: 10.10.10.168 x-real-port: 10443 host: ompap.inner content-length: 315 date: Fri, 13 Apr 2018 06:48:35 GMT authorization: WSSE realm="SDP",profile="UsernameToken",type="Appkey" x-wsse: UsernameToken Username="ZRBRz4bAXoFgEH7o4Ew308eXc1RA",PasswordDigest="NDA1MWIwNjI2ZTkyNWFlM2FhMTE5NDE1YTk5NjU1YWE4NjNlZTY1MmRhYzkxZGViNzczZjdjMjkzZWQ4ZjAwNA==",Nonce="ac1c911c4792492687f8f6b2264a491e",Created="2018-05-26T00:35:30Z" accept: application/json content-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"}

响应示例 HTTP/1.1 200 OK Date: Fri, 13 Apr 2018 06:46:04 GMT Server: WebServer Content-Type: application/json;charset=UTF-8 Content-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"}

请求示例2（AK/SK认证） POST /sms/batchSendDiffSms/v1 HTTP/1.1 Host: smsapi.cn-north-4.myhuaweicloud.com:443 X-Sdk-Date: 20230519T005038Z Authorization: SDK-HMAC-SHA256 Access=uxOF5yvM0H3C0t5G0xc272g7hA2I, SignedHeaders=content-type;host;x-sdk-date, Signature=082f05bcd561e291a7469939980c022f721a581967cc30eb3725c7aea4bd634d content-length: 315 Content-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短信发送量最大限额。

响应参数 表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 无 短信拆分条数。

请求示例 创建短信模板，请求方式：POST ，请求URL：/v2/{project_id}/msgsms/templates，路径参数：project_id，请求头参数：X-Auth-Token，Content-Type；请求体：app_id，region，template_content，template_type，template_name。 POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/templates Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token: **** Content-Length: 308 { "app_id": "******9c-1a6b-4ee5-9651-5bca450694b3", "brackets": "GB", "region": "cn", "sign_id": "******10-c3fb-427e-965c-a98ae844c5bd", "template_content": "测试", "template_name": "auto_test789", "template_type": "NOTIFY_TYPE", "universal_template": 0 }

请求参数 表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 模板参数 表4 SmsTemplateVariableAttrReq 参数 是否必选 参数类型 描述 variable_desc 否 String 变量说明，当变量类型为TEXT时，必填 variable_index 是 Integer 变量索引，对应模板内容变量索引 variable_type 是 String 变量类型，目前支持：PHONE|CHARDIGIT|DATETIME|MONEY|TEXT

请求示例 获取模板详情，请求方式：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.***.***:30300 Content-Type: application/json X-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", }

响应参数 状态码： 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：拒绝 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，请求URI：/v2/{project_id}/msgsms/apps-count，路径参数project_id，请求头参数：X-Auth-Token，Content-Type Query参数：region。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps-count?region=cn Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******