检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概况 消息&短信服务所提供的接口,根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API
API 应用、签名、模板 发送接收短信
调用API 认证鉴权 父主题: 发送接收短信
业务部署在其他云平台,能否使用华为云短信服务? 可以。只要您的业务满足规范要求,即可使用短信服务。 父主题: 其他问题
如何调用API 构造请求 认证鉴权 返回结果 父主题: 应用、签名、模板
如何获取短信平台的应用接入密钥? 开通消息&短信服务后,创建消息&短信应用时,平台会自动生成APP_Key和APP_Secret,用于调用短信API时的鉴权。获取APP_Key和APP_Secret,登录短信控制台。国内短信单击“国内短信 > 应用管理”获取。 图1 获取国内短信应用接入密钥
API使用说明 API列表 发送短信 接收状态报告 接收上行短信 发送短信API:向单个或多个用户发送相同内容的短信 发送分批短信API:向多个用户发送不同内容的短信 接收状态报告API:用于接收短信发送状态报告 接收上行短信API:用于接收用户回复的短信 API请求地址 API
API错误码(发送短信) 本章节为调用API错误返回的错误码全集,数量较多,建议您使用快捷键Ctrl+F在界面进行搜索,找到您需要的错误码处理建议。 404问题处理 若调用接口时返回了404响应,请检查APP接入地址和访问URI(详见开发准备)是否都填写正确,且拼接成了完整的请求
"error_detail": "appKey=123" } error_code为API错误码字段,当您调用API时,如果遇到error_code 为“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 错误码 错误信息 描述 处理措施 MSGSMS.0001
资质提交支持API接口吗? 消息&短信服务申请资质暂未提供接口,请在短信控制台提交申请,具体操作请参见短信资质管理。 父主题: 资质相关
如何处理调用短信API超时? 如果在您在服务器上调用短信API超时,没有响应。 处理建议如下: 请检查请求地址是否正确,修正后重试。 请检查客户服务器IP地址是否为国际IP地址,被限制接入,建议购买国内服务器。 当您的业务满足如下两个要求时,可以申请将国际IP地址加入短信平台IP白名单:
如何获取短信平台的HTTPS调测证书? 短信平台不提供HTTPS调测证书。推荐使用APP接入地址,请求时不会出现证书校验问题。 APP接入地址从短信控制台的“应用管理”页面获取。详细指导参考开发指南。 父主题: 二次开发相关
批量接收状态报告 功能介绍 该接口用于用户批量接收短信平台主动发送的短信状态报告,批量接收状态报告中的回调地址在控制台的应用管理中设置。 前提条件 用户对短信平台推送的状态报告免鉴权。 用户服务器若有IP白名单配置,请联系运营经理获取短信平台IP地址并加入白名单。 用户在创建短信应用时配置了批量接收状态报告地址。
通过API使用消息&短信服务 短信服务提供短信发送、短信分批发送、接收状态报告,接收上行短信(国内短信)等API接口。获取更多信息,请参见API参考。 如有任何疑问,请联系华为云智能客服,将有专人为您解答。
功能介绍 该接口用于用户接收短信平台主动发送的短信状态报告,状态报告中的回调地址在“发送短信”与“发送分批短信”接口中的“statusCallback”字段中设置。 前提条件 用户对短信平台推送的状态报告免鉴权。 用户服务器若有IP白名单配置,请联系运营经理获取短信平台IP地址并加入白名单。
认证鉴权 调用接口需通过特殊AK/SK认证或者X-WSSE认证。 推荐使用AK/SK签名认证方式,算法更安全。 特殊AK/SK认证(推荐) AK/SK签名认证方式仅支持12MB以内的消息体。 特殊AK/SK认证的“特殊”,是相对于一般AK/SK认证而言,AK、SK、EndPoin
发送分批短信 功能介绍 该接口用于用户请求短信平台向不同用户发送不同的短信。 前提条件 已创建短信应用,获取APP_Key、APP_Secret和APP接入地址。 (仅国内短信)已申请短信签名,获取签名通道号。 已申请短信模板,获取模板ID。 调试 您可以参考发送分批短信API,进行快速上手调试。
接收上行短信 功能介绍 该接口用于用户接收短信平台主动发送的上行短信通知,接收该通知的上行短信接收地址在创建短信应用时配置。 前提条件 已在创建短信应用时填写上行短信接收地址。 用户服务器若有IP白名单配置,请联系运营经理获取短信平台IP地址并加入白名单。 调试 您可以参考接收上行短信代码样例,进行快速上手调试。
通过特殊AK/SK方式鉴权时,取值为: SDK-HMAC-SHA256 Access= app_key的值, SignedHeaders=参与签名的头域(小写), Signature=经过签名算法计算得到的值 具体计算方式请参考添加签名信息到请求头。 通过X-WSSE方式鉴权时,取值为:WSSE
on”,有其他取值时会在具体接口中专门说明。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 对于获取用户Token接口,由于不需要认证,所以只添加