发送智能信息基础版任务
功能介绍
支持用户通过此接口进行智能信息基础版任务发送。
URI
POST /v1/aim-basic/send-tasks
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
Content-Type |
是 |
String |
请求体参数类型，该字段必须设置为：application/json。 |
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
task_name |
是 |
String |
任务名称。 最小长度：0 最大长度：32 |
tpl_id |
是 |
String |
智能信息基础版模板ID。 最小长度：0 最大长度：10 |
expiration_time |
否 |
Integer |
失效时间（小时，范围是1~72小时）。 最小值：1 最大值：72 缺省值：24 |
mobiles |
否 |
Array of strings |
群发手机号码列表，最多支持5000个号码。
说明：
长度指的是单个号码的长度。 mobiles和individual_params字段只能二选一。 最小长度：1 最大长度：20 数组长度：1 - 5000 |
dync_params |
否 |
Array of ContentParam objects |
群发动态参数数组。
数组长度：1 - 100 |
individual_params |
否 |
Array of IndividualParam objects |
个性化手机号码及动态参数数组。 mobiles和individual_params字段只能二选一。 |
exdata |
否 |
String |
智能信息基础版扩展字段。 最小长度：0 最大长度：256 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
param_name |
是 |
String |
智能信息基础版参数名称。 最小长度：0 最大长度：64 |
content_type |
是 |
String |
智能信息基础版参数类型。txt：纯文字动参。 最小长度：0 最大长度：256 |
content_source |
是 |
String |
智能信息基础版参数源。txt：内容源自纯文字。 最小长度：0 最大长度：256 |
content_detail |
是 |
String |
智能信息基础版参数内容，填写经过utf-8编码的文字。 最小长度：0 最大长度：256 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
mobiles |
是 |
Array of strings |
个性化动态参数号码列表，最多支持5000个号码。
说明：
长度指的是单个号码的长度。 最小长度：1 最大长度：20 |
dync_params |
是 |
Array of IndividualContentParam objects |
个性化动态参数数组。 参数顺序按照模板创建时参数占位符的顺序传入，例如创建模板时设置动参有#p_1#、#p_2#、#p_3#，则传入的参数数组顺序第一个元素为#p_1#，第二个元素是#p_2#，第三个元素为#p_3#。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
status |
String |
请求状态，固定200。 |
message |
String |
状态描述。 |
data |
VMSTaskResponse object |
发送智能信息基础版发送任务响应。 |
参数 |
参数类型 |
描述 |
|---|---|---|
ret_code |
String |
智能信息基础版下发结果返回码。 |
task_id |
String |
智能信息基础版下发任务批次ID。 |
desc |
String |
智能信息基础版下发描述信息。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
结果状态码。 |
error_msg |
String |
结果详情。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
结果状态码。 |
error_msg |
String |
结果详情。 |
请求示例
发送智能信息基础版任务-动态参数。模板ID为"800000002"，任务名称为"测试-行程提醒"，失效时间为72小时。
https://koomessage.myhuaweicloud.cn/v1/aim-basic/send-tasks { "tpl_id" : "800000002", "task_name" : "测试-行程提醒", "expiration_time" : "72", "dync_params" : [ { "param_name" : "p_1", "content_type" : "txt", "content_source" : "txt", "content_detail" : "会员" }, { "param_name" : "p_2", "content_type" : "txt", "content_source" : "txt", "content_detail" : "2022-02-03" } ], "mobiles" : [ "131****0000", "131****0001" ] }发送智能信息基础版任务-个性化动态参数。模板ID为"800000002"，任务名称为"测试-行程提醒"，失效时间为72小时。
https://koomessage.myhuaweicloud.cn/v1/aim-basic/send-tasks { "tpl_id" : "800000002", "task_name" : "测试-行程提醒", "expiration_time" : "72", "individual_params" : [ { "mobiles" : [ "131****0000", "131****0001" ], "dync_params" : [ { "param_name" : "p_1", "content_type" : "txt", "content_source" : "txt", "content_detail" : "会员" }, { "param_name" : "p_2", "content_type" : "txt", "content_source" : "txt", "content_detail" : "2022-02-03" } ] }, { "mobiles" : [ "131****0002", "131****0003" ], "dync_params" : [ { "param_name" : "p_1", "content_type" : "txt", "content_source" : "txt", "content_detail" : "会员2" }, { "param_name" : "p_2", "content_type" : "txt", "content_source" : "txt", "content_detail" : "2022-02-05" } ] } ] }
响应示例
状态码： 200
智能信息基础版任务发送返回体。
{
"status" : "200",
"message" : "success",
"data" : {
"ret_code" : null,
"desc" : null,
"task_id" : "8113760c-787c-4c87-82c8-1d27024fef34"
}
}
状态码
状态码 |
描述 |
|---|---|
200 |
智能信息基础版任务发送返回体。 |
400 |
非法参数。 |
500 |
内部错误。 |
错误码
请参见错误码。
