一站式服务号创建

功能介绍

一站式服务号创建。

URI

POST /v1/aim-sa/unify/pubs

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：0 最大长度：2000

表2 请求Body参数
参数	是否必选	参数类型	描述
pub_request_body	是	PubCreateRequestBody object	创建服务号的请求体。
portal_request_body	是	PortalRequestBody object	创建主页的请求体。
menu_request_body	是	MenuRequestBody object	创建菜单的请求体。

表3 PubCreateRequestBody
参数	是否必选	参数类型	描述
logo_img	是	String	服务号LOGO图片ID。说明：通过上传智能信息服务号图片资源接口上传LOGO图片后获得的图片resource_id。图片要求大于等于240*240且比例相同。最小长度：32 最大长度：32
pub_name	是	String	服务号名称。说明：同一个企业下可以相同，不同企业下不能重复。最小长度：1 最大长度：15
pub_abstract	是	String	服务号简介。最小长度：1 最大长度：75
pub_remark	否	String	服务号备注。说明：同一个企业下，服务号名称相同时该项必须不同。最小长度：1 最大长度：15
auto_get_port	否	Integer	是否授权系统自动收集端口。 0：否 1：是最小值：0 最大值：1 缺省值：0
signs_for_auto_get_port	否	Array of strings	自动收集端口使用的签名列表。说明： auto_get_port为1时，该字段为必填，每个签名长度为2-18个字符，每个服务号签名不可以重复。最小长度：2 最大长度：18 数组长度：0 - 5
industry	否	Integer	从事行业，默认取服务号所属商家的行业分类。 1：金融理财 2：社交通讯 3：影音娱乐 4：旅游出行 5：购物 6：本地生活 7：运动健康 8：教育培训 9：新闻阅读 10：运营商 11：其他最小值：1 最大值：11
authorization_files	是	Array of strings	授权证明图片ID，支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M，最多支持6张。说明：参数值为上传智能信息服务号图片资源API返回的resource_id。数组长度：0 - 6
areas_for_auto_get_port	否	Array of strings	自动收集端口生效的地区列表。地区取值见《地区名称列表》。说明： auto_get_port为1时，该字段有效。不填则默认全国，不允许传入重叠地区。

表4 PortalRequestBody
参数	是否必选	参数类型	描述
background_img	是	String	主页背景图片资源ID。说明：分辨率大于等于1440*810，支持jpg、jpeg、bmp、png。参数值为上传智能信息服务号图片资源API返回的resource_id。最小长度：32 最大长度：32
summary	是	String	简介。最小长度：1 最大长度：75
tels	否	Array of TelModel objects	热线号列表。数组长度：0 - 5
fastapps	否	Array of CreatePubFastappModel objects	快应用列表。数组长度：0 - 10
hw_pubs	否	Array of strings	华为服务号列表。说明：预留，暂未使用。最小长度：1 最大长度：50 数组长度：0 - 10

表5 TelModel
参数	是否必选	参数类型	描述
tel	是	String	电话号码（只能包含数字和“-”，且开头和结尾必须为数字）。最小长度：1 最大长度：20
usage	是	String	号码用途。说明：号码用途长度范围为1-30个字符，中文占2个字符，英文占1个字符。

表6 CreatePubFastappModel
参数	是否必选	参数类型	描述
name	是	String	快应用名。说明：长度范围为1-30个字符，中文占2个字符，英文占1个字符。
logo_img	是	String	快应用LOGO图片资源ID。说明：图片格式为jpg、bmp、jpeg，分辨率大于等于192*192，大小不超过4M。参数值为上传智能信息服务号图片资源API返回的resource_id。最小长度：32 最大长度：32
description	是	String	快应用描述。说明：长度范围为1-38个字符，中文占2个字符，英文占1个字符。
deeplink	是	String	快应用跳转链接。最小长度：1 最大长度：1000
depend_engine_version	是	String	快应用依赖引擎版本。说明：长度范围为1-50个字符，中文占2个字符，英文占1个字符。

表7 MenuRequestBody
参数	是否必选	参数类型	描述
menu	是	MenusMode object	菜单对象。

表8 MenusMode
参数	是否必选	参数类型	描述
menu_items	是	Array of MenuItem objects	各子菜单项配置。数组长度：0 - 3

