# Alibaba Cloud Phone Number Protection API

> Alibaba Cloud Phone Number Protection API on Apizie: 61 endpoints (Adds a tracking number for a private number in the AXN binding, Adds a phone number to the blacklist of a China number pool. Only AXN privacy number, AXN extension number,…, Establishes a call binding relationship (B, X, A) for work number X of employee B on the work number…, Adds an AXB binding, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-dyplsapi`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/dyplsapi
- Page: https://zieapi.vercel.app/api/cloud/aliyun-dyplsapi
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-dyplsapi/openapi.json

Alibaba Cloud OpenAPI for Phone Number Protection (dyplsapi, version 2017-05-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a tracking number for a private number in the AXN binding
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/add-axn-track-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | string | yes | 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 | string | yes | The tracking number |
| SubsId | string | yes | The binding ID. You can call the https://help.aliyun.com/document_detail/110258.html operation to obtain the value of SubsId |

### Adds a phone number to the blacklist of a China number pool. Only AXN privacy number, AXN extension number,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/add-secret-blacklist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the number pool. You can obtain the number pool key on the Number Pool Management… |
| BlackNo | string | yes | The blacklisted phone number. The value type depends on the BlackType parameter: Point-to-point blacklist: A pair of numbers (A and B… |
| Remark | string | no | The remarks for the blacklist entry |
| BlackType | string | yes | The blacklist type. Valid values: POINT_TO_POINT_BLACK: point-to-point blacklist. PARTNER_GLOBAL_NUMBER_BLACK: number pool blacklist |
| WayControl | string | no | The call direction control. Valid values: PHONEA_REJECT: The first number in BlackNo can call the second number, but the second number… |

### Establishes a call binding relationship (B, X, A) for work number X of employee B on the work number…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axbcall` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The key of the number pool |
| TelA | string | yes | The phone number of customer A |
| AuthId | string | yes | The unique ID of the BX binding relationship |
| Expiration | integer | yes | The expiration time of the binding relationship. The value must be greater than 0. Unit: seconds. The automatic unbinding time is… |
| UserData | string | no | The custom callback parameter |

### Adds an AXB binding
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | 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 | string | yes | 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 | string | no | 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 | string | no | Phone number X in the AXB binding. Phone number X is the phone number that you purchased in the Phone Number Protection console… |
| Expiration | string | yes | 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 | string | no | 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 | string | no | Specifies whether to record all calls made by the bound phone numbers. Valid values: true false (default) |
| OutId | string | no | The extension field for the external business. This parameter is returned in a call record receipt |
| OutOrderId | string | no | The ID of the external business |
| CallRestrict | string | no | 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 | integer | no | 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 | string | no | 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 | string | no | Specifies whether to enable automatic speech recognition (ASR). Valid values: false (default): disables ASR. true: enables ASR |
| ASRModelId | string | no | The ID of the ASR model. On the Automatic Speech Recognition (ASR) Model Management… |
| CallTimeout | integer | no | The maximum ringing duration for each number in sequential ringing. Unit: seconds. The value ranges from 5 to 20 |
| DtmfConfig | string | no | Specifies the dual tone multiple frequency (DTMF) key configuration in the AXB binding. The following content can be configured:… |

### Binds phone numbers for a 700AXB private number. A 700AXB private number restricts the calling relationship…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axb700` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the China 700 number pool |
| Expiration | string | yes | 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 | string | yes | The phone number of user A |
| TelB | string | yes | The phone number of user B |
| TelX | string | no | 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 | string | no | Specifies whether call recording files are required for all calls made through this number binding. Valid values: true: Enable recording.… |
| RecType | string | no | The recording file format. Valid values: mp3 and wav |
| CallRestrict | string | no | The one-way call restriction logic. Valid values: CONTROL_AX_DISABLE: Number A cannot call number X. CONTROL_BX_DISABLE: Number B cannot… |
| Audio | string | no | 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 | string | no | 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 | string | no | The industrial Internet identifier code, which has a one-to-one mapping with OrderId. The code supports characters such as "." and "/" as… |
| OutId | string | no | The external business extension field. This parameter is returned in the call record receipt message |
| OutOrderId | string | no | The external business ID |
| NeedAsr | string | no | Specifies whether to enable the ASR service. Valid values: false: Disable (default). true: Enable |
| AsrModelId | string | no | Optional. The ASR model ID. Valid values: General-Phone-Mandarin model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac General-Phone-Cantonese model… |
| CallTimeout | integer | no | The sequential ringing duration. Unit: seconds. Valid values: 5 to 20 |
| DtmfConfig | string | no | Optional. The DTMF key configuration for 700AXB number binding. The following items can be configured: endCallIvrPhoneNo: The audio… |

### The fixed-line AXB privacy number binding restricts the calling relationship to a one-to-one relationship.…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axb-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | Number pool ID |
| Ts | string | yes | Business timestamp, in the format yyyyMMddHHmmssSSS. The time uses Beijing time, 24-hour clock, accurate to milliseconds |
| BindType | string | yes | Binding type. Valid values: mode101: Customer specifies the X number. mode102: Platform allocates the X number |
| OrderId | string | yes | Unique identifier for the message request |
| TelA | string | yes | 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 | string | no | The X number in the fixed-line AXB privacy number. The X number is a privacy number you have purchased in the console… |
| TelB | string | yes | 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 | string | yes | Binding time, in the format yyyyMMddHHmmss. The time uses Beijing time, 24-hour clock |
| Anucode | string | yes | 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 | string | no | 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 | string | no | 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 | string | no | Area code. Supports specifying the X number's region (specified city -> provincial capital -> nationwide routing). If no region is… |
| Expiration | string | yes | Expiration time, unit: seconds. Valid values: 0: Never expires. Other values: When other values are specified, for example 60s, the… |
| Remark | string | no | External business extension field. This parameter will be returned in the call record receipt message. Must not exceed 100 characters in… |
| Extra | string | no | Extension parameters (JSON-encoded) |

### Adds an AXG binding
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axg` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | 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 | string | yes | 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 | string | yes | 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 | string | no | 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 | string | no | 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 | string | yes | 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 | string | no | 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 | string | no | Specifies whether to record all calls made by the bound phone numbers |
| OutId | string | no | The extension field for the external business. This parameter is returned in a call record receipt |
| OutOrderId | string | no | The ID of the external business |
| CallDisplayType | integer | no | 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 | string | no | Sets the ringtone for enterprise Color Ring Back Tone (CRBT) in the AXG binding. Ringtone setting (with a callback number) when phone… |
| ASRStatus | string | no | Specifies whether to enable automatic speech recognition (ASR). Valid values: False (default): disables ASR. True: enables ASR |
| ASRModelId | string | no | The ID of the ASR model |
| CallRestrict | string | no | The status of call restrictions. Valid values: CONTROL_AX_DISABLE: Phone number A cannot be used to call phone number X.… |

### Creates a binding for an AXN Privacy Number. This process assigns a dedicated Privacy Number (the X Number)…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axn` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | The key of the Number Pool. You can get the Pool Key from the Number Pool Management… |
| PhoneNoA | string | yes | 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 | string | no | 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 | string | no | Phone number X, the privacy number for the AXN binding. Phone number X must be one of your Purchased Privacy Numbers… |
| Expiration | string | yes | 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 | string | no | 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 | string | no | Specifies whether to enable call recording for this binding. Valid values: true: Enables call recording. false (default): Disables call… |
| NoType | string | no | The number type. This parameter applies to legacy Alibaba Dayu customers. Current Alibaba Cloud users can ignore this parameter |
| OutId | string | no | An external extension field that is included in the call detail record (CDR) callback |
| OutOrderId | string | no | The external business ID |
| CallDisplayType | integer | no | 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 | string | no | 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 | string | no | Specifies whether to enable or disable Automatic Speech Recognition (ASR). Valid values: false (default): Disables ASR. true: Enables ASR |
| ASRModelId | string | no | The ID of the ASR model. Valid values: Generic - Telephony - Mandarin Chinese model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac Generic -… |
| CallTimeout | integer | no | The call timeout in seconds |
| CallRestrict | string | no | The call restriction policy. Valid values: CONTROL_AX_DISABLE: Disables calls from Phone number A to Phone number X. CONTROL_BX_DISABLE:… |
| Extend | string | no | The Extend |

### AXN with extension creates a binding. This feature is similar to AXN for privacy protection but introduces…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axn-extension` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | The number pool key. You can find the Pool Key on the Number Pool Management… |
| PhoneNoA | string | yes | 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 | string | no | 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 | string | no | 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 | string | no | Specifies Number X for the AXN extension binding. Number X must be one of your purchased privacy numbers… |
| Expiration | string | yes | 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 | string | no | 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 | string | no | Specifies whether to enable Call Recording for all calls associated with this binding. Valid values: true: Enables call recording. false… |
| OutId | string | no | The External Business Extension Field. This field is included in call record receipt messages |
| OutOrderId | string | no | The external business ID |
| CallDisplayType | integer | no | 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 | string | no | Sets the Enterprise Ringback Tone for an AXN extension binding when Number X is called. This parameter requires a ringtone field and a… |
| ASRStatus | string | no | Specifies whether to enable ASR (Automatic Speech Recognition). Valid values: true: Enables ASR. false (default): Disables ASR |
| ASRModelId | string | no | The ASR model ID. Valid values: General - Telephony - Mandarin Model ID: `7ee372834d2f4cc7ac0d0ab2d0ae1aac` General - Telephony -… |
| CallRestrict | string | no | Specifies the Call Restriction policy. Valid values: CONTROL_AX_DISABLE: Number A cannot call Number X. CONTROL_BX_DISABLE: Number B… |
| Extend | string | no | Reserved for future use |

### The fixed-line AXN extension number introduces extension numbers on top of the fixed-line AXN privacy…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axn-extension-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | Number pool ID |
| Ts | string | yes | Business timestamp. Format: yyyyMMddHHmmssSSS. Uses Beijing time, 24-hour clock, accurate to milliseconds |
| OrderId | string | yes | Unique identifier of the message request |
| BindType | string | yes | Binding type. Valid values: mode101: Customer specifies the X number. mode102: Platform assigns the X number |
| Subts | string | yes | Binding time. Format: yyyyMMddHHmmss. Uses Beijing time, 24-hour clock |
| TelA | string | yes | 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 | string | no | The X number for the fixed-line AXN extension number. The X number is a privacy number that you have purchased… |
| TelXext | string | no | Extension number. This parameter is required when the BindType parameter is set to mode101 |
| Anucode | string | yes | Caller-side ringtone code. This parameter is required for AXB scenarios. Must contain codes for 3 scenarios. Enter the codes in the order… |
| Anucodecalled | string | no | 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 | string | no | 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 | string | yes | Expiration time. Unit: seconds. Valid values: 0: Never expires. Other values: When other values are specified, such as 60, the binding is… |
| Areacode | string | no | Area code. Supports specifying the home location of the X number (specified city -> provincial capital -> nationwide routing). If no home… |
| Remark | string | no | External business extension field. This parameter is returned in call record receipt messages. Must not exceed 100 characters |
| Extraaxx | string | no | Extension parameters (JSON-encoded) |

### Binds a number to a fixed-line AXN private number. User A is assigned a dedicated private number X, and any…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-axn-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The ID of the number pool |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| OrderId | string | yes | The unique identifier of the message request |
| BindType | string | yes | The binding type. Valid values: mode101: The customer specifies the X number. mode102: The platform assigns the X number |
| Subts | string | yes | The binding time. Format: yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format |
| TelA | string | yes | 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 | string | no | 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 | string | no | The N number of the fixed-line AXN private number |
| Anucode | string | yes | 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 | string | no | 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 | string | no | 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 | string | no | The area code. Specifies the location of the X number (specified city -> provincial capital -> nationwide routing). If no location is… |
| Expiration | string | yes | The expiration time, in seconds. Valid values: 0: Never expires. Other values: The binding remains valid for the specified duration after… |
| Remark | string | no | The external business extension field. This parameter is returned in call record receipt messages. The value cannot exceed 100 characters |
| Extra | string | no | The extension parameters (JSON-encoded) |

### Adds AXG bindings in batches. The AXG model is a Phone Number Protection Solution for scenarios requiring…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-batch-axg` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | 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 | string | yes | The list of AXG bindings (JSON-encoded) |

### Adds a binding relationship for a 700GXB private number. The 700GXB product is a privacy protection…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-gxb700` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the China 700 number pool |
| Expiration | string | yes | The expiration time of the number binding. Note The expiration time must be at least 1 minute later than the current binding time,… |
| TelB | string | yes | Phone number of user B |
| DefaultA | string | no | 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 | string | no | The ID of number group G. Number group G is created by using the "Create G Number Group" message |
| TelX | string | no | 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 | string | no | Specifies whether the business user requires all call media files generated by this number binding relationship. Valid values: true:… |
| RecType | string | no | The recording type. Valid values: mp3 and wav |
| CallRestrict | string | no | The one-way call restriction logic. Valid values: CONTROL_BX_DISABLE: number B cannot call number X. CONTROL_GX_DISABLE: numbers in number… |
| Audio | string | no | 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 | string | no | 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 | string | no | The Industrial Internet identifier code, which has a one-to-one mapping with OrderID. The code supports characters such as "." and "/" as… |
| OutId | string | no | An external business extension field. This parameter is returned in the call record receipt message |
| OutOrderId | string | no | The external business ID |
| NeedAsr | string | no | Specifies whether to enable the ASR service. Valid values: false: Disabled (default value). true: Enabled |
| AsrModelId | string | no | The ASR model ID. Valid values: General-Phone-Chinese Mandarin model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac General-Phone-Chinese Cantonese… |
| CallTimeout | integer | no | The sequential ringing duration. Unit: seconds. Valid values: 5 to 20 |
| DtmfConfig | string | no | The DTMF key configuration, used when setting up AXB intermediate number binding. The following items can be configured:… |

### Establishes a binding relationship between a specified work number X and an employee number B on the work…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/bind-xb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and is not required |
| CustomerPoolKey | string | yes | The number pool key |
| TelB | string | yes | The actual phone number of the employee |
| TelX | string | yes | The work number X |
| UserData | string | no | The custom data to be returned in the callback |

### Purchases a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/buy-secret-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | integer | yes | 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 | string | yes | 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 | string | no | 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 | string | no | Specifies whether to add the phone number to the pool of numbers that will be displayed during calls. This parameter takes effect only for… |

### Cancels a door-to-door delivery order
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/cancel-pick-up-waybill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| OuterOrderCode | string | yes | The ID of the external order |
| CancelDesc | string | yes | The cancellation reason |

### Configures an X number to independently manage communication features such as voice calls and enterprise…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/config-x` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length of reqId is 20 characters. The caller must ensure atomicity |
| CallerParentId | integer | no | The customer UID |
| CustomerPoolKey | string | yes | The key of the number pool |
| TelX | string | yes | The X number |
| GNFlag | string | no | Specifies whether to pass through the caller ID to display the actual caller. Valid values: 00: No pass-through. The work number is… |
| SmsSignMode | string | no | Specifies whether to pass through the SMS signature to display the actual user. Valid values: 0: No pass-through. 1: Pass-through. Default… |
| SmsAbility | string | no | Specifies whether to enable the SMS feature. Valid values: 0: Disable. 1: Enable |
| CallAbility | string | no | Specifies whether to enable the call capability. Valid values: 0: Disable. 1: Enable |
| SequenceMode | string | no | The sequential ringing mode. Valid values: 0: No sequential ringing. This is the default value. 1: Conditional sequential ringing. The… |
| SequenceCalls | string | no | The sequential ringing control parameters (JSON-encoded) |

### Creates number group G
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/create-axg-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | string | no | 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 | string | no | The remarks of number group G. The value must be 0 to 256 characters in length |
| Numbers | string | no | The phone numbers that you add to number group G. Separate multiple phone numbers with commas (,). A maximum of 200 phone numbers can be… |

### Submit Individual Information of a landline number A through an API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/create-fixed-no-areport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| FixedNoA | string | yes | Number A (fixed-line number) |
| ANoWhiteGroupId | integer | yes | ID of the group to which Number A belongs. On the Qualification Management (https://dyplsnext.console.aliyun.com/qualification) Page, go… |
| DocumentType | integer | yes | Certificate type. Enter 1 for ID card |
| CustName | string | yes | Name |
| DocumentNumber | string | yes | Certificate number |
| CustType | integer | yes | Fixed-line customer type. Valid values: 1: Legal representative. 2: Agent |
| FixedLineWorkId | string | no | Ticket number from the offline service hall when applying for a fixed-line number |
| IdCardFrontPhoto | string | no | OSS path of the photo of the front (national emblem side) of the ID card |
| IdCardBackPhoto | string | no | OSS path of the photo of the back (portrait side) of the ID card |
| IdCardAlivePhoto | string | yes | OSS path of the front-facing portrait photo |
| Remark | string | no | Remarks (user-defined business notes) |
| CustPhoneNo | string | no | Phone number of the legal representative or agent. If this qualification includes a Mobile X number, this field is Required; otherwise,… |

### Submit Individual Information of an A-number mobile phone number through an API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/create-phone-no-areport` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PhoneNoA | string | yes | Phone number. |
| ANoWhiteGroupId | integer | yes | ID of the A-number group. On the Qualification Management (https://dyplsnext.console.aliyun.com/qualification) page, click View Details in… |
| DocumentType | integer | yes | Certificate type. Enter 1 for an ID card. |
| CustName | string | yes | Name. |
| DocumentNumber | string | yes | Certificate number. |
| IdCardFrontPhoto | string | no | OSS path of the photo of the front side (national emblem side) of the ID card. |
| IdCardBackPhoto | string | no | OSS path of the photo of the back side (portrait side) of the ID card. |
| IdCardAlivePhoto | string | yes | OSS path of the front-facing portrait photo |
| Remark | string | no | Remark (business remark added by the user). |

### Creates a door-to-door pickup order
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/create-pick-up-waybill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| OuterOrderCode | string | yes | The external order ID |
| OrderChannels | string | yes | The external channel source |
| CpCode | string | no | The courier company code |
| SendName | string | yes | The sender name |
| SendMobile | string | no | The sender mobile number. You must specify either SendMobile or SendPhone |
| SendPhone | string | no | The sender phone number. You must specify either SendMobile or SendPhone |
| SendAddress | string | yes | The sender address (JSON-encoded) |
| ConsigneeName | string | yes | The consignee name |
| ConsigneeMobile | string | no | The consignee mobile number. You must specify either ConsigneeMobile or ConsigneePhone |
| ConsigneePhone | string | no | The consignee phone number. You must specify either ConsigneeMobile or ConsigneePhone |
| ConsigneeAddress | string | yes | The consignee address (JSON-encoded) |
| Remark | string | no | The remarks. The remark content printed on the shipping label |
| GoodsInfos | string | no | The list of goods (JSON-encoded) |
| AppointGotStartTime | string | no | 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 | string | no | 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 | integer | no | The pickup mode. Valid values: 0: real-time order (default). 1: scheduled order |

### Pre-queries shipping order information before placing an order
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/create-pick-up-waybill-pre-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| SenderInfo | string | yes | The sender information (JSON-encoded) |
| ConsigneeInfo | string | yes | The recipient information (JSON-encoded) |
| CpCode | string | no | The courier company code. If not specified, the system automatically assigns a courier company |
| PreWeight | string | no | The estimated weight, in grams. If you want to query the estimated price, this parameter is required |
| OuterOrderCode | string | no | The order number in the caller's system |
| OrderChannels | string | yes | The external channel source identifier. The value cannot contain underscores. The value is agreed upon with the system during integration |

### Generates a text message delivery tag for scenarios where an employee sends a text message to a customer by…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/create-sms-sign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The number pool key |
| CalledNo | string | yes | The recipient number |
| CallingNo | string | yes | The sender number |

### Unbind a fixed-line AXB privacy number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/delete-axb-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | Number pool ID |
| Ts | string | yes | Business timestamp. Format: yyyyMMddHHmmssSSS. The time uses Beijing time in 24-hour clock format, accurate to milliseconds |
| SubId | string | yes | Binding ID |
| OrderId | string | yes | Unique identifier of the message request |

### Deletes a G group. G groups are supported only in Number Pools designated for the AXG privacy number type
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/delete-axg-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the number pool. You can obtain the key of the number pool on the Number Pool Management… |
| GroupId | integer | yes | The G group ID (GID). Log on to the Phone Number Privacy Protection console. On the Number Pool Management… |

### Unbinds a fixed-line AXN private number binding relationship
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/delete-axn-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The number pool ID |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| OrderId | string | yes | The unique identifier of the message request |
| SubId | string | yes | The binding ID |

### Unbind a fixed-line AXN extension number binding
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/delete-axn-extension-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The business ID identifier assigned by Alibaba Cloud to the customer |
| Ts | string | yes | Format: yyyyMMddHHmmssSSS. The time uses Beijing time in 24-hour format, accurate to milliseconds |
| OrderId | string | yes | The unique identifier of the message request |
| SubId | string | yes | The binding ID |

### Delete A-number filing data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/delete-secret-aphone-no-to-cust` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PhoneNoA | string | yes | A-number |
| ANoWhiteGroupId | integer | yes | A-number group ID |

### Deletes the blacklist of a number pool. Only number pools of the AXN privacy number, AXN extension number,…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/delete-secret-blacklist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the number pool. You can obtain the number pool key on the Number Pool Management… |
| BlackNo | string | yes | The blacklisted number. The value type is determined by the BlackType parameter: Point-to-point blacklist: a pair of numbers separated by… |
| Remark | string | no | The remark for the blacklist |
| BlackType | string | yes | The type of the blacklist. Valid values: POINT_TO_POINT_BLACK: point-to-point blacklist PARTNER_GLOBAL_NUMBER_BLACK: number pool blacklist |
| WayControl | string | no | The call direction control. Valid values: PHONEA_REJECT: The first number in BlackNo can call the second number, but the second number… |

### Obtain OSS resource configuration information. This configuration information will be used for subsequent…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/get-dypls-ossinfo-for-upload-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| BizType | string | yes | The business type. Default Value: phone_card |

### Obtains the details of the automatic speech recognition (ASR) result
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/get-secret-asr-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| CallId | string | yes | 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 | string | yes | The call initiation time in the call record. You can log on to the Phone Number Protection console… |
| PoolKey | string | yes | The key of the phone number pool. You can log on to the Phone Number Protection console… |

### Obtains the download URL of a recorded ringing tone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/get-total-public-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| CheckSubs | string | yes | Specifies whether the verification on the binding ID is required |
| PartnerKey | string | yes | 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 | string | yes | 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 | string | yes | The call initiation time in the call record. Log on to the Phone Number Protection console… |

### Retrieves the configuration information of the X number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/get-xconfig` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The key of the number pool |
| TelX | string | yes | The X number |

### Retrieves the default configurations of an X number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/get-xdefault-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The number pool key |
| TelX | string | yes | The X number |

### Queries the list of X numbers under a customer account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/list-xtelephones` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | no | The number pool key |
| PageNo | integer | no | The page number for the paged query. Paging starts from 1 |
| PageSize | integer | no | The number of entries per page |

### Locks a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/lock-secret-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | string | yes | The private number that you want to lock. You must enter a complete mobile phone number |

### Modifies number group G
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/operate-axg-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | integer | yes | 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 | string | yes | The type of the operation on number group G. Valid values: addNumbers: adds phone numbers to number group G. deleteNumbers: deletes phone… |
| Numbers | string | yes | 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 |

### Adds a phone number to a blacklist or deletes a phone number from a blacklist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/operate-black-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | string | yes | The phone number to be added to or deleted from the blacklist |
| OperateType | string | yes | The type of the operation on the phone number. Valid values: AddBlack: adds the phone number to the blacklist. DeleteBlack: deletes the… |
| Tips | string | no | The description |

### Queries the binding information of an AXB landline privacy number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-axb-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The number pool ID |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| QueryType | string | yes | The query type. Valid values: 0: Query by binding ID. 1: Query by X and A/B numbers |
| SubId | string | no | The binding ID. Required when QueryType is set to 0 |
| Phone | string | no | The A/B number. Required when QueryType is set to 1 |
| TelX | string | no | The X number. Required when QueryType is set to 1 |
| OrderId | string | yes | The unique identifier of the message request |

### Queries the binding information of an AXN landline privacy number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-axn-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The number pool ID |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| QueryType | string | yes | The query type. Valid values: 0: query by binding ID. 1: query by X and A/B phone number |
| SubId | string | no | The binding ID. This parameter is required when QueryType is set to 1 |
| Phone | string | no | The A/B phone number. This parameter is required when QueryType is set to 1 |
| TelX | string | no | The X phone number. This parameter is required when QueryType is set to 1 |
| OrderId | string | yes | The unique identifier of the message request |

### Queries the binding information of a landline AXN extension number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-axn-extension-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The ID of the number pool |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| QueryType | string | yes | The query type. Valid values: 0: query by binding ID. 1: query by X and A/B numbers |
| SubId | string | no | The binding ID. This parameter is required when QueryType is set to 0 |
| TelA | string | no | The number A. This parameter is required when QueryType is set to 1 |
| OrderId | string | yes | The unique identifier of the message request |

### Queries the details about a tracking number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-phone-no-aby-track-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| trackNo | string | yes | The tracking number |
| CabinetNo | string | no | The cabinet number |
| PhoneNoX | string | no | Phone number X returned by the API operation for creating a binding |

### Obtains the download URL of a recording file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-record-file-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | 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 | string | no | 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 | string | yes | 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 | string | no | The call initiation time in the call record. Log on to the Phone Number Protection console… |

### Query the reporting status of an A number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-secret-aphone-no-to-cust` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PhoneNoA | string | yes | A number |
| ANoWhiteGroupId | integer | yes | Number group ID |

### Queries the property information of a private number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-secret-no-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| SecretNo | string | yes | 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 | string | yes | 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… |

### Queries the quantity of remaining phone numbers available for online purchase
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-secret-no-remain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| SpecId | integer | yes | 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 | string | yes | 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 | string | no | The prefix of the phone number. When you call the QuerySecretNoRemain operation with SecretNo specified, the quantity of remaining phone… |

### Queries the downloadable URL of a call recording by call ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-sound-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically retrieved by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The number pool key |
| CallId | string | yes | The call ID, which uniquely identifies a call |

### Queries binding IDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-subs-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | The key of the phone number pool. Log on to the Phone Number Protection console (https://dyplsnext.console.aliyun.com/overview) and view… |
| PhoneNoX | string | yes | The private number in the binding, that is, phone number X |

### Queries the binding details of a phone number. Retrieves information such as the binding relationship…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/query-subscription-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | The key of the number pool. Log on to the privacy protection console and go to the Number Pool Management… |
| ProductType | string | no | The product type. Valid values: AXB_170 AXN_170 AXN_95 AXN_EXTENSION_REUSE This parameter is applicable to former Alibaba Dayu users.… |
| SubsId | string | yes | The binding relationship ID. Logon to the privacy protection console, go to the Number Management… |
| PhoneNoX | string | yes | The privacy number in the binding relationship, which is the X number. Logon to the privacy protection console and go to the Number… |

### Releases a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/release-secret-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | string | yes | The prefix of phone numbers. When you call the ReleaseSecretNo operation with SecretNo specified, the system performs fuzzy matching… |

### Dissociates a specified call binding relationship (A, X, and B). After the call binding relationship is…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/un-bind-axb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The number pool key |
| BindId | string | yes | The unique ID of the AXB binding relationship |

### Cancels the binding between work number X and employee number B. After the binding is canceled, calls to X…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/un-bind-xb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| ReqId | string | yes | The request deduplication ID. The maximum length is 20 characters. Ensure the atomicity of the request ID |
| CallerParentId | integer | no | The customer UID. This parameter is automatically obtained by the system and does not need to be specified |
| CustomerPoolKey | string | yes | The number pool key |
| AuthId | string | yes | The unique ID of the XB binding relationship |
| TelX | string | yes | The number X |

### Unbinds a 700 number from its binding relationship
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/unbind-subs700` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the China 700 number pool. You can obtain the number pool key from the China 700 Number Pool Management… |
| SubsId | integer | yes | The binding ID |
| TelX | string | yes | The intermediate number X. If the service user does not specify an X number, the application platform assigns a number from the number… |
| OrderId | string | no | The order ID. This parameter is required in practice. Encrypt the order ID before submission because it is reported to the regulatory… |
| IndustrialId | string | no | Optional. The Industrial Internet identifier code, which has a one-to-one relationship with OrderId. The code supports delimiter… |

### Unbinds a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/unbind-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | 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 | string | no | The product type. Fixed value: AXB_170. This parameter is applicable to the original key accounts of Alibaba Cloud. This parameter can be… |
| SubsId | string | yes | The binding ID. Log on to the Phone Number Protection console, choose Number and Number Pool > Number Management. On the Number Management… |
| SecretNo | string | yes | The private number, that is, phone number X specified in an API operation for a phone number binding such as… |

### Unlocks a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/unlock-secret-no` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | 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 | string | yes | The private number that you want to unlock. You must enter a complete mobile phone number |

### Modifies the binding information of a landline AXB privacy number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/update-axb-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The number pool ID |
| Ts | string | yes | The business timestamp in the format of yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| SubId | string | yes | The binding ID |
| OrderId | string | yes | The unique identifier of the message request |
| TelA | string | no | 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 | string | no | 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 | string | yes | The binding time in the format of yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format |
| Anucode | string | no | 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 | string | no | 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 | string | no | 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 | string | no | The expiration time, in seconds. Valid values: 0: never expires. Other values: when other values are specified, such as 60s, the binding… |
| Remark | string | no | An external business extension field. This parameter is returned in the call record receipt message. The value cannot exceed 100… |
| Extra | string | no | The extension parameters (JSON-encoded) |

### Modifies the binding information of a landline AXN private number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/update-axn-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The number pool ID |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| OrderId | string | yes | The unique identifier of the message request |
| Subts | string | yes | The binding time. Format: yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format |
| SubId | string | yes | The binding ID |
| TelA | string | no | 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 | string | no | The N number of the landline AXN private number |
| Anucode | string | no | The caller-side ringback tone codes. This parameter is required for AXB services. The codes must include three scenarios. Enter the codes… |
| Anucodecalled | string | no | 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 | string | no | 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 | string | no | The expiration time. Unit: seconds. Valid values: 0: never expires. Other values: specifies the validity period. For example, if you set… |
| Remark | string | no | An external business extension field. This parameter is returned in the call record receipt message. The value cannot exceed 100… |
| Extra | string | no | The extension parameters (JSON-encoded) |

### Modifies the binding relationship of a landline AXN extension number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/update-axn-extension-bind-fixed-line` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| AppId | string | yes | The number pool ID |
| Ts | string | yes | The business timestamp. Format: yyyyMMddHHmmssSSS. The time is in UTC+8, in 24-hour format, accurate to milliseconds |
| OrderId | string | yes | The unique identifier of the message request |
| Subts | string | yes | The binding time. Format: yyyyMMddHHmmss. The time is in UTC+8, in 24-hour format |
| SubId | string | yes | The binding ID |
| TelA | string | yes | 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 | string | no | The caller-side ringback tone code. This parameter is required for AXB services. The code must contain codes for 3 scenarios. Enter the… |
| Anucodecalled | string | no | 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 | string | no | 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 | string | no | The expiration time. Unit: seconds. Valid values: 0: never expires. Other values: when you specify another value such as 60, the binding… |
| Remark | string | no | The external business extension field. This parameter is returned in the call record receipt message. The value cannot exceed 100… |
| Extraaxx | string | no | The extension parameter (JSON-encoded) |

### Modifies the binding relationship of a 700 number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/update-subs700` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | yes | The key of the number pool |
| OperateType | string | yes | updateNoA: Updates number A. updateNoB: Updates number B. updateExpire: Updates the validity period of the binding relationship.… |
| SubsId | integer | yes | The binding relationship ID, which uniquely identifies a number binding relationship |
| TelX | string | yes | 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 | string | no | The order ID. This parameter is required in practice. Encrypt the order ID before submission because it is reported to the regulatory… |
| IndustrialId | string | no | Optional. The Industrial Internet identifier code, which has a one-to-one correspondence with OrderID. The code supports delimiter… |
| TelA | string | no | The number A to update in the binding relationship |
| DefaultA | string | no | Number A. The DefaultA number for GXB private numbers. Note The callback mode can be configured at the number pool level. When the… |
| TelB | string | no | The number B to update in the binding relationship |
| GroupId | string | no | The GroupID to update in the binding relationship |
| Expiration | string | no | The validity period to update for the binding relationship |
| CallRestrict | string | no | The single-call restriction logic to update |
| NeedRecord | string | no | The media selection to update in the binding relationship |
| Audio | string | no | 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 | string | no | An external business extension field. This parameter is returned in the call record receipt message |
| NeedAsr | string | no | Specifies whether to enable the ASR service. Valid values: false: Disabled. This is the default value. true: Enabled |
| AsrModelId | string | no | The ASR model ID. Valid values: General phone Chinese Mandarin model ID: 7ee372834d2f4cc7ac0d0ab2d0ae1aac General phone Chinese Cantonese… |

### Modifies a phone number binding
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/update-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |
| PoolKey | string | no | 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 | string | no | 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 | string | yes | The binding ID. Log on to the Phone Number Protection console (https://dypls.console.aliyun.com/dypls.htm#/account), choose Number and… |
| PhoneNoX | string | yes | Phone number X in the phone number binding |
| PhoneNoA | string | no | Phone number A in the phone number binding. This parameter is required when OperateType is set to updateNoA |
| PhoneNoB | string | no | Phone number B in the phone number binding. This parameter is required when OperateType is set to updateNoB |
| GroupId | string | no | The ID of number group G in the phone number binding. This parameter is required when OperateType is set to updateAxgGroup |
| CallRestrict | string | no | One-way call restrictions. Valid values: CONTROL_AX_DISABLE: Phone number A cannot be used to call phone number X. CONTROL_BX_DISABLE:… |
| Expiration | string | no | Re-sets the expiration time of the phone number binding. This parameter is required when OperateType is set to updateExpire. The… |
| CallDisplayType | integer | no | 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 | string | no | Re-sets the value of the OutId parameter in the phone number binding |
| IsRecordingEnabled | string | no | 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 | string | yes | The operation to modify the phone number binding. Valid values: updateNoA: modifies phone number A. updateNoB: modifies phone number B.… |
| RingConfig | string | no | Updates the ringtone code for enterprise Color Ring Back Tone (CRBT) in the phone number binding. AXB product: Ringtone setting when phone… |
| ASRStatus | string | no | Specifies whether to enable automatic speech recognition (ASR). Valid values: false (default): disables ASR. true: enables ASR |
| ASRModelId | string | no | The ID of the ASR model |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyplsapi.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/add-axn-track-no" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Phone Number Protection API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dyplsapi/add-axn-track-no with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Phone Number Protection API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Phone Number Protection itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Phone Number Protection API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-dyplsapi.

### What is the status of the Alibaba Cloud Phone Number Protection API?
Needs your own provider key (bring your own key)