检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。
man或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。获取Token后,您可以使用Token认证调用其他API。 父主题: 如何调用API
认证鉴权 调用接口需通过特殊AK/SK认证或者X-WSSE认证。 推荐使用AK/SK签名认证方式,算法更安全。 特殊AK/SK认证(推荐) AK/SK签名认证方式仅支持12MB以内的消息体。 特殊AK/SK认证的“特殊”,是相对于一般AK/SK认证而言,AK、SK、EndPoin
获取应用详情 功能介绍 该接口用于用户查询应用详情信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/msgsms/apps/{id}
API概况 消息&短信服务所提供的接口,根据不同的API调用方式分为应用、签名、模板API和发送接收短信API。 表1 接口说明 类型 子类型 说明 应用、签名、模板API 短信应用API 可以实现查询短信应用、创建短信应用、查询应用数量、获取应用详情、修改短信应用等操作。 短信签名API
API 应用、签名、模板 发送接收短信
调用API 认证鉴权 父主题: 发送接收短信
获取签名详情 功能介绍 该接口用于用户查询签名详情信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/msgsms/signatures/{id}
获取模板详情 功能介绍 该接口用于用户查询已创建的模板详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/msgsms/templates/{id}
en。有了Token之后,您就可以使用Token认证调用其他API。 图1 获取用户Token响应消息头 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。
如何调用API 构造请求 认证鉴权 返回结果 父主题: 应用、签名、模板
图2 查看账号名、账号ID、用户名、用户ID、项目名称、项目ID 调用API获取用户ID、项目ID 获取用户ID请参考:管理员查询IAM用户列表。 获取项目ID请参考:查询指定条件下的项目列表。 父主题: 获取调用信息
获取终端节点 消息&短信终端节点如下表所示: 参数 描述 Endpoint Web 消息&短信当前可用Endpoint: 华北-北京四:msgsms.cn-north-4.myhuaweicloud.com 华南-广州:msgsms.cn-south-1.myhuaweicloud
Authorization格式错误 特殊AK/SK认证时,请检查HTTP消息头Authorization格式。 E000044 X-Sdk-Date过期 特殊AK/SK认证时,请检查HTTP消息头X-Sdk-Date的时间,不能与发送请求时的本地时间相差太大(15分钟内),否则会导致鉴权失败。 E000045
API使用说明 API列表 发送短信 接收状态报告 接收上行短信 发送短信API:向单个或多个用户发送相同内容的短信 发送分批短信API:向多个用户发送不同内容的短信 接收状态报告API:用于接收短信发送状态报告 接收上行短信API:用于接收用户回复的短信 API请求地址 API
获取调用信息 获取终端节点 获取账号、用户、项目的名称和ID 父主题: 应用、签名、模板
查询应用数量 功能介绍 该接口用于用户查询应用使用的数量信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/msgsms/apps-count
X-Sdk-Date 否(特殊AK/SK认证必选) String 无 格式为:yyyyMMdd'T'HHmmss'Z' X-Sdk-Date不能与发送请求时的本地时间相差太大(15分钟内),否则会导致鉴权失败。 Host 否 String 无 API调用目的地址,用于特殊AK/SK认证:如smsapi
修改短信应用 功能介绍 该接口用于用户修改应用信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/{project_id}/msgsms/apps/{id}
查询短信应用 功能介绍 该接口用于用户查询已创建的应用信息。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/{project_id}/msgsms/apps