{"base_path":null,"components":null,"consumes":"","definitions":{"AimSaErrorMsg":{"properties":{"error_code":{"description":"错误码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}},"ListPortInfosResponseModel":{"description":"查询结果返回体。","properties":{"data":{"description":"请求成功返回的数据。","items":{"properties":{"authorization_files":{"additionalProperties":{"type":"string"},"description":"授权证明图片,key是上传的图片ID,value是图片对应的URL。","type":"object"},"create_time":{"description":"创建时间,格式:yyyy-MM-ddTHH:mm:ssZ。","example":"2022-02-03T00:29:13Z","format":"date-time","type":"string"},"id":{"description":"主键ID。","example":"184e9e13e83b4398b96e0793d6bfde75","type":"string"},"is_bind":{"description":"是否绑定。\n\n- 0: 未绑定\n- 1: 绑定\n","example":1,"format":"int32","type":"integer"},"port":{"description":"通道号。\n","example":"102030003","type":"string"},"port_type":{"description":"通道号类型。\n- 1:普通\n- 3:前缀号段\n- 5:后缀号段\n\n","example":1,"type":"integer"},"province":{"description":"未绑定服务号时该项为null。","example":"山东省","type":"string"},"pub_id":{"description":"服务号ID,在通道号列表显示为null。","example":"044c1bf88e391204c92746ee502109cc","type":"string"},"pub_list":{"description":"绑定的服务号列表。\n\n> 以JSON列表返回,格式:\n> [{\"pub_name\":\"服务号名称\",\"pub_reference\":\"服务号备注\"}]。\n","items":{"$ref":"#/definitions/PortSearchPubDetail"},"type":"array"},"pub_name":{"description":"服务号名称,查询通道号列表时该项为null。","example":"主页测试服务号","type":"string"},"sign":{"description":"签名数组。\n\n- 查询通道号列表时,该项为通道号签名列表\n\n- 查询绑定关系时,该项为通道号绑定签名列表\n","example":["001"],"items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"sign_check":{"description":"是否需要校验。\n\n- 0:不校验\n- 1:校验签名\n","example":1,"format":"int32","type":"integer"}},"type":"object"},"maxItems":50000,"minItems":0,"type":"array"},"page_info":{"$ref":"#/definitions/PageOffSet","description":"包含当前查询分页信息和可查询数据总数。"}}},"ListPortInfosRsp":{"properties":{"data":{"$ref":"#/definitions/ListPortInfosResponseModel"}}},"PageOffSet":{"properties":{"limit":{"description":"每页显示的条目数量。","type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","type":"integer"},"total":{"description":"总量。","type":"integer"}}},"PortSearchPubDetail":{"properties":{"pub_name":{"description":"服务号名称。","example":"服务号名称","type":"string"},"pub_reference":{"description":"服务号备注。","example":"服务号备注","type":"string"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"b4a7a8e177fe47a98f2392a437e7826f","info_version":"v1","method":"get","name":"ListPortInfos","parameters":{},"paths":{"/v1/aim-sa/ports":{"get":{"consumes":["application/json"],"description":"支持查询通道号列表和通道号绑定信息。","operationId":"ListPortInfos","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"操作类型。\n- 0:查询通道号列表\n- 1:查询绑定关系列表\n","in":"query","maxLength":1,"minLength":0,"name":"type","required":false,"type":"integer"},{"description":"通道号。\n","in":"query","maxLength":21,"minLength":0,"name":"port","required":false,"type":"string"},{"description":"通道号类型。\n- 1:普通\n- 3:前缀号段 \n- 5:后缀号段\n","in":"query","maximum":5,"minimum":1,"name":"port_type","required":false,"type":"integer"},{"description":"单个通道号签名。\n\n> 不支持多个签名查询,支持模糊搜索。长度要求0-18。\n","in":"query","maxLength":18,"minLength":0,"name":"sign_search","required":false,"type":"string"},{"default":0,"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","format":"int32","in":"query","maximum":2147483647,"minimum":0,"name":"offset","required":false,"type":"integer"},{"default":10,"description":"每页显示的条目数量。","format":"int32","in":"query","maximum":100,"minimum":1,"name":"limit","required":false,"type":"integer"},{"description":"开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ。","format":"date-time","in":"query","name":"start_time","required":false,"type":"string"},{"description":"结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ。","format":"date-time","in":"query","name":"end_time","required":false,"type":"string"},{"description":"服务号名称。\n\n> - type=1时,此字段作为过滤条件\n> - type=0时,不作为过滤条件\n","in":"query","maxLength":64,"minLength":0,"name":"pub_name","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"data":{"data":[{"authorization_files":{"3d214a61672846f88ad77597f935cccc":"AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png"},"create_time":"2022-08-05T01:45:05Z","id":"a67928a301364aa38d8cf6f08242cccc","port":"8822053111111","port_type":1,"sign":["华为云KooMessage"],"sign_check":0},{"authorization_files":{"37fd9a91d5bb4457aae5dd431676cccc":"AimSauploadService/62dcfe64c95b4635bef2ef76a72bcccc测试3.PNG"},"create_time":"2022-08-04T09:27:29Z","id":"fce3da488355458f80ba5407e3c1cccc","port":"8822053112222","port_type":1,"sign":["0804测试测试"],"sign_check":1}],"page_info":{"limit":2,"offset":0,"total":8}}}},"schema":{"$ref":"#/definitions/ListPortInfosRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}}},"security":[{"apig-auth-iam":[]}],"summary":"查询通道号列表","tags":["AimSaPort"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-request-examples-description-1":"查询通道号列表","x-request-examples-description-2":"查询通道号绑定信息列表","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports?type=0&limit=2","x-request-examples-url-2":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports?type=1&limit=2","x-support-sdk":"Y"}}},"product_short":"KooMessage","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"查询通道号列表","tags":"智能信息服务号通道号","uri":null,"version":"2.0"}