云服务器内容精选

  • 修订记录 发布日期 修改记录 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 第一次正式发布。
  • API概况 消息&短信服务所提供的接口,根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API 可以实现查询签名信息、创建短信签名、获取签名详情、修改短信签名、删除短信签名、申请激活签名、查询申请文件、上传申请文件等操作。 短信模板API 可以实现查询发送国家、查询短信模板、创建短信模板、获取模板详情、修改短信模板、删除短信模板、查询模板变量等操作。 发送接收短信API 发送短信API 向单个或多个用户发送相同内容的短信。 发送分批短信API 向多个用户发送不同内容的短信。 接收状态报告API 用于接收短信发送状态报告。 接收上行短信API 用于接收用户回复的短信。 如有任何疑问,请联系华为云智能客服,将有专人为您解答。
  • 请求参数 表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 签名来源标题内容
  • 请求示例 修改短信签名详情,请求方式: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。 PUT /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures/eb55ddeb-76f3-4e07-94f4-9af775f8a9a7 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:****** Content-Length: 245 { "app_id":"******9c-1a6b-4ee5-9651-5bca450694b3", "apply_desc":"test", "file_id":"******93-e9e4-4fa9-b9eb-6424f4974c4b", "is_involved_third":"No", "signature_name":"auto_test789", "signature_source":"0", "signature_type":"NOTIFY_TYPE" }
  • 响应示例 { "results": [ { "create_time": "2022-08-12 07:14:18", "customer_id": "******c55c3c4526b2ed7a0213bc9871", "id": "******bb-d48c-4c4d-b3da-baa8e4664852", "signature_name": "auto_test789", "signature_id": "******d1-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", "site": "cn", "signature_source": 0, "is_involved_third": "No", "urge_status": "NO", "app_key": "******3baZf4c856O4Qrbqvui3K2", "signature_usage": "COMMERCIAL" } ], "total": 1 }
  • 请求示例 查询签名信息,返回签名信息,请求方式:GET,请求URI:/v2/{project_id}/msgsms/signatures,路径参数id,project_id;Query参数:limit(分页大小),offset(数据偏移量),app_name(应用名称)。 GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures?signature_name=auto_test789 HTTP/1.1 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******
  • 响应参数 状态码: 200 表4 响应Body参数 参数 是否必选 参数类型 描述 results 否 Array of SmsSignatureResp 查询结果 total 否 Long 总数 表5 响应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 tenant 否 表6 TentantBasic - 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 签名状态 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 签名用途 表6 TentantBasic 参数 是否必选 参数类型 描述 customer_id 否 String 租户customer id customer_name 否 String 租户customer name enterprise_name 否 String 租户企业名称
  • URI GET /v2/{project_id}/msgsms/signatures 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,参考“获取帐号、用户、项目的名称和ID” 表2 Query参数 参数 是否必选 参数类型 描述 app_name 否 String 应用名称 end_time 否 String 结束时间 limit 否 Integer 数量,默认值10 offset 否 Integer 偏移量 signature_id 否 String 签名ID signature_name 否 String 签名名称 signature_type 否 String 签名类型 VERIFY_CODE_TYPE:验证码类 PROMOTION_TYPE:推广类 NOTIFY_TYPE:通知类 site 否 String 地域,取值范围:cn及hk ,当前该参数暂时不使用 sort_dir 否 String 排序方式 desc:降序 asc:升序 sort_key 否 String 排序字段,仅支持create_time start_time 否 String 开始时间 status 否 String 状态 PENDING_REVIEW:待审核 PRO CES SING: 内容审核 通过,签名处理中 REVIEW_PASSED:处理完毕 REVIEW_NOT_PASS:审核不通过 TO_BE_ACTIVATED:待激活 PENDING_ACTIVATE:激活审核中
  • 请求示例 创建短信签名,请求方式POST,请求URI:/v2/{project_id}/msgsms/signatures,路径参数:project_id,请求头参数:X-Auth-Token,Content-Type;请求体参数:app_id,is_involved_third,signature_name,signature_source,signature_type。 POST /v2/845ada5bc7444f1295cd517af0123da1/msgsms/signatures Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:****** Content-Length: 245 { "app_id":"******9c-1a6b-4ee5-9651-5bca450694b3", "apply_desc":"test", "file_id":"******ab-1390-4268-9463-73db98cdc2e1", "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 签名来源标题内容
  • 请求示例 获取签名详情,请求方式: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.***.***:30300 Content-Type: application/json X-Auth-Token:******
  • 响应示例 { "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" }
  • 响应参数 状态码: 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:待审核 PROCESSING:内容审核通过,签名处理中 REVIEW_PASSED:处理完毕 REVIEW_NOT_PASS:审核不通过 TO_BE_ACTIVATED:待激活 PENDING_ACTIVATE:激活审核中 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 签名用途 表4 TenantBasic 参数 是否必填 参数类型 描述 customer_id 否 String 租户custom id customer_name 否 String 租户custom name enterprise_name 否 String 租户企业名称
  • 短信群发助手中,为何无法选择短信签名和模板? 使用群发助手提交发送任务时,请按先后顺序依次选择“短信应用” 、 “短信签名”、“短信模板”。 国内短信应用、签名、模板之间的关联关系,详见短信资源介绍。若下拉选项为空,请按下表处理。 参数 问题现象 可能原因 处理建议 短信应用 下拉选项为空,显示“暂无数据” 该华为云账号下还未添加短信应用。 请先创建短信应用。 短信签名 未选择“短信应用”。 已选择的“短信应用”下无可用的短信签名。 请检查“短信应用”参数,并确认选择正确。 请检查该应用下是否有可用的非验证码类短信签名。若没有,请先申请短信签名。 短信模板 未选择“短信应用”。 (仅国内短信)未选择“短信签名”。 (仅国内短信)已选择的“短信签名”下无可用的短信模板。 请检查“短信应用”参数,并确认选择正确。 (仅国内短信)请检查“短信签名”参数,并确认选择正确。 (仅国内短信)请检查该签名下是否有可用的短信模板。若没有,请先申请短信模板。 父主题: 故障排除
  • 其他问题 短信封禁规则是什么? 下行短信ID和上行短信ID是否一致? 上行短信和下行短信分别是什么?如何关联? 短信服务资源能跨账号转移吗? 能否将一个账号开通短信服务,给另一个账号下的云服务(例如云速建站)使用? 能否将第三方云平台已备案的短信模板和签名迁移到华为云? 如何使用测试签名和模板? 测试签名和模板的使用有效期是多久? 如何查询用户回复的短信/上行短信? 业务部署在其他云平台,能否使用华为云短信服务? 欠费后短信业务被停用,怎么重新开通? 使用群发助手,号码导入有格式限制吗? 调用接口发送短信时,填写的手机号码有格式要求吗? 消息&短信服务器部署在什么环境? 如何上传第三方授权委托书? 为什么购买短信套餐包前需要先申请短信签名和短信模板?