表9 MenuItem
参数	是否必选	参数类型	描述
name	是	String	子菜单名称。一级菜单名长度和菜单数量有关，具体约束为：当菜单数量为1个时，菜单名长度范围在1-24个字符。当菜单数量为2个时，菜单名长度范围在1-12个字符。当菜单数量为3个时，菜单名长度范围在1-8个字符。二级菜单名长度范围恒为1-16个字符。说明：以上字符区分中英文，一个中文占2个字符，字母和数字占1个字符，且同时生效的一组菜单内名称不能重复。
action_type	是	String	菜单动作类型。 OPEN_SUBMENU：打开子菜单 OPEN_URL：打开URL CALLING：拨打电话 OPEN_APP：打开APP OPEN_QUICK：打开快应用最小长度：0 最大长度：30
content	否	String	对应值类型。对应不同action_type值，content含义如下： action_type=OPEN_SUBMENU：不填 action_type=OPEN_URL：参数数值为跳转URL action_type=CALLING：参数数值为电话号码 action_type=OPEN_APP：参数数值为APP的跳转deeplink action_type=OPEN_QUICK：参数数值为快应用跳转的deeplink 最小长度：0 最大长度：1000
ext_msg	否	ExtMsg object	额外需要携带的信息。 action_type=OPEN_SUBMENU时，不填 action_type=CALLING时，不填 action_type=OPEN_URL时，必填 action_type=OPEN_APP时，必填 action_type=OPEN_QUICK时，必填
sub_menu_items	否	Array of MenuItem objects	子菜单配置项。说明：仅当action_type=OPEN_SUBMENU时生效，且该项内不允许再配置子菜单。数组长度：0 - 5

**表10** ExtMsg
参数	是否必选	参数类型	描述
open_in_browser	否	String	打开方式。 0：webView打开 1：浏览器打开说明： action_type=OPEN_URL必填，其他不填。
web_title	否	String	标题，必填，长度范围为1-20个字符。说明： action_type=OPEN_URL必填，其他不填。
package_name	否	String	app包名，长度范围为1-50个字符。说明： action_type=OPEN_APP必填，其他不填。
app_id	否	String	商家应用的appid，长度范围为0-60个字符。说明： action_type=OPEN_APP必填，其他不填。
browser_floor_url	否	String	兜底url，长度范围为0-1000个字符，支持http/https。说明： action_type=OPEN_APP选填，其他不填。
depend_engine_ver	否	String	依赖的快应用引擎版本号，长度范围为1-50个字符。说明： action_type=OPEN_QUICK必填，其他不填。
third_service_name	否	String	第三方服务名，长度范围为1-50个字符。说明： action_type=OPEN_QUICK或OPEN_APP必填，其他不填。

响应参数

状态码： 200

**表11** 响应Body参数
参数	参数类型	描述
data	PubCreateResponse object	创建服务号的返回值。

**表12** PubCreateResponse
参数	参数类型	描述
data	data object	响应实体类。

**表13** data
参数	参数类型	描述
log_id	String	服务号申请记录ID。
pub_id	String	服务号ID。
menu_id	String	菜单ID。
portal_id	String	主页ID。
pub_name	String	服务号名称。

状态码： 400

**表14** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	结果详情。

状态码： 500

**表15** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	结果详情。

请求示例

一站式创建智能信息服务号。

https://koomessage.myhuaweicloud.cn/v1/aim-sa/unify/pubs

{
  "pub_request_body" : {
    "logo_img" : "651029053e15443eb5e26e1f4495cccc",
    "pub_name" : "服务号名称",
    "pub_abstract" : "服务号摘要",
    "pub_remark" : "服务号备注",
    "auto_get_port" : 1,
    "signs_for_auto_get_port" : [ "短信签名" ],
    "areas_for_auto_get_port" : [ "四川省", "佛山市" ],
    "industry" : 1,
    "authorization_files" : [ "0315f966f362400d9b2f369aef98cccc" ]
  },
  "portal_request_body" : {
    "background_img" : "6d5eb6dc1c1a4fa6a240671e0845cccc",
    "summary" : "主页简介",
    "tels" : [ {
      "tel" : "131****0000",
      "usage" : "官网电话用途"
    } ],
    "fastapps" : [ {
      "name" : "主页快应用",
      "logo_img" : "651029053e15443eb5e26e1f4495cccc",
      "description" : "快应用简介",
      "deeplink" : "hap://app/fastapp1",
      "depend_engine_version" : "1040"
    } ],
    "hw_pubs" : null
  },
  "menu_request_body" : {
    "menu" : {
      "menu_items" : [ {
        "name" : "打开商城",
        "action_type" : "OPEN_URL",
        "content" : "https://www.example.com/",
        "ext_msg" : {
          "web_title" : "百度百度",
          "open_in_browser" : 1
        },
        "sub_menu_items" : [ ]
      }, {
        "action_type" : "OPEN_SUBMENU",
        "name" : "联系我们",
        "content" : null,
        "ext_msg" : { },
        "sub_menu_items" : [ {
          "action_type" : "OPEN_URL",
          "name" : "百度一下",
          "sub_menu_items" : [ ],
          "content" : "https://www.example.com/",
          "ext_msg" : {
            "web_title" : "url标题",
            "open_in_browser" : 1
          }
        } ]
      } ]
    }
  }
}

响应示例

状态码： 200

返回信息。

{
  "data" : {
    "data" : {
      "pub_id" : "5467ec75eb974f508cee2cee10a7cccc",
      "menu_id" : "b1323ef35b8f4ee3a6767fa5b6cbcccc",
      "portal_id" : "71233b4208194db991e0ec091f23cccc",
      "log_id" : "14458",
      "pub_name" : "服务号名称"
    }
  }
}