检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取短信应用详情 功能介绍 该接口用于用户获取已创建的短信应用详情。 URI GET /v1/sms/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
修改短信应用 功能介绍 该接口用于用户修改短信应用。 URI PUT /v1/sms/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
PortalModel 参数 参数类型 描述 portal_id String 主页ID。 company_id String 企业ID。 company_name String 企业名称。 pub_id String 服务号ID。 pub_name String 服务号名称。 background_img
String 模板类型。 最小长度:1 最大长度:20 app_id String 应用ID。 最小长度:1 最大长度:50 app_name String 应用名称。 最小长度:1 最大长度:30 signature_id String 签名ID。 最小长度:1 最大长度:50 template_content
请求体参数类型,该字段必须设置为:application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 否 String 应用ID,默认取签名所属的应用ID。 最小长度:1 最大长度:50 signature_id 是 String 签名ID。 最小长度:1 最大长度:50
请求Body参数 参数 是否必选 参数类型 描述 aim_resource_id 是 String AIM资源ID。 最小长度:1 最大长度:36 thumbnail_id 是 String 视频封面图ID。 最小长度:1 最大长度:36 响应参数 状态码: 200 表3 响应Body参数 参数
package_name 否 String app包名,长度范围为1-50个字符。 说明: action_type=OPEN_APP必填,其他不填。 app_id 否 String 商家应用的appid,长度范围为0-60个字符。 说明: action_type=OPEN_APP必填,其他不填。 browser_floor_url
必须与另外三个字段sms_tpl_id、sms_sign、sms_app_name相匹配,这些字段信息可以从“云消息服务KooMessage-管理控制台-短信配置-短信签名管理-通道号”中获取。 sms_tpl_id 是 String 短信模板ID。 说明: 必须与另外三个字段ch
最大长度:255 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 app_name String 应用名称。 最小长度:1 最大长度:30 app_id String 应用ID。 最小长度:1 最大长度:50 状态码: 400 表4 响应Body参数 参数 参数类型
该接口用于用户删除已创建的短信模板。 URI DELETE /v1/sms/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
功能介绍 支持用户更新服务号信息。 URI POST /v1/aim-sa/pubs/{pub_id} 表1 路径参数 参数 是否必选 参数类型 描述 pub_id 是 String 服务号ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
Array of SmsApp objects 查询结果。 page_info Page object 分页信息。 表4 SmsApp 参数 参数类型 描述 app_id String 应用ID,用于获取、修改应用的唯一标识。 最小长度:1 最大长度:50 app_name String
signature_id String 签名ID。 最小长度:1 最大长度:50 signature_type String 签名类型。 最小长度:1 最大长度:20 app_name String 应用名称。 最小长度:1 最大长度:30 app_id String 应用ID。 最小长度:1
根据用户提供的模板ID,删除模板素材。 URI POST /v1/aim/template-materials/delete 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。
PROMOTION_TYPE:营销类 NOTIFY_TYPE:通知类 app_id 是 String 短信应用ID。 最小长度:1 最大长度:50 apply_desc 否 String 申请说明。 最小长度:0 最大长度:80 file_id 是 String 营业执照文件ID。调用上传申请文件接口获取。 最小长度:1
支持用户通过此接口冻结服务号。 URI POST /v1/aim-sa/pubs/{pub_id}/freeze 表1 路径参数 参数 是否必选 参数类型 描述 pub_id 是 String 服务号ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
板所属签名通道号。 最小长度:1 最大长度:21 template_id 是 String 短信模板ID。 说明: 可以从“云消息服务KooMessage-管理控制台-短消息配置(国内)-短消息模板管理-模板ID”中获取。 最小长度:1 最大长度:32 signature 否 String
该接口用于用户查询短信模板变量。 URI GET /v1/sms/templates/{template_id}/variable 表1 路径参数 参数 是否必选 参数类型 描述 template_id 是 String 短信模板ID。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token
Content-Type 是 String 请求体参数类型,该字段必须设置为:application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 pub_id 是 String 服务号ID。 最小长度:0 最大长度:32 port 是 String 通道号。 port_type=5时,长度必须为5
page_info Page object 分页信息。 表4 AIMTemplate 参数 参数类型 描述 tpl_id String 智能信息模板ID。 说明: 智能信息平台生成的模板ID,由9位数字组成。 tpl_name String 智能信息模板名称。 scene String 场景类型。