{"openapi":"3.0.0","info":{"title":"A2P平台服务北向接口","description":"A2P平台服务北向接口，提供对商家，服务号，菜单，主页，端口号生命周期管理接口。并在资源变更时，会将信息通知到商家。 <b> <p>2020/2/17 资源操作类接口（创建/修改/删除/冻结/解冻等）返回结果新增字段callbackSN，仅需要审核的接口有回执，不审核的不再返回回执；资源变更回执，新增字段callbackSN和result，ApproveNoticeState修改描述；资源查询接口query和get接口不再返回审核信息approveStates</p> <p>2020/3/26 2.0版本开始。新增接口dataencryptor/encrypt</p> </b>\n","version":"1.2.0"},"servers":[{"url":"https://待确定/dev-napi/","description":"生产环境服务调用"},{"url":"https://测试环境/dev-napi/","description":"测试环境服务调用"}],"externalDocs":{"description":"使用华为账号注册成为开发者","url":"https://developer.huawei.com/consumer/cn/devservice/doc/50102"},"tags":[{"name":"merchant","description":"商家管理接口"},{"name":"port","description":"端口管理接口(迭代一)"},{"name":"media","description":"媒体文件管理接口(迭代一)"},{"name":"callback","description":"回调功能说明(迭代一)"},{"name":"pub","description":"服务号管理接口(迭代二)"},{"name":"menu","description":"服务号菜单管理接口(迭代二)"},{"name":"not implement","description":"第一期版本中暂不提供的接口（后续会逐渐提供）"},{"name":"user complaint","description":"用户投诉"},{"name":"port pub relation","description":"端口和服务号绑定关系管理接口"},{"name":"data encryptor","description":"数据加密接口"}],"paths":{"/v1/merchant/add":{"post":{"tags":["merchant"],"summary":"创建一个商家（1.2版本新增）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"创建商家的Post内容","required":true,"content":{"application/json":{"schema":{"type":"object","required":["merchant"],"properties":{"merchant":{"$ref":"#/components/schemas/Merchant"}}}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/CallbackSN"}]}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/merchant/update":{"post":{"tags":["merchant"],"summary":"修改一个商家（1.2版本新增）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"修改商家Post内容","required":true,"content":{"application/json":{"schema":{"type":"object","required":["merchantId","merchant","changeReason"],"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/ResourceVersion"}],"properties":{"merchant":{"$ref":"#/components/schemas/MerchantNoRequired"},"changeReason":{"type":"string","description":"修改描述"}}}}}},"responses":{"200":{"description":"请求成功，修改完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/CallbackSN"}]}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/merchant/query":{"post":{"tags":["merchant"],"summary":"查询下属商家","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"content":{"application/json":{"schema":{"required":["pageRequest"],"type":"object","properties":{"pageRequest":{"description":"分页信息。如果不填写此字段，则查询开发者下所有的商家信息。","allOf":[{"$ref":"#/components/schemas/PageRequest"}]}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/PagedResult"}],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MerchantProfile"}}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/merchant/get":{"post":{"tags":["merchant"],"summary":"查询指定商家（1.2版本新增）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"修改商家Post内容","required":true,"content":{"application/json":{"schema":{"type":"object","required":["merchantId"],"allOf":[{"$ref":"#/components/schemas/TargetMerchant"}]}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MerchantDetail"}]}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/merchant/whitelist/add":{"post":{"tags":["not implement"],"summary":"创建商家白名单","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"创建商家白名单内容","required":true,"content":{"application/json":{"schema":{"type":"object","required":["users"],"properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/WhiteListUser"}}}}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"properties":{"failUsers":{"description":"仅有失败用户会在这里提示。","type":"array","items":{"$ref":"#/components/schemas/WhiteListUserResponse"}}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/merchant/whitelist/delete":{"post":{"tags":["not implement"],"summary":"删除商家白名单","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"删除商家白名单的内容","required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/WhiteListUser"}}}}}},"responses":{"200":{"description":"请求成功"},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/merchant/whitelist/query":{"post":{"tags":["not implement"],"summary":"查询商家生效的白名单","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/WhiteListUser"}}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/pub/add":{"post":{"tags":["pub"],"summary":"创建服务号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"创建服务号。创建服务号会需要经过审核，审核后会使用资源状态变更回调（见callback章节）通知。在审核期间，使用查询接口能够查询到服务号的审核状态。","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMerchant"}],"required":["pub"],"properties":{"pub":{"required":["merchantId"],"allOf":[{"$ref":"#/components/schemas/PubService4Add"}]}}}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pub/update":{"post":{"tags":["pub"],"summary":"修改指定服务号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"修改服务号Post内容。修改服务号会需要经过审核，审核后会使用资源状态变更回调（见callback章节）通知。在审核期间，使用查询接口能够查询到服务号的审核状态。","required":true,"content":{"application/json":{"schema":{"type":"object","required":["pub","changeReason"],"properties":{"pub":{"$ref":"#/components/schemas/PubService4Update"},"changeReason":{"type":"string","description":"修改描述"}},"allOf":[{"$ref":"#/components/schemas/TargetPub"},{"$ref":"#/components/schemas/ResourceVersion"}]}}}},"responses":{"200":{"description":"请求成功，修改完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pub/query":{"post":{"tags":["pub"],"summary":"查询下属服务号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"查询服务号请求结构","required":true,"content":{"application/json":{"schema":{"type":"object","required":["merchantId","pageRequest"],"properties":{"pageRequest":{"description":"分页信息","allOf":[{"$ref":"#/components/schemas/PageRequest"}]},"merchantId":{"type":"string","description":"商家ID"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"type":"object","required":["pubs"],"allOf":[{"$ref":"#/components/schemas/PagedResult"}],"properties":{"pubs":{"type":"array","items":{"$ref":"#/components/schemas/PubProfile"}}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pub/get":{"post":{"tags":["pub"],"summary":"查询指定服务号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"查询单个服务号的请求结构","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TargetPub"}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PubDetail"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pub/freeze":{"post":{"tags":["pub"],"summary":"冻结指定服务号（1.2版本新增）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"指定服务号信息","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"type":"object","required":["description","changeReason"],"properties":{"changeReason":{"type":"string","description":"冻结原因说明"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pub/unfreeze":{"post":{"tags":["pub"],"summary":"解冻指定服务号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"指定服务号信息","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"type":"object","required":["description","changeReason"],"properties":{"changeReason":{"type":"string","description":"解冻原因说明"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/pubmenu/add":{"post":{"tags":["menu"],"summary":"在指定服务号下创建菜单","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"创建服务号菜单输入内容。创建服务号菜单会需要经过审核，审核后会使用资源状态变更回调（见callback章节）通知。在审核期间，使用查询接口能够查询到服务号菜单的审核状态。","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"required":["menu"],"type":"object","properties":{"menu":{"$ref":"#/components/schemas/PubMenu"},"submit":{"deprecated":true,"type":"boolean","description":"是否直接提审，还是等待提交真机测试附件后进行提审。第一期暂不需要进行真机测试。"}}}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMenu"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pubmenu/update":{"post":{"tags":["menu"],"summary":"在指定服务号，全量修改菜单（1.2版本新增）（此接口直接覆盖原有菜单，不支持单独的项目修改）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"修改服务号菜单输入内容","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMenu"},{"$ref":"#/components/schemas/ResourceVersion"}],"type":"object","required":["menu","changeReason"],"properties":{"menu":{"$ref":"#/components/schemas/PubMenu"},"changeReason":{"type":"string","description":"修改描述"},"submit":{"deprecated":true,"type":"boolean","description":"是否直接提审，还是等待提交真机测试附件后进行提审。第一期暂不需要进行真机测试。"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMenu"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pubmenu/submit":{"post":{"tags":["not implement"],"summary":"在添加/修改菜单时，如果仅做了添加/修改，没有将submit设置为true时，需要调用此接口，上传测试图片正式提审。","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"提交菜单时上传的附件文件","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"type":"object","properties":{"attaches":{"type":"array","description":"附件列表","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/pubmenu/get":{"post":{"tags":["menu"],"summary":"在指定服务号查询菜单内容","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"查询服务号菜单输入内容","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMenu"}]}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/MenuProfile"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/pubmenu/delete":{"post":{"tags":["menu"],"summary":"在指定服务号，删除菜单","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"删除菜单输入内容","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMenu"}]}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMenu"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/port/add":{"post":{"tags":["port"],"summary":"创建端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"创建端口号内容。创建端口号会需要经过审核，审核后会使用资源状态变更回调（见callback章节）通知。在审核期间，使用查询接口能够查询到端口号的审核状态。","required":true,"content":{"application/json":{"schema":{"required":["port"],"properties":{"port":{"$ref":"#/components/schemas/PortWithRequired"}},"allOf":[{"$ref":"#/components/schemas/TargetMerchant"}]}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"},{"$ref":"#/components/schemas/CallbackSN"}]}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/port/update":{"post":{"tags":["not implement"],"summary":"修改一个端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"修改端口号内容","required":true,"content":{"application/json":{"schema":{"required":["portInfo"],"allOf":[{"$ref":"#/components/schemas/TargetMerchant"}],"properties":{"portInfo":{"$ref":"#/components/schemas/Port"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"}],"properties":{"sendCheck":{"type":"boolean","description":"是否触发审核"}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/port/query":{"post":{"tags":["port"],"summary":"查询下属端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["pageRequest"],"type":"object","allOf":[{"$ref":"#/components/schemas/TargetMerchant"}],"properties":{"pageRequest":{"description":"分页信息","allOf":[{"$ref":"#/components/schemas/PageRequest"}]}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"type":"object","required":["ports"],"allOf":[{"$ref":"#/components/schemas/PagedResult"}],"properties":{"ports":{"type":"array","items":{"$ref":"#/components/schemas/PortProfile"}}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/port/get":{"post":{"tags":["port"],"summary":"查询指定端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/TargetPort"}]}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortProfile"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/port/delete":{"post":{"tags":["port"],"summary":"删除指定商家下的端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"删除端口号内容","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"}]}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/port/freeze":{"post":{"tags":["not implement"],"summary":"冻结指定端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"指定端口号信息","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"}],"type":"object","required":["description","changeReason"],"properties":{"changeReason":{"type":"string","description":"冻结原因说明"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/port/unfreeze":{"post":{"tags":["not implement"],"summary":"解冻指定端口号","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"description":"指定端口号信息","required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"}],"type":"object","required":["changeReason"],"properties":{"changeReason":{"type":"string","description":"解冻原因说明"}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetPort"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}},"deprecated":true}},"/v1/media/upload":{"post":{"tags":["media"],"summary":"商家上传素材接口。暂时只支持图片。","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/ContentTypeFormData"}],"requestBody":{"description":"<p>单个文件上传。图片支持jpg,jpeg,bmp,png格式的图片。文件大小不得大于5M。此处统一说明各场景使用图片的分辨率与比例要求。</p>  <p>服务号与主页logo。要求分辨率必须大于等于240*240且比例一致</p> <p>快应用logo。要求分辨率必须大于等于184*184且比例一致</p> <p>服务号主页背景图。要求分辨率必须大于等于1440*810且比例一致</p> <p>其他文件，比如资质证明，不要求分辨率</p>\n","required":true,"content":{"application/json":{"schema":{"required":["file"],"properties":{"file":{"type":"string","format":"binary","description":"商家上传文件的byte流"}}}}}},"responses":{"200":{"description":"请求成功。","content":{"application/json":{"schema":{"properties":{"mediaId":{"type":"string","description":"媒体文件ID"},"timestamp":{"type":"integer","format":"int64","description":"创建成功的时间戳"}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/complaint/downloadScreenshot":{"get":{"tags":["user complaint"],"parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptForData"},{"$ref":"#/components/parameters/ContentTypeJson"},{"name":"complId","in":"query","description":"投诉ID","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"query","description":"文件ID","required":true,"schema":{"type":"string"}}],"summary":"投诉截图文件下载接口","responses":{"200":{"description":"请求成功","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/complaint/updateHandlingResult":{"post":{"tags":["user complaint"],"summary":"更新用户投诉处理结果。","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["complId","merchantId","handlingResult"],"properties":{"complId":{"type":"string","description":"投诉ID"},"merchantId":{"type":"string","description":"商家ID"},"handlingResult":{"type":"integer","description":"投诉处理结果 0.投诉不成立 1.投诉成立"},"handlingComment":{"type":"string","description":"投诉处理说明"}}}}}},"responses":{"200":{"description":"请求成功"},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/callback":{"post":{"tags":["callback"],"summary":"此接口仅用于演示回调场景，不可直接进行调用。A2P平台会调用开发者在入驻时提供的回调地址。","responses":{"200":{"description":"成功"},"500":{"$ref":"#/components/responses/500ExternalError"}},"callbacks":{"A2PResourceChange":{"$ref":"#/components/callbacks/A2PResourceChange"},"A2PUserComplaint":{"$ref":"#/components/callbacks/A2PUserComplaint"}}}},"/v1/portpub/add":{"post":{"tags":["port pub relation"],"summary":"新增端口服务号绑定关系（绑定）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/PortPubRelationWithConditon"}]}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/portpub/update":{"post":{"tags":["port pub relation"],"summary":"修改端口服务号绑定关系（换绑），支持把oldPubId改为新pubId，并设置新pubId的匹配条件condition","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["oldPubId"],"properties":{"oldPubId":{"type":"string","description":"老服务号ID。","example":"4jdw2Au2u4nggu5oncjruQ"}},"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/PortPubRelationWithConditon"}]}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/portpub/delete":{"post":{"tags":["port pub relation"],"summary":"删除端口服务号绑定关系（解绑）","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/PortPubRelation"}]}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CallbackSN"}],"type":"object"}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/portpub/query":{"post":{"tags":["port pub relation"],"summary":"查询端口服务号绑定关系","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["condition","pageRequest"],"properties":{"pageRequest":{"description":"分页信息","allOf":[{"$ref":"#/components/schemas/PageRequest"}]},"condition":{"description":"查询条件。","allOf":[{"$ref":"#/components/schemas/ConditionForPortPub"}]}}}}}},"responses":{"200":{"description":"请求成功","content":{"application/json":{"schema":{"type":"object","required":["pubs"],"allOf":[{"$ref":"#/components/schemas/PagedResult"}],"properties":{"portPubs":{"type":"array","items":{"$ref":"#/components/schemas/PortPubRelationWithConditon"}}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}},"/v1/dataencryptor/encrypt":{"post":{"tags":["data encryptor"],"summary":"加密数据","parameters":[{"$ref":"#/components/parameters/AccessToken"},{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/AcceptJson"},{"$ref":"#/components/parameters/ContentTypeJson"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["data"],"properties":{"data":{"type":"string","description":"待加密数据"}}}}}},"responses":{"200":{"description":"请求成功，创建完成","content":{"application/json":{"schema":{"type":"object","required":["encryptedData","workKeyId"],"properties":{"encryptedData":{"type":"string","description":"加密后的数据"},"workKeyId":{"type":"string","description":"密钥ID"}}}}}},"401":{"$ref":"#/components/responses/401InvalidSession"},"404":{"$ref":"#/components/responses/404Notfound"},"500":{"$ref":"#/components/responses/500InternalError"}}}}},"components":{"schemas":{"ErrorCode":{"type":"integer","description":"返回错误码：\n  \n  <p>100001-参数不合法</p>\n  <p>100002-系统异常</p>\n  <p>100003-accessToken或者APPID不合法</p>\n  <p>120001-上传图片大小不合规</p>\n  <p>120002-图片文件不存在</p>\n  <p>120003-不合法的图片文件类型</p>\n  <p>120004-开发者已经被注册</p>\n  <p>120005-商家已经被注册</p>\n  <p>120006-服务号已经被注册</p>\n  <p>120007-端口已经被注册</p>\n  <p>120008-菜单已被注册</p>\n  <p>120009-端口号已被其他服务号引用</p>\n  <p>120010-开发者不存在</p>\n  <p>120011-商家不存在或者未生效</p>\n  <p>120012-服务号不存在或者未生效</p>\n  <p>120013-端口号不存在或者未生效</p>\n  <p>120014-开发者未生效</p>\n  <p>120015-商家未生效</p>\n  <p>120016-服务号未生效</p>\n  <p>120017-端口未生效</p>\n  <p>120018-资源已经存在创建/修改审批流程，无法再发起创建/修改操作</p>\n  <p>120019-资源已经处于冻结状态或有冻结审批流程，无法再发起冻结操作</p>\n  <p>120020-资源不在冻结状态或已经有解冻审批流程，无法进行解冻操作</p>\n  <p>120021-开发者的商家超过限制</p>\n  <p>120022-商家的服务号超过限制</p>\n  <p>120023-商家的端口号超过限制</p>\n  <p>120028-端口，服务号有效期不允许超过商家有效期</p>\n  <p>120029-不允许提前有效期</p>\n  <p>120030-引用的图片尺寸或者格式不正确，比如不能将主页背景图片使用在服务号logo的位置</p>\n  <p>120031-商家已经被冻结</p>\n  <p>120032-服务号已经被冻结</p>\n  <p>120033-端口号已经被冻结</p>\n  <p>120034-商家还未到生效时间</p>\n  <p>120035-服务号还未到生效时间</p>\n  <p>120036-端口还未到生效时间</p>\n  <p>120037-商家已失效</p>\n  <p>120038-服务号已失效</p>\n  <p>120039-端口已失效</p>\n  <p>120040-商家未生效或被冻结</p>\n  <p>120041-服务号未生效或被冻结</p>\n  <p>120042-端口号未生效或被冻结</p>\n  <p>120043-主页已被注册</p>\n  <p>120044-主页内的快应用个数超过限制</p>\n  <p>120046-主页不存在</p>\n  <p>120048-商家下属服务号超过限制</p>\n  <p>120049-服务号下属端口号超过限制</p>\n  <p>120050-菜单不存在</p>\n  <p>120051-服务号的菜单超过限制</p>\n  <p>120052-端口号已经被抢注，不允许冻结，可以到抢注此端口号的商家去冻结端口号</p>\n  <p>120053-更新资源版本不一致</p>\n  <p>120054-该用户投诉不存在</p>\n  <p>120055-该用户投诉截图不存在</p>\n  <p>120056-端口号未绑定服务号，或者绑定的服务号未生效或已失效或被冻结</p>\n  <p>120068-新服务号和老服务号重复</p>\n  <p>120072-区域编码不存在</p>\n  <p>120073-端口服务号绑定关系的区域编码重复</p>\n  <p>120074-端口绑定的服务号重复</p>\n  <p>120075-服务号name重复时remark不允许重复</p>\n  <p>160001-设备被锁定，请求失败</p>\n  <p>160002-未找到此设备的开通记录</p>\n  <p>160003-用户未开通</p>\n  <p>160004-号码已被注册为白名单</p>\n  <p>160005-白名单不存在</p>\n  <p>160006-黑名单不存在</p>\n  <p>160007-北向删除寻址开关关闭</p>\n  <p>160008-南向哈希上报开关关闭</p>\n  <p>160009-北向接口验签失败</p>\n  <p>160010-寻址开关关闭，请联系华为工程师</p>\n  <p>160012-未开通A2P</p>\n  <p>230002-不允许删除预置模板</p>\n","enum":[100001,100002,100003,120001,120002,120003,120004,120005,120006,120007,120008,120009,120010,120011,120012,120013,120014,120015,120016,120017,120018,120019,120020,120021,120022,120023,120024,120025,120026,120027,120028,120029,120030,120031,120032,120033,120034,120035,120036,120037,120038,120039,120040,120041,120042,120043,120044,120045,120046,120047,120048,120049,120050,120051,120052,120053,120054,120055,120056,120068,120072,120073,120074,120075,160001,160002,160003,160004,160005,160006,160007,160008,160009,160010,160012,230002]},"ErrorMsg":{"type":"object","description":"错误信息","required":["code","message"],"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"message":{"type":"string"}}},"TargetMerchant":{"type":"object","required":["merchantId"],"properties":{"merchantId":{"type":"string","description":"商家ID","example":"3dkJ2-z92fr9DuD9rNvp4A"}}},"ResourceApproveState":{"type":"object","description":"查询资源返回的审核状态。","properties":{"operateType":{"type":"integer","description":"操作类型：\n  <p>1-创建</p>\n  <p>2-修改</p>\n  <p>3-运营冻结</p>\n  <p>4-运营解冻</p>\n  <p>5-商家冻结</p>\n  <p>6-商家解冻</p>\n","enum":[1,2,3,4,5,6],"example":1},"approveState":{"type":"integer","description":"审核类型：\n  <p>1-待审核</p>\n  <p>3-驳回</p>\n  <p>4-审核通过</p>\n","enum":[1,3,4],"example":1}}},"MerchantIndustry":{"type":"integer","description":"行业分类：1-金融理财；2-社交通讯；3-影音娱乐；4-旅游出行；5-购物；6-本地生活；7-运动健康；8-教育培训；9-新闻阅读；10-运营商；11-其他"},"MerchantBasicInfo":{"type":"object","description":"商家基本信息","properties":{"name":{"type":"string","description":"商家昵称","example":"华为公司"},"type":{"type":"integer","description":"商家类型：1-企业;2-党政&国家机关;3-事业单位;4-个体工商户;5-民办非企业单位;6-社会团体","enum":["1","2","3","4","5","6"],"example":1},"industry":{"$ref":"#/components/schemas/MerchantIndustry"}}},"MerchantQualificationInformation":{"type":"object","description":"商资质证明信息","properties":{"companyName":{"type":"string","description":"1-企业名称;2-单位名称;3-事业单位名称;4-名称;5-民办非企业单位名称;6-社会团体名称","example":"华为技术有限公司"},"creditNumber":{"type":"string","description":"商家类型：1-社会信用代码（注册号）;2-社会信用代码（执法证号）;3-社会信用代码（事证号）;4-社会信用代码（注册号）;5-社会信用代码（民政字号）;6-社会信用代码（社证号）"},"license":{"type":"string","description":"营业执照上传后返回的ID。1-营业执照;2-行政执法主体资格证;3-事业单位法人证书;4-营业执照;5-民办非企业单位登记证书;6-社会团体法人证书"}}},"MerchantContact":{"type":"object","description":"商家联系方式","properties":{"contact":{"type":"string","description":"联系人","example":"张三"},"tel":{"type":"string","description":"联系电话","example":1300000000},"email":{"type":"string","description":"联系邮箱","example":"abc@huawei.com"}}},"MerchantAuthorizationInfo":{"type":"object","properties":{"authorization":{"type":"string","description":"授权证明材料上传后的返回ID","example":""},"validUntil":{"type":"string","description":"有效期截止时间。格式为yyyy-mm-dd","example":"2019-10-09"}}},"MerchantNoRequired":{"type":"object","description":"商家信息","allOf":[{"$ref":"#/components/schemas/MerchantBasicInfo"},{"$ref":"#/components/schemas/MerchantQualificationInformation"},{"$ref":"#/components/schemas/MerchantContact"},{"$ref":"#/components/schemas/MerchantAuthorizationInfo"}]},"Merchant":{"type":"object","description":"商家信息","required":["name","type","industry","validUntil"],"allOf":[{"$ref":"#/components/schemas/MerchantBasicInfo"},{"$ref":"#/components/schemas/MerchantQualificationInformation"},{"$ref":"#/components/schemas/MerchantContact"},{"$ref":"#/components/schemas/MerchantAuthorizationInfo"}]},"MerchantState":{"type":"integer","description":"商家状态：\n  <p>1-未生效</p>\n  <p>3-已生效</p>\n  <p>4-已失效</p>\n","enum":[1,3,4]},"MerchantDetail":{"type":"object","description":"查询指定商家返回的所有信息","required":["version"],"allOf":[{"$ref":"#/components/schemas/MerchantProfile"},{"$ref":"#/components/schemas/Merchant"},{"$ref":"#/components/schemas/ResourceVersion"}]},"MerchantProfile":{"type":"object","description":"商家摘要信息","required":["name","type","industry","merchantId","pubNum","portNum","templateNum","state","messageCapacityState"],"allOf":[{"$ref":"#/components/schemas/MerchantBasicInfo"}],"properties":{"merchantId":{"type":"string","description":"商家ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"pubNum":{"type":"integer","description":"下属服务号个数","example":1},"portNum":{"type":"integer","description":"下属端口号数量","example":1},"templateNum":{"type":"integer","description":"下属消息模板数量","example":1},"state":{"$ref":"#/components/schemas/MerchantState"}}},"TargetPubNoMerchant":{"type":"object","description":"服务号信息","required":["pubId"],"properties":{"pubId":{"type":"string","description":"服务号ID","example":"4jdw2Au2u4nggu5oncjruQ"}}},"TargetMenu":{"required":["menuId"],"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"properties":{"menuId":{"type":"string","description":"菜单ID，一期中服务号与菜单为一对一关系，后续一个服务号能够支持多个菜单。","example":"3dkJ2-z92fr9DuD9rNvp4A"}}},"TargetPortal":{"required":["portalId"],"allOf":[{"$ref":"#/components/schemas/TargetPub"}],"properties":{"portalId":{"type":"string","description":"主页ID，一期中服务号与主页为一对一关系，后续一个服务号能够支持多个主页。","example":"3dkJ2-z92fr9DuD9rNvp4A"}}},"TargetPub":{"type":"object","required":["merchantId"],"allOf":[{"$ref":"#/components/schemas/TargetPubNoMerchant"}],"properties":{"merchantId":{"type":"string","description":"商家ID","example":"3dkJ2-z92fr9DuD9rNvp4A"}}},"PubServiceBasicInfo":{"type":"object","description":"服务号基本信息","properties":{"name":{"type":"string","description":"服务号名称。不同商家不允许重复，同一商家下允许重复，重复时remark必须不重复。","example":"华为技术有限公司"},"abstract":{"type":"string","description":"服务号简介信息"},"logoImg":{"type":"string","description":"Logo图片文件上传后的ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"authorizationFiles":{"type":"string","description":"授权证明图片文件上传后的ID列表","example":["3dkJ2-z92fr9DuD9rNvp4A","3dkJ2-z92fr9DuD9rNvpB"]},"remark":{"type":"string","description":"服务号备注信息。同一商家下name重复时，remark必须不重复。"}}},"PubService4Update":{"type":"object","description":"服务号基本信息","allOf":[{"$ref":"#/components/schemas/PubServiceBasicInfo"}]},"PubService4Add":{"type":"object","description":"服务号基本信息","required":["merchantId","name","abstract","logoImg","validUntil","orderYears"],"allOf":[{"$ref":"#/components/schemas/PubServiceBasicInfo"}],"properties":{"orderYears":{"type":"integer","description":"订购年份，按年计算。新增时输入。","example":1}}},"PubService":{"type":"object","description":"服务号基本信息","required":["merchantId","name","abstract","logoImg","validUntil","orderYears"],"allOf":[{"$ref":"#/components/schemas/PubServiceBasicInfo"}],"properties":{"orderYears":{"type":"integer","description":"订购年份，按年计算。新增时输入。","example":1}}},"PubDetail":{"type":"object","allOf":[{"$ref":"#/components/schemas/PubService"},{"$ref":"#/components/schemas/PubProfile"}]},"PubProfile":{"type":"object","description":"服务号摘要信息","allOf":[{"$ref":"#/components/schemas/TargetPub"},{"$ref":"#/components/schemas/ResourceVersion"}],"required":["pubId","state","validUntil","version"],"properties":{"validUntil":{"type":"string","description":"有效期结束时间。查询时获得，国内数据中心按东八区为准，精确到天。格式为：YYYY-MM-DD"},"state":{"$ref":"#/components/schemas/PubState"}}},"PubState":{"type":"integer","description":"服务号状态：\n  <p>1-未生效</p>\n  <p>3-已生效</p>\n  <p>4-已失效</p>\n  <p>5-商家冻结</p>\n  <p>6-运营冻结</p>\n","enum":[1,3,4,5,6]},"PubMenu":{"type":"object","description":"服务号菜单列表，最多15个。只有2级，一级列表固定3个，二级列表最多5个。","allOf":[{"$ref":"#/components/schemas/PubMenuBizAttr"}]},"PubMenuBizAttr":{"type":"object","properties":{"menuItems":{"type":"array","description":"菜单项列表，最多15个。只有2级，一级列表固定3个，二级列表最多5个。","items":{"$ref":"#/components/schemas/MenuItem"}}}},"MenuItem":{"type":"object","required":["name","actionType","content"],"properties":{"name":{"type":"string","description":"菜单名称"},"actionType":{"type":"integer","enum":[0,1,2,3,4,6],"description":"菜单动作类型：\n  <p>0-打开子菜单。此菜单下要求必须要有菜单</p>\n  <p>1-打开URL</p>\n  <p>2-拨打电话</p>\n  <p>3-打开APP</p>\n  <p>4-打开快应用</p>\n  <p>6-发送短信</p>\n  <p>7-预留-特殊地址处理</p>\n","externalDocs":{"description":"跳转APK与快应用Deeplink获取地址","url":"https://developer.huawei.com/consumer/cn/devservice/doc/5060303"},"example":1},"content":{"type":"string","description":"对应值类型：\n  <p>0-不填</p>\n  <p>1-跳转URL。此链接必须为https链接。如果此地址非http链接，会返回错误。</p>\n  <p>2-电话号码</p>\n  <p>3-APP的跳转deeplink</p>\n  <p>4-快应用跳转的deeplink。参考填写地址为https://developer.huawei.com/consumer/cn/service/hms/catalog/fastapp.html?page=fastapp_fastapp_devguide_deeplink</p>\n  <p>6-短信内容</p>\n  <p>7-预留-特殊地址</p>\n"},"extMsg":{"additionalProperties":{"type":"string","description":"额外需要携带的信息。 <p>当跳转快应用时，需要写明依赖的快应用引擎版本号dependEngineVer,参考路径：https://developer.huawei.com/consumer/cn/service/hms/catalog/fastapp.html?page=fastapp_fastapp_devguide_frame 中对(minPlatformVersion)的说明</p> <p>当跳转应用时，需要填写应用的包名packageName</p> <p>当跳转URL时，需要填写webview的显示标题webTitle</p>\n"},"example":{"dependEngineVer":"1040"}},"subMenuItems":{"type":"array","description":"菜单子项列表","items":{"$ref":"#/components/schemas/MenuItem"}}}},"MenuProfile":{"type":"object","required":["pubId","state","version"],"description":"菜单信息","allOf":[{"$ref":"#/components/schemas/TargetMenu"},{"$ref":"#/components/schemas/ResourceVersion"}],"properties":{"state":{"$ref":"#/components/schemas/MenuState"},"menu":{"$ref":"#/components/schemas/PubMenu"}}},"MenuState":{"type":"integer","description":"服务号菜单状态：\n  <p>1-未生效</p>\n  <p>3-已生效</p>\n  <p>4-已失效</p>\n  <p>5-商家冻结</p>\n  <p>6-运营冻结</p>\n","enum":[1,3,4,5,6]},"PubPortal":{"type":"object","description":"服务号主页","required":["backgroundImg","abstract"],"properties":{"backgroundImg":{"type":"string","description":"上传完成后背景图片的ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"abstract":{"type":"string","description":"主页简介说明","example":"这是一段主页说明"},"tels":{"type":"array","description":"热线电话号码列表","items":{"type":"object","required":["tel","usage"],"properties":{"tel":{"type":"string","description":"电话号码","example":4008001233},"usage":{"type":"string","description":"号码用途","example":"客服"}}}},"fastapps":{"type":"array","items":{"type":"object","required":["name","deeplink","dependEngineVer","logoImg"],"properties":{"name":{"type":"string","description":"快应用名","example":"快应用"},"deeplink":{"type":"string","description":"跳转快应用链接","example":"hap://app/com.mytest.deeplink:8080/deeplinkDetail?param1=test"},"dependEngineVer":{"type":"string","description":"依赖快应用引擎版本。参考路径https://developer.huawei.com/consumer/cn/service/hms/catalog/fastapp.html?page=fastapp_fastapp_devguide_frame","example":"1040"},"logoImg":{"type":"string","description":"快应用logo图片上传ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"description":{"type":"string","description":"快应用描述"}}}}}},"PubPortal4Update":{"type":"object","description":"服务号主页","properties":{"backgroundImg":{"type":"string","description":"上传完成后背景图片的ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"abstract":{"type":"string","description":"主页简介说明","example":"这是一段主页说明"},"tels":{"type":"array","description":"热线电话号码列表。注意：修改时必须传入全量数据。","items":{"type":"object","required":["tel","usage"],"properties":{"tel":{"type":"string","description":"电话号码","example":4008001233},"usage":{"type":"string","description":"号码用途","example":"客服"}}}},"fastapps":{"type":"array","description":"快应用列表。注意：修改时必须传入全量数据。","items":{"type":"object","required":["name","deeplink","dependEngineVer","logoImg"],"properties":{"name":{"type":"string","description":"快应用名","example":"快应用"},"deeplink":{"type":"string","description":"跳转快应用链接","example":"hap://app/com.mytest.deeplink:8080/deeplinkDetail?param1=test"},"dependEngineVer":{"type":"string","description":"依赖快应用引擎版本。参考路径https://developer.huawei.com/consumer/cn/service/hms/catalog/fastapp.html?page=fastapp_fastapp_devguide_frame","example":"1040"},"logoImg":{"type":"string","description":"快应用logo图片上传ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"description":{"type":"string","description":"快应用描述"}}}}}},"PortalProfile":{"type":"object","required":["pubId","state","pubName","pubLogo","version"],"description":"菜单信息","allOf":[{"$ref":"#/components/schemas/TargetPortal"},{"$ref":"#/components/schemas/PubPortal"},{"$ref":"#/components/schemas/ResourceVersion"}],"properties":{"state":{"$ref":"#/components/schemas/PortalState"},"pubName":{"type":"string","description":"服务号名称","example":"华为技术有限公司"},"pubLogo":{"type":"string","description":"服务号Logo在上传后提供的ID","example":"3dkJ2-z92fr9DuD9rNvp4A"}}},"PortalState":{"type":"integer","description":"服务号主页状态：\n  <p>1-未生效</p>\n  <p>3-已生效</p>\n  <p>4-已失效</p>\n  <p>5-商家冻结</p>\n  <p>6-运营冻结</p>\n","enum":[1,3,4,5]},"TargetPortNoMerchant":{"type":"object","description":"端口信息","required":["port"],"properties":{"port":{"type":"string","description":"端口号","example":10691218759102}}},"TargetPort":{"type":"object","description":"端口信息","required":["merchantId","port"],"allOf":[{"$ref":"#/components/schemas/TargetPortNoMerchant"}],"properties":{"merchantId":{"type":"string","description":"商家ID","example":"3dkJ2-z92fr9DuD9rNvp4A"}}},"Port":{"type":"object","description":"端口号信息","properties":{"port":{"type":"string","description":"端口号","example":10691218759102},"sign":{"type":"string","description":"签名，不允许带【】","example":"华为技术"},"usage":{"type":"string","description":"用途","example":"客服"},"province":{"type":"string","description":"省份。","example":"all","deprecated":true},"authorizationFiles":{"type":"array","items":{"type":"string","description":"授权证明材料上传后的返回ID"}},"validStart":{"type":"string","description":"生效开始时间，可以晚于当前时间。格式为yyyy-mm-dd","example":"2019-1-1"},"validUntil":{"type":"string","description":"生效结束时间，必须大于当前调用时间。格式为yyyy-mm-dd","example":"2020-12-31"},"portType":{"type":"integer","description":"端口类型，1-普通端口，3-号段，默认值1","example":1}}},"PortWithRequired":{"type":"object","description":"端口号信息","required":["port","sign","authorizationFiles","validStart","validUntil"],"allOf":[{"$ref":"#/components/schemas/Port"}]},"PortState":{"type":"integer","description":"端口号生效状态：\n  <p>1-未生效</p>\n  <p>3-已生效</p>\n  <p>4-已失效</p>\n  <p>5-商家冻结</p>\n  <p>6-运营冻结</p>\n","enum":[1,3,4,5,6]},"PortProfile":{"type":"object","description":"端口号信息","allOf":[{"$ref":"#/components/schemas/PortWithRequired"},{"$ref":"#/components/schemas/TargetMerchant"},{"$ref":"#/components/schemas/ResourceVersion"}],"required":["state","version"],"properties":{"state":{"$ref":"#/components/schemas/PortState"}}},"WhiteListUser":{"type":"object","required":["tel","imsi"],"properties":{"tel":{"type":"string","description":"测试用户电话号码","example":13000000000},"imsi":{"type":"string","description":"测试用户SIM卡的IMSI号码。"}}},"WhiteListUserResponse":{"type":"object","required":["tel","imsi"],"allOf":[{"$ref":"#/components/schemas/ErrorMsg"}],"properties":{"tel":{"type":"string","description":"测试用户电话号码","example":13000000000},"imsi":{"type":"string","description":"测试用户SIM卡的IMSI号码。"}}},"CallbackEventType":{"type":"integer","enum":[1,2,3],"description":"对应值类型：\n  <p>1-资源状态变更</p>\n  <p>3-用户投诉</p>\n","example":2},"ResourceType":{"type":"integer","description":"资源类型：\n  <p>2-商家，1.2版本提供状态通知能力。</p>\n  <p>3-端口号，第一期版本会提供新增审核的回调通知，提供冻结，解冻通知。</p>\n  <p>4-服务号，第一期版本会提供新增，修改审核通知，提供冻结，解冻通知。</p>\n  <p>5-服务号菜单，第一期版本提供新增审核通知</p>\n  <p>6-服务号主页，第一期版本提供新增审核通知</p>\n  <p>7-商家消息模板，第一期版本提供新增审核通知</p>\n","enum":[1,2,3,4,5,6,7],"example":1},"CallbackEventCommon":{"type":"object","description":"回调事件","required":["eventType"],"discriminator":{"propertyName":"eventType"},"properties":{"eventType":{"$ref":"#/components/schemas/CallbackEventType"}}},"ApproveNoticeState":{"type":"object","description":"资源审核完成时的审核信息。仅资源管理接口需要审核时才返回，不需要审核时不返回。运营人员或者定时任务发起的操作不返回此信息。","properties":{"operateType":{"type":"integer","description":"操作类型：\n  <p>1-创建</p>\n  <p>2-修改</p>\n  <p>3-运营冻结</p>\n  <p>4-运营解冻</p>\n  <p>5-商家冻结</p>\n  <p>6-商家解冻</p>\n","enum":[1,2,3,4,5,6],"example":1},"approveState":{"type":"integer","description":"审核类型：\n  <p>3-驳回</p>\n  <p>4-审核通过</p>\n","enum":[1,2],"example":2},"desc":{"type":"string","description":"审批描述，将运营的审批意见写入"}}},"ResourceNoticeState":{"type":"integer","description":"通知时刻的资源状态：\n  <p>1-未生效</p>\n  <p>3-已生效</p>\n  <p>4-已失效</p>\n  <p>5-商家冻结</p>\n  <p>6-运营冻结</p>\n","enum":[1,3,4,5,6],"example":1},"ResourceStateChange":{"type":"object","required":["eventType","resourceType","resourceId","resourceState"],"properties":{"resourceType":{"$ref":"#/components/schemas/ResourceType"},"resourceId":{"description":"资源唯一ID。资源类型为商家时，为商家ID；端口号时为端口号；服务号时为服务号ID；服务号菜单时为菜单ID；服务号主页时为服务号主页ID；消息模板时，为消息模板ID；","example":"3dkJ2-z92fr9DuD9rNvp4A"},"resourceState":{"$ref":"#/components/schemas/ResourceNoticeState"},"approveState":{"$ref":"#/components/schemas/ApproveNoticeState"},"changeReason":{"type":"string","description":"修改描述/冻结原因等，包括运营冻结原因。"},"callbackSN":{"type":"string","description":"回执流水号。与资源管理接口被调用时返回的回执流水号相对应。运营人员或者定时任务发起的操作的通知，不是资源管理接口的回执，不返回此字段或者返回流水号没有在资源管理接口返回。","example":"DuD9rNvp4A3dkJ2z92fr9"},"result":{"type":"integer","description":"执行结果。资源管理接口被调用后的业务最终执行结果。运营人员或者定时任务发起的操作不返回此字段，默认为成功。取值包括：\n  <p>0-失败</p>\n  <p>1-成功</p>\n","enum":[0,1],"example":1}}},"ResourceVersion":{"type":"object","properties":{"version":{"type":"integer","format":"int64","description":"资源版本号。用于防止脏写与版本更新判断逻辑"}}},"UserComplaint":{"type":"object","description":"端侧用户投诉信息","required":["complId","rsrcId","rsrcType","type","detail","complItem","merchantId"],"properties":{"complId":{"type":"string","description":"投诉ID"},"rsrcId":{"type":"string","description":"内部资源ID，例如rsrcType为服务号，则rsrcId为服务号ID"},"rsrcType":{"type":"integer","description":"资源类型:\n*4-服务号\nenum: [4]\n"},"type":{"type":"integer","description":"投诉分类:\n*1-诈骗信息\n*2-赌博色情\n*3-骚扰信息\n*4-其他\n"},"tel":{"type":"string","description":"用户联系方式"},"screenshots":{"type":"array","items":{"type":"string"}},"detail":{"type":"string","description":"投诉内容"},"complItem":{"type":"integer","description":"投诉项目:\n*1-服务号消息\n","enum":[1]},"complItemInfo":{"type":"object","additionalProperties":{"type":"string"},"example":{"id":"消息ID","port":"来源端口号","rts":"消息抵达时间戳","externalId":"外部系统ID","to":"发送消息使用的目的用户标识，可能是tel","toType":1}},"merchantId":{"type":"string","description":"商家ID"}}},"PagedResult":{"properties":{"totalItems":{"type":"integer"},"pageSize":{"type":"integer"},"currentPage":{"type":"integer"}}},"PageRequest":{"required":["pageSize","currentPage"],"properties":{"pageSize":{"type":"integer"},"currentPage":{"type":"integer"}}},"ExternalError":{"type":"object","description":"商家系统返回的错误码及描述","properties":{"code":{"type":"string","description":"错误码"},"message":{"type":"string","description":"错误描述"}}},"PortPubRelation":{"type":"object","description":"端口服务号绑定关系","required":["port","pubId"],"properties":{"port":{"type":"string","description":"端口号。","example":10691218759102},"pubId":{"type":"string","description":"服务号ID","example":"4jdw2Au2u4nggu5oncjruQ"}}},"PortPubRelationWithConditon":{"type":"object","description":"端口服务号绑定关系，包括匹配条件condition","required":["port","pubId"],"allOf":[{"$ref":"#/components/schemas/PortPubRelation"}],"properties":{"condition":{"type":"object","description":"端口服务号一对多时，1个端口可以绑定多个不同的服务号，必须是不同的匹配条件condition，当前仅支持不同的区域。不填时，默认中国。","required":["conditionType","conditionValue"],"properties":{"conditionType":{"type":"integer","description":"条件类型：1-区域编码","example":1},"conditionValue":{"type":"string","description":"条件值。","example":320000}}}}},"ConditionForPortPub":{"type":"object","description":"端口服务号绑定关系查询条件","required":["merchantId"],"properties":{"merchantId":{"type":"string","description":"商家ID","example":"3dkJ2-z92fr9DuD9rNvp4A"},"pubId":{"type":"string","description":"服务号ID。说明：服务号/端口号，二者必须传入一个。","example":"4jdw2Au2u4nggu5oncjruQ"},"port":{"type":"string","description":"端口号。说明：服务号/端口号，二者必须传入一个。","example":10691218759102}}},"CallbackSN":{"type":"object","description":"接口返回的回执流水号","properties":{"callbackSN":{"type":"string","description":"回执流水号。如果返回回执流水号，说明业务异步处理，需等待回执，回执会包含业务执行结果；没有返回回执流水号（没有此字段或者字段值为空），说明没有回执，标识业务已执行完成。","example":"DuD9rNvp4A3dkJ2z92fr9"}}}},"parameters":{"AccessToken":{"name":"access_token","in":"header","description":"开发者接入后获取到的Token。获取方式请参阅https://developer.huawei.com/consumer/cn/devservice/doc/30101的Client Credentials模式。","required":true,"schema":{"type":"string"}},"APPID":{"name":"appid","in":"header","description":"开发者的APPID","required":true,"schema":{"type":"string"}},"Mode":{"name":"mode","in":"header","description":"对应值类型：\n  <p>0-运行模式(默认)</p>\n  <p>1-测试模式。此模式下的管理接口会构造模拟返回与审批结果返回。此模式在第一期版本中暂不提供</p>\n","schema":{"type":"integer","enum":[0,1]},"deprecated":true},"ContentTypeJson":{"name":"Content-Type","in":"header","description":"填写application/json","required":true,"schema":{"type":"string","example":"application/json"}},"ContentTypeFormData":{"name":"Content-Type","in":"header","description":"填写multipart/form-data","required":true,"schema":{"type":"string","example":"multipart/form-data"}},"AcceptJson":{"name":"Accept","in":"header","description":"填写application/json","required":true,"schema":{"type":"string","example":"application/json"}},"AcceptForData":{"name":"Accept","in":"header","description":"填写application/octet-stream","required":true,"schema":{"type":"string","example":"application/octet-stream"}},"CallbackEventType":{"name":"eventType","in":"header","description":"标识回调事件类型：\n  <p>1-资源状态变更</p>\n  <p>3-用户投诉</p>\n","required":true,"schema":{"type":"integer"}},"CallbackSign":{"name":"sign","in":"header","description":"回复消息时的消息签名。使用appid+timestamp+随机数，进行hmac-sha256签名（开发者注册时提供的密钥），防止仿冒。","required":true,"schema":{"type":"string"}},"CallbackNonce":{"name":"nonce","in":"header","description":"回复消息时的随机数字，用于验签","required":true,"schema":{"type":"integer"}},"CallbackTimestamp":{"name":"timestamp","in":"header","description":"回复消息时时间戳，用于验签","required":true,"schema":{"type":"integer"}},"CallbackTraceId":{"name":"traceId","in":"header","description":"跟踪ID。","required":true,"schema":{"type":"string"}}},"responses":{"401InvalidSession":{"description":"认证失败"},"404Notfound":{"description":"资源未找到"},"500InternalError":{"description":"内部错误","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ErrorMsg"}]}}}},"500ExternalError":{"description":"外部商家系统处理失败时返回的错误码及描述。","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/ExternalError"}]}}}}},"callbacks":{"A2PResourceChange":{"资源状态变更通知。通知地址为商家在注册时提供的回调地址。仅支持https 443端口调用":{"post":{"parameters":[{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/CallbackNonce"},{"$ref":"#/components/parameters/CallbackTimestamp"},{"$ref":"#/components/parameters/CallbackSign"},{"$ref":"#/components/parameters/CallbackEventType"},{"$ref":"#/components/parameters/CallbackTraceId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CallbackEventCommon"},{"$ref":"#/components/schemas/ResourceStateChange"}]}}}},"responses":{"200":{"description":"成功"},"500":{"$ref":"#/components/responses/500ExternalError"}}}}},"A2PUserComplaint":{"端侧用户发起投诉通知。通知地址为商家在注册时提供的回调地址。仅支持https 443端口调用":{"post":{"parameters":[{"$ref":"#/components/parameters/APPID"},{"$ref":"#/components/parameters/CallbackNonce"},{"$ref":"#/components/parameters/CallbackTimestamp"},{"$ref":"#/components/parameters/CallbackSign"},{"$ref":"#/components/parameters/CallbackEventType"},{"$ref":"#/components/parameters/CallbackTraceId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CallbackEventCommon"},{"$ref":"#/components/schemas/UserComplaint"}]}}}},"responses":{"200":{"description":"成功"},"500":{"$ref":"#/components/responses/500ExternalError"}}}}}}}}