检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概况 消息&短信服务所提供的接口,根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API
API 应用、签名、模板 发送接收短信
调用API 认证鉴权 父主题: 发送接收短信
API使用说明 API列表 发送短信 接收状态报告 接收上行短信 发送短信API:向单个或多个用户发送相同内容的短信 发送分批短信API:向多个用户发送不同内容的短信 接收状态报告API:用于接收短信发送状态报告 接收上行短信API:用于接收用户回复的短信 API请求地址 API
如何调用API 构造请求 认证鉴权 返回结果 父主题: 应用、签名、模板
API错误码(发送短信) 本章节为调用API错误返回的错误码全集,数量较多,建议您使用快捷键Ctrl+F在界面进行搜索,找到您需要的错误码处理建议。 404问题处理 若调用接口时返回了404响应,请检查APP接入地址和访问URI(详见开发准备)是否都填写正确,且拼接成了完整的请求
资质提交支持API接口吗? 消息&短信服务申请资质暂未提供接口,请在短信控制台提交申请,具体操作请参见短信资质管理。 父主题: 资质相关
Token无效。 请检查鉴权参数是否正确。 供参考的排查项: 调用接口的时候,如果使用的是token鉴权,则token需要使用project级的token,而不是Global级token。Project级的token,就是在到IAM申请token的时候,project参数需要填写。 MSGSMS
构造请求 本节如何构造REST API的请求,并以调用IAM服务的获取用户Token说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
对于获取用户Token接口,返回如图1所示的消息头,其中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Con
白名单: 客户的服务部署在华为云海外节点上,有对口的客户经理清楚的了解客户的相关业务。 国际IP入口必须只是行业短信(通知短信和验证码短信),且短信签名和内容需要报备。 请检查客户服务器防火墙配置,放通短信控制台中应用管理页面指定的API接入地址的端口。 请检查客户服务器网络(如
调用示例,您可以从签名SDK与demo中选择需要的语言,然后参考示例与API调用说明部分,将SDK集成到您的应用中。 签名SDK与demo中,获取AK/SK之处,需要替换为从消息&短信服务Console中获取的Application Key、Application Secret;
在计算机系统中,Token代表令牌(临时),拥有Token就代表拥有某种权限。Token认证就是调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限。 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 云服务存在两种部署方式:
通过API使用消息&短信服务 短信服务提供短信发送、短信分批发送、接收状态报告,接收上行短信(国内短信)等API接口。获取更多信息,请参见API参考。 如有任何疑问,请联系华为云智能客服,将有专人为您解答。
签名名称,必须是已审核通过的,与模板类型一致的签名名称。 仅在templateId指定的模板类型为通用模板时生效且必填,用于指定在通用模板短信内容前面补充的签名。 说明: 在templateId指定的模板类型为通用模板时,from字段非必填。 在templateId指定的模板类型不是通用模板时,from字段必填。
签名名称,必须是已审核通过的,与模板类型一致的签名名称。 仅在templateId指定的模板类型为通用模板时生效且必填,用于指定在通用模板短信内容前面补充的签名。 响应参数 表5 响应结果参数 参数名称 是否必选 参数类型 默认值 说明 code 是 String(1-7) 无 请求返回的结果码。
接收状态报告 功能介绍 该接口用于用户接收短信平台主动发送的短信状态报告,状态报告中的回调地址在“发送短信”与“发送分批短信”接口中的“statusCallback”字段中设置。 前提条件 用户对短信平台推送的状态报告免鉴权。 用户服务器若有IP白名单配置,请联系运营经理获取短信平台IP地址并加入白名单。
短信API请求地址必须是域名吗?可以提供固定IP吗? 为了保证服务的连续性,推荐使用域名接入。 短信服务对外提供的请求接入地址是域名,不提供固定IP,您可以通过解析域名的方式获取固定IP,如: ping smsapi.cn-north-4.myhuaweicloud.com 短信
获取应用详情 功能介绍 该接口用于用户查询应用详情信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/msgsms/apps/{id}
创建短信应用 功能介绍 该接口用于用户创建应用信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI POST /v2/{project_id}/msgsms/apps