{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dyplsapi/add-axn-track-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_add_axn_track_no","summary":"Adds a tracking number for a private number in the AXN binding","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","PhoneNoX","trackNo","SubsId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"PhoneNoX":{"type":"string","description":"The private number in the AXN binding, that is, phone number X. You can call the https://help.aliyun.com/document_detail/110258.html…"},"trackNo":{"type":"string","description":"The tracking number"},"SubsId":{"type":"string","description":"The binding ID. You can call the https://help.aliyun.com/document_detail/110258.html operation to obtain the value of SubsId"}}}}}},"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:aliyun-dyplsapi/add-secret-blacklist":{"post":{"operationId":"cloud_aliyun_dyplsapi_add_secret_blacklist","summary":"Adds a phone number to the blacklist of a China number pool. Only AXN privacy number, AXN extension number,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","BlackNo","BlackType"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the number pool. You can obtain the number pool key on the Number Pool Management…"},"BlackNo":{"type":"string","description":"The blacklisted phone number. The value type depends on the BlackType parameter: Point-to-point blacklist: A pair of numbers (A and B…"},"Remark":{"type":"string","description":"The remarks for the blacklist entry"},"BlackType":{"type":"string","description":"The blacklist type. Valid values: POINT_TO_POINT_BLACK: point-to-point blacklist. PARTNER_GLOBAL_NUMBER_BLACK: number pool blacklist"},"WayControl":{"type":"string","enum":["DUPLEX_REJECT","PHONEA_REJECT","PHONEB_REJECT"],"description":"The call direction control. Valid values: PHONEA_REJECT: The first number in BlackNo can call the second number, but the second number…"}}}}}},"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:aliyun-dyplsapi/bind-axbcall":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axbcall","summary":"Establishes a call binding relationship (B, X, A) for work number X of employee B on the work number…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","TelA","AuthId","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The key of the number pool"},"TelA":{"type":"string","description":"The phone number of customer A"},"AuthId":{"type":"string","description":"The unique ID of the BX binding relationship"},"Expiration":{"type":"integer","description":"The expiration time of the binding relationship. The value must be greater than 0. Unit: seconds. The automatic unbinding time is…"},"UserData":{"type":"string","description":"The custom callback parameter"}}}}}},"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:aliyun-dyplsapi/bind-axb":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axb","summary":"Adds an AXB binding","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"PhoneNoA":{"type":"string","description":"Phone number A in the AXB binding. Phone number A can be set to a mobile phone number or a landline phone number. The landline phone…"},"PhoneNoB":{"type":"string","description":"Phone number B in the AXB binding. If phone number A is used to call phone number X, the call is forwarded to phone number B. Phone number…"},"PhoneNoX":{"type":"string","description":"Phone number X in the AXB binding. Phone number X is the phone number that you purchased in the Phone Number Protection console…"},"Expiration":{"type":"string","description":"The expiration time of the AXB binding. The expiration time must be more than 1 minute later than the time when you call this API operation"},"ExpectCity":{"type":"string","description":"Specifies the city to which phone number X to be selected belongs. If no phone number for the specified city is available in the current…"},"IsRecordingEnabled":{"type":"string","description":"Specifies whether to record all calls made by the bound phone numbers. Valid values: true false (default)"},"OutId":{"type":"string","description":"The extension field for the external business. This parameter is returned in a call record receipt"},"OutOrderId":{"type":"string","description":"The ID of the external business"},"CallRestrict":{"type":"string","enum":["CONTROL_AX_DISABLE","CONTROL_BX_DISABLE","CONTROL_CLEAR_DISABLE"],"description":"The status of the one-way call restriction. Valid values: CONTROL_AX_DISABLE: Phone number A cannot be used to call phone number X.…"},"CallDisplayType":{"type":"integer","description":"Re-sets the phone number display logic in the AXB binding. Fixed value: 1, indicating that phone number X is displayed on both the calling…"},"RingConfig":{"type":"string","description":"Sets the ringtone code for enterprise Color Ring Back Tone (CRBT) in the AXB binding. Ringtone setting when phone number A is used to call…"},"ASRStatus":{"type":"string","description":"Specifies whether to enable automatic speech recognition (ASR). Valid values: false (default): disables ASR. true: enables ASR"},"ASRModelId":{"type":"string","description":"The ID of the ASR model. On the Automatic Speech Recognition (ASR) Model Management…"},"CallTimeout":{"type":"integer","description":"The maximum ringing duration for each number in sequential ringing. Unit: seconds. The value ranges from 5 to 20"},"DtmfConfig":{"type":"string","description":"Specifies the dual tone multiple frequency (DTMF) key configuration in the AXB binding. The following content can be configured:…"}}}}}},"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:aliyun-dyplsapi/bind-axb700":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axb700","summary":"Binds phone numbers for a 700AXB private number. A 700AXB private number restricts the calling relationship…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","Expiration","TelA","TelB"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the China 700 number pool"},"Expiration":{"type":"string","description":"The expiration time of the number binding. The expiration time must be at least 1 minute later than the current binding time, accurate to…"},"TelA":{"type":"string","description":"The phone number of user A"},"TelB":{"type":"string","description":"The phone number of user B"},"TelX":{"type":"string","description":"Optional. The intermediate number X. If the caller does not specify an X number, the platform assigns a number from the number pool as the…"},"NeedRecord":{"type":"string","description":"Specifies whether call recording files are required for all calls made through this number binding. Valid values: true: Enable recording.…"},"RecType":{"type":"string","description":"The recording file format. Valid values: mp3 and wav"},"CallRestrict":{"type":"string","description":"The one-way call restriction logic. Valid values: CONTROL_AX_DISABLE: Number A cannot call number X. CONTROL_BX_DISABLE: Number B cannot…"},"Audio":{"type":"string","description":"The audio prompt encoding. ACallX_Apre: The audio prompt encoding played to A before the call is connected when A calls X. ACallX_Ain: The…"},"OrderId":{"type":"string","description":"The business order code. This code has a one-to-one mapping with the actual business order and must be unique. The code supports…"},"IndustrialId":{"type":"string","description":"The industrial Internet identifier code, which has a one-to-one mapping with OrderId. The code supports characters such as \".\" and \"/\" as…"},"OutId":{"type":"string","description":"The external business extension field. This parameter is returned in the call record receipt message"},"OutOrderId":{"type":"string","description":"The external business ID"},"NeedAsr":{"type":"string","description":"Specifies whether to enable the ASR service. Valid values: false: Disable (default). true: Enable"},"AsrModelId":{"type":"string","description":"Optional. The ASR model ID. Valid values: General-Phone-Mandarin model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac General-Phone-Cantonese model…"},"CallTimeout":{"type":"integer","description":"The sequential ringing duration. Unit: seconds. Valid values: 5 to 20"},"DtmfConfig":{"type":"string","description":"Optional. The DTMF key configuration for 700AXB number binding. The following items can be configured: endCallIvrPhoneNo: The audio…"}}}}}},"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:aliyun-dyplsapi/bind-axb-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axb_fixed_line","summary":"The fixed-line AXB privacy number binding restricts the calling relationship to a one-to-one relationship.…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","BindType","OrderId","TelA","TelB","Subts","Anucode","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"Number pool ID"},"Ts":{"type":"string","description":"Business timestamp, in the format yyyyMMddHHmmssSSS. The time uses Beijing time, 24-hour clock, accurate to milliseconds"},"BindType":{"type":"string","description":"Binding type. Valid values: mode101: Customer specifies the X number. mode102: Platform allocates the X number"},"OrderId":{"type":"string","description":"Unique identifier for the message request"},"TelA":{"type":"string","description":"The A number in the fixed-line AXB privacy number. The A number can be set to a mobile phone number or a landline number. For landline…"},"TelX":{"type":"string","description":"The X number in the fixed-line AXB privacy number. The X number is a privacy number you have purchased in the console…"},"TelB":{"type":"string","description":"The B number in the fixed-line AXB privacy number. The B number can be set to a mobile phone number or a landline number. For landline…"},"Subts":{"type":"string","description":"Binding time, in the format yyyyMMddHHmmss. The time uses Beijing time, 24-hour clock"},"Anucode":{"type":"string","description":"Caller-side ringback tone code. Must be set for fixed-line AXB privacy number business. Must contain codes for 3 scenarios. Fill in the…"},"Anucodecalled":{"type":"string","description":"Post-connection callee-side ringback tone code. Must contain codes for 2 scenarios. Fill in the codes in the order of \"A as callee, B as…"},"TAnucodeConnect":{"type":"string","description":"Post-connection caller-side ringback tone code. Must contain codes for 2 scenarios. Fill in the codes in the order of \"A as callee, B as…"},"Areacode":{"type":"string","description":"Area code. Supports specifying the X number's region (specified city -> provincial capital -> nationwide routing). If no region is…"},"Expiration":{"type":"string","description":"Expiration time, unit: seconds. Valid values: 0: Never expires. Other values: When other values are specified, for example 60s, the…"},"Remark":{"type":"string","description":"External business extension field. This parameter will be returned in the call record receipt message. Must not exceed 100 characters in…"},"Extra":{"type":"string","description":"Extension parameters (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/bind-axg":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axg","summary":"Adds an AXG binding","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","GroupId","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"PhoneNoA":{"type":"string","description":"Phone number A in the AXG binding. Phone number A can be set to a mobile phone number or a landline phone number. The landline phone…"},"GroupId":{"type":"string","description":"The group ID in the AXG binding. You can view the group ID by using either of the following methods: On the Number Pool Management page in…"},"PhoneNoB":{"type":"string","description":"Phone number B in the AXG binding. If phone number A is used to call phone number X, the call is forwarded to phone number B. If you need…"},"PhoneNoX":{"type":"string","description":"Phone number X in the AXG binding. If you do not specify this parameter, a random phone number is selected from the phone number pool…"},"Expiration":{"type":"string","description":"The expiration time of the AXG binding. The value is accurate to seconds. The expiration time must be more than 1 minute later than the…"},"ExpectCity":{"type":"string","description":"Specifies the city to which phone number X to be selected belongs. If no phone number for the specified city is available in the current…"},"IsRecordingEnabled":{"type":"string","description":"Specifies whether to record all calls made by the bound phone numbers"},"OutId":{"type":"string","description":"The extension field for the external business. This parameter is returned in a call record receipt"},"OutOrderId":{"type":"string","description":"The ID of the external business"},"CallDisplayType":{"type":"integer","description":"Re-sets the phone number display logic in the AXG binding. Fixed value: 1, indicating that phone number X is displayed on both the calling…"},"RingConfig":{"type":"string","description":"Sets the ringtone for enterprise Color Ring Back Tone (CRBT) in the AXG binding. Ringtone setting (with a callback number) when phone…"},"ASRStatus":{"type":"string","description":"Specifies whether to enable automatic speech recognition (ASR). Valid values: False (default): disables ASR. True: enables ASR"},"ASRModelId":{"type":"string","description":"The ID of the ASR model"},"CallRestrict":{"type":"string","description":"The status of call restrictions. Valid values: CONTROL_AX_DISABLE: Phone number A cannot be used to call phone number X.…"}}}}}},"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:aliyun-dyplsapi/bind-axn":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axn","summary":"Creates a binding for an AXN Privacy Number. This process assigns a dedicated Privacy Number (the X Number)…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the Number Pool. You can get the Pool Key from the Number Pool Management…"},"PhoneNoA":{"type":"string","description":"Phone number A for the AXN binding. This can be a mobile phone number or a fixed-line phone. For a fixed-line phone, you must include the…"},"PhoneNoB":{"type":"string","description":"Phone number B for the AXN binding. This can be a mobile phone number or a fixed-line phone. For a fixed-line phone, you must include the…"},"PhoneNoX":{"type":"string","description":"Phone number X, the privacy number for the AXN binding. Phone number X must be one of your Purchased Privacy Numbers…"},"Expiration":{"type":"string","description":"The expiration time of the binding. The time must be in the `YYYY-MM-DD HH:mm:ss` format. The expiration time must be at least 60 seconds…"},"ExpectCity":{"type":"string","description":"The city from which to select Phone number X. If no numbers are available in the specified city or if you do not specify this parameter,…"},"IsRecordingEnabled":{"type":"string","description":"Specifies whether to enable call recording for this binding. Valid values: true: Enables call recording. false (default): Disables call…"},"NoType":{"type":"string","description":"The number type. This parameter applies to legacy Alibaba Dayu customers. Current Alibaba Cloud users can ignore this parameter"},"OutId":{"type":"string","description":"An external extension field that is included in the call detail record (CDR) callback"},"OutOrderId":{"type":"string","description":"The external business ID"},"CallDisplayType":{"type":"integer","description":"Sets the caller ID display logic for the binding. The value must be 1, which indicates that the privacy number (Phone number X) is…"},"RingConfig":{"type":"string","description":"Configures the enterprise ring-back tone for calls to Phone number X. This parameter requires a ringtone field and a ring-back tone code.…"},"ASRStatus":{"type":"string","description":"Specifies whether to enable or disable Automatic Speech Recognition (ASR). Valid values: false (default): Disables ASR. true: Enables ASR"},"ASRModelId":{"type":"string","description":"The ID of the ASR model. Valid values: Generic - Telephony - Mandarin Chinese model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac Generic -…"},"CallTimeout":{"type":"integer","description":"The call timeout in seconds"},"CallRestrict":{"type":"string","description":"The call restriction policy. Valid values: CONTROL_AX_DISABLE: Disables calls from Phone number A to Phone number X. CONTROL_BX_DISABLE:…"},"Extend":{"type":"string","description":"The Extend"}}}}}},"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:aliyun-dyplsapi/bind-axn-extension":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axn_extension","summary":"AXN with extension creates a binding. This feature is similar to AXN for privacy protection but introduces…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The number pool key. You can find the Pool Key on the Number Pool Management…"},"PhoneNoA":{"type":"string","description":"Specifies Number A for the AXN extension binding. Number A can be a mobile number or a landline. For a landline, include the area code but…"},"Extension":{"type":"string","description":"The extension for Number X. The extension must be 1 to 3 digits long. If you specify the `Extension` parameter, you must also specify the…"},"PhoneNoB":{"type":"string","description":"Specifies Number B for the AXN extension binding. Number B can be a mobile number or a landline. For a landline, include the area code but…"},"PhoneNoX":{"type":"string","description":"Specifies Number X for the AXN extension binding. Number X must be one of your purchased privacy numbers…"},"Expiration":{"type":"string","description":"The expiration time of the binding, accurate to the second. The expiration time must be at least one minute later than the current time"},"ExpectCity":{"type":"string","description":"The desired city for Number X. If no numbers are available in the specified city or if this parameter is not specified, the system…"},"IsRecordingEnabled":{"type":"string","description":"Specifies whether to enable Call Recording for all calls associated with this binding. Valid values: true: Enables call recording. false…"},"OutId":{"type":"string","description":"The External Business Extension Field. This field is included in call record receipt messages"},"OutOrderId":{"type":"string","description":"The external business ID"},"CallDisplayType":{"type":"integer","description":"Sets the caller ID display logic for the binding. The value must be 1, which specifies that Number X is displayed to both the caller and…"},"RingConfig":{"type":"string","description":"Sets the Enterprise Ringback Tone for an AXN extension binding when Number X is called. This parameter requires a ringtone field and a…"},"ASRStatus":{"type":"string","description":"Specifies whether to enable ASR (Automatic Speech Recognition). Valid values: true: Enables ASR. false (default): Disables ASR"},"ASRModelId":{"type":"string","description":"The ASR model ID. Valid values: General - Telephony - Mandarin Model ID: `7ee372834d2f4cc7ac0d0ab2d0ae1aac` General - Telephony -…"},"CallRestrict":{"type":"string","description":"Specifies the Call Restriction policy. Valid values: CONTROL_AX_DISABLE: Number A cannot call Number X. CONTROL_BX_DISABLE: Number B…"},"Extend":{"type":"string","description":"Reserved for future use"}}}}}},"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:aliyun-dyplsapi/bind-axn-extension-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axn_extension_fixed_line","summary":"The fixed-line AXN extension number introduces extension numbers on top of the fixed-line AXN privacy…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","OrderId","BindType","Subts","TelA","Anucode","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"Number pool ID"},"Ts":{"type":"string","description":"Business timestamp. Format: yyyyMMddHHmmssSSS. Uses Beijing time, 24-hour clock, accurate to milliseconds"},"OrderId":{"type":"string","description":"Unique identifier of the message request"},"BindType":{"type":"string","description":"Binding type. Valid values: mode101: Customer specifies the X number. mode102: Platform assigns the X number"},"Subts":{"type":"string","description":"Binding time. Format: yyyyMMddHHmmss. Uses Beijing time, 24-hour clock"},"TelA":{"type":"string","description":"The A number for the fixed-line AXN extension number. The A number can be set to a mobile number or a fixed-line number. Fixed-line…"},"TelX":{"type":"string","description":"The X number for the fixed-line AXN extension number. The X number is a privacy number that you have purchased…"},"TelXext":{"type":"string","description":"Extension number. This parameter is required when the BindType parameter is set to mode101"},"Anucode":{"type":"string","description":"Caller-side ringtone code. This parameter is required for AXB scenarios. Must contain codes for 3 scenarios. Enter the codes in the order…"},"Anucodecalled":{"type":"string","description":"Called-side ringtone code after connection. Must contain codes for 2 scenarios. Enter the codes in the order of \"A as called party, B as…"},"TAnucodeConnect":{"type":"string","description":"Caller-side ringtone code after connection. Must contain codes for 2 scenarios. Enter the codes in the order of \"A as called party, B as…"},"Expiration":{"type":"string","description":"Expiration time. Unit: seconds. Valid values: 0: Never expires. Other values: When other values are specified, such as 60, the binding is…"},"Areacode":{"type":"string","description":"Area code. Supports specifying the home location of the X number (specified city -> provincial capital -> nationwide routing). If no home…"},"Remark":{"type":"string","description":"External business extension field. This parameter is returned in call record receipt messages. Must not exceed 100 characters"},"Extraaxx":{"type":"string","description":"Extension parameters (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/bind-axn-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_axn_fixed_line","summary":"Binds a number to a fixed-line AXN private number. User A is assigned a dedicated private number X, and any…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","OrderId","BindType","Subts","TelA","Anucode","Expiration"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the number pool"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"OrderId":{"type":"string","description":"The unique identifier of the message request"},"BindType":{"type":"string","description":"The binding type. Valid values: mode101: The customer specifies the X number. mode102: The platform assigns the X number"},"Subts":{"type":"string","description":"The binding time. Format: yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format"},"TelA":{"type":"string","description":"The A number of the fixed-line AXN private number. The A number can be a mobile phone number or a landline number. For landline numbers,…"},"TelX":{"type":"string","description":"The X number of the fixed-line AXN private number. The X number is a private number that you purchased in the console. This parameter is…"},"TelB":{"type":"string","description":"The N number of the fixed-line AXN private number"},"Anucode":{"type":"string","description":"The caller-side voice prompt codes. Must include codes for 3 scenarios, in the order of \"B->X, A->X, other numbers->X\", separated by…"},"Anucodecalled":{"type":"string","description":"The callee-side voice prompt codes. Must include codes for 2 scenarios, in the order of \"A as callee, other numbers as callee\", separated…"},"TAnucodeConnect":{"type":"string","description":"The post-connection caller-side voice prompt codes. Must include codes for 2 scenarios, in the order of \"A as callee, other numbers as…"},"Areacode":{"type":"string","description":"The area code. Specifies the location of the X number (specified city -> provincial capital -> nationwide routing). If no location is…"},"Expiration":{"type":"string","description":"The expiration time, in seconds. Valid values: 0: Never expires. Other values: The binding remains valid for the specified duration after…"},"Remark":{"type":"string","description":"The external business extension field. This parameter is returned in call record receipt messages. The value cannot exceed 100 characters"},"Extra":{"type":"string","description":"The extension parameters (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/bind-batch-axg":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_batch_axg","summary":"Adds AXG bindings in batches. The AXG model is a Phone Number Protection Solution for scenarios requiring…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AxgBindList"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the number pool. You can log on to the Phone Number Protection console and obtain the key on the Number Pool Management…"},"AxgBindList":{"type":"string","description":"The list of AXG bindings (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/bind-gxb700":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_gxb700","summary":"Adds a binding relationship for a 700GXB private number. The 700GXB product is a privacy protection…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","Expiration","TelB"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the China 700 number pool"},"Expiration":{"type":"string","description":"The expiration time of the number binding. Note The expiration time must be at least 1 minute later than the current binding time,…"},"TelB":{"type":"string","description":"Phone number of user B"},"DefaultA":{"type":"string","description":"Phone number A. The DefaultA number for the GXB private number. Note The callback mode can be configured at the number pool level. When…"},"GroupId":{"type":"string","description":"The ID of number group G. Number group G is created by using the \"Create G Number Group\" message"},"TelX":{"type":"string","description":"The intermediate number X. If the business user does not specify an X number, the platform assigns a number from the number pool as the X…"},"NeedRecord":{"type":"string","description":"Specifies whether the business user requires all call media files generated by this number binding relationship. Valid values: true:…"},"RecType":{"type":"string","description":"The recording type. Valid values: mp3 and wav"},"CallRestrict":{"type":"string","description":"The one-way call restriction logic. Valid values: CONTROL_BX_DISABLE: number B cannot call number X. CONTROL_GX_DISABLE: numbers in number…"},"Audio":{"type":"string","description":"The audio prompt code. GCallX_Gpre: the audio prompt code played to the caller before the call is connected when a number in group G calls…"},"OrderId":{"type":"string","description":"The business order code. This code has a one-to-one mapping with the actual business order and must be unique. The code supports…"},"IndustrialId":{"type":"string","description":"The Industrial Internet identifier code, which has a one-to-one mapping with OrderID. The code supports characters such as \".\" and \"/\" as…"},"OutId":{"type":"string","description":"An external business extension field. This parameter is returned in the call record receipt message"},"OutOrderId":{"type":"string","description":"The external business ID"},"NeedAsr":{"type":"string","description":"Specifies whether to enable the ASR service. Valid values: false: Disabled (default value). true: Enabled"},"AsrModelId":{"type":"string","description":"The ASR model ID. Valid values: General-Phone-Chinese Mandarin model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac General-Phone-Chinese Cantonese…"},"CallTimeout":{"type":"integer","description":"The sequential ringing duration. Unit: seconds. Valid values: 5 to 20"},"DtmfConfig":{"type":"string","description":"The DTMF key configuration, used when setting up AXB intermediate number binding. The following items can be configured:…"}}}}}},"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:aliyun-dyplsapi/bind-xb":{"post":{"operationId":"cloud_aliyun_dyplsapi_bind_xb","summary":"Establishes a binding relationship between a specified work number X and an employee number B on the work…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","TelB","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and is not required"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"TelB":{"type":"string","description":"The actual phone number of the employee"},"TelX":{"type":"string","description":"The work number X"},"UserData":{"type":"string","description":"The custom data to be returned in the callback"}}}}}},"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:aliyun-dyplsapi/buy-secret-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_buy_secret_no","summary":"Purchases a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","SpecId","City"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"SpecId":{"type":"integer","description":"The type of the phone number. Valid values: 1: a phone number assigned by a virtual network operator, that is, a phone number that belongs…"},"City":{"type":"string","description":"Specifies the home location of the phone number. The home location can be set only to a location in the Chinese mainland. A phone number…"},"SecretNo":{"type":"string","description":"The prefix of the phone number. If you specify the value of SecretNo when you purchase a phone number, a phone number starting with the…"},"DisplayPool":{"type":"string","description":"Specifies whether to add the phone number to the pool of numbers that will be displayed during calls. This parameter takes effect only for…"}}}}}},"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:aliyun-dyplsapi/cancel-pick-up-waybill":{"post":{"operationId":"cloud_aliyun_dyplsapi_cancel_pick_up_waybill","summary":"Cancels a door-to-door delivery order","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OuterOrderCode","CancelDesc"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"OuterOrderCode":{"type":"string","description":"The ID of the external order"},"CancelDesc":{"type":"string","description":"The cancellation reason"}}}}}},"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:aliyun-dyplsapi/config-x":{"post":{"operationId":"cloud_aliyun_dyplsapi_config_x","summary":"Configures an X number to independently manage communication features such as voice calls and enterprise…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length of reqId is 20 characters. The caller must ensure atomicity"},"CallerParentId":{"type":"integer","description":"The customer UID"},"CustomerPoolKey":{"type":"string","description":"The key of the number pool"},"TelX":{"type":"string","description":"The X number"},"GNFlag":{"type":"string","description":"Specifies whether to pass through the caller ID to display the actual caller. Valid values: 00: No pass-through. The work number is…"},"SmsSignMode":{"type":"string","description":"Specifies whether to pass through the SMS signature to display the actual user. Valid values: 0: No pass-through. 1: Pass-through. Default…"},"SmsAbility":{"type":"string","description":"Specifies whether to enable the SMS feature. Valid values: 0: Disable. 1: Enable"},"CallAbility":{"type":"string","description":"Specifies whether to enable the call capability. Valid values: 0: Disable. 1: Enable"},"SequenceMode":{"type":"string","description":"The sequential ringing mode. Valid values: 0: No sequential ringing. This is the default value. 1: Conditional sequential ringing. The…"},"SequenceCalls":{"type":"string","description":"The sequential ringing control parameters (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/create-axg-group":{"post":{"operationId":"cloud_aliyun_dyplsapi_create_axg_group","summary":"Creates number group G","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"Name":{"type":"string","description":"The name of number group G. If the name of number group G is not specified, the ID of number group G is used as the name of number group…"},"Remark":{"type":"string","description":"The remarks of number group G. The value must be 0 to 256 characters in length"},"Numbers":{"type":"string","description":"The phone numbers that you add to number group G. Separate multiple phone numbers with commas (,). A maximum of 200 phone numbers can be…"}}}}}},"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:aliyun-dyplsapi/create-fixed-no-areport":{"post":{"operationId":"cloud_aliyun_dyplsapi_create_fixed_no_areport","summary":"Submit Individual Information of a landline number A through an API","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FixedNoA","ANoWhiteGroupId","DocumentType","CustName","DocumentNumber","CustType","IdCardAlivePhoto"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"FixedNoA":{"type":"string","description":"Number A (fixed-line number)"},"ANoWhiteGroupId":{"type":"integer","description":"ID of the group to which Number A belongs. On the Qualification Management (https://dyplsnext.console.aliyun.com/qualification) Page, go…"},"DocumentType":{"type":"integer","description":"Certificate type. Enter 1 for ID card"},"CustName":{"type":"string","description":"Name"},"DocumentNumber":{"type":"string","description":"Certificate number"},"CustType":{"type":"integer","description":"Fixed-line customer type. Valid values: 1: Legal representative. 2: Agent"},"FixedLineWorkId":{"type":"string","description":"Ticket number from the offline service hall when applying for a fixed-line number"},"IdCardFrontPhoto":{"type":"string","description":"OSS path of the photo of the front (national emblem side) of the ID card"},"IdCardBackPhoto":{"type":"string","description":"OSS path of the photo of the back (portrait side) of the ID card"},"IdCardAlivePhoto":{"type":"string","description":"OSS path of the front-facing portrait photo"},"Remark":{"type":"string","description":"Remarks (user-defined business notes)"},"CustPhoneNo":{"type":"string","description":"Phone number of the legal representative or agent. If this qualification includes a Mobile X number, this field is Required; otherwise,…"}}}}}},"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:aliyun-dyplsapi/create-phone-no-areport":{"post":{"operationId":"cloud_aliyun_dyplsapi_create_phone_no_areport","summary":"Submit Individual Information of an A-number mobile phone number through an API","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","ANoWhiteGroupId","DocumentType","CustName","DocumentNumber","IdCardAlivePhoto"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PhoneNoA":{"type":"string","description":"Phone number."},"ANoWhiteGroupId":{"type":"integer","description":"ID of the A-number group. On the Qualification Management (https://dyplsnext.console.aliyun.com/qualification) page, click View Details in…"},"DocumentType":{"type":"integer","description":"Certificate type. Enter 1 for an ID card."},"CustName":{"type":"string","description":"Name."},"DocumentNumber":{"type":"string","description":"Certificate number."},"IdCardFrontPhoto":{"type":"string","description":"OSS path of the photo of the front side (national emblem side) of the ID card."},"IdCardBackPhoto":{"type":"string","description":"OSS path of the photo of the back side (portrait side) of the ID card."},"IdCardAlivePhoto":{"type":"string","description":"OSS path of the front-facing portrait photo"},"Remark":{"type":"string","description":"Remark (business remark added by the user)."}}}}}},"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:aliyun-dyplsapi/create-pick-up-waybill":{"post":{"operationId":"cloud_aliyun_dyplsapi_create_pick_up_waybill","summary":"Creates a door-to-door pickup order","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OuterOrderCode","OrderChannels","SendName","SendAddress","ConsigneeName","ConsigneeAddress"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"OuterOrderCode":{"type":"string","description":"The external order ID"},"OrderChannels":{"type":"string","description":"The external channel source"},"CpCode":{"type":"string","description":"The courier company code"},"SendName":{"type":"string","description":"The sender name"},"SendMobile":{"type":"string","description":"The sender mobile number. You must specify either SendMobile or SendPhone"},"SendPhone":{"type":"string","description":"The sender phone number. You must specify either SendMobile or SendPhone"},"SendAddress":{"type":"string","description":"The sender address (JSON-encoded)"},"ConsigneeName":{"type":"string","description":"The consignee name"},"ConsigneeMobile":{"type":"string","description":"The consignee mobile number. You must specify either ConsigneeMobile or ConsigneePhone"},"ConsigneePhone":{"type":"string","description":"The consignee phone number. You must specify either ConsigneeMobile or ConsigneePhone"},"ConsigneeAddress":{"type":"string","description":"The consignee address (JSON-encoded)"},"Remark":{"type":"string","description":"The remarks. The remark content printed on the shipping label"},"GoodsInfos":{"type":"string","description":"The list of goods (JSON-encoded)"},"AppointGotStartTime":{"type":"string","description":"The scheduled pickup start time in the format of YYYY-MM-DD HH:mm:ss. Obtain the value of AppointGotStartTime from the StartTime field in…"},"AppointGotEndTime":{"type":"string","description":"The scheduled pickup end time in the format of YYYY-MM-DD HH:mm:ss. Obtain the value of AppointGotEndTime from the EndTime field in…"},"BizType":{"type":"integer","description":"The pickup mode. Valid values: 0: real-time order (default). 1: scheduled order"}}}}}},"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:aliyun-dyplsapi/create-pick-up-waybill-pre-query":{"post":{"operationId":"cloud_aliyun_dyplsapi_create_pick_up_waybill_pre_query","summary":"Pre-queries shipping order information before placing an order","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SenderInfo","ConsigneeInfo","OrderChannels"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"SenderInfo":{"type":"string","description":"The sender information (JSON-encoded)"},"ConsigneeInfo":{"type":"string","description":"The recipient information (JSON-encoded)"},"CpCode":{"type":"string","description":"The courier company code. If not specified, the system automatically assigns a courier company"},"PreWeight":{"type":"string","description":"The estimated weight, in grams. If you want to query the estimated price, this parameter is required"},"OuterOrderCode":{"type":"string","description":"The order number in the caller's system"},"OrderChannels":{"type":"string","description":"The external channel source identifier. The value cannot contain underscores. The value is agreed upon with the system during integration"}}}}}},"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:aliyun-dyplsapi/create-sms-sign":{"post":{"operationId":"cloud_aliyun_dyplsapi_create_sms_sign","summary":"Generates a text message delivery tag for scenarios where an employee sends a text message to a customer by…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","CalledNo","CallingNo"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"CalledNo":{"type":"string","description":"The recipient number"},"CallingNo":{"type":"string","description":"The sender number"}}}}}},"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:aliyun-dyplsapi/delete-axb-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_delete_axb_bind_fixed_line","summary":"Unbind a fixed-line AXB privacy number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","SubId","OrderId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"Number pool ID"},"Ts":{"type":"string","description":"Business timestamp. Format: yyyyMMddHHmmssSSS. The time uses Beijing time in 24-hour clock format, accurate to milliseconds"},"SubId":{"type":"string","description":"Binding ID"},"OrderId":{"type":"string","description":"Unique identifier of the message request"}}}}}},"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:aliyun-dyplsapi/delete-axg-group":{"post":{"operationId":"cloud_aliyun_dyplsapi_delete_axg_group","summary":"Deletes a G group. G groups are supported only in Number Pools designated for the AXG privacy number type","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","GroupId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the number pool. You can obtain the key of the number pool on the Number Pool Management…"},"GroupId":{"type":"integer","description":"The G group ID (GID). Log on to the Phone Number Privacy Protection console. On the Number Pool Management…"}}}}}},"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:aliyun-dyplsapi/delete-axn-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_delete_axn_bind_fixed_line","summary":"Unbinds a fixed-line AXN private number binding relationship","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","OrderId","SubId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The number pool ID"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"OrderId":{"type":"string","description":"The unique identifier of the message request"},"SubId":{"type":"string","description":"The binding ID"}}}}}},"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:aliyun-dyplsapi/delete-axn-extension-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_delete_axn_extension_bind_fixed_line","summary":"Unbind a fixed-line AXN extension number binding","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","OrderId","SubId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The business ID identifier assigned by Alibaba Cloud to the customer"},"Ts":{"type":"string","description":"Format: yyyyMMddHHmmssSSS. The time uses Beijing time in 24-hour format, accurate to milliseconds"},"OrderId":{"type":"string","description":"The unique identifier of the message request"},"SubId":{"type":"string","description":"The binding ID"}}}}}},"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:aliyun-dyplsapi/delete-secret-aphone-no-to-cust":{"post":{"operationId":"cloud_aliyun_dyplsapi_delete_secret_aphone_no_to_cust","summary":"Delete A-number filing data","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","ANoWhiteGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PhoneNoA":{"type":"string","description":"A-number"},"ANoWhiteGroupId":{"type":"integer","description":"A-number group ID"}}}}}},"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:aliyun-dyplsapi/delete-secret-blacklist":{"post":{"operationId":"cloud_aliyun_dyplsapi_delete_secret_blacklist","summary":"Deletes the blacklist of a number pool. Only number pools of the AXN privacy number, AXN extension number,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","BlackNo","BlackType"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the number pool. You can obtain the number pool key on the Number Pool Management…"},"BlackNo":{"type":"string","description":"The blacklisted number. The value type is determined by the BlackType parameter: Point-to-point blacklist: a pair of numbers separated by…"},"Remark":{"type":"string","description":"The remark for the blacklist"},"BlackType":{"type":"string","description":"The type of the blacklist. Valid values: POINT_TO_POINT_BLACK: point-to-point blacklist PARTNER_GLOBAL_NUMBER_BLACK: number pool blacklist"},"WayControl":{"type":"string","enum":["DUPLEX_REJECT","PHONEA_REJECT","PHONEB_REJECT"],"description":"The call direction control. Valid values: PHONEA_REJECT: The first number in BlackNo can call the second number, but the second number…"}}}}}},"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:aliyun-dyplsapi/get-dypls-ossinfo-for-upload-file":{"post":{"operationId":"cloud_aliyun_dyplsapi_get_dypls_ossinfo_for_upload_file","summary":"Obtain OSS resource configuration information. This configuration information will be used for subsequent…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BizType"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"BizType":{"type":"string","description":"The business type. Default Value: phone_card"}}}}}},"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:aliyun-dyplsapi/get-secret-asr-detail":{"post":{"operationId":"cloud_aliyun_dyplsapi_get_secret_asr_detail","summary":"Obtains the details of the automatic speech recognition (ASR) result","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallId","CallTime","PoolKey"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"CallId":{"type":"string","description":"The ID of the call record. You can log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"CallTime":{"type":"string","description":"The call initiation time in the call record. You can log on to the Phone Number Protection console…"},"PoolKey":{"type":"string","description":"The key of the phone number pool. You can log on to the Phone Number Protection console…"}}}}}},"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:aliyun-dyplsapi/get-total-public-url":{"post":{"operationId":"cloud_aliyun_dyplsapi_get_total_public_url","summary":"Obtains the download URL of a recorded ringing tone","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CheckSubs","PartnerKey","CallId","CallTime"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"CheckSubs":{"type":"string","description":"Specifies whether the verification on the binding ID is required"},"PartnerKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"CallId":{"type":"string","description":"The ID of the call record. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and view…"},"CallTime":{"type":"string","description":"The call initiation time in the call record. Log on to the Phone Number Protection console…"}}}}}},"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:aliyun-dyplsapi/get-xconfig":{"post":{"operationId":"cloud_aliyun_dyplsapi_get_xconfig","summary":"Retrieves the configuration information of the X number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The key of the number pool"},"TelX":{"type":"string","description":"The X number"}}}}}},"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:aliyun-dyplsapi/get-xdefault-config":{"post":{"operationId":"cloud_aliyun_dyplsapi_get_xdefault_config","summary":"Retrieves the default configurations of an X number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"TelX":{"type":"string","description":"The X number"}}}}}},"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:aliyun-dyplsapi/list-xtelephones":{"post":{"operationId":"cloud_aliyun_dyplsapi_list_xtelephones","summary":"Queries the list of X numbers under a customer account","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"PageNo":{"type":"integer","description":"The page number for the paged query. Paging starts from 1"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"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:aliyun-dyplsapi/lock-secret-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_lock_secret_no","summary":"Locks a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","SecretNo"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"SecretNo":{"type":"string","description":"The private number that you want to lock. You must enter a complete mobile phone number"}}}}}},"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:aliyun-dyplsapi/operate-axg-group":{"post":{"operationId":"cloud_aliyun_dyplsapi_operate_axg_group","summary":"Modifies number group G","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","GroupId","OperateType","Numbers"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"GroupId":{"type":"integer","description":"The group ID in the AXG binding. You can view the group ID by using either of the following methods: On the Number Pool Management page in…"},"OperateType":{"type":"string","description":"The type of the operation on number group G. Valid values: addNumbers: adds phone numbers to number group G. deleteNumbers: deletes phone…"},"Numbers":{"type":"string","description":"The phone numbers that you add to number group G. Separate the phone numbers with commas (,). You can add up to 200 phone numbers at a time"}}}}}},"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:aliyun-dyplsapi/operate-black-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_operate_black_no","summary":"Adds a phone number to a blacklist or deletes a phone number from a blacklist","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","BlackNo","OperateType"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"BlackNo":{"type":"string","description":"The phone number to be added to or deleted from the blacklist"},"OperateType":{"type":"string","description":"The type of the operation on the phone number. Valid values: AddBlack: adds the phone number to the blacklist. DeleteBlack: deletes the…"},"Tips":{"type":"string","description":"The description"}}}}}},"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:aliyun-dyplsapi/query-axb-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_axb_bind_fixed_line","summary":"Queries the binding information of an AXB landline privacy number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","QueryType","OrderId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The number pool ID"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"QueryType":{"type":"string","description":"The query type. Valid values: 0: Query by binding ID. 1: Query by X and A/B numbers"},"SubId":{"type":"string","description":"The binding ID. Required when QueryType is set to 0"},"Phone":{"type":"string","description":"The A/B number. Required when QueryType is set to 1"},"TelX":{"type":"string","description":"The X number. Required when QueryType is set to 1"},"OrderId":{"type":"string","description":"The unique identifier of the message request"}}}}}},"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:aliyun-dyplsapi/query-axn-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_axn_bind_fixed_line","summary":"Queries the binding information of an AXN landline privacy number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","QueryType","OrderId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The number pool ID"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"QueryType":{"type":"string","description":"The query type. Valid values: 0: query by binding ID. 1: query by X and A/B phone number"},"SubId":{"type":"string","description":"The binding ID. This parameter is required when QueryType is set to 1"},"Phone":{"type":"string","description":"The A/B phone number. This parameter is required when QueryType is set to 1"},"TelX":{"type":"string","description":"The X phone number. This parameter is required when QueryType is set to 1"},"OrderId":{"type":"string","description":"The unique identifier of the message request"}}}}}},"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:aliyun-dyplsapi/query-axn-extension-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_axn_extension_bind_fixed_line","summary":"Queries the binding information of a landline AXN extension number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","QueryType","OrderId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The ID of the number pool"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"QueryType":{"type":"string","description":"The query type. Valid values: 0: query by binding ID. 1: query by X and A/B numbers"},"SubId":{"type":"string","description":"The binding ID. This parameter is required when QueryType is set to 0"},"TelA":{"type":"string","description":"The number A. This parameter is required when QueryType is set to 1"},"OrderId":{"type":"string","description":"The unique identifier of the message request"}}}}}},"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:aliyun-dyplsapi/query-phone-no-aby-track-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_phone_no_aby_track_no","summary":"Queries the details about a tracking number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["trackNo"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"trackNo":{"type":"string","description":"The tracking number"},"CabinetNo":{"type":"string","description":"The cabinet number"},"PhoneNoX":{"type":"string","description":"Phone number X returned by the API operation for creating a binding"}}}}}},"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:aliyun-dyplsapi/query-record-file-download-url":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_record_file_download_url","summary":"Obtains the download URL of a recording file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CallId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"ProductType":{"type":"string","description":"The product type. Valid values: AXB_170. AXN_170. AXN_95. AXN_EXTENSION_REUSE This parameter is applicable to the original key accounts of…"},"CallId":{"type":"string","description":"The ID of the call record. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and view…"},"CallTime":{"type":"string","description":"The call initiation time in the call record. Log on to the Phone Number Protection console…"}}}}}},"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:aliyun-dyplsapi/query-secret-aphone-no-to-cust":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_secret_aphone_no_to_cust","summary":"Query the reporting status of an A number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoA","ANoWhiteGroupId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PhoneNoA":{"type":"string","description":"A number"},"ANoWhiteGroupId":{"type":"integer","description":"Number group ID"}}}}}},"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:aliyun-dyplsapi/query-secret-no-detail":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_secret_no_detail","summary":"Queries the property information of a private number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SecretNo","PoolKey"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"SecretNo":{"type":"string","description":"The privacy number, which is the X number. Log on to the Phone Number Protection console and obtain the X number on the Number Management…"},"PoolKey":{"type":"string","description":"The key of the number pool. Log on to the Phone Number Protection console and obtain the Number Pool Key on the Number Pool Management…"}}}}}},"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:aliyun-dyplsapi/query-secret-no-remain":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_secret_no_remain","summary":"Queries the quantity of remaining phone numbers available for online purchase","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SpecId","City"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"SpecId":{"type":"integer","description":"The type of the phone number. Valid values: 1: a phone number assigned by a virtual network operator, that is, a phone number that belongs…"},"City":{"type":"string","description":"The home location of the phone number. If SpecId is set to 1 or 2, you can specify the City parameter to query the quantity of available…"},"SecretNo":{"type":"string","description":"The prefix of the phone number. When you call the QuerySecretNoRemain operation with SecretNo specified, the quantity of remaining phone…"}}}}}},"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:aliyun-dyplsapi/query-sound-record":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_sound_record","summary":"Queries the downloadable URL of a call recording by call ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","CallId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically retrieved by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"CallId":{"type":"string","description":"The call ID, which uniquely identifies a call"}}}}}},"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:aliyun-dyplsapi/query-subs-id":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_subs_id","summary":"Queries binding IDs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PhoneNoX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dyplsnext.console.aliyun.com/overview) and view…"},"PhoneNoX":{"type":"string","description":"The private number in the binding, that is, phone number X"}}}}}},"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:aliyun-dyplsapi/query-subscription-detail":{"post":{"operationId":"cloud_aliyun_dyplsapi_query_subscription_detail","summary":"Queries the binding details of a phone number. Retrieves information such as the binding relationship…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SubsId","PhoneNoX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the number pool. Log on to the privacy protection console and go to the Number Pool Management…"},"ProductType":{"type":"string","description":"The product type. Valid values: AXB_170 AXN_170 AXN_95 AXN_EXTENSION_REUSE This parameter is applicable to former Alibaba Dayu users.…"},"SubsId":{"type":"string","description":"The binding relationship ID. Logon to the privacy protection console, go to the Number Management…"},"PhoneNoX":{"type":"string","description":"The privacy number in the binding relationship, which is the X number. Logon to the privacy protection console and go to the Number…"}}}}}},"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:aliyun-dyplsapi/release-secret-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_release_secret_no","summary":"Releases a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","SecretNo"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"SecretNo":{"type":"string","description":"The prefix of phone numbers. When you call the ReleaseSecretNo operation with SecretNo specified, the system performs fuzzy matching…"}}}}}},"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:aliyun-dyplsapi/un-bind-axb":{"post":{"operationId":"cloud_aliyun_dyplsapi_un_bind_axb","summary":"Dissociates a specified call binding relationship (A, X, and B). After the call binding relationship is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","BindId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"BindId":{"type":"string","description":"The unique ID of the AXB binding relationship"}}}}}},"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:aliyun-dyplsapi/un-bind-xb":{"post":{"operationId":"cloud_aliyun_dyplsapi_un_bind_xb","summary":"Cancels the binding between work number X and employee number B. After the binding is canceled, calls to X…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ReqId","CustomerPoolKey","AuthId","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"ReqId":{"type":"string","description":"The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID"},"CallerParentId":{"type":"integer","description":"The customer UID. This parameter is automatically obtained by the system and does not need to be specified"},"CustomerPoolKey":{"type":"string","description":"The number pool key"},"AuthId":{"type":"string","description":"The unique ID of the XB binding relationship"},"TelX":{"type":"string","description":"The number X"}}}}}},"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:aliyun-dyplsapi/unbind-subs700":{"post":{"operationId":"cloud_aliyun_dyplsapi_unbind_subs700","summary":"Unbinds a 700 number from its binding relationship","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","SubsId","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the China 700 number pool. You can obtain the number pool key from the China 700 Number Pool Management…"},"SubsId":{"type":"integer","description":"The binding ID"},"TelX":{"type":"string","description":"The intermediate number X. If the service user does not specify an X number, the application platform assigns a number from the number…"},"OrderId":{"type":"string","description":"The order ID. This parameter is required in practice. Encrypt the order ID before submission because it is reported to the regulatory…"},"IndustrialId":{"type":"string","description":"Optional. The Industrial Internet identifier code, which has a one-to-one relationship with OrderId. The code supports delimiter…"}}}}}},"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:aliyun-dyplsapi/unbind-subscription":{"post":{"operationId":"cloud_aliyun_dyplsapi_unbind_subscription","summary":"Unbinds a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SubsId","SecretNo"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"ProductType":{"type":"string","description":"The product type. Fixed value: AXB_170. This parameter is applicable to the original key accounts of Alibaba Cloud. This parameter can be…"},"SubsId":{"type":"string","description":"The binding ID. Log on to the Phone Number Protection console, choose Number and Number Pool > Number Management. On the Number Management…"},"SecretNo":{"type":"string","description":"The private number, that is, phone number X specified in an API operation for a phone number binding such as…"}}}}}},"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:aliyun-dyplsapi/unlock-secret-no":{"post":{"operationId":"cloud_aliyun_dyplsapi_unlock_secret_no","summary":"Unlocks a phone number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","SecretNo"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"SecretNo":{"type":"string","description":"The private number that you want to unlock. You must enter a complete mobile phone number"}}}}}},"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:aliyun-dyplsapi/update-axb-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_update_axb_bind_fixed_line","summary":"Modifies the binding information of a landline AXB privacy number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","SubId","OrderId","Subts"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The number pool ID"},"Ts":{"type":"string","description":"The business timestamp in the format of yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"SubId":{"type":"string","description":"The binding ID"},"OrderId":{"type":"string","description":"The unique identifier of the message request"},"TelA":{"type":"string","description":"Sets number A in the binding relationship. Number A can be set to a mobile phone number or a landline number. Landline numbers must…"},"TelB":{"type":"string","description":"Sets number B in the binding relationship. Number B can be set to a mobile phone number or a landline number. Landline numbers must…"},"Subts":{"type":"string","description":"The binding time in the format of yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format"},"Anucode":{"type":"string","description":"The ringback tone code for the caller side. This parameter must be set for the landline AXB privacy number service. The tone code must…"},"Anucodecalled":{"type":"string","description":"The ringback tone code for the called side after the call is connected. The called-side tone code must contain codes for two scenarios.…"},"TAnucodeConnect":{"type":"string","description":"The ringback tone code for the caller side after the call is connected. The tone code must contain codes for two scenarios. Enter the…"},"Expiration":{"type":"string","description":"The expiration time, in seconds. Valid values: 0: never expires. Other values: when other values are specified, such as 60s, the binding…"},"Remark":{"type":"string","description":"An external business extension field. This parameter is returned in the call record receipt message. The value cannot exceed 100…"},"Extra":{"type":"string","description":"The extension parameters (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/update-axn-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_update_axn_bind_fixed_line","summary":"Modifies the binding information of a landline AXN private number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","OrderId","Subts","SubId"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The number pool ID"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"OrderId":{"type":"string","description":"The unique identifier of the message request"},"Subts":{"type":"string","description":"The binding time. Format: yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format"},"SubId":{"type":"string","description":"The binding ID"},"TelA":{"type":"string","description":"The A number of the landline AXN private number. The A number can be a mobile phone number or a landline number. A landline number must…"},"TelB":{"type":"string","description":"The N number of the landline AXN private number"},"Anucode":{"type":"string","description":"The caller-side ringback tone codes. This parameter is required for AXB services. The codes must include three scenarios. Enter the codes…"},"Anucodecalled":{"type":"string","description":"The callee-side ringback tone codes played after the call is connected. The codes must include two scenarios. Enter the codes in the order…"},"TAnucodeConnect":{"type":"string","description":"The caller-side ringback tone codes played after the call is connected. The codes must include two scenarios. Enter the codes in the order…"},"Expiration":{"type":"string","description":"The expiration time. Unit: seconds. Valid values: 0: never expires. Other values: specifies the validity period. For example, if you set…"},"Remark":{"type":"string","description":"An external business extension field. This parameter is returned in the call record receipt message. The value cannot exceed 100…"},"Extra":{"type":"string","description":"The extension parameters (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/update-axn-extension-bind-fixed-line":{"post":{"operationId":"cloud_aliyun_dyplsapi_update_axn_extension_bind_fixed_line","summary":"Modifies the binding relationship of a landline AXN extension number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AppId","Ts","OrderId","Subts","SubId","TelA"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"AppId":{"type":"string","description":"The number pool ID"},"Ts":{"type":"string","description":"The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds"},"OrderId":{"type":"string","description":"The unique identifier of the message request"},"Subts":{"type":"string","description":"The binding time. Format: yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format"},"SubId":{"type":"string","description":"The binding ID"},"TelA":{"type":"string","description":"Phone number A of the landline AXN extension. Phone number A can be a mobile phone number or a landline number. For landline numbers,…"},"Anucode":{"type":"string","description":"The caller-side ringback tone code. This parameter is required for AXB services. The code must contain codes for 3 scenarios. Enter the…"},"Anucodecalled":{"type":"string","description":"The callee-side ringback tone code played after the call is connected. The code must contain codes for 2 scenarios. Enter the codes in the…"},"TAnucodeConnect":{"type":"string","description":"The caller-side ringback tone code played after the call is connected. The code must contain codes for 2 scenarios. Enter the codes in the…"},"Expiration":{"type":"string","description":"The expiration time. Unit: seconds. Valid values: 0: never expires. Other values: when you specify another value such as 60, the binding…"},"Remark":{"type":"string","description":"The external business extension field. This parameter is returned in the call record receipt message. The value cannot exceed 100…"},"Extraaxx":{"type":"string","description":"The extension parameter (JSON-encoded)"}}}}}},"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:aliyun-dyplsapi/update-subs700":{"post":{"operationId":"cloud_aliyun_dyplsapi_update_subs700","summary":"Modifies the binding relationship of a 700 number","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PoolKey","OperateType","SubsId","TelX"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the number pool"},"OperateType":{"type":"string","description":"updateNoA: Updates number A. updateNoB: Updates number B. updateExpire: Updates the validity period of the binding relationship.…"},"SubsId":{"type":"integer","description":"The binding relationship ID, which uniquely identifies a number binding relationship"},"TelX":{"type":"string","description":"The intermediate number X. If the business user does not specify an X number, the platform assigns one from the number pool as the X number"},"OrderId":{"type":"string","description":"The order ID. This parameter is required in practice. Encrypt the order ID before submission because it is reported to the regulatory…"},"IndustrialId":{"type":"string","description":"Optional. The Industrial Internet identifier code, which has a one-to-one correspondence with OrderID. The code supports delimiter…"},"TelA":{"type":"string","description":"The number A to update in the binding relationship"},"DefaultA":{"type":"string","description":"Number A. The DefaultA number for GXB private numbers. Note The callback mode can be configured at the number pool level. When the…"},"TelB":{"type":"string","description":"The number B to update in the binding relationship"},"GroupId":{"type":"string","description":"The GroupID to update in the binding relationship"},"Expiration":{"type":"string","description":"The validity period to update for the binding relationship"},"CallRestrict":{"type":"string","description":"The single-call restriction logic to update"},"NeedRecord":{"type":"string","description":"The media selection to update in the binding relationship"},"Audio":{"type":"string","description":"Optional. The audio prompt code. AXB mode ACallX_Apre: The audio prompt code played to A before the call is connected when A calls number…"},"OutId":{"type":"string","description":"An external business extension field. This parameter is returned in the call record receipt message"},"NeedAsr":{"type":"string","description":"Specifies whether to enable the ASR service. Valid values: false: Disabled. This is the default value. true: Enabled"},"AsrModelId":{"type":"string","description":"The ASR model ID. Valid values: General phone Chinese Mandarin model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac General phone Chinese Cantonese…"}}}}}},"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:aliyun-dyplsapi/update-subscription":{"post":{"operationId":"cloud_aliyun_dyplsapi_update_subscription","summary":"Modifies a phone number binding","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SubsId","PhoneNoX","OperateType"],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"},"PoolKey":{"type":"string","description":"The key of the phone number pool. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account) and…"},"ProductType":{"type":"string","description":"The product type. Valid values: AXB_170 AXN_170 AXN_95 AXN_EXTENSION_REUSE This parameter is applicable to the original key accounts of…"},"SubsId":{"type":"string","description":"The binding ID. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account), choose Number and…"},"PhoneNoX":{"type":"string","description":"Phone number X in the phone number binding"},"PhoneNoA":{"type":"string","description":"Phone number A in the phone number binding. This parameter is required when OperateType is set to updateNoA"},"PhoneNoB":{"type":"string","description":"Phone number B in the phone number binding. This parameter is required when OperateType is set to updateNoB"},"GroupId":{"type":"string","description":"The ID of number group G in the phone number binding. This parameter is required when OperateType is set to updateAxgGroup"},"CallRestrict":{"type":"string","description":"One-way call restrictions. Valid values: CONTROL_AX_DISABLE: Phone number A cannot be used to call phone number X. CONTROL_BX_DISABLE:…"},"Expiration":{"type":"string","description":"Re-sets the expiration time of the phone number binding. This parameter is required when OperateType is set to updateExpire. The…"},"CallDisplayType":{"type":"integer","description":"Re-sets the phone number display logic in the phone number binding. Fixed value: 1, indicating that phone number X is displayed on both…"},"OutId":{"type":"string","description":"Re-sets the value of the OutId parameter in the phone number binding"},"IsRecordingEnabled":{"type":"string","description":"Re-sets the recording status in the phone number binding. This parameter does not have a default value. If you do not specify this…"},"OperateType":{"type":"string","description":"The operation to modify the phone number binding. Valid values: updateNoA: modifies phone number A. updateNoB: modifies phone number B.…"},"RingConfig":{"type":"string","description":"Updates the ringtone code for enterprise Color Ring Back Tone (CRBT) in the phone number binding. AXB product: Ringtone setting when phone…"},"ASRStatus":{"type":"string","description":"Specifies whether to enable automatic speech recognition (ASR). Valid values: false (default): disables ASR. true: enables ASR"},"ASRModelId":{"type":"string","description":"The ID of the ASR model"}}}}}},"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:aliyun-dyplsapi/version":{"post":{"operationId":"cloud_aliyun_dyplsapi_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://dyplsapi.aliyuncs.com"],"default":"https://dyplsapi.aliyuncs.com","description":"Regional endpoint, for example https://dyplsapi.aliyuncs.com"}}}}}},"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":"dev-tools:hash"},"data":{},"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"}}}}}}}