检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
基本概念 AIM AIM是指应用消息,英文application messsage的缩写。包含短信,企业使用KooMessage发送短信并做智能信息解析。 AIM+ AIM+是不含短信,企业使用已有短信发送通道,企业使用KooMessage只做智能信息解析。 短信通道 短信通道是
时,该项为必填项。 1:指资源ID 2:指资源地址 说明: src_type为2,即资源地址时,src或cover内容必须是存储在客户侧服务器上的资源地址。 最小值:1 最大值:10 src 否 String 资源来源,资源类型为Image或Video时,为必填。 说明: 如上s
删除短信模板 功能介绍 该接口用于用户删除已创建的短信模板。 URI DELETE /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2 请求Header参数
删除通道号 功能介绍 删除通道号。 URI DELETE /v1/aim-sa/ports/{port_id} 表1 路径参数 参数 是否必选 参数类型 描述 port_id 是 String 通道号ID。 最小长度:32 最大长度:32 请求参数 表2 请求Header参数 参数
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证调用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需
删除模板实例 功能介绍 根据用户提供的模板ID,删除智能信息个人模板。 URI DELETE /v1/aim/template/{tpl_id} 表1 路径参数 参数 是否必选 参数类型 描述 tpl_id 是 String 智能信息模板ID。 最小长度:1 最大长度:36 请求参数
启用或禁用模板实例 功能介绍 根据用户提供的模板ID,启用或禁用智能信息个人模板。 URI PUT /v1/aim/template-state/{tpl_id} 表1 路径参数 参数 是否必选 参数类型 描述 tpl_id 是 String 智能信息模板ID。 最小长度:1 最大长度:36
查询通道号列表 功能介绍 支持查询通道号列表和通道号绑定信息。 URI GET /v1/aim-sa/ports 表1 Query参数 参数 是否必选 参数类型 描述 type 否 Integer 操作类型。 0:查询通道号列表 1:查询绑定关系列表 缺省值:0 最小长度:0 最大长度:1
删除短信签名 功能介绍 该接口用于用户删除已创建的短信签名。删除已审核通过的签名,会同步删除该签名对应的通道号和该签名下的所有短信模板,请谨慎操作。 URI DELETE /v1/sms/signatures/{signature_id} 表1 路径参数 参数 是否必选 参数类型
上传申请文件 功能介绍 该接口用于用户上传创建短信签名所需的营业执照/授权委托书文件。 URI POST /v1/sms/signatures/files 表1 Query参数 参数 是否必选 参数类型 描述 file_desc 否 String 文件描述。 请求参数 表2 请求Header参数
修改主页信息 功能介绍 用户对已创建的主页进行信息的修改。 URI PUT /v1/aim-sa/portals/{portal_id} 表1 路径参数 参数 是否必选 参数类型 描述 portal_id 是 String 主页ID。 最小长度:32 最大长度:32 请求参数 表2
注册通道号 功能介绍 注册通道号。 URI POST /v1/aim-sa/ports 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
删除模板素材 功能介绍 根据用户提供的模板ID,删除模板素材。 URI POST /v1/aim/template-materials/delete 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,
注册智能信息基础版回执URL 功能介绍 用户根据要求创建智能信息基础版回执接口后,可以调用此接口进行注册。 URI POST /v1/aim-basic/callbacks 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
创建短信应用 功能介绍 该接口用于用户创建短信应用。 URI POST /v1/sms/apps 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消
查询短信模板变量 功能介绍 该接口用于用户查询短信模板变量。 URI GET /v1/sms/templates/{template_id}/variable 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2
设置视频模板封面图 功能介绍 根据用户提供的视频封面图资源ID和AIM视频资源ID设置视频模板的封面图。 URI POST /v1/aim/template-material-thumbnails 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type
查询申请文件 功能介绍 该接口用于用户查询创建短信签名时上传的营业执照/授权委托书文件信息。 URI GET /v1/sms/signatures/files 表1 Query参数 参数 是否必选 参数类型 描述 file_id 是 String 营业执照/授权委托书文件ID。 offset
发送短信 功能介绍 向单个或多个用户发送相同内容的短信。 前提条件 已创建短信应用。 已申请短信签名,获取签名通道号。 已申请短信模板,获取模板ID。 注意事项 最多允许携带500个号码,每个号码最大长度为21位。 URI POST /v1/aim/sms/messages 请求参数
发送智能信息 功能介绍 根据客户的参数发送任务名称、智能信息模板ID等进行智能信息发送。一次最多发送100个智能信息。 URI POST /v1/aim/send-tasks 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String