{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:tencent-npp/create-call-back":{"post":{"operationId":"cloud_tencent_npp_create_call_back","summary":"Create Call Back","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId","Src","Dst"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"Src":{"type":"string"},"Dst":{"type":"string"},"SrcDisplayNum":{"type":"string"},"DstDisplayNum":{"type":"string"},"Record":{"type":"string"},"MaxAllowTime":{"type":"string"},"StatusFlag":{"type":"string"},"StatusUrl":{"type":"string"},"HangupUrl":{"type":"string"},"RecordUrl":{"type":"string"},"BizId":{"type":"string"},"LastCallId":{"type":"string"},"PreCallerHandle":{"type":"object"},"OrderId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/del-virtual-num":{"post":{"operationId":"cloud_tencent_npp_del_virtual_num","summary":"Del Virtual Num","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId","BindId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"BindId":{"type":"string"},"BizId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/delete-call-back":{"post":{"operationId":"cloud_tencent_npp_delete_call_back","summary":"Delete Call Back","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId","CallId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"CallId":{"type":"string"},"CancelFlag":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/describe-call-back-cdr":{"post":{"operationId":"cloud_tencent_npp_describe_call_back_cdr","summary":"Describe Call Back Cdr","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"CallId":{"type":"string"},"Src":{"type":"string"},"StartTimeStamp":{"type":"string"},"EndTimeStamp":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/describe-call-back-status":{"post":{"operationId":"cloud_tencent_npp_describe_call_back_status","summary":"Describe Call Back Status","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId","CallId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"CallId":{"type":"string"},"Src":{"type":"string"},"Dst":{"type":"string"},"CallStatus":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/describe-caller-display-list":{"post":{"operationId":"cloud_tencent_npp_describe_caller_display_list","summary":"Describe Caller Display List","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/get400-cdr":{"post":{"operationId":"cloud_tencent_npp_get400_cdr","summary":"Get400 Cdr","description":"POST /","tags":["cloud"],"x-apizie-access":"write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"CallId":{"type":"string"},"Src":{"type":"string"},"StartTimeStamp":{"type":"string"},"EndTimeStamp":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:tencent-npp/get-virtual-num":{"post":{"operationId":"cloud_tencent_npp_get_virtual_num","summary":"Get Virtual Num","description":"POST /","tags":["cloud"],"x-apizie-access":"read","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizAppId","Dst"],"properties":{"X-TC-Region":{"type":"string","description":"Region for regional products, for example ap-singapore, ap-guangzhou, na-siliconvalley"},"BizAppId":{"type":"string"},"Dst":{"type":"string"},"Src":{"type":"string"},"AccreditList":{"type":"array"},"AssignVirtualNum":{"type":"string"},"Record":{"type":"string"},"CityId":{"type":"string"},"BizId":{"type":"string"},"MaxAssignTime":{"type":"string"},"StatusFlag":{"type":"string"},"StatusUrl":{"type":"string"},"HangupUrl":{"type":"string"},"RecordUrl":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}