summaryrefslogtreecommitdiff
path: root/data/zh_cn/dyplsapi
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/dyplsapi
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/dyplsapi')
-rw-r--r--data/zh_cn/dyplsapi/2017-05-25/api-docs.php15476
1 files changed, 5578 insertions, 9898 deletions
diff --git a/data/zh_cn/dyplsapi/2017-05-25/api-docs.php b/data/zh_cn/dyplsapi/2017-05-25/api-docs.php
index 50d585b..6c73747 100644
--- a/data/zh_cn/dyplsapi/2017-05-25/api-docs.php
+++ b/data/zh_cn/dyplsapi/2017-05-25/api-docs.php
@@ -1,296 +1,323 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'Dyplsapi',
- 'version' => '2017-05-25',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'Dyplsapi', 'version' => '2017-05-25'],
'directories' => [
[
- 'id' => 204593,
- 'title' => '实际使用人报备A号码报备',
+ 'children' => ['DeleteSecretAPhoneNoToCust', 'QuerySecretAPhoneNoToCust', 'CreateFixedNoAReport', 'GetDyplsOSSInfoForUploadFile', 'CreatePhoneNoAReport'],
'type' => 'directory',
- 'children' => [
- 'DeleteSecretAPhoneNoToCust',
- 'QuerySecretAPhoneNoToCust',
- 'CreateFixedNoAReport',
- 'GetDyplsOSSInfoForUploadFile',
- 'CreatePhoneNoAReport',
- ],
+ 'title' => '实际使用人报备A号码报备',
+ 'id' => 329686,
],
[
- 'id' => 126550,
- 'title' => '添加号码绑定',
+ 'children' => ['BindAxb', 'BindAxn', 'BindAxnExtension', 'BindAxg', 'BindBatchAxg', 'UpdateSubscription', 'UnbindSubscription'],
'type' => 'directory',
- 'children' => [
- 'BindAxb',
- 'BindAxn',
- 'BindAxnExtension',
- 'BindAxg',
- 'BindBatchAxg',
- 'UpdateSubscription',
- 'UnbindSubscription',
- ],
+ 'title' => '添加号码绑定',
+ 'id' => 329640,
],
[
- 'id' => 126560,
- 'title' => '查询号码绑定',
+ 'children' => ['QuerySubscriptionDetail', 'QuerySubsId', 'QuerySecretNoDetail'],
'type' => 'directory',
- 'children' => [
- 'QuerySubscriptionDetail',
- 'QuerySubsId',
- 'QuerySecretNoDetail',
- ],
+ 'title' => '查询号码绑定',
+ 'id' => 329648,
],
[
- 'id' => 192616,
- 'title' => 'G号码组',
+ 'children' => ['CreateAxgGroup', 'OperateAxgGroup', 'DeleteAxgGroup'],
'type' => 'directory',
- 'children' => [
- 'CreateAxgGroup',
- 'OperateAxgGroup',
- 'DeleteAxgGroup',
- ],
+ 'title' => 'G号码组',
+ 'id' => 329671,
],
[
- 'id' => 126565,
- 'title' => '录音及ASR获取',
+ 'children' => ['QueryRecordFileDownloadUrl', 'GetTotalPublicUrl', 'GetSecretAsrDetail'],
'type' => 'directory',
- 'children' => [
- 'QueryRecordFileDownloadUrl',
- 'GetTotalPublicUrl',
- 'GetSecretAsrDetail',
- ],
+ 'title' => '录音及ASR获取',
+ 'id' => 329652,
],
[
- 'id' => 126575,
- 'title' => '号码资源管理',
+ 'children' => ['AddSecretBlacklist', 'DeleteSecretBlacklist', 'OperateBlackNo', 'QuerySecretNoRemain', 'BuySecretNo', 'ReleaseSecretNo', 'LockSecretNo', 'UnlockSecretNo'],
'type' => 'directory',
- 'children' => [
- 'AddSecretBlacklist',
- 'DeleteSecretBlacklist',
- 'OperateBlackNo',
- 'QuerySecretNoRemain',
- 'BuySecretNo',
- 'ReleaseSecretNo',
- 'LockSecretNo',
- 'UnlockSecretNo',
- ],
+ 'title' => '号码资源管理',
+ 'id' => 329662,
],
[
- 'id' => 126569,
- 'title' => '电商物流行业接口',
+ 'children' => ['CreatePickUpWaybillPreQuery', 'CreatePickUpWaybill', 'CancelPickUpWaybill', 'AddAxnTrackNo', 'QueryPhoneNoAByTrackNo'],
'type' => 'directory',
- 'children' => [
- 'CreatePickUpWaybillPreQuery',
- 'CreatePickUpWaybill',
- 'CancelPickUpWaybill',
- 'AddAxnTrackNo',
- 'QueryPhoneNoAByTrackNo',
- ],
+ 'title' => '电商物流行业接口',
+ 'id' => 329656,
],
[
- 'id' => 199020,
- 'title' => '工作号',
+ 'children' => ['UnBindAXB', 'BindXB', 'BindAXBCall', 'UnBindXB', 'QuerySoundRecord', 'CreateSmsSign', 'ListXTelephones', 'GetXConfig', 'ConfigX', 'GetXDefaultConfig'],
'type' => 'directory',
- 'children' => [
- 'UnBindAXB',
- 'BindXB',
- 'BindAXBCall',
- 'UnBindXB',
- 'QuerySoundRecord',
- 'CreateSmsSign',
- 'ListXTelephones',
- 'GetXConfig',
- 'ConfigX',
- 'GetXDefaultConfig',
- ],
+ 'title' => '工作号',
+ 'id' => 329675,
],
[
- 'id' => 320433,
- 'title' => '700',
+ 'children' => ['BindAxb700', 'BindGxb700', 'UpdateSubs700', 'UnbindSubs700'],
'type' => 'directory',
- 'children' => [
- 'BindAxb700',
- 'BindGxb700',
- 'UpdateSubs700',
- 'UnbindSubs700',
- ],
+ 'title' => '700',
+ 'id' => 329705,
],
[
- 'id' => 205486,
- 'title' => '其他',
+ 'children' => ['DeleteAxnExtensionBindFixedLine', 'UpdateAxnExtensionBindFixedLine', 'QueryAxbBindFixedLine', 'UpdateAxnBindFixedLine', 'UpdateAxbBindFixedLine', 'BindAxnExtensionFixedLine', 'QueryAxnBindFixedLine', 'DeleteAxnBindFixedLine', 'QueryAxnExtensionBindFixedLine', 'BindAxnFixedLine', 'BindAxbFixedLine', 'DeleteAxbBindFixedLine'],
'type' => 'directory',
- 'children' => [
- 'DeleteAxnExtensionBindFixedLine',
- 'UpdateAxnExtensionBindFixedLine',
- 'QueryAxbBindFixedLine',
- 'UpdateAxnBindFixedLine',
- 'UpdateAxbBindFixedLine',
- 'BindAxnExtensionFixedLine',
- 'QueryAxnBindFixedLine',
- 'DeleteAxnBindFixedLine',
- 'QueryAxnExtensionBindFixedLine',
- 'BindAxnFixedLine',
- 'BindAxbFixedLine',
- 'DeleteAxbBindFixedLine',
- ],
+ 'title' => '其他',
+ 'id' => 329692,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'DeleteSecretAPhoneNoToCust' => [
- 'summary' => 'A号码报备数据删除。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddAxnTrackNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '72606',
+ 'abilityTreeNodes' => ['FEATUREdyplsOMLRO6'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PhoneNoA',
+ 'name' => 'PoolKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '号码池Key。请登录[号码隐私保护控制台](https://dypls.console.aliyun.com/dypls.htm#/account)，在**号码池管理**中查看号码池Key。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC2235****'],
+ ],
+ [
+ 'name' => 'PhoneNoX',
+ 'in' => 'query',
+ 'schema' => ['description' => '绑定关系中的隐私号码，即X号码。'."\n"
+ ."\n"
+ .'您可以通过[BindAxn](~~110258~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => '1700000****'],
+ ],
+ [
+ 'name' => 'trackNo',
'in' => 'query',
+ 'schema' => ['description' => '运单号。', 'type' => 'string', 'required' => true, 'example' => 'abcde*****'],
+ ],
+ [
+ 'name' => 'SubsId',
+ 'in' => 'query',
+ 'schema' => ['description' => '订购关系ID。'."\n"
+ ."\n"
+ .'您可以通过[BindAxn](~~110258~~)接口获取。', 'type' => 'string', 'required' => true, 'example' => '15678890****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'A号码',
- 'description' => 'A号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '130*****1234',
+ 'description' => '返回数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '状态码。'."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => '请求成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1A4CADEF-8516-5890-9177-A1A4D97F****'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"1A4CADEF-8516-5890-9177-A1A4D97F****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAxnTrackNoResponse>\\n <Code>OK</Code>\\n <Message>请求成功</Message>\\n <RequestId>8906582E-6722</RequestId>\\n</AddAxnTrackNoResponse>","errorExample":""}]',
+ 'title' => '为AXN隐私号添加运单号',
+ 'summary' => '为AXN隐私号添加运单号。',
+ 'description' => '### QPS限制'."\n"
+ .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:AddAxnTrackNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AddSecretBlacklist' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'ANoWhiteGroupId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '72607',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PoolKey',
+ 'in' => 'query',
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC2235****'],
+ ],
+ [
+ 'name' => 'BlackNo',
+ 'in' => 'query',
+ 'schema' => ['description' => '黑名单号码。根据**BlackType**参数值决定取值类型：'."\n"
+ ."\n"
+ .'- **点对点黑名单**：一对号码（指AB号码），用英文冒号（:）分隔。'."\n"
+ .'- **号池黑名单**：单个号码。'."\n"
+ ."\n"
+ .'>（*）不是通配符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1825638****:1825248****'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['description' => '黑名单备注。', 'type' => 'string', 'required' => false, 'example' => '黑名单备注'],
+ ],
+ [
+ 'name' => 'BlackType',
+ 'in' => 'query',
+ 'schema' => ['description' => '黑名单类型。取值：'."\n"
+ ."\n"
+ .'- **POINT_TO_POINT_BLACK**：点对点黑名单。'."\n"
+ .'- **PARTNER_GLOBAL_NUMBER_BLACK**：号码池黑名单。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'POINT_TO_POINT_BLACK'],
+ ],
+ [
+ 'name' => 'WayControl',
'in' => 'query',
'schema' => [
- 'title' => 'A号码组ID',
- 'description' => 'A号码组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '51',
+ 'description' => '呼叫方向控制。取值：'."\n"
+ ."\n"
+ .'- **PHONEA_REJECT**：BlackNo中第一个号码可以呼叫第二个号码，第二个号码不能呼叫第一个。'."\n"
+ .'- **PHONEB_REJECT**：BlackNo中第一个号码不可呼叫第二个号码，第二个号码可呼叫第一个号码。'."\n"
+ .'- **不填**：BlackNo中两个号码不可相互呼叫。'."\n"
+ ."\n"
+ .'>只有在点对点黑名单时候才有用。',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'PHONEA_REJECT',
+ 'enum' => ['DUPLEX_REJECT', 'PHONEA_REJECT', 'PHONEB_REJECT'],
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'title' => '返回id',
- 'description' => '返回ID。',
- 'type' => 'string',
- 'example' => '1D73E648-0978-18A5-B089-3BB2',
- ],
- 'Message' => [
- 'title' => '失败错误提示',
- 'description' => '失败错误提示。',
- 'type' => 'string',
- 'example' => '号码组不存在',
- ],
- 'Data' => [
- 'title' => '删除是否成功',
- 'description' => '删除是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '请求状态码',
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '请求是否成功',
- 'description' => '请求是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。取值：'."\n"
+ ."\n"
+ .'- OK：代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RamPermissionDenied', 'errorMessage' => 'RAM permission is denied.', 'description' => 'RAM权限DENY'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"号码组不存在\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除A号码报备记录',
- 'description' => '- 此接口只能删除报备状态为已通过审核或审核失败的A号码报备信息，不支持删除报备状态为审核中的A号码报备信息。'."\n"
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<AddSecretBlacklistResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n</AddSecretBlacklistResponse>","errorExample":""}]',
+ 'title' => '添加黑名单',
+ 'summary' => '向号码池添加黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。',
+ 'description' => '- 此接口不是批处理接口，仅支持一次添加一组**点对点黑名单**号码，或者一个**号池黑名单**号码。'."\n"
+ .'- 若需删除黑名单，可调用[DeleteSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-deletesecretblacklist)接口。'."\n"
+ .'### 数量限制'."\n"
+ .'本接口的单号池数量限制为200万个，超过限制，API调用添加黑名单号码将会失败，这可能会影响您的业务，如需特殊要求请联系您的阿里云商务经理。'."\n"
."\n"
- .'- 删除A号码报备信息后运营商将直接对该号码实施限呼拦截或关停，可能影响您的业务连续性，请谨慎操作。',
- ],
- 'QuerySecretAPhoneNoToCust' => [
- 'summary' => 'A号码报备状态查询。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:AddSecretBlacklist',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'BindAXBCall' => [
+ 'summary' => '接入方调用本接口向工作号平台请求为员工B的工作号X建立呼叫绑定关系（B，X，A），允许员工B通过工作号X呼叫客户A。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '244980',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PhoneNoA',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A号码',
- 'description' => 'A号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '130*****8888',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'ANoWhiteGroupId',
+ 'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'title' => '号码组ID',
- 'description' => '号码组ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '58',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
+ ],
+ [
+ 'name' => 'CustomerPoolKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
+ ],
+ [
+ 'name' => 'TelA',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户A号码', 'description' => '客户A号码。', 'type' => 'string', 'required' => true, 'example' => '13*******43'],
+ ],
+ [
+ 'name' => 'AuthId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'authId绑定关系BX唯一id', 'description' => '绑定关系BX唯一id。', 'type' => 'string', 'required' => true, 'example' => '12353'],
+ ],
+ [
+ 'name' => 'Expiration',
+ 'in' => 'query',
+ 'schema' => ['title' => '绑定关系过期失效时间： 取值必须大于0； 单位：秒，ct_time + expiration = 自动解绑时间', 'description' => '绑定关系过期失效时间：取值必须大于0；单位：秒，绑定时间 + 过期失效时间 = 自动解绑时间。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7200'],
+ ],
+ [
+ 'name' => 'UserData',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户自定义参数回调带回', 'description' => '回传参数，客户可自定义。', 'type' => 'string', 'required' => false, 'example' => '000'],
],
],
'responses' => [
@@ -298,377 +325,458 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'title' => '返回id',
- 'description' => '返回ID。',
- 'type' => 'string',
- 'example' => '1D73E648-0978-18A5-B089-3BB2',
- ],
- 'Message' => [
- 'title' => '失败错误提示',
- 'description' => '失败错误提示。',
- 'type' => 'string',
- 'example' => '号码组不存在',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
- 'title' => 'A号码报备状态查询结构体',
- 'description' => 'A号码报备状态查询结构体。',
'type' => 'object',
'properties' => [
- 'NoType' => [
- 'title' => '号码类型',
- 'description' => '号码类型。取值：'."\n"
- ."\n"
- .'- Mobile：手机号。'."\n"
- ."\n"
- .'- Fixed：固话。',
- 'type' => 'string',
- 'example' => 'Mobile',
- ],
- 'CustPhoneNo' => [
- 'title' => '固话报备的经办人/法人电话',
- 'description' => '固话报备的经办人/法定代表人电话。',
- 'type' => 'string',
- 'example' => '130*****8888',
- ],
- 'ReportResult' => [
- 'title' => '报备失败原因',
- 'description' => '审核失败原因。',
- 'type' => 'string',
- 'example' => '["系统判断为不同人"]',
- ],
- 'ReportStatus' => [
- 'title' => '报备结果',
- 'description' => '报备结果。取值：'."\n"
- ."\n"
- .'- REVIEWING：审核中。'."\n"
- ."\n"
- .'- PASS：审核通过。'."\n"
- ."\n"
- .'- FAIL：审核不通过。',
- 'type' => 'string',
- 'example' => 'REVIEWING',
- ],
- 'ANoWhiteGroupId' => [
- 'title' => '所属a号码组id',
- 'description' => '所属A号码组ID。',
- 'type' => 'string',
- 'example' => '19',
- ],
- 'PhoneNoA' => [
- 'title' => 'A号码',
- 'description' => 'A号码。',
- 'type' => 'string',
- 'example' => '130*****1234',
- ],
- 'Remark' => [
- 'title' => '备注（客户自己的业务备注，可编辑）',
- 'description' => '备注（用户自身的业务备注）。',
- 'type' => 'string',
- 'example' => '***报备',
- ],
+ 'BindId' => ['title' => '绑定关系ID', 'description' => '绑定关系ID', 'type' => 'string', 'example' => '476567566'],
],
- ],
- 'Code' => [
- 'title' => '请求状态码',
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '请求是否成功',
- 'description' => '请求是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'example' => '',
+ 'description' => '',
+ ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"BindId\\": \\"476567566\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AXB呼叫绑定',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAXBCall',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"号码组不存在\\",\\n \\"Data\\": {\\n \\"NoType\\": \\"Mobile\\",\\n \\"CustPhoneNo\\": \\"130*****8888\\",\\n \\"ReportResult\\": \\"[\\\\\\"系统判断为不同人\\\\\\"]\\",\\n \\"ReportStatus\\": \\"REVIEWING\\",\\n \\"ANoWhiteGroupId\\": \\"19\\",\\n \\"PhoneNoA\\": \\"130*****1234\\",\\n \\"Remark\\": \\"***报备\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询A号码报备状态',
- 'description' => '您在调用此接口查询A号码报备状态前，请先调用[CreatePhoneNoAReport](~~2880908~~)或[CreateFixedNoAReport](~~2881429~~)接口进行提交A号码手机号或固话个人实名信息。具体操作请参见[API提交A号码个人实名信息](~~2880077~~)。',
],
- 'CreateFixedNoAReport' => [
- 'summary' => '通过API提交A号码固话个人信息报备。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'BindAxb' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72608',
+ 'abilityTreeNodes' => ['FEATUREdyplsU6B07Q'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
'parameters' => [
[
- 'name' => 'FixedNoA',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => 'a号码(固话)',
- 'description' => 'A号码（固话）。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '89*****1234',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'>在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'ANoWhiteGroupId',
+ 'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'title' => '所属a号码组id',
- 'description' => '所属A号码组ID。在[资质管理](https://dyplsnext.console.aliyun.com/qualification)页面所属资质的A号码白名单栏单击查看详情。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '12',
- ],
+ 'schema' => ['description' => 'AXB中间号的A号码。'."\n"
+ ."\n"
+ .'>- A号码可设置为**手机号码**或**固定电话**，固定电话请加区号，区号和固定电话之间不需要连字符。'."\n"
+ .'>- 如果您的业务需要修改已绑定的号码，可以调用[UpdateSubscription](~~110253~~)接口进行修改，控制台可以绑定或解绑号码，暂时不支持修改已绑定的号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****0000'],
],
[
- 'name' => 'DocumentType',
+ 'name' => 'PhoneNoB',
'in' => 'query',
- 'schema' => [
- 'title' => '证件类型 填写1表示身份证',
- 'description' => '证件类型，填写1表示身份证。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => 'AXB中间号的B号码。'."\n"
+ ."\n"
+ .'>- B号码可设置为**手机号码**或**固定电话**，固定电话请加区号，区号和固定电话中间不需要连字符。'."\n"
+ .'> - 如果您的业务需要修改已绑定的号码，可以调用[UpdateSubscription](~~110253~~)接口进行修改，控制台可以绑定或解绑号码，暂时不支持修改已绑定的号码。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '136****0000'],
],
[
- 'name' => 'CustName',
+ 'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'title' => '姓名',
- 'description' => '姓名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '赵**',
- ],
+ 'schema' => ['description' => 'AXB中间号的X号码。'."\n"
+ ."\n"
+ .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
+ ."\n"
+ .'> - 如果您未填写X号码，系统会根据**ExpectCity**参数值从指定号码池中随机选择一个号码作为X号码。'."\n"
+ .'> - 如果当前号码池中没有该城市的X号码，或未填写**ExpectCity**参数值，系统会从指定号码池中随机分配一个其他城市的号码作为X号码。'."\n"
+ .'> - 如果X号码分配模式配置为**严格匹配模式**，默认分配A号码所属城市号码，如果该城市无号码，返回绑定号码失败。号码分配模式操作请参见[配置号码池](https://help.aliyun.com/zh/pnp/user-guide/manage-phone-number-pools?spm=a2c4g.11186623.0.0.689e7d22cbD4Um#section-st9-xl1-l3c)。', 'type' => 'string', 'required' => false, 'example' => '171****1893'],
],
[
- 'name' => 'DocumentNumber',
+ 'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'title' => '证件号码',
- 'description' => '证件号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '370*********',
- ],
+ 'schema' => ['description' => '号码绑定的过期时间。'."\n"
+ ."\n"
+ .'> - 必须晚于当前绑定时间1分钟以上，时间精确到秒。'."\n"
+ .'>- 号码绑定过期时间内，您可随时进行手动解绑。'."\n"
+ .'>- 若您对正在通话中的号码进行解绑，不会影响本次通话。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-05 12:00:00'],
],
[
- 'name' => 'CustType',
+ 'name' => 'ExpectCity',
'in' => 'query',
- 'schema' => [
- 'title' => '固话客户类型 1:法人,2:经办人',
- 'description' => '固话客户类型。取值：'."\n"
- ."\n"
- .'- 1：法定代表人。'."\n"
- ."\n"
- .'- 2：经办人。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '指定城市进行X号码的选号。'."\n"
+ ."\n"
+ .'> - 如果当前号码池中没有该城市的X号码，或未填写**ExpectCity**参数值，系统会从指定号码池中随机分配一个其他城市的号码作为X号码。'."\n"
+ .'> - 如果X号码分配模式配置为**严格匹配模式**，即默认分配A号码所属城市号码，如果该城市无号码，返回绑定号码失败。号码分配模式操作请参见[配置号码池](https://help.aliyun.com/zh/pnp/user-guide/manage-phone-number-pools?spm=a2c4g.11186623.0.0.689e7d22cbD4Um#section-st9-xl1-l3c)。', 'type' => 'string', 'required' => false, 'example' => '北京'],
],
[
- 'name' => 'FixedLineWorkId',
+ 'name' => 'IsRecordingEnabled',
'in' => 'query',
- 'schema' => [
- 'title' => '固话申请时服务大厅工单号',
- 'description' => '固话申请时线下服务大厅工单号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '45***12',
- ],
+ 'schema' => ['description' => '是否开启通话录音功能。取值：'."\n"
+ ."\n"
+ .'- **true**：录音。'."\n"
+ .'- **false**：不录音（默认值）。'."\n"
+ ."\n"
+ .'>开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'IdCardFrontPhoto',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'title' => '身份证正面照片oss路径地址',
- 'description' => '身份证正面（国徽面）照片OSS路径地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456/test1719383196031.jpg',
- ],
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
- 'name' => 'IdCardBackPhoto',
+ 'name' => 'OutOrderId',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部业务ID。', 'type' => 'string', 'required' => false, 'example' => '34553330****'],
+ ],
+ [
+ 'name' => 'CallRestrict',
'in' => 'query',
'schema' => [
- 'title' => '身份证反面照片oss路径地址',
- 'description' => '身份证反面（人像面）照片OSS路径地址。',
+ 'description' => '单次呼叫限制的状态。取值：'."\n"
+ ."\n"
+ .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。',
'type' => 'string',
'required' => false,
- 'example' => '123456/test1719383196032.jpg',
+ 'example' => 'CONTROL_AX_DISABLE',
+ 'enum' => ['CONTROL_AX_DISABLE', 'CONTROL_BX_DISABLE', 'CONTROL_CLEAR_DISABLE'],
],
],
[
- 'name' => 'IdCardAlivePhoto',
+ 'name' => 'CallDisplayType',
'in' => 'query',
- 'schema' => [
- 'title' => '正面人像照片 OSS 路径地址',
- 'description' => '正面人像照片OSS路径地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456/test1719383196033.jpg',
- ],
+ 'schema' => ['description' => '重置绑定关系中的号码显示逻辑。固定取值**1**，即主叫和被叫显示中间号码X。'."\n"
+ ."\n"
+ .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Remark',
+ 'name' => 'RingConfig',
'in' => 'query',
- 'schema' => [
- 'title' => '备注（客户自己的业务备注，可编辑）',
- 'description' => '备注（用户自身的业务备注）。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '***报备',
- ],
+ 'schema' => ['description' => '彩铃配置，AXB中间号号码绑定后，拨打X号码的企业彩铃；此参数请填写**铃音字段**和**彩铃编码**。'."\n"
+ ."\n"
+ .'**铃音字段**如下：'."\n"
+ .'- A号码拨打X接通前的铃音设置：AXBRing_A'."\n"
+ .'- B号码拨打X接通前的铃音设置：AXBRing_B'."\n"
+ .'- A号码拨打X接通后的铃音设置：AXBRing_A_PICKUP'."\n"
+ .'- B号码拨打X接通后的铃音设置：AXBRing_B_PICKUP'."\n"
+ ."\n"
+ .'**彩铃编码**：在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
+ ."\n"
+ .'**填写示例**： 如设置B号码拨打X接通前的铃音，填写："AXBRing_B": "1000****1"。'."\n"
+ ."\n"
+ .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "AXBRing_B": "1000****1",'."\n"
+ .' "AXBRing_A": "1000****1"'."\n"
+ .'}'],
],
[
- 'name' => 'CustPhoneNo',
+ 'name' => 'ASRStatus',
'in' => 'query',
- 'schema' => [
- 'title' => '经办人/法人电话',
- 'description' => '法定代表人/经办人手机号'."\n"
- .'>若该资质下有移动X号码，则此字段必填，否则将审核不通过。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '130*****8888',
- ],
+ 'schema' => ['description' => '是否开启ASR服务功能。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭（默认值）。'."\n"
+ .'- **true**：开启。'."\n"
+ ."\n"
+ .'> 开通功能后，可以将通话中的语音转为文本，获取录音文件同时可获取文本内容。可在呼叫记录中下载语音文本。 文本结果按通话分钟计费，ASR费用0.060元/分钟。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ASRModelId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ASR模型ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ ."\n"
+ .'- 通用-电话-中文粤语模型ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ ."\n"
+ .'- 通用-电话-地方口音模型ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
+ ],
+ [
+ 'name' => 'CallTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '顺振时长。单位：秒。取值范围为5~20。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '180', 'minimum' => '0', 'example' => '10秒', 'default' => '15'],
+ ],
+ [
+ 'name' => 'DtmfConfig',
+ 'in' => 'query',
+ 'schema' => ['description' => 'dtmf按键配置，设置AXB中间号号码绑定时使用，可配置内容如下：'."\n"
+ .'- endCallIvrPhoneNo：放音对象A或B。'."\n"
+ .'- waitingDtmfTime：放完第一段音后的最大等待时长，最大时长为30秒。'."\n"
+ .'- maxLoop dtmf：按键不匹配，循环播放第一个放音文件的最大次数，最大循环次数为5次。'."\n"
+ .'- step1File：第一个放音文件名称。'."\n"
+ .'- step2File：第二个放音文件名称。'."\n"
+ .'- validKey：合法按键值定义，如：1,2只允许配置两个有效键值，用","分隔。'."\n"
+ .'- waitingEndCall：运营商挂机等待时长，最大等待时长为10秒。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "endCallIvrPhoneNo":"A",'."\n"
+ .' "waitingDtmfTime":10,'."\n"
+ .' "maxLoop":3,'."\n"
+ .' "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav",'."\n"
+ .' "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav",'."\n"
+ .' "validKey":"1,2",'."\n"
+ .' "waitingEndCall":2'."\n"
+ .'}'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'title' => '返回id',
- 'description' => '返回ID。',
- 'type' => 'string',
- 'example' => '1D73E648-0978-18A5-B089-3BB2',
- ],
- 'Message' => [
- 'title' => '失败错误提示',
- 'description' => '失败错误提示。',
- 'type' => 'string',
- 'example' => '固话号码***已存在',
- ],
- 'Data' => [
- 'title' => 'A号码报备结果结构体',
- 'description' => 'A号码报备结果结构体。',
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050******'],
+ 'SecretBindDTO' => [
+ 'description' => '号码绑定成功后返回的结构体。',
'type' => 'object',
'properties' => [
- 'CreateResult' => [
- 'title' => '创建结果',
- 'description' => '创建结果。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'FailType' => [
- 'title' => '创建类型枚举，1为成功，负数为创建失败',
- 'description' => '创建类型枚举，1表示成功，负数表示创建失败。取值：'."\n"
- ."\n"
- .'- 1：成功。'."\n"
- ."\n"
- .'- -1：该手机号已经提交报备，无需再次提交报备。'."\n"
- ."\n"
- .'- -2：该手机号已报备成功，无需再次报备。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Extension' => ['description' => '接口BindAxb不涉及此参数，请忽略该返回参数。', 'type' => 'string', 'example' => '130'],
+ 'SubsId' => ['description' => '号码绑定ID。'."\n"
+ ."\n"
+ .'>您可以用返回的**号码绑定ID**，调用[QuerySubscriptionDetail](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-querysubscriptiondetail?spm=a2c4g.11186623.0.0.122b4d02RB4KDs)接口，查询号码绑定详情。', 'type' => 'string', 'example' => '100017838816****'],
+ 'SecretNo' => ['description' => '已购买的隐私号码，即X号码。', 'type' => 'string', 'example' => '171****1893'],
],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '请求状态码',
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '请求是否成功',
- 'description' => '请求是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"固话号码***已存在\\",\\n \\"Data\\": {\\n \\"CreateResult\\": true,\\n \\"FailType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交A号码固话个人实名信息',
- 'description' => '在调用此接口前，您需要先调用[GetDyplsOSSInfoForUploadFile](~~2880885~~)将个人照片信息上传至OSS，具体操作流程请参见[API提交A号码个人实名信息](~~2880077~~)。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\",\\n \\"SecretBindDTO\\": {\\n \\"Extension\\": \\"130\\",\\n \\"SubsId\\": \\"100017838816****\\",\\n \\"SecretNo\\": \\"171****1893\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<BindAxbResponse>\\n<SecretBindDTO>\\n <Extension>130</Extension>\\n <SecretNo>170****0000</SecretNo>\\n <SubsId>10000007683*****</SubsId>\\n</SecretBindDTO>\\n<Message>OK</Message>\\n<RequestId>9297B722-A016-43FB-B51A-E54050D9369D</RequestId>\\n<Code>OK</Code>\\n<BindAxbResponse>","errorExample":""}]',
+ 'title' => 'AXB中间号-号码绑定',
+ 'summary' => 'AXB中间号，是将拨打关系限定在一对一关系中，用户A可以通过中间号码X联系到用户B，用户B也可以通过中间号码X联系到用户A。',
+ 'description' => '- 在调用此接口前，请确保您已在控制台[购买隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
+ ."\n"
+ .'- 您可以使用此接口给AXB中间号绑定号码，也可以在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list?resType=1&billId=FC100000165392498)页面给AXB中间号绑定A、B号码。'."\n"
+ ."\n"
+ .'- AXB中间号，绑定号码前建议您先明确业务场景中的A角色和B角色。例如：在打车应用场景中，A是乘客角色，B是司机角色。'."\n"
+ ."\n"
+ .'- AXB中间号主要应用在1对1场景下的隐私保护，客户把A号码和B号码通过号码隐私服务实现绑定关系，A拨打X转接到B，B拨打X转接到A；一个X号码可以供200对绑定关系复用，如A1XB1、A2XB2、A3XB3......，只要A、B用户手机号码不重复，一个X号码可同时绑定200组手机号码，通话也可以同时进行。'."\n"
+ ."\n"
.'### QPS限制'."\n"
- .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- ],
- 'GetDyplsOSSInfoForUploadFile' => [
- 'summary' => '获取OSS资源配置信息，此配置信息将用于后续OSS图片上传操作。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxb',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'BindAxb700' => [
+ 'summary' => '700AXB中间号，是将拨打关系限定在一对一关系中，用户A可以通过700开头的中间号码X联系到用户B，用户B也可以通过700开头的中间号码X联系到用户A。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'none',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '283900',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'BizType',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '业务类型。'."\n"
- .'默认值为：phone_card。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'phone_card',
- ],
+ 'schema' => ['description' => '号码池Key。', 'type' => 'string', 'required' => true, 'example' => 'FC2258****'],
+ ],
+ [
+ 'name' => 'Expiration',
+ 'in' => 'query',
+ 'schema' => ['description' => '号码绑定的过期时间。'."\n"
+ ."\n"
+ .'> - 必须晚于当前绑定时间1分钟以上，时间精确到秒。'."\n"
+ .'>- 号码绑定过期时间内，您可随时进行手动解绑。'."\n"
+ .'>- 若您对正在通话中的号码进行解绑，不会影响本次通话。', 'type' => 'string', 'required' => true, 'example' => '2021-09-05 12:00:00'],
+ ],
+ [
+ 'name' => 'TelA',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户A号码', 'type' => 'string', 'required' => true, 'example' => '139****0000'],
+ ],
+ [
+ 'name' => 'TelB',
+ 'in' => 'query',
+ 'schema' => ['description' => '用户B号码', 'type' => 'string', 'required' => true, 'example' => '136****0000'],
+ ],
+ [
+ 'name' => 'TelX',
+ 'in' => 'query',
+ 'schema' => ['description' => '可选 中间号X。'."\n"
+ .'> - 业务使用方未指定X号码时，'."\n"
+ .'> - 由应用平台从号码池中指定一个号码作为X号码。', 'type' => 'string', 'required' => false, 'example' => '700********0000'],
+ ],
+ [
+ 'name' => 'NeedRecord',
+ 'in' => 'query',
+ 'schema' => ['description' => '用于表示业务使用方是否需要该号码绑定关系产生的所有通话媒体文件。取值：'."\n"
+ ."\n"
+ .'- true：录音。'."\n"
+ ."\n"
+ .'- false：不录音（默认值）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'RecType',
+ 'in' => 'query',
+ 'schema' => ['description' => '录音类型，mp3、wav。', 'type' => 'string', 'required' => false, 'example' => 'mp3'],
+ ],
+ [
+ 'name' => 'CallRestrict',
+ 'in' => 'query',
+ 'schema' => ['description' => '单通呼叫限制逻辑。取值：'."\n"
+ ."\n"
+ .'- CONTROL_AX_DISABLE：A号码无法呼叫 X 号码。'."\n"
+ ."\n"
+ .'- CONTROL_BX_DISABLE：B号码无法呼叫 X 号码。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
+ ],
+ [
+ 'name' => 'Audio',
+ 'in' => 'query',
+ 'schema' => ['description' => '放音编码。'."\n"
+ ."\n"
+ .'- ACallX_Apre A呼叫X号码时，呼叫接通前，向A播放的语音提示放音编码。'."\n"
+ .'- ACallX_Ain A呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
+ .'- ACallX_Bin A呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
+ .'- BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
+ .'- BCallX_Ain B呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
+ .'- BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。', 'type' => 'string', 'required' => false, 'example' => ' {'."\n"
+ .'"ACallX_Apre":"185"'."\n"
+ .'}'],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => ['description' => '业务订单编码。'."\n"
+ ."\n"
+ .'- 该编码与真实业务订单是一一对应关系，且不可重复。'."\n"
+ ."\n"
+ .'- 编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
+ ."\n"
+ .'- 当业务使用方提交业务订单编码，由应用平台生成工业互联网标识编码时，该字段必选。'."\n"
+ .'> '."\n"
+ .'> - OrderId与IndustrialId两个字段按业务情况必选其一', 'type' => 'string', 'required' => false, 'example' => '12345678'],
+ ],
+ [
+ 'name' => 'IndustrialId',
+ 'in' => 'query',
+ 'schema' => ['description' => '工业互联网标识编码，与OrderID保持一一对应关系。'."\n"
+ ."\n"
+ .'编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
+ ."\n"
+ .'当业务使用方自行生成工业互联网标识编码时，该字段必选。'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> - OrderId与IndustrialId两个字段按业务情况必选其一', 'type' => 'string', 'required' => false, 'example' => '700.100.1/12345678'],
+ ],
+ [
+ 'name' => 'OutId',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
+ ],
+ [
+ 'name' => 'OutOrderId',
+ 'in' => 'query',
+ 'schema' => ['description' => '外部业务 ID。', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh'],
+ ],
+ [
+ 'name' => 'NeedAsr',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否开启 ASR 服务功能。取值：'."\n"
+ ."\n"
+ .'- false：关闭（默认值）。'."\n"
+ ."\n"
+ .'- true：开启。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'AsrModelId',
+ 'in' => 'query',
+ 'schema' => ['description' => '可选 ASR 模型 ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
+ ],
+ [
+ 'name' => 'CallTimeout',
+ 'in' => 'query',
+ 'schema' => ['description' => '顺振时长。单位：秒。取值范围为 5~20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'DtmfConfig',
+ 'in' => 'query',
+ 'schema' => ['description' => '可选 dtmf 按键配置，设置 AXB 中间号号码绑定时使用，可配置内容如下：'."\n"
+ ."\n"
+ .'- endCallIvrPhoneNo：放音对象 A 或 B。'."\n"
+ .'- waitingDtmfTime：放完第一段音后的最大等待时长，最大时长为 30 秒。'."\n"
+ .'- maxLoop dtmf：按键不匹配，循环播放第一个放音文件的最大次数，最大循环次数为 5 次。'."\n"
+ .'- step1File：第一个放音文件名称。'."\n"
+ .'- step2File：第二个放音文件名称。'."\n"
+ .'- validKey：合法按键值定义，如：1,2 只允许配置两个有效键值，用","分隔。'."\n"
+ .'- waitingEndCall：运营商挂机等待时长，最大等待时长为 10 秒。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .' "endCallIvrPhoneNo":"A",'."\n"
+ .' "waitingDtmfTime":10,'."\n"
+ .' "maxLoop":3,'."\n"
+ .' "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav",'."\n"
+ .' "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav",'."\n"
+ .' "validKey":"1,2",'."\n"
+ .' "waitingEndCall":2'."\n"
+ .'}'],
],
],
'responses' => [
@@ -676,202 +784,180 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E2FD3B2F-5028-16E3-9F83-2F76F99B3873',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050******'],
+ 'Message' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Policy' => [
- 'description' => '签名策略。',
- 'type' => 'string',
- 'example' => 'IjoiMjAyN*****9udGV',
- ],
- 'StartPath' => [
- 'description' => '策略路径。',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'AccessKeyId' => [
- 'description' => '签名使用的AccessKey ID。',
- 'type' => 'string',
- 'example' => 'YOUR_ACCESS_KEY_ID',
- ],
- 'Signature' => [
- 'description' => '根据**AccessKey Secret**和**Policy**计算出的签名信息。调用OSS API时，OSS验证该签名信息，从而确认Post请求的合法性。',
- 'type' => 'string',
- 'example' => 'BXwW**********aoZH',
- ],
- 'Host' => [
- 'description' => 'Host 地址。',
- 'type' => 'string',
- 'example' => 'https://alicom-**********-cn-zhangjiakou.aliyuncs.com',
- ],
- 'ExpireTime' => [
- 'description' => '到期时间。',
- 'type' => 'string',
- 'example' => '1744613007',
- ],
+ 'SecretNo' => ['description' => '已购买的700隐私号码，即 X 号码。', 'type' => 'string', 'example' => '700********0001'],
+ 'SubsId' => ['description' => '号码绑定 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123*******'],
],
],
- 'Code' => [
- 'description' => '请求状态码。取值：'."\n"
- .'* OK：代表请求成功。'."\n"
- .'* 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '返回是否成功。取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '返回状态码，取值：'."\n"
+ .'- OK：表示成功。'."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'- true：成功。'."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"E2FD3B2F-5028-16E3-9F83-2F76F99B3873\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Policy\\": \\"IjoiMjAyN*****9udGV\\",\\n \\"StartPath\\": \\"123456\\",\\n \\"AccessKeyId\\": \\"YOUR_ACCESS_KEY_ID\\",\\n \\"Signature\\": \\"BXwW**********aoZH\\",\\n \\"Host\\": \\"https://alicom-**********-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"1744613007\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取A号码报备OSS配置信息',
- 'description' => '- 您在上传A号码手机号个人报备照片时，需上传正面人像（照片清晰，人脸无遮挡）照片、选择上传身份证正反面照片（非必选）。上传后有助于审核人员了解您的个人身份信息。支持png、jpg、jpeg 格式，图片大小不要超过2M。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SecretNo\\": \\"700********0001\\",\\n \\"SubsId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '700AXB中间号-号码绑定',
+ 'description' => '在调用此接口前，请确保您已在控制台购买隐私号。'."\n"
+ .'您可以使用此接口给700AXB中间号绑定号码，也可以在控制台号码管理页面给700AXB中间号绑定A、B号码。'."\n"
+ .'700AXB中间号，绑定号码前建议您先明确业务场景中的A角色和B角色。例如：在打车应用场景中，A是乘客角色，B是司机角色。'."\n"
."\n"
- .'- 您在通过API提交A号码手机号个人实名报备时，具体操作流程请参见[API提交A号码手机号个人实名信息](~~2880077~~)。',
- ],
- 'CreatePhoneNoAReport' => [
- 'summary' => '通过API提交A号码手机号个人信息报备。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ .'700AXB中间号主要应用在1对1场景下的隐私保护，客户把A号码和B号码通过号码隐私服务实现绑定关系，A拨打X转接到B，B拨打X转接到A；一个X号码可以供200对绑定关系复用，如A1XB1、A2XB2、A3XB3......，只要A、B用户手机号码不重复，一个X号码可同时绑定200组手机号码，通话也可以同时进行。'."\n"
+ ."\n"
+ .'QPS限制'."\n"
+ ."\n"
+ .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
+ 'ramActions' => [],
+ ],
+ 'BindAxbFixedLine' => [
+ 'summary' => '固话绑定AXB隐私号，是将拨打关系限定在一对一关系中，用户A可以通过固话中间号码X联系到用户B，用户B也可以通过中间号码X联系到用户A。固话隐私号目前为邀约制，请联系您的技术支持进行服务开通，并提供对接支持。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '271000',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
'parameters' => [
[
- 'name' => 'PhoneNoA',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '手机号',
- 'description' => '手机号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '130*****1234',
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****', 'default' => ''],
],
[
- 'name' => 'ANoWhiteGroupId',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'title' => '所属a号码组id',
- 'description' => '所属A号码组ID。在[资质管理](https://dyplsnext.console.aliyun.com/qualification)页面所属资质的A号码白名单栏单击查看详情。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '19',
- ],
+ 'schema' => ['title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'DocumentType',
+ 'name' => 'BindType',
'in' => 'query',
- 'schema' => [
- 'title' => '证件类型 填写1表示身份证',
- 'description' => '证件类型，填写1表示身份证。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', 'description' => '绑定类型，取值：'."\n"
+ ."\n"
+ .'- mode101：客户指定X号码。'."\n"
+ ."\n"
+ .'- mode102：平台分配X号码。', 'type' => 'string', 'required' => true, 'example' => 'mode101'],
],
[
- 'name' => 'CustName',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '姓名',
- 'description' => '姓名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '赵**',
- ],
+ 'schema' => ['title' => '消息请求唯一标识。', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
- 'name' => 'DocumentNumber',
+ 'name' => 'TelA',
'in' => 'query',
- 'schema' => [
- 'title' => '证件号码',
- 'description' => '证件号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '370*********',
- ],
+ 'schema' => ['title' => '真实号码', 'description' => '固话AXB隐私号的A号码。'."\n"
+ ."\n"
+ .'> - A号码可设置为手机号码或固定电话，固定电话请加区号，区号和固定电话之间不需要连字符。 '."\n"
+ .'>- 如果您的业务需要修改已绑定的号码，可以调用[UpdateAxbBindFixedLine](~~2883050~~)接口进行修改。', 'type' => 'string', 'required' => true, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
],
[
- 'name' => 'IdCardFrontPhoto',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => '身份证正面照片oss路径地址',
- 'description' => '身份证正面（国徽面）照片OSS路径地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456/test1719383196031.jpg',
- ],
+ 'schema' => ['title' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数 格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '固话AXB隐私号的X号码。X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
+ ."\n"
+ .'> 客户指定X号码模式下（即BindType参数为mode101），本参数必填。', 'type' => 'string', 'required' => false, 'example' => '0571******23'],
],
[
- 'name' => 'IdCardBackPhoto',
+ 'name' => 'TelB',
'in' => 'query',
- 'schema' => [
- 'title' => '身份证反面照片oss路径地址',
- 'description' => '身份证反面（人像面）照片OSS路径地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123456/test1719383196032.jpg',
- ],
+ 'schema' => ['title' => '对端号码', 'description' => '固话AXB隐私号的B号码。'."\n"
+ ."\n"
+ .'> - B号码可设置为手机号码或固定电话，固定电话请加区号，区号和固定电话中间不需要连字符。'."\n"
+ .'> - 如果您的业务需要修改已绑定的号码，可以调用[UpdateAxbBindFixedLine](~~2883050~~)接口进行修改。', 'type' => 'string', 'required' => true, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
],
[
- 'name' => 'IdCardAlivePhoto',
+ 'name' => 'Subts',
'in' => 'query',
- 'schema' => [
- 'title' => '半身照oss路径地址',
- 'description' => '正面人像照片OSS路径地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123456/test1719383196033.jpg',
- ],
+ 'schema' => ['title' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'required' => true, 'example' => '20161114143116'],
+ ],
+ [
+ 'name' => 'Anucode',
+ 'in' => 'query',
+ 'schema' => ['title' => '主叫侧放音编码，AXB业务时必须设置。 放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', 'description' => '主叫侧放音编码，固话AXB隐私号业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。', 'type' => 'string', 'required' => true, 'example' => '1,2,3'],
+ ],
+ [
+ 'name' => 'Anucodecalled',
+ 'in' => 'query',
+ 'schema' => ['title' => '接通后被叫侧放音编码,接通后被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'TAnucodeConnect',
+ 'in' => 'query',
+ 'schema' => ['title' => '接通后主叫侧的放音编码,接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'Areacode',
+ 'in' => 'query',
+ 'schema' => ['title' => '区号,去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费。', 'description' => '区号。支持指定X号码归属地（指定城市->省会->全国路由）。不指定归属地，全国随机。', 'type' => 'string', 'required' => false, 'example' => '0571'],
+ ],
+ [
+ 'name' => 'Expiration',
+ 'in' => 'query',
+ 'schema' => ['title' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。', 'type' => 'string', 'required' => true, 'example' => '60'],
],
[
'name' => 'Remark',
'in' => 'query',
+ 'schema' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'required' => false, 'example' => '19394'],
+ ],
+ [
+ 'name' => 'Extra',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '备注（客户自己的业务备注，可编辑）',
- 'description' => '备注（用户自身的业务备注）。',
- 'type' => 'string',
+ 'title' => '扩展参数',
+ 'description' => '扩展参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callrecording' => ['title' => '录音控制，默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
'required' => false,
- 'example' => '***报备',
+ 'example' => '',
],
],
],
@@ -880,107 +966,74 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'title' => '返回id',
- 'description' => '返回ID。',
- 'type' => 'string',
- 'example' => '1D73E648-0978-18A5-B089-3BB2',
- ],
- 'Message' => [
- 'title' => '失败错误提示',
- 'description' => '失败错误提示。',
- 'type' => 'string',
- 'example' => '手机号码***已存在',
- ],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['title' => '响应消息', 'description' => '响应消息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '649E9EB5-9436-53CF-B41A-C4F0433212E7'],
'Data' => [
- 'title' => 'A号码报备结果结构体',
- 'description' => 'A号码报备结果结构体。',
+ 'title' => '响应内容',
+ 'description' => '响应内容。',
'type' => 'object',
'properties' => [
- 'CreateResult' => [
- 'title' => '创建结果',
- 'description' => '创建结果。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'FailType' => [
- 'title' => '创建类型枚举，1为成功，负数为创建失败',
- 'description' => '创建类型枚举，1表示成功，负数表示创建失败。取值：'."\n"
- ."\n"
- .'- 1：成功。'."\n"
- ."\n"
- .'- -1：该手机号已经提交报备，无需再次提交报备。'."\n"
- ."\n"
- .'- -2：该手机号已报备成功，无需再次报备。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'Subid' => ['title' => '绑定id', 'description' => '绑定id。', 'type' => 'string', 'example' => 'GHX0*************************'],
+ 'TelX' => ['title' => 'X号码', 'description' => 'X号码。', 'type' => 'string', 'example' => '0571******23'],
],
'example' => '',
],
- 'Code' => [
- 'title' => '请求状态码',
- 'description' => '请求状态码。',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '请求是否成功',
- 'description' => '请求是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '响应码 0-成功', 'description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['title' => '是否处理成功 true-成功', 'description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"649E9EB5-9436-53CF-B41A-C4F0433212E7\\",\\n \\"Data\\": {\\n \\"Subid\\": \\"GHX0*************************\\",\\n \\"TelX\\": \\"0571******23\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AXB固话隐私号-号码绑定',
+ 'description' => '- 在调用此接口前，请确保您已在控制台购买隐私号。您可以使用此接口给固话AXB中间号绑定号码，暂时不支持控制台号码管理页面给固话AXB中间号绑定A、B号码。'."\n"
+ ."\n"
+ .'- 绑定号码前建议您先明确业务场景中的A角色和B角色。例如：在打车应用场景中，A是乘客角色，B是司机角色。'."\n"
+ ."\n"
+ .'- 固话AXB中间号主要应用在1对1场景下的隐私保护，把A号码和B号码通过号码隐私服务实现绑定关系，A拨打X转接到B，B拨打X转接到A。一个固话X号码可以供N对绑定关系复用，如A1XB1、A2XB2、A3XB3......，只要A、B用户手机号码不重复，一个固话X号码可同时绑定N组手机号码，通话也可以同时进行。'."\n"
+ ."\n"
+ .'- 号码复用次数根据您购买的号码有所不同，具体复用次数可以在号码购买时与您的技术支持确认。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxbFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"手机号码***已存在\\",\\n \\"Data\\": {\\n \\"CreateResult\\": true,\\n \\"FailType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交A号码手机号个人实名信息',
- 'description' => '在调用此接口前，您需要先调用[GetDyplsOSSInfoForUploadFile](~~2880885~~)将个人照片信息上传至OSS，具体操作流程请参见[API提交A号码手机号个人实名信息](~~2880077~~)。'."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
],
- 'BindAxb' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BindAxg' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72608',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsU6B07Q',
- ],
+ 'abilityTreeCode' => '72609',
+ 'abilityTreeNodes' => ['FEATUREdyplsNPUT41'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -988,248 +1041,129 @@
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'>在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FC10000012345****'],
],
[
'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXB中间号的A号码。'."\n"
- ."\n"
- .'>- A号码可设置为**手机号码**或**固定电话**，固定电话请加区号，区号和固定电话之间不需要连字符。'."\n"
- .'>- 如果您的业务需要修改已绑定的号码，可以调用[UpdateSubscription](~~110253~~)接口进行修改，控制台可以绑定或解绑号码，暂时不支持修改已绑定的号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****0000',
- ],
+ 'schema' => ['description' => 'AXG隐私号的A号码。'."\n"
+ .'A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****0000'],
+ ],
+ [
+ 'name' => 'GroupId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'AXG中的G组ID，即GID。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.50fe545b5d568v)页面筛选出**AXG隐私号**，并单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
+ ."\n"
+ .'> G号码组中必须有一个及以上的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '200001234****'],
],
[
'name' => 'PhoneNoB',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXB中间号的B号码。'."\n"
- ."\n"
- .'>- B号码可设置为**手机号码**或**固定电话**，固定电话请加区号，区号和固定电话中间不需要连字符。'."\n"
- .'> - 如果您的业务需要修改已绑定的号码，可以调用[UpdateSubscription](~~110253~~)接口进行修改，控制台可以绑定或解绑号码，暂时不支持修改已绑定的号码。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '136****0000',
- ],
+ 'schema' => ['description' => 'AXG隐私号的B号码。'."\n"
+ ."\n"
+ .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
+ .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
+ .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXG隐私号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
+ .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i16)接口更新。', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXB中间号的X号码。'."\n"
- ."\n"
- .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
- ."\n"
- .'> - 如果您未填写X号码，系统会根据**ExpectCity**参数值从指定号码池中随机选择一个号码作为X号码。'."\n"
- .'> - 如果当前号码池中没有该城市的X号码，或未填写**ExpectCity**参数值，系统会从指定号码池中随机分配一个其他城市的号码作为X号码。'."\n"
- .'> - 如果X号码分配模式配置为**严格匹配模式**，默认分配A号码所属城市号码，如果该城市无号码，返回绑定号码失败。号码分配模式操作请参见[配置号码池](https://help.aliyun.com/zh/pnp/user-guide/manage-phone-number-pools?spm=a2c4g.11186623.0.0.689e7d22cbD4Um#section-st9-xl1-l3c)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '171****1893',
- ],
+ 'schema' => ['description' => 'AXG隐私号的X号码。'."\n"
+ ."\n"
+ .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。'."\n"
+ ."\n"
+ .'> 如果未指定X号码时，将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。', 'type' => 'string', 'required' => false, 'example' => '139****1111'],
],
[
'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'description' => '号码绑定的过期时间。'."\n"
- ."\n"
- .'> - 必须晚于当前绑定时间1分钟以上，时间精确到秒。'."\n"
- .'>- 号码绑定过期时间内，您可随时进行手动解绑。'."\n"
- .'>- 若您对正在通话中的号码进行解绑，不会影响本次通话。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2021-09-05 12:00:00',
- ],
+ 'schema' => ['description' => '绑定关系的过期时间，时间单位精确到秒。'."\n"
+ .'>必须晚于当前时间1分钟以上。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-05 12:00:00'],
],
[
'name' => 'ExpectCity',
'in' => 'query',
- 'schema' => [
- 'description' => '指定城市进行X号码的选号。'."\n"
- ."\n"
- .'> - 如果当前号码池中没有该城市的X号码，或未填写**ExpectCity**参数值，系统会从指定号码池中随机分配一个其他城市的号码作为X号码。'."\n"
- .'> - 如果X号码分配模式配置为**严格匹配模式**，即默认分配A号码所属城市号码，如果该城市无号码，返回绑定号码失败。号码分配模式操作请参见[配置号码池](https://help.aliyun.com/zh/pnp/user-guide/manage-phone-number-pools?spm=a2c4g.11186623.0.0.689e7d22cbD4Um#section-st9-xl1-l3c)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
+ 'schema' => ['description' => '指定城市进行X号码的选号。'."\n"
+ ."\n"
+ .'> - 如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
+ .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。', 'type' => 'string', 'required' => false, 'example' => '北京'],
],
[
'name' => 'IsRecordingEnabled',
'in' => 'query',
- 'schema' => [
- 'description' => '是否开启通话录音功能。取值：'."\n"
- ."\n"
- .'- **true**：录音。'."\n"
- .'- **false**：不录音（默认值）。'."\n"
- ."\n"
- .'>开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '是否需要针对该绑定关系产生的所有通话录制通话录音。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
'name' => 'OutOrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '34553330****',
- ],
- ],
- [
- 'name' => 'CallRestrict',
- 'in' => 'query',
- 'schema' => [
- 'description' => '单次呼叫限制的状态。取值：'."\n"
- ."\n"
- .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
- 'enum' => [
- 'CONTROL_AX_DISABLE',
- 'CONTROL_BX_DISABLE',
- 'CONTROL_CLEAR_DISABLE',
- ],
- ],
+ 'schema' => ['description' => '外部业务ID。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
'name' => 'CallDisplayType',
'in' => 'query',
- 'schema' => [
- 'description' => '重置绑定关系中的号码显示逻辑。固定取值**1**，即主叫和被叫显示中间号码X。'."\n"
- ."\n"
- .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '重置绑定关系中的号码显示逻辑。固定取值： **1**（主被叫显示中间号码X）。'."\n"
+ ."\n"
+ .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'RingConfig',
'in' => 'query',
- 'schema' => [
- 'description' => '彩铃配置，AXB中间号号码绑定后，拨打X号码的企业彩铃；此参数请填写**铃音字段**和**彩铃编码**。'."\n"
- ."\n"
- .'**铃音字段**如下：'."\n"
- .'- A号码拨打X接通前的铃音设置：AXBRing_A'."\n"
- .'- B号码拨打X接通前的铃音设置：AXBRing_B'."\n"
- .'- A号码拨打X接通后的铃音设置：AXBRing_A_PICKUP'."\n"
- .'- B号码拨打X接通后的铃音设置：AXBRing_B_PICKUP'."\n"
- ."\n"
- .'**彩铃编码**：在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
- ."\n"
- .'**填写示例**： 如设置B号码拨打X接通前的铃音，填写："AXBRing_B": "1000****1"。'."\n"
- ."\n"
- .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "AXBRing_B": "1000****1",'."\n"
- .' "AXBRing_A": "1000****1"'."\n"
- .'}',
- ],
+ 'schema' => ['description' => '设置AXG隐私号在号码绑定后，拨打X号码的企业彩铃。'."\n"
+ ."\n"
+ .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
+ ."\n"
+ .'**铃音字段**取值：'."\n"
+ .'- AXG中，A号码打X的铃音设置（有回拨号码）：AXGRing_AB'."\n"
+ .'- AXG中，A号码打X的铃音设置（无回拨号码）：AXGRing_A'."\n"
+ .'- AXG中，G组号码打X的铃音设置：AXGRing_G'."\n"
+ ."\n"
+ .'**彩铃编码**：'."\n"
+ ."\n"
+ .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
+ ."\n"
+ .'**填写示例**：'."\n"
+ ."\n"
+ .'如设置G组号码打X的铃音，填写："AXGRing_G": "1000****1"。'."\n"
+ ."\n"
+ .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。', 'type' => 'string', 'required' => false, 'example' => '{"AXGRing_AB":"1000****1","AXGRing_A":"1000****2","AXGRing_G":"1000****3"}'],
],
[
'name' => 'ASRStatus',
'in' => 'query',
- 'schema' => [
- 'description' => '是否开启ASR服务功能。取值：'."\n"
- ."\n"
- .'- **false**：关闭（默认值）。'."\n"
- .'- **true**：开启。'."\n"
- ."\n"
- .'> 开通功能后，可以将通话中的语音转为文本，获取录音文件同时可获取文本内容。可在呼叫记录中下载语音文本。 文本结果按通话分钟计费，ASR费用0.060元/分钟。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => 'ASR状态。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭（默认值）'."\n"
+ .'- **true**：开启', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
'name' => 'ASRModelId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- ."\n"
- .'- 通用-电话-中文粤语模型ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- ."\n"
- .'- 通用-电话-地方口音模型ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'schema' => ['description' => 'ASR模型ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ ."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ ."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '9b4afe3d224e4fa3bf963697113e2f77'],
],
[
- 'name' => 'CallTimeout',
- 'in' => 'query',
- 'schema' => [
- 'description' => '顺振时长。单位：秒。取值范围为5~20。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '180',
- 'minimum' => '0',
- 'example' => '10秒',
- 'default' => '15',
- ],
- ],
- [
- 'name' => 'DtmfConfig',
+ 'name' => 'CallRestrict',
'in' => 'query',
- 'schema' => [
- 'description' => 'dtmf按键配置，设置AXB中间号号码绑定时使用，可配置内容如下：'."\n"
- .'- endCallIvrPhoneNo：放音对象A或B。'."\n"
- .'- waitingDtmfTime：放完第一段音后的最大等待时长，最大时长为30秒。'."\n"
- .'- maxLoop dtmf：按键不匹配，循环播放第一个放音文件的最大次数，最大循环次数为5次。'."\n"
- .'- step1File：第一个放音文件名称。'."\n"
- .'- step2File：第二个放音文件名称。'."\n"
- .'- validKey：合法按键值定义，如：1,2只允许配置两个有效键值，用","分隔。'."\n"
- .'- waitingEndCall：运营商挂机等待时长，最大等待时长为10秒。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "endCallIvrPhoneNo":"A",'."\n"
- .' "waitingDtmfTime":10,'."\n"
- .' "maxLoop":3,'."\n"
- .' "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav",'."\n"
- .' "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav",'."\n"
- .' "validKey":"1,2",'."\n"
- .' "waitingEndCall":2'."\n"
- .'}',
- ],
+ 'schema' => ['description' => '通话呼叫限制的状态。取值：'."\n"
+ ."\n"
+ .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
],
],
'responses' => [
@@ -1238,80 +1172,59 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050******',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'],
'SecretBindDTO' => [
- 'description' => '号码绑定成功后返回的结构体。',
+ 'description' => '绑定成功后返回的结构体。',
'type' => 'object',
'properties' => [
- 'Extension' => [
- 'description' => '接口BindAxb不涉及此参数，请忽略该返回参数。',
- 'type' => 'string',
- 'example' => '130',
- ],
- 'SubsId' => [
- 'description' => '号码绑定ID。'."\n"
- ."\n"
- .'>您可以用返回的**号码绑定ID**，调用[QuerySubscriptionDetail](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-querysubscriptiondetail?spm=a2c4g.11186623.0.0.122b4d02RB4KDs)接口，查询号码绑定详情。',
- 'type' => 'string',
- 'example' => '100017838816****',
- ],
- 'SecretNo' => [
- 'description' => '已购买的隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '171****1893',
- ],
+ 'Extension' => ['description' => '分机号码。'."\n"
+ ."\n"
+ .'> 接口BindAxg不涉及分机号码，请忽略该返回参数。', 'type' => 'string', 'example' => '130'],
+ 'SubsId' => ['description' => '绑定关系ID。', 'type' => 'string', 'example' => '1************3'],
+ 'SecretNo' => ['description' => '隐私号码，即X号码。', 'type' => 'string', 'example' => '139****1111'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\",\\n \\"SecretBindDTO\\": {\\n \\"Extension\\": \\"130\\",\\n \\"SubsId\\": \\"100017838816****\\",\\n \\"SecretNo\\": \\"171****1893\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<BindAxbResponse>\\n<SecretBindDTO>\\n <Extension>130</Extension>\\n <SecretNo>170****0000</SecretNo>\\n <SubsId>10000007683*****</SubsId>\\n</SecretBindDTO>\\n<Message>OK</Message>\\n<RequestId>9297B722-A016-43FB-B51A-E54050D9369D</RequestId>\\n<Code>OK</Code>\\n<BindAxbResponse>","errorExample":""}]',
- 'title' => 'AXB中间号-号码绑定',
- 'summary' => 'AXB中间号，是将拨打关系限定在一对一关系中，用户A可以通过中间号码X联系到用户B，用户B也可以通过中间号码X联系到用户A。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SecretBindDTO\\": {\\n \\"Extension\\": \\"130\\",\\n \\"SubsId\\": \\"1************3\\",\\n \\"SecretNo\\": \\"139****1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<BindAxgResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n <SecretBindDTO>\\n <Extension>150****0000</Extension>\\n <SubsId>100000076389****</SubsId>\\n <SecretNo>171****0000</SecretNo>\\n </SecretBindDTO>\\n</BindAxgResponse>","errorExample":""}]',
+ 'title' => 'AXG隐私号-号码绑定',
+ 'summary' => '添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。',
'description' => '- 在调用此接口前，请确保您已在控制台[购买隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
."\n"
- .'- 您可以使用此接口给AXB中间号绑定号码，也可以在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list?resType=1&billId=FC100000165392498)页面给AXB中间号绑定A、B号码。'."\n"
- ."\n"
- .'- AXB中间号，绑定号码前建议您先明确业务场景中的A角色和B角色。例如：在打车应用场景中，A是乘客角色，B是司机角色。'."\n"
+ .'- 您可以使用此接口给AXG隐私号绑定号码，也可以在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list?spm=a2c4g.11186623.0.0.64e649bbTzmb6j&resType=1&billId=FC100000165392498)页面给AXG隐私号绑定号码。'."\n"
."\n"
- .'- AXB中间号主要应用在1对1场景下的隐私保护，客户把A号码和B号码通过号码隐私服务实现绑定关系，A拨打X转接到B，B拨打X转接到A；一个X号码可以供200对绑定关系复用，如A1XB1、A2XB2、A3XB3......，只要A、B用户手机号码不重复，一个X号码可同时绑定200组手机号码，通话也可以同时进行。'."\n"
+ .'- AXG隐私号，绑定号码前建议您先明确业务场景中的A角色、G角色。例如：在招聘平台中，A是应聘者，G是招聘团队。'."\n"
."\n"
.'### QPS限制'."\n"
.'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'BindAxn' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1323,9 +1236,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '72610',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -1333,233 +1244,143 @@
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'FC2256****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FC2256****'],
],
[
'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXN隐私号的A号码。'."\n"
- .'A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****0000',
- ],
+ 'schema' => ['description' => 'AXN隐私号的A号码。'."\n"
+ .'A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****0000'],
],
[
'name' => 'PhoneNoB',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXN隐私号的B号码。'."\n"
- ."\n"
- .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
- .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
- .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXN隐私号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
- .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i11)接口更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'schema' => ['description' => 'AXN隐私号的B号码。'."\n"
+ ."\n"
+ .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
+ .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
+ .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXN隐私号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
+ .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i11)接口更新。', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXN隐私号的X号码。'."\n"
- ."\n"
- .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。'."\n"
- ."\n"
- .'> 如果未指定X号码时，将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '139****1111',
- ],
+ 'schema' => ['description' => 'AXN隐私号的X号码。'."\n"
+ ."\n"
+ .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。'."\n"
+ ."\n"
+ .'> 如果未指定X号码时，将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。', 'type' => 'string', 'required' => false, 'example' => '139****1111'],
],
[
'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系的过期时间，单位：秒。'."\n"
- ."\n"
- .'> 必须晚于当前时间60秒以上。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2021-09-05 12:00:00',
- ],
+ 'schema' => ['description' => '绑定关系的过期时间，单位：秒。'."\n"
+ ."\n"
+ .'> 必须晚于当前时间60秒以上。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-09-05 12:00:00'],
],
[
'name' => 'ExpectCity',
'in' => 'query',
- 'schema' => [
- 'description' => '指定城市进行X号码的选号。'."\n"
- ."\n"
- .'> - 如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
- .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '上海',
- ],
+ 'schema' => ['description' => '指定城市进行X号码的选号。'."\n"
+ ."\n"
+ .'> - 如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
+ .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。', 'type' => 'string', 'required' => false, 'example' => '上海'],
],
[
'name' => 'IsRecordingEnabled',
'in' => 'query',
- 'schema' => [
- 'description' => '是否需要针对该绑定关系产生的所有通话录制通话录音。取值：'."\n"
- ."\n"
- .'- **true**：录音。'."\n"
- .'- **false**：不录音（默认值）。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否需要针对该绑定关系产生的所有通话录制通话录音。取值：'."\n"
+ ."\n"
+ .'- **true**：录音。'."\n"
+ .'- **false**：不录音（默认值）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'NoType',
'in' => 'query',
- 'schema' => [
- 'description' => '号码类型。'."\n"
- ."\n"
- .'> 适用于原阿里大于客户，阿里云用户可忽略。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AXB_170',
- ],
+ 'schema' => ['description' => '号码类型。'."\n"
+ ."\n"
+ .'> 适用于原阿里大于客户，阿里云用户可忽略。', 'type' => 'string', 'required' => false, 'example' => 'AXB_170'],
],
[
'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
'name' => 'OutOrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '34553330****',
- ],
+ 'schema' => ['description' => '外部业务ID。', 'type' => 'string', 'required' => false, 'example' => '34553330****'],
],
[
'name' => 'CallDisplayType',
'in' => 'query',
- 'schema' => [
- 'description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
- ."\n"
- .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
+ ."\n"
+ .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'RingConfig',
'in' => 'query',
- 'schema' => [
- 'description' => '设置AXN隐私号在号码绑定后，拨打X号码的企业彩铃。'."\n"
- ."\n"
- .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
- ."\n"
- .'**铃音字段**取值：'."\n"
- .'- AXN中，A号码打X接通前的铃音设置（有回拨号码）：AXNRing_AB'."\n"
- .'- AXN中，A号码打X接通前的铃音设置（无回拨号码）：AXNRing_A'."\n"
- .'- AXN中，N侧号码打X接通前的铃音设置：AXNRing_N'."\n"
- .'- AXN中，A号码打X接通后的铃音设置：AXNRing_A_PICKUP'."\n"
- .'- AXN中，N号码打X接通后的铃音设置：AXNRing_N_PICKUP'."\n"
- ."\n"
- .'**彩铃编码**：'."\n"
- ."\n"
- .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
- ."\n"
- .'**填写示例**：'."\n"
- ."\n"
- .'如设置A号码拨打X接通前的铃音（无回拨号码），填写："AXNRing_A": "1000****1"。'."\n"
- ."\n"
- .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"AXNRing_N":"1000****1","AXNRing_A":"1000****1"}',
- ],
+ 'schema' => ['description' => '设置AXN隐私号在号码绑定后，拨打X号码的企业彩铃。'."\n"
+ ."\n"
+ .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
+ ."\n"
+ .'**铃音字段**取值：'."\n"
+ .'- AXN中，A号码打X接通前的铃音设置（有回拨号码）：AXNRing_AB'."\n"
+ .'- AXN中，A号码打X接通前的铃音设置（无回拨号码）：AXNRing_A'."\n"
+ .'- AXN中，N侧号码打X接通前的铃音设置：AXNRing_N'."\n"
+ .'- AXN中，A号码打X接通后的铃音设置：AXNRing_A_PICKUP'."\n"
+ .'- AXN中，N号码打X接通后的铃音设置：AXNRing_N_PICKUP'."\n"
+ ."\n"
+ .'**彩铃编码**：'."\n"
+ ."\n"
+ .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
+ ."\n"
+ .'**填写示例**：'."\n"
+ ."\n"
+ .'如设置A号码拨打X接通前的铃音（无回拨号码），填写："AXNRing_A": "1000****1"。'."\n"
+ ."\n"
+ .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。', 'type' => 'string', 'required' => false, 'example' => '{"AXNRing_N":"1000****1","AXNRing_A":"1000****1"}'],
],
[
'name' => 'ASRStatus',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR状态。取值：'."\n"
- ."\n"
- .'- **false**：关闭（默认值）'."\n"
- .'- **true**：开启',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'ASR状态。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭（默认值）'."\n"
+ .'- **true**：开启', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ASRModelId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- ."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- ."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'schema' => ['description' => 'ASR模型ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ ."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ ."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
],
[
'name' => 'CallTimeout',
'in' => 'query',
- 'schema' => [
- 'description' => '顺振时长。单位：秒。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '20',
- 'minimum' => '5',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '顺振时长。单位：秒。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '5', 'example' => '10'],
],
[
'name' => 'CallRestrict',
'in' => 'query',
- 'schema' => [
- 'description' => '单通呼叫限制的状态。取值：'."\n"
- ."\n"
- .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
- ],
+ 'schema' => ['description' => '单通呼叫限制的状态。取值：'."\n"
+ ."\n"
+ .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
],
[
'name' => 'Extend',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
@@ -1568,53 +1389,27 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'],
'SecretBindDTO' => [
'description' => '号码绑定成功后返回的结构体。',
'type' => 'object',
'properties' => [
- 'Extension' => [
- 'description' => '分机号。'."\n"
- ."\n"
- .'> 接口BindAxn不涉及分机号码，请忽略。',
- 'type' => 'string',
- 'example' => '130',
- ],
- 'SubsId' => [
- 'description' => '绑定关系ID。',
- 'type' => 'string',
- 'example' => '1***************3',
- ],
- 'SecretNo' => [
- 'description' => '隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '139****1111',
- ],
+ 'Extension' => ['description' => '分机号。'."\n"
+ ."\n"
+ .'> 接口BindAxn不涉及分机号码，请忽略。', 'type' => 'string', 'example' => '130'],
+ 'SubsId' => ['description' => '绑定关系ID。', 'type' => 'string', 'example' => '1***************3'],
+ 'SecretNo' => ['description' => '隐私号码，即X号码。', 'type' => 'string', 'example' => '139****1111'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SecretBindDTO\\": {\\n \\"Extension\\": \\"130\\",\\n \\"SubsId\\": \\"1***************3\\",\\n \\"SecretNo\\": \\"139****1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<BindAxnResponse>\\n<SecretBindDTO>\\n <Extension>130</Extension>\\n <SecretNo>170****0000</SecretNo>\\n <SubsId>100000076879****</SubsId>\\n</SecretBindDTO>\\n<Message>OK</Message>\\n<RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n<Code>OK</Code>\\n</BindAxnResponse>","errorExample":""}]',
'title' => 'AXN隐私号-号码绑定',
'summary' => '添加AXN隐私号的绑定关系。AXN隐私号是为A用户分配一个专属的隐私号，任何号码N通过拨打X号码都可以转接到A。',
@@ -1629,16 +1424,26 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-24T08:45:20.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'BindAxnExtension' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -1650,9 +1455,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '72611',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -1660,217 +1463,135 @@
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'FC10000011111****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FC10000011111****'],
],
[
'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXN分机号的A号码。'."\n"
- .'A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****0000',
- ],
+ 'schema' => ['description' => 'AXN分机号的A号码。'."\n"
+ .'A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****0000'],
],
[
'name' => 'Extension',
'in' => 'query',
- 'schema' => [
- 'description' => 'X号码的分机号码，1~3位。'."\n"
- ."\n"
- .'> 如果指定分机号，必须同时指定X号码，即Extension、PhoneNoX两个字段必须同时被指定。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '130',
- ],
+ 'schema' => ['description' => 'X号码的分机号码，1~3位。'."\n"
+ ."\n"
+ .'> 如果指定分机号，必须同时指定X号码，即Extension、PhoneNoX两个字段必须同时被指定。', 'type' => 'string', 'required' => false, 'example' => '130'],
],
[
'name' => 'PhoneNoB',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXN分机号的B号码。'."\n"
- ."\n"
- .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
- .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
- .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXN分机号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
- .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i16)接口更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'schema' => ['description' => 'AXN分机号的B号码。'."\n"
+ ."\n"
+ .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
+ .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
+ .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXN分机号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
+ .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i16)接口更新。', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXN分机号的X号码。'."\n"
- ."\n"
- .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。'."\n"
- ."\n"
- .'> 如果未指定X号码时，将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '139****1111',
- ],
+ 'schema' => ['description' => 'AXN分机号的X号码。'."\n"
+ ."\n"
+ .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。'."\n"
+ ."\n"
+ .'> 如果未指定X号码时，将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。', 'type' => 'string', 'required' => false, 'example' => '139****1111'],
],
[
'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系的过期时间，时间单位精确到秒。'."\n"
- .'>必须晚于当前时间1分钟以上。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2019-09-05 12:00:00',
- ],
+ 'schema' => ['description' => '绑定关系的过期时间，时间单位精确到秒。'."\n"
+ .'>必须晚于当前时间1分钟以上。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-09-05 12:00:00'],
],
[
'name' => 'ExpectCity',
'in' => 'query',
- 'schema' => [
- 'description' => '指定城市进行X号码的选号。'."\n"
- ."\n"
- .'> - 如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
- .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
+ 'schema' => ['description' => '指定城市进行X号码的选号。'."\n"
+ ."\n"
+ .'> - 如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
+ .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。', 'type' => 'string', 'required' => false, 'example' => '北京'],
],
[
'name' => 'IsRecordingEnabled',
'in' => 'query',
- 'schema' => [
- 'description' => '是否需要针对该绑定关系产生的所有通话进行通话录音。取值：'."\n"
- ."\n"
- .'- **true**：录音。'."\n"
- .'- **false**：不录音（默认值）。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '是否需要针对该绑定关系产生的所有通话进行通话录音。取值：'."\n"
+ ."\n"
+ .'- **true**：录音。'."\n"
+ .'- **false**：不录音（默认值）。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
'name' => 'OutOrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '外部业务ID。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
'name' => 'CallDisplayType',
'in' => 'query',
- 'schema' => [
- 'description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
- ."\n"
- .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
+ ."\n"
+ .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
'name' => 'RingConfig',
'in' => 'query',
- 'schema' => [
- 'description' => '设置AXN分机号在号码绑定后，拨打X号码的企业彩铃。'."\n"
- ."\n"
- .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
- ."\n"
- .'**铃音字段**取值：'."\n"
- .'- AXN分机号中，A号码打X接通前的铃音设置（有回拨号码）：AXNRing_AB'."\n"
- .'- AXN分机号中，A号码打X接通前的铃音设置（无回拨号码）：AXNRing_A'."\n"
- .'- AXN分机号中，N侧号码打X接通前的铃音设置：AXNRing_N'."\n"
- .'- AXN分机号中，A号码打X接通后的铃音设置：AXNRing_A_PICKUP'."\n"
- .'- AXN分机号中，N号码打X接通后的铃音设置：AXNRing_N_PICKUP'."\n"
- ."\n"
- .'**彩铃编码**：'."\n"
- ."\n"
- .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
- ."\n"
- .'**填写示例**：'."\n"
- ."\n"
- .'如设置A号码拨打X接通前的铃音（无回拨号码），填写："AXNRing_A": "1000****1"。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"AXNRing_N":"1000****1","AXNRing_A":"1000****1"}',
- ],
+ 'schema' => ['description' => '设置AXN分机号在号码绑定后，拨打X号码的企业彩铃。'."\n"
+ ."\n"
+ .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
+ ."\n"
+ .'**铃音字段**取值：'."\n"
+ .'- AXN分机号中，A号码打X接通前的铃音设置（有回拨号码）：AXNRing_AB'."\n"
+ .'- AXN分机号中，A号码打X接通前的铃音设置（无回拨号码）：AXNRing_A'."\n"
+ .'- AXN分机号中，N侧号码打X接通前的铃音设置：AXNRing_N'."\n"
+ .'- AXN分机号中，A号码打X接通后的铃音设置：AXNRing_A_PICKUP'."\n"
+ .'- AXN分机号中，N号码打X接通后的铃音设置：AXNRing_N_PICKUP'."\n"
+ ."\n"
+ .'**彩铃编码**：'."\n"
+ ."\n"
+ .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
+ ."\n"
+ .'**填写示例**：'."\n"
+ ."\n"
+ .'如设置A号码拨打X接通前的铃音（无回拨号码），填写："AXNRing_A": "1000****1"。', 'type' => 'string', 'required' => false, 'example' => '{"AXNRing_N":"1000****1","AXNRing_A":"1000****1"}'],
],
[
'name' => 'ASRStatus',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR状态。取值：'."\n"
- ."\n"
- .'- **false**：关闭（默认值）'."\n"
- .'- **true**：开启',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => 'ASR状态。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭（默认值）'."\n"
+ .'- **true**：开启', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'ASRModelId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- ."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- ."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'schema' => ['description' => 'ASR模型ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ ."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ ."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
],
[
'name' => 'CallRestrict',
'in' => 'query',
- 'schema' => [
- 'description' => '通呼叫限制的状态。取值：'."\n"
- ."\n"
- .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
- ],
+ 'schema' => ['description' => '通呼叫限制的状态。取值：'."\n"
+ ."\n"
+ .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
],
[
'name' => 'Extend',
'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
@@ -1879,51 +1600,25 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050D9369D',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050D9369D'],
'SecretBindDTO' => [
'description' => '绑定成功后返回的结构体。',
'type' => 'object',
'properties' => [
- 'Extension' => [
- 'description' => '分机号码。',
- 'type' => 'string',
- 'example' => '130',
- ],
- 'SubsId' => [
- 'description' => '绑定关系ID。',
- 'type' => 'string',
- 'example' => '1***************3',
- ],
- 'SecretNo' => [
- 'description' => '隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '139*****1111',
- ],
+ 'Extension' => ['description' => '分机号码。', 'type' => 'string', 'example' => '130'],
+ 'SubsId' => ['description' => '绑定关系ID。', 'type' => 'string', 'example' => '1***************3'],
+ 'SecretNo' => ['description' => '隐私号码，即X号码。', 'type' => 'string', 'example' => '139*****1111'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050D9369D\\",\\n \\"SecretBindDTO\\": {\\n \\"Extension\\": \\"130\\",\\n \\"SubsId\\": \\"1***************3\\",\\n \\"SecretNo\\": \\"139*****1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\n<BindAxnExtensionResponse>\\n<SecretBindDTO>\\n <Extension>130</Extension>\\n <SecretNo>150*****0000</SecretNo>\\n <SubsId>100000082000****</SubsId>\\n</SecretBindDTO>\\n<Message>OK</Message>\\n<RequestId>9297B722-A016-43FB-B51A-E54050D9369D</RequestId>\\n<Code>OK</Code>\\n</BindAxnExtensionResponse>","errorExample":""}]',
'title' => 'AXN分机号-号码绑定',
'summary' => '添加AXN分机号的绑定关系。AXN分机号与AXN隐私号功能类似，AXN分机号在AXN基础上引入了分机号，从而降低X号码的使用量，在呼叫时候首先拨打X号码，听到提示音后输入对应分机号转接到A。',
@@ -1939,319 +1634,397 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'BindAxg' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2024-06-07T02:40:35.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxnExtension',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'BindAxnExtensionFixedLine' => [
+ 'summary' => '固话AXN分机号在固话AXN隐私号基础上引入了分机号，从而降低X号码的使用量，在呼叫时候首先拨打X号码，听到提示音后输入对应分机号转接到A。固话AXN分机号目前为邀约制，请联系您的技术支持进行服务开通，并提供对接支持。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72609',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsNPUT41',
- ],
+ 'abilityTreeCode' => '271367',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'PhoneNoA',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXG隐私号的A号码。'."\n"
- .'A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****0000',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'GroupId',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXG中的G组ID，即GID。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.50fe545b5d568v)页面筛选出**AXG隐私号**，并单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
- ."\n"
- .'> G号码组中必须有一个及以上的电话号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '200001234****',
- ],
+ 'schema' => ['title' => '消息请求唯一标识', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
- 'name' => 'PhoneNoB',
+ 'name' => 'BindType',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXG隐私号的B号码。'."\n"
- ."\n"
- .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
- .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
- .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXG隐私号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
- .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i16)接口更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'schema' => ['title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', 'description' => '绑定类型。取值：'."\n"
+ ."\n"
+ .'- mode101：客户指定X号码。'."\n"
+ ."\n"
+ .'- mode102：平台分配X号码。', 'type' => 'string', 'required' => true, 'example' => 'mode101'],
],
[
- 'name' => 'PhoneNoX',
+ 'name' => 'Subts',
'in' => 'query',
- 'schema' => [
- 'description' => 'AXG隐私号的X号码。'."\n"
- ."\n"
- .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。'."\n"
- ."\n"
- .'> 如果未指定X号码时，将根据参数ExpectCity从指定号码池中随机指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '139****1111',
- ],
+ 'schema' => ['title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'required' => true, 'example' => '20161114143116'],
+ ],
+ [
+ 'name' => 'TelA',
+ 'in' => 'query',
+ 'schema' => ['title' => 'A号码', 'description' => '固话AXN分机号的A号码。'."\n"
+ ."\n"
+ .'> A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => true, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
+ ],
+ [
+ 'name' => 'TelX',
+ 'in' => 'query',
+ 'schema' => ['title' => 'X号码；平台分配号码模式下，该参数可不带，系统忽略该参数', 'description' => '固话AXN分机号的X号码。X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。', 'type' => 'string', 'required' => false, 'example' => '0571******23'],
+ ],
+ [
+ 'name' => 'TelXext',
+ 'in' => 'query',
+ 'schema' => ['title' => '分机号；平台分配号码模式下，该参数可不带，系统忽略该参数', 'description' => '分机号。BindType参数为mode101时此参数必填。', 'type' => 'string', 'required' => false, 'example' => '1009'],
+ ],
+ [
+ 'name' => 'Anucode',
+ 'in' => 'query',
+ 'schema' => ['title' => '', 'description' => '主叫侧放音编码，AXB业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。', 'type' => 'string', 'required' => true, 'example' => '1,2,3'],
+ ],
+ [
+ 'name' => 'Anucodecalled',
+ 'in' => 'query',
+ 'schema' => ['title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'TAnucodeConnect',
+ 'in' => 'query',
+ 'schema' => ['title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2', 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
[
'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系的过期时间，时间单位精确到秒。'."\n"
- .'>必须晚于当前时间1分钟以上。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2019-09-05 12:00:00',
- ],
+ 'schema' => ['title' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效；超过60s后，自动解绑。', 'type' => 'string', 'required' => true, 'example' => '60'],
],
[
- 'name' => 'ExpectCity',
+ 'name' => 'Areacode',
'in' => 'query',
- 'schema' => [
- 'description' => '指定城市进行X号码的选号。'."\n"
- ."\n"
- .'> - 如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
- .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
+ 'schema' => ['title' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费', 'description' => '区号。支持指定X号码归属地（指定城市->省会->全国路由）。不指定归属地，全国随机。', 'type' => 'string', 'required' => false, 'example' => '0571'],
],
[
- 'name' => 'IsRecordingEnabled',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '是否需要针对该绑定关系产生的所有通话录制通话录音。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'required' => false, 'example' => '19394'],
],
[
- 'name' => 'OutId',
+ 'name' => 'Extraaxx',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n",
- 'type' => 'string',
+ 'title' => '额外字段',
+ 'description' => '拓展参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callback' => ['title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码', 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不能外呼。'."\n"
+ ."\n"
+ .'- 1：接续最近的N号码。'."\n"
+ ."\n"
+ .'- 2：回拨固定号码TelB。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ 'Callrecording' => ['title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
'required' => false,
- 'example' => 'abcdef',
+ 'example' => '',
],
],
- [
- 'name' => 'OutOrderId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '外部业务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => 'AE2D6997-643A-59CB-9B3C-918572E5CEAA'],
+ 'Data' => [
+ 'title' => '响应信息',
+ 'description' => '响应信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Subid' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'example' => 'GHX0**********************'],
+ 'TelXext' => ['title' => '分机号，只有4位', 'description' => '分机号，只有4位。', 'type' => 'string', 'example' => '1001'],
+ 'TelX' => ['title' => '隐私号码', 'description' => '隐私号码。', 'type' => 'string', 'example' => '0571******23'],
+ ],
+ 'example' => '',
+ ],
+ 'Code' => ['title' => '响应码 0：成功，其它失败，具体见文档', 'description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'string', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"AE2D6997-643A-59CB-9B3C-918572E5CEAA\\",\\n \\"Data\\": {\\n \\"Subid\\": \\"GHX0**********************\\",\\n \\"TelXext\\": \\"1001\\",\\n \\"TelX\\": \\"0571******23\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
+ 'title' => 'AXN分机号绑定',
+ 'description' => '- 在调用此接口前，请确保您已在控制台[购买隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
+ ."\n"
+ .'- 您可以使用此接口给固话AXN分机号绑定号码，暂不支持在控制台给固话AXN分机号绑定号码。'."\n"
+ ."\n"
+ .'- 绑定号码前建议您先明确业务场景中的A角色和N角色。例如：A号码是客户，则X号码是为客户分配的隐私号，其他的任何号码拨打X号码+分机号码都会转接到A号码，A拨打X的时候呼叫会转接到绑定时所传入的默认B号码。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxnExtensionFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'BindAxnFixedLine' => [
+ 'summary' => '固话绑定AXN隐私号，是将A用户分配到一个专属的隐私号，任何号码N通过拨打X号码都可以转接到A。固话隐私号目前为邀约制，请联系您的技术支持进行服务开通，并提供对接支持。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'CallDisplayType',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '重置绑定关系中的号码显示逻辑。固定取值： **1**（主被叫显示中间号码X）。'."\n"
- ."\n"
- .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。'."\n",
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'RingConfig',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => '设置AXG隐私号在号码绑定后，拨打X号码的企业彩铃。'."\n"
- ."\n"
- .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
- ."\n"
- .'**铃音字段**取值：'."\n"
- .'- AXG中，A号码打X的铃音设置（有回拨号码）：AXGRing_AB'."\n"
- .'- AXG中，A号码打X的铃音设置（无回拨号码）：AXGRing_A'."\n"
- .'- AXG中，G组号码打X的铃音设置：AXGRing_G'."\n"
- ."\n"
- .'**彩铃编码**：'."\n"
- ."\n"
- .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
- ."\n"
- .'**填写示例**：'."\n"
- ."\n"
- .'如设置G组号码打X的铃音，填写："AXGRing_G": "1000****1"。'."\n"
- ."\n"
- .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"AXGRing_AB":"1000****1","AXGRing_A":"1000****2","AXGRing_G":"1000****3"}',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式为yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'ASRStatus',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR状态。取值：'."\n"
- ."\n"
- .'- **false**：关闭（默认值）'."\n"
- .'- **true**：开启',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '消息请求唯一标识', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
- 'name' => 'ASRModelId',
+ 'name' => 'BindType',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- ."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- ."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '9b4afe3d224e4fa3bf963697113e2f77',
- ],
+ 'schema' => ['title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', 'description' => '绑定类型，取值：'."\n"
+ ."\n"
+ .'- mode101：客户指定X号码。'."\n"
+ ."\n"
+ .'- mode102：平台分配X号码。', 'type' => 'string', 'required' => true, 'example' => 'mode101'],
],
[
- 'name' => 'CallRestrict',
+ 'name' => 'Subts',
+ 'in' => 'query',
+ 'schema' => ['title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'required' => true, 'example' => '20161114143116'],
+ ],
+ [
+ 'name' => 'TelA',
+ 'in' => 'query',
+ 'schema' => ['title' => 'A号码', 'description' => '固话AXN隐私号的A号码。'."\n"
+ ."\n\n"
+ .'> - A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ .'> - 如果您的业务需要修改已绑定的号码，可以调用[UpdateAxnBindFixedLine](~~2883049~~)接口进行修改。', 'type' => 'string', 'required' => true, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
+ ],
+ [
+ 'name' => 'TelX',
+ 'in' => 'query',
+ 'schema' => ['title' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数', 'description' => '固话AXN隐私号的X号码。X号码是您在控制台已购买的隐私号。'."\n"
+ ."\n"
+ .'> 客户指定X号码模式下（即BindType参数为mode101），本参数必填。', 'type' => 'string', 'required' => false, 'example' => '0571******23'],
+ ],
+ [
+ 'name' => 'TelB',
+ 'in' => 'query',
+ 'schema' => ['title' => 'N号码', 'description' => '固话AXN隐私号的N号码。', 'type' => 'string', 'required' => false, 'example' => '155****2222'],
+ ],
+ [
+ 'name' => 'Anucode',
+ 'in' => 'query',
+ 'schema' => ['title' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', 'description' => '主叫侧放音编码，必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。', 'type' => 'string', 'required' => true, 'example' => '1,2,3'],
+ ],
+ [
+ 'name' => 'Anucodecalled',
+ 'in' => 'query',
+ 'schema' => ['title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', 'description' => '被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'TAnucodeConnect',
+ 'in' => 'query',
+ 'schema' => ['title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2', 'description' => '接通后主叫侧放音编码，必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
+ ],
+ [
+ 'name' => 'Areacode',
+ 'in' => 'query',
+ 'schema' => ['title' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费', 'description' => '区号。支持指定X号码归属地（指定城市->省会->全国路由）。不指定归属地，全国随机。', 'type' => 'string', 'required' => false, 'example' => '0571'],
+ ],
+ [
+ 'name' => 'Expiration',
+ 'in' => 'query',
+ 'schema' => ['title' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效；超过60s后，自动解绑。', 'type' => 'string', 'required' => true, 'example' => '60'],
+ ],
+ [
+ 'name' => 'Remark',
+ 'in' => 'query',
+ 'schema' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'required' => false, 'example' => '19394'],
+ ],
+ [
+ 'name' => 'Extra',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '通话呼叫限制的状态。取值：'."\n"
- ."\n"
- .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。',
- 'type' => 'string',
+ 'title' => '扩展参数',
+ 'description' => '扩展参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callback' => ['title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB', 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不能外呼。'."\n"
+ ."\n"
+ .'- 1：接续最近的N号码。'."\n"
+ ."\n"
+ .'- 2：回拨固定号码TelB。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ 'Callrecording' => ['title' => '仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
- ],
- 'SecretBindDTO' => [
- 'description' => '绑定成功后返回的结构体。',
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '4D690962-08CE-5D38-A65A-AB247D7DF7A2'],
+ 'Data' => [
+ 'description' => '响应信息。',
'type' => 'object',
'properties' => [
- 'Extension' => [
- 'description' => '分机号码。'."\n"
- ."\n"
- .'> 接口BindAxg不涉及分机号码，请忽略该返回参数。',
- 'type' => 'string',
- 'example' => '130',
- ],
- 'SubsId' => [
- 'description' => '绑定关系ID。',
- 'type' => 'string',
- 'example' => '1************3',
- ],
- 'SecretNo' => [
- 'description' => '隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '139****1111',
- ],
+ 'Subid' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'example' => 'GHX0*************************'],
+ 'TelX' => ['title' => '隐私号码', 'description' => '隐私号码。', 'type' => 'string', 'example' => '0571******23'],
],
+ 'example' => '',
],
+ 'Code' => ['title' => '响应码 0：成功，其它失败，具体见文档', 'description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SecretBindDTO\\": {\\n \\"Extension\\": \\"130\\",\\n \\"SubsId\\": \\"1************3\\",\\n \\"SecretNo\\": \\"139****1111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<BindAxgResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n <SecretBindDTO>\\n <Extension>150****0000</Extension>\\n <SubsId>100000076389****</SubsId>\\n <SecretNo>171****0000</SecretNo>\\n </SecretBindDTO>\\n</BindAxgResponse>","errorExample":""}]',
- 'title' => 'AXG隐私号-号码绑定',
- 'summary' => '添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。',
- 'description' => '- 在调用此接口前，请确保您已在控制台[购买隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
- ."\n"
- .'- 您可以使用此接口给AXG隐私号绑定号码，也可以在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list?spm=a2c4g.11186623.0.0.64e649bbTzmb6j&resType=1&billId=FC100000165392498)页面给AXG隐私号绑定号码。'."\n"
- ."\n"
- .'- AXG隐私号，绑定号码前建议您先明确业务场景中的A角色、G角色。例如：在招聘平台中，A是应聘者，G是招聘团队。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4D690962-08CE-5D38-A65A-AB247D7DF7A2\\",\\n \\"Data\\": {\\n \\"Subid\\": \\"GHX0*************************\\",\\n \\"TelX\\": \\"0571******23\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AXN固话隐私号-号码绑定',
+ 'description' => '- 在调用此接口前，请确保您已在控制台购买隐私号。您可以使用此接口给固话AXN隐私号绑定号码，控制台暂不支持固话AXN隐私号绑定。'."\n"
."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ .'- 绑定号码前建议您先明确业务场景中的A角色。例如：在二手车信息发布场景中，A是房东或经纪人联系方式。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [],
],
'BindBatchAxg' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -2263,9 +2036,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '175378',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -2273,15 +2044,9 @@
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'FC2235****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FC2235****'],
],
[
'name' => 'AxgBindList',
@@ -2293,151 +2058,79 @@
'items' => [
'type' => 'object',
'properties' => [
- 'PhoneNoA' => [
- 'description' => 'AXG中的A号码。 A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****0000',
- ],
- 'GroupId' => [
- 'description' => 'AXG中的G组ID，即GID。'."\n"
- ."\n"
- .'可以通过以下方式查看GID：'."\n"
- .'- 登录号码隐私保护控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**，单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
- .'- 如果G号码组是通过接口[CreateAxgGroup](~~110250~~)创建的，则接口的返回参数**GroupID**就是此处的请求参数**GroupID**。'."\n"
- ."\n"
- .'> G号码组中必须有一个及以上的电话号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '200001234****',
- ],
- 'PhoneNoB' => [
- 'description' => 'AXG中的B号码。'."\n"
- ."\n"
- .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- ."\n"
- .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
- .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
- .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXN隐私号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
- .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i16)接口更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
- 'PhoneNoX' => [
- 'description' => 'AXG中的X号码。'."\n"
- ."\n"
- .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)，可在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list)筛选**AXG隐私号**获取X号码。'."\n"
- ."\n"
- .'> 如果未指定X号码，将根据参数**ExpectCity**从指定号码池中随机指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '139****1111',
- ],
- 'ExpectCity' => [
- 'description' => '指定城市进行X号码的选号。'."\n"
- ."\n"
- .'> - 如果当前号池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
- .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京',
- ],
- 'IsRecordingEnabled' => [
- 'description' => '是否需要针对该绑定关系产生的所有通话进行通话录音。取值：'."\n"
- ."\n"
- .'- **true**：录音。'."\n"
- .'- **false**：不录音（默认值）。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'OutId' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '1***********0fd',
- ],
- 'Expiration' => [
- 'description' => '绑定关系的过期时间，时间单位精确到秒。'."\n"
- .'> - 必须晚于当前时间1分钟以上。'."\n"
- .'> - 此参数为必填参数，请您调用时填写。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2022-07-11 01:05:15',
- ],
- 'OutOrderId' => [
- 'description' => '外部业务ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20***************677',
- ],
- 'CallDisplayType' => [
- 'description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
- ."\n"
- .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'RingConfig' => [
- 'description' => '设置AXG隐私号在号码绑定后，拨打X号码的企业彩铃。'."\n"
- ."\n"
- .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
- ."\n"
- .'**铃音字段**取值：'."\n"
- .'- AXG中，A号码打X的铃音设置（有回拨号码）：AXGRing_AB'."\n"
- .'- AXG中，A号码打X的铃音设置（无回拨号码）：AXGRing_A'."\n"
- .'- AXG中，G组号码打X的铃音设置：AXGRing_G'."\n"
- ."\n"
- .'**彩铃编码**：'."\n"
- ."\n"
- .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
- ."\n"
- .'**填写示例**：'."\n"
- ."\n"
- .'如设置A号码打X的铃音（无回拨号码），填写："AXGRing_A": "1000****1"。'."\n"
- ."\n"
- .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"AXGRing_AB":"1000****2","AXGRing_A":"1000****1"}',
- ],
- 'ASRStatus' => [
- 'description' => 'ASR状态。取值：'."\n"
- ."\n"
- .'- **false**：关闭（默认值）'."\n"
- .'- **true**：开启',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'ASRModelId' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- ."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- ."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
- 'CallRestrict' => [
- 'description' => '单通呼叫限制的状态。取值：'."\n"
- ."\n"
- .'- **CONTROL\\_AX\\_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL\\_BX\\_DISABLE**：B号码无法呼叫X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
- ],
+ 'PhoneNoA' => ['description' => 'AXG中的A号码。 A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****0000'],
+ 'GroupId' => ['description' => 'AXG中的G组ID，即GID。'."\n"
+ ."\n"
+ .'可以通过以下方式查看GID：'."\n"
+ .'- 登录号码隐私保护控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**，单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
+ .'- 如果G号码组是通过接口[CreateAxgGroup](~~110250~~)创建的，则接口的返回参数**GroupID**就是此处的请求参数**GroupID**。'."\n"
+ ."\n"
+ .'> G号码组中必须有一个及以上的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '200001234****'],
+ 'PhoneNoB' => ['description' => 'AXG中的B号码。'."\n"
+ ."\n"
+ .'B号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ ."\n"
+ .'> - A号码拨打X号码时，默认会转接到B号码，如B号码未设置，则无法接通。'."\n"
+ .'> - A号码拨打X号码时，**A号码回拨模式**为**默认模式**时，才会转接到B号码，若不是**默认模式**，则无法接通。'."\n"
+ .'> - 如需修改**A号码回拨模式**，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?resType=1)>筛选**AXN隐私号**>**号池管理**>**A号码回拨模式**>**调整配置**修改。'."\n"
+ .'> - 如需更新B号码，请调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription?spm=a2c4g.11186623.0.i16)接口更新。', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
+ 'PhoneNoX' => ['description' => 'AXG中的X号码。'."\n"
+ ."\n"
+ .'X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)，可在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list)筛选**AXG隐私号**获取X号码。'."\n"
+ ."\n"
+ .'> 如果未指定X号码，将根据参数**ExpectCity**从指定号码池中随机指定一个号码作为X号码。', 'type' => 'string', 'required' => false, 'example' => '139****1111'],
+ 'ExpectCity' => ['description' => '指定城市进行X号码的选号。'."\n"
+ ."\n"
+ .'> - 如果当前号池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为X号码。'."\n"
+ .'> - 如果**X号码分配模式**配置为**严格匹配模式**，当符合条件的号码不存在时，系统会提示分配错误。', 'type' => 'string', 'required' => false, 'example' => '北京'],
+ 'IsRecordingEnabled' => ['description' => '是否需要针对该绑定关系产生的所有通话进行通话录音。取值：'."\n"
+ ."\n"
+ .'- **true**：录音。'."\n"
+ .'- **false**：不录音（默认值）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'OutId' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。'."\n", 'type' => 'string', 'required' => false, 'example' => '1***********0fd'],
+ 'Expiration' => ['description' => '绑定关系的过期时间，时间单位精确到秒。'."\n"
+ .'> - 必须晚于当前时间1分钟以上。'."\n"
+ .'> - 此参数为必填参数，请您调用时填写。', 'type' => 'string', 'required' => false, 'example' => '2022-07-11 01:05:15'],
+ 'OutOrderId' => ['description' => '外部业务ID。', 'type' => 'string', 'required' => false, 'example' => '20***************677'],
+ 'CallDisplayType' => ['description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
+ ."\n"
+ .'> 由于运营商监管限制，呼叫时显示真实号码的设置不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'RingConfig' => ['description' => '设置AXG隐私号在号码绑定后，拨打X号码的企业彩铃。'."\n"
+ ."\n"
+ .'此参数请填写**铃音字段**和**彩铃编码**。'."\n"
+ ."\n"
+ .'**铃音字段**取值：'."\n"
+ .'- AXG中，A号码打X的铃音设置（有回拨号码）：AXGRing_AB'."\n"
+ .'- AXG中，A号码打X的铃音设置（无回拨号码）：AXGRing_A'."\n"
+ .'- AXG中，G组号码打X的铃音设置：AXGRing_G'."\n"
+ ."\n"
+ .'**彩铃编码**：'."\n"
+ ."\n"
+ .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
+ ."\n"
+ .'**填写示例**：'."\n"
+ ."\n"
+ .'如设置A号码打X的铃音（无回拨号码），填写："AXGRing_A": "1000****1"。'."\n"
+ ."\n"
+ .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。', 'type' => 'string', 'required' => false, 'example' => '{"AXGRing_AB":"1000****2","AXGRing_A":"1000****1"}'],
+ 'ASRStatus' => ['description' => 'ASR状态。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭（默认值）'."\n"
+ .'- **true**：开启', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'ASRModelId' => ['description' => 'ASR模型ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ ."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ ."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
+ 'CallRestrict' => ['description' => '单通呼叫限制的状态。取值：'."\n"
+ ."\n"
+ .'- **CONTROL\\_AX\\_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL\\_BX\\_DISABLE**：B号码无法呼叫X号码。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
],
'required' => false,
+ 'description' => '',
],
'required' => true,
'docRequired' => true,
@@ -2450,23 +2143,11 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '5DCCA8CD-6C0A-50B4-A496-B1D2AB48A1C3',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '5DCCA8CD-6C0A-50B4-A496-B1D2AB48A1C3'],
'SecretBindList' => [
'type' => 'object',
'itemNode' => true,
@@ -2477,58 +2158,30 @@
'items' => [
'type' => 'object',
'properties' => [
- 'SecretNo' => [
- 'description' => '隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '139****1111',
- ],
- 'SubsId' => [
- 'description' => '绑定关系ID。',
- 'type' => 'string',
- 'example' => '1000012345******',
- ],
- 'Extension' => [
- 'description' => '分机号。'."\n"
- ."\n"
- .'> 接口BindBatchAxg不涉及分机号码，请忽略。',
- 'type' => 'string',
- 'example' => '257',
- ],
- 'GroupId' => [
- 'description' => 'AXG中的G组ID，即GID。',
- 'type' => 'string',
- 'example' => '200001234****',
- ],
- 'PhoneNoA' => [
- 'description' => 'AXG中的A号码。',
- 'type' => 'string',
- 'example' => '139****0000',
- ],
- 'Code' => [
- 'description' => '单条AXG创建绑定的请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](https://help.aliyun.com/document_detail/109196.html)。',
- 'type' => 'string',
- 'example' => 'isv.INVALID_PARAMETERS',
- ],
- 'Message' => [
- 'description' => '单条AXG创建绑定的请求状态码描述。',
- 'type' => 'string',
- 'example' => 'ringConfig invalid',
- ],
+ 'SecretNo' => ['description' => '隐私号码，即X号码。', 'type' => 'string', 'example' => '139****1111'],
+ 'SubsId' => ['description' => '绑定关系ID。', 'type' => 'string', 'example' => '1000012345******'],
+ 'Extension' => ['description' => '分机号。'."\n"
+ ."\n"
+ .'> 接口BindBatchAxg不涉及分机号码，请忽略。', 'type' => 'string', 'example' => '257'],
+ 'GroupId' => ['description' => 'AXG中的G组ID，即GID。', 'type' => 'string', 'example' => '200001234****'],
+ 'PhoneNoA' => ['description' => 'AXG中的A号码。', 'type' => 'string', 'example' => '139****0000'],
+ 'Code' => ['description' => '单条AXG创建绑定的请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](https://help.aliyun.com/document_detail/109196.html)。', 'type' => 'string', 'example' => 'isv.INVALID_PARAMETERS'],
+ 'Message' => ['description' => '单条AXG创建绑定的请求状态码描述。', 'type' => 'string', 'example' => 'ringConfig invalid'],
],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"5DCCA8CD-6C0A-50B4-A496-B1D2AB48A1C3\\",\\n \\"SecretBindList\\": {\\n \\"SecretBind\\": [\\n {\\n \\"SecretNo\\": \\"139****1111\\",\\n \\"SubsId\\": \\"1000012345******\\",\\n \\"Extension\\": \\"257\\",\\n \\"GroupId\\": \\"200001234****\\",\\n \\"PhoneNoA\\": \\"139****0000\\",\\n \\"Code\\": \\"isv.INVALID_PARAMETERS\\",\\n \\"Message\\": \\"ringConfig invalid\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
'title' => '批量添加AXG号码的绑定关系',
'summary' => '批量添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。',
@@ -2540,490 +2193,340 @@
."\n"
.'### QPS 限制'."\n"
.'本接口的单用户QPS限制为 5000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- ],
- 'UpdateSubscription' => [
- 'methods' => [
- 'post',
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-27T09:07:17.000Z', 'description' => 'OpenAPI 下线'],
],
- 'schemes' => [
- 'http',
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindBatchAxg'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:BindBatchAxg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'BindGxb700' => [
+ 'summary' => '添加700GXB号码的绑定关系。700GXB产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72641',
- 'abilityTreeNodes' => [
- 'FEATUREdypls13M9H9',
- ],
+ 'abilityTreeCode' => '285985',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'>在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。当**ProductType**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'FC122356****',
- ],
+ 'schema' => ['description' => '号码池 Key。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'ProductType',
+ 'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'description' => '产品类型。取值：'."\n"
- .'- **AXB_170**。'."\n"
- .'- **AXN_170**。'."\n"
- .'- **AXN_95**。'."\n"
- .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
- ."\n"
- .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
- .'> - 当**PoolKey**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AXB_170',
- ],
+ 'schema' => ['description' => '号码绑定的过期时间。'."\n"
+ ."\n"
+ .'> 说明'."\n"
+ .'必须晚于当前绑定时间 1 分钟以上，时间精确到秒。'."\n"
+ .'号码绑定过期时间内，您可随时进行手动解绑。'."\n"
+ .'若您对正在通话中的号码进行解绑，不会影响本次通话。', 'type' => 'string', 'required' => true, 'example' => '2021-09-05 12:00:00'],
],
[
- 'name' => 'SubsId',
+ 'name' => 'TelB',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系ID。'."\n"
- ."\n"
- .'> 请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页筛选号码，点击**详情**查看号码的绑定关系ID，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定API时查看返回参数中的**SubsId**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '100000076879****',
- ],
+ 'schema' => ['description' => '用户B号码', 'type' => 'string', 'required' => true, 'example' => '136****0000'],
],
[
- 'name' => 'PhoneNoX',
+ 'name' => 'DefaultA',
'in' => 'query',
- 'schema' => [
- 'description' => '号码绑定关系中的X号码。'."\n"
- ."\n"
- .'>X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码。在填写X号码时，注意填写与**SubsId**参数关联的X号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****1111',
- ],
+ 'schema' => ['description' => 'A号码'."\n"
+ .'GXB 隐私号的 DefaultA号码。'."\n"
+ ."\n"
+ .'> 说明'."\n"
+ .'支持在号池维度设置回拨模式，当回拨模式为默认模式时，此字段生效，即 B 号码拨打 X 号码时，默认会转接到 此 A 号码，如 A 号码未设置，则无法接通。'."\n"
+ .'如需更新 A 号码，请调用 号码绑定修改接口', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
- 'name' => 'PhoneNoA',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '设置绑定关系中的A号码。'."\n"
- ."\n"
- .'>A 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。当**OperateType**指定为**updateNoA**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '139****0000',
- ],
+ 'schema' => ['description' => '号码组G的ID。'."\n"
+ ."\n"
+ .'其中，号码组G是通过“G号码组创建”消息创建的。', 'type' => 'string', 'required' => false, 'example' => '10000*****'],
],
[
- 'name' => 'PhoneNoB',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'description' => '设置绑定关系中的B号码。'."\n"
- ."\n"
- .'>B 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。当**OperateType**指定为**updateNoB**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'schema' => ['description' => '中间号X。业务使用方未指定X号码时，由应用平台从号码池中指定一个号码作为X号码。', 'type' => 'string', 'required' => false, 'example' => '700********0000'],
],
[
- 'name' => 'GroupId',
+ 'name' => 'NeedRecord',
'in' => 'query',
- 'schema' => [
- 'description' => '设置绑定关系中的G号码组ID。'."\n"
- ."\n"
- .'> 当**OperateType**指定为**updateAxgGroup**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '200001234****',
- ],
+ 'schema' => ['description' => '用于表示业务使用方是否需要该号码绑定关系产生的所有通话媒体文件，取值：'."\n"
+ ."\n"
+ .'- true：录音。'."\n"
+ .'- false：不录音（默认值）。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'RecType',
+ 'in' => 'query',
+ 'schema' => ['description' => '录音类型，mp3、wav', 'type' => 'string', 'required' => false, 'example' => 'mp3'],
],
[
'name' => 'CallRestrict',
'in' => 'query',
- 'schema' => [
- 'description' => '设置单通呼叫限制。取值：'."\n"
- .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。'."\n"
- .'- **CONTROL_CLEAR_DISABLE**：清除呼叫限制。'."\n"
- ."\n"
- .'> 当**OperateType**指定为**updateCallRestrict**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_BX_DISABLE ',
- ],
+ 'schema' => ['description' => '单通呼叫限制逻辑，取值：'."\n"
+ ."\n"
+ .'- CONTROL_BX_DISABLE：B 号码无法呼叫 X 号码。'."\n"
+ .'- CONTROL_GX_DISABLE：号码组G号码无法呼叫 X 号码。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
],
[
- 'name' => 'Expiration',
+ 'name' => 'Audio',
'in' => 'query',
- 'schema' => [
- 'description' => '重新设置绑定关系的过期时间。'."\n"
- ."\n"
- .'> - **OperateType**为**updateExpire**时必填。'."\n"
- .'> - 过期时间必须晚于当前时间1分钟以上。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2019-09-05 12:00:00',
- ],
+ 'schema' => ['description' => '放音编码。'."\n"
+ ."\n\n"
+ .'- GCallX_Gpre 号码组G中的号码呼叫X号码时，呼叫接通前，向主叫播放的语音提示放音编码。'."\n"
+ .'- GCallX_Gin 号码组G中的号码呼叫X号码时，呼叫接通后，向主叫播放的语音提示放音编码。'."\n"
+ .'- GCallX_Bin 号码组G中的号码呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
+ .'- BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
+ .'- BCallX_Gin 呼叫X号码时，呼叫接通后，向被叫播放的语音提示放音编码。'."\n"
+ .'- BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .'"GCallX_Gpre":"185"'."\n"
+ .'}'],
],
[
- 'name' => 'CallDisplayType',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
- ."\n"
- .'> 由于运营商监管限制，暂时关闭透传功能。呼叫时，显示真实号码的设置不生效。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '业务订单编码。'."\n"
+ ."\n"
+ .'- 该编码与真实业务订单是一一对应关系，且不可重复。'."\n"
+ ."\n"
+ .'- 编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
+ ."\n"
+ .'- 当业务使用方提交业务订单编码，由应用平台生成工业互联网标识编码时，该字段必选。', 'type' => 'string', 'required' => false, 'example' => '12345678'],
+ ],
+ [
+ 'name' => 'IndustrialId',
+ 'in' => 'query',
+ 'schema' => ['description' => '- 工业互联网标识编码，与OrderID保持一一对应关系。'."\n"
+ ."\n"
+ .'- 编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
+ ."\n"
+ .'- 当业务使用方自行生成工业互联网标识编码时，该字段必选。', 'type' => 'string', 'required' => false, 'example' => '700.100.1/12345678'],
],
[
'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'description' => '重新设置绑定关系中的OutId。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
- 'name' => 'IsRecordingEnabled',
+ 'name' => 'OutOrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '重新设置绑定关系中的录音状态。取值：'."\n"
- ."\n"
- .'- **true**：录音。'."\n"
- ."\n"
- .'- **false**：不录音。'."\n"
- ."\n"
- .'> 该参数没有默认值，不传该参数就不更新对应字段。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['description' => '外部业务 ID。', 'type' => 'string', 'required' => false, 'example' => 'abcdefgh'],
],
[
- 'name' => 'OperateType',
+ 'name' => 'NeedAsr',
'in' => 'query',
- 'schema' => [
- 'description' => '修改绑定关系的操作。取值：'."\n"
- .'- **updateNoA**：修改A号码。'."\n"
- .'- **updateNoB**：修改B号码。'."\n"
- .'- **updateExpire**：修改绑定关系有效期。'."\n"
- .'- **updateAxgGroup**：修改G号码组。'."\n"
- .'- **updateCallRestrict**：设置单通呼叫限制。'."\n"
- .'- **updateCallDisplayType**：更新呼叫显号逻辑。'."\n"
- .'- **updateOutId**：更新OutId字段。'."\n"
- .'- **updateIsRecordingEnabled**：更新绑定中录音状态。'."\n"
- .'- **updateAsr**：更新绑定中ASR状态。'."\n"
- .'> 在修改已绑定的号码时，一次只能修改一个已绑定的号码，若您需要同时修改两个已绑定的A号码和B号码，需要调用两次接口进行修改，或者您也可对A号码和B号码先进行解绑，然后再绑定C号码和D号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'updateNoA',
- ],
+ 'schema' => ['description' => '是否开启 ASR 服务功能。取值： '."\n"
+ ."\n"
+ .'- false：关闭（默认值）。'."\n"
+ ."\n"
+ .' - true：开启。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'RingConfig',
+ 'name' => 'AsrModelId',
'in' => 'query',
- 'schema' => [
- 'description' => '更新绑定关系中的企业彩铃放音编码，此参数请填写**铃音字段**和**彩铃编码**。**铃音字段**取值：'."\n"
- ."\n"
- .'AXB产品：'."\n"
- .'- AXB中，A号码打X的铃音设置：AXBRing_A'."\n"
- .'- AXB中，B号码打X的铃音设置：AXBRing_B'."\n"
- .'- AXB中，A号码拨打X接通后的铃音设置：AXBRing_A_PICKUP'."\n"
- .'- AXB中，B号码拨打X接通后的铃音设置：AXBRing_B_PICKUP'."\n"
- ."\n"
- .'AXN产品（含AXN隐私号、AXN分机号）：'."\n"
- .'- AXN中，A号码打X接通前的铃音设置（有回拨号码）：AXNRing_AB'."\n"
- .'- AXN中，A号码打X接通前的铃音设置（无回拨号码）：AXNRing_A'."\n"
- .'- AXN中，N侧号码打X接通前的铃音设置：AXNRing_N'."\n"
- .'- AXN中，A号码打X接通后的铃音设置：AXNRing_A_PICKUP'."\n"
- .'- AXN中，N号码打X接通后的铃音设置：AXNRing_N_PICKUP'."\n"
- ."\n"
- .'AXG产品：'."\n"
- .'- AXG中，A号码打X的铃音设置（有回拨号码）：AXGRing_AB'."\n"
- .'- AXG中，A号码打X的铃音设置（无回拨号码）：AXGRing_A'."\n"
- .'- AXG中，G组号码打X的铃音设置：AXGRing_G'."\n"
- ."\n"
- .'**填写示例**：'."\n"
- .'如设置AXN分机号，A号码拨打X接通前的铃音（无回拨号码），填写："AXNRing_A": "1000****1"。'."\n"
- ."\n"
- .'**彩铃编码**：'."\n"
- .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
- ."\n"
- .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"AXBRing_B":"1000****1","AXBRing_A":"1000****1"}',
- ],
+ 'schema' => ['description' => 'ASR 模型 ID。取值： '."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac '."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77 '."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
],
[
- 'name' => 'ASRStatus',
+ 'name' => 'CallTimeout',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR状态。取值：'."\n"
- ."\n"
- .'- **false**：关闭（默认值）。'."\n"
- .'- **true**：开启。'."\n"
- ."\n"
- .'> 当OperateType为updateAsr时此参数必填。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '顺振时长。单位：秒。取值范围为 5~20。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'ASRModelId',
+ 'name' => 'DtmfConfig',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b'."\n"
- ."\n"
- .'> 当ASRStatus为true时此参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'schema' => ['description' => 'dtmf 按键配置，设置 AXB 中间号号码绑定时使用，可配置内容如下：'."\n"
+ ."\n"
+ .'- endCallIvrPhoneNo：放音对象 A 或 B。 '."\n"
+ .'- waitingDtmfTime：放完第一段音后的最大等待时长，最大时长为 30 秒。 '."\n"
+ .'- maxLoop dtmf：按键不匹配，循环播放第一个放音文件的最大次数，最大循环次数为 5 次。 '."\n"
+ .'- step1File：第一个放音文件名称。 '."\n"
+ .'- step2File：第二个放音文件名称。'."\n"
+ .'- validKey：合法按键值定义，如：1,2 只允许配置两个有效键值，用","分隔。 '."\n"
+ .'- waitingEndCall：运营商挂机等待时长，最大等待时长为 10 秒。', 'type' => 'string', 'required' => false, 'example' => '{ "endCallIvrPhoneNo":"A", "waitingDtmfTime":10, "maxLoop":3, "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav", "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav", "validKey":"1,2", "waitingEndCall":2 }'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36',
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '{}'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n"],
+ 'Message' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'SecretNo' => ['description' => '已购买的700隐私号码，即 X 号码。', 'type' => 'string', 'example' => '700********0001'],
+ 'SubsId' => ['description' => '号码绑定 ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '123*******'],
+ ],
+ 'example' => '',
],
+ 'Code' => ['description' => '返回状态码，取值：'."\n"
+ .'OK：表示成功。'."\n"
+ .'其他表示失败。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'true：成功。'."\n"
+ .'false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A9901233D36\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateSubscriptionResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</UpdateSubscriptionResponse>","errorExample":""}]',
- 'title' => '修改已绑定的号码',
- 'summary' => '修改号码的绑定关系。',
- 'description' => '### QPS限制'."\n"
- .'本接口的单用户QPS限制为10000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SecretNo\\": \\"700********0001\\",\\n \\"SubsId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '700GXB中间号-号码绑定',
+ 'description' => '在调用此接口前，请确保您已在控制台购买隐私号。'."\n"
."\n"
- .'### PoolKey和ProductType限制'."\n"
- .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。 建议原阿里大于客户填ProductType参数，阿里云用户填PoolKey参数。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ .'您可以使用此接口给700GXB隐私号绑定号码，也可以在控制台号码管理页面给700GXB隐私号绑定号码。'."\n"
+ ."\n"
+ .'700GXB隐私号，绑定号码前建议您先明确业务场景中的G角色、B角色。例如：在招聘平台中，B是应聘者，G是招聘团队。'."\n"
+ ."\n"
+ .'QPS限制'."\n"
+ .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'UnbindSubscription' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BindXB' => [
+ 'summary' => '接入方调用本接口请求工作号平台为指定工作号X和员工号码B建立关联（B，X）。仅当员工（号码B）完成工作号X的实名认证之后，关系绑定才会生效。关系绑定成功后，所有对工作号X的呼叫都会转接到员工号码B。工作号平台通过“异步通知接口”，把关系绑定的结果推送到接入方。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72636',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '244978',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。'."\n"
- ."\n"
- .'> 当**ProductType**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'ProductType',
+ 'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'description' => '产品类型。取值：'."\n"
- .'- **AXB_170**。'."\n"
- .'- **AXN_170**。'."\n"
- .'- **AXN_95**。'."\n"
- .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
- ."\n"
- .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
- .'> - 当**PoolKey**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AXB_170',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
- 'name' => 'SubsId',
+ 'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系ID。'."\n"
- ."\n"
- .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页筛选号码，点击**详情**查看号码的绑定关系ID，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定API时查看返回参数中的**SubsId**。'."\n"
- .'> 在填写绑定关系ID时，注意填写与**SecretNo**参数关联的绑定关系ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1************2',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'SecretNo',
+ 'name' => 'TelB',
'in' => 'query',
- 'schema' => [
- 'description' => '隐私号码。'."\n"
- ."\n"
- .'调用[BindAXG](~~110249~~)等号码绑定接口时指定或自动分配的X号码。'."\n"
- ."\n"
- .'登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码。'."\n"
- .'> 在填写X号码时，注意填写与**SubsId**参数关联的X号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****1111',
- ],
+ 'schema' => ['title' => '员工真实号码', 'description' => '员工真实号码。', 'type' => 'string', 'required' => true, 'example' => '18*******22'],
+ ],
+ [
+ 'name' => 'TelX',
+ 'in' => 'query',
+ 'schema' => ['title' => 'X号码', 'description' => 'X号码。', 'type' => 'string', 'required' => true, 'example' => '17*******22'],
+ ],
+ [
+ 'name' => 'UserData',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户自定义参数回调带回', 'description' => '回传参数，客户可自定义。', 'type' => 'string', 'required' => false, 'example' => '000'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36',
- ],
- 'ChargeId' => [
- 'description' => '废弃参数。',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthId' => ['title' => '工作号关系绑定的唯一标识', 'description' => '工作号关系绑定的唯一标识', 'type' => 'string', 'example' => '4353453456'],
+ 'TelX' => ['title' => 'X号码', 'description' => 'X号码', 'type' => 'string', 'example' => '18640577897'],
+ ],
+ 'example' => '',
+ 'description' => '',
+ ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .'其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A9901233D36\\",\\n \\"ChargeId\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UnbindSubscriptionResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>9B2757F9-8FD0-48B9-9640-EF54783A06C4</RequestId>\\r\\n\\t<ChargeId>true</ChargeId>\\r\\n\\t<Code>OK</Code>\\r\\n</UnbindSubscriptionResponse>","errorExample":""}]',
- 'title' => '解除已绑定的号码',
- 'summary' => '解除号码的绑定关系。',
- 'description' => '- 在解绑前，建议您明确需解除绑定关系的隐私号码，即X号码。'."\n"
- ."\n"
- .'- 释放号码前，需解除号码绑定关系。'."\n"
- ."\n"
- .'- 您可以使用此接口解除号码绑定关系，也可以在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面>**详情**>**解绑**>**确定**解除号码绑定关系。'."\n"
- ."\n"
- .'### QPS 限制'."\n"
- .'本接口的单用户QPS限制为 5000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
- ."\n"
- .'### PoolKey和ProductType限制'."\n"
- .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。 建议原阿里大于用户填ProductType参数，现阿里云用户填PoolKey参数。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"AuthId\\": \\"4353453456\\",\\n \\"TelX\\": \\"18640577897\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ 'title' => 'XB关系绑定',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'QuerySubscriptionDetail' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'BuySecretNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'none',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72633',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '72612',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -3031,251 +2534,119 @@
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。'."\n"
- ."\n"
- .'> 当**ProductType**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['description' => '号码池Key。请登录[号码隐私保护控制台](https://dypls.console.aliyun.com/dypls.htm#/account)，在**号码池管理**中查看号码池Key。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC123456'],
],
[
- 'name' => 'ProductType',
+ 'name' => 'SpecId',
'in' => 'query',
- 'schema' => [
- 'description' => '产品类型。取值：'."\n"
- .'- **AXB_170**。'."\n"
- .'- **AXN_170**。'."\n"
- .'- **AXN_95**。'."\n"
- .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
- ."\n"
- .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
- .'> - 当**PoolKey**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AXB_170',
- ],
+ 'schema' => ['description' => '号码类型。取值：'."\n"
+ .'- **1**：虚商号码，即170或171。'."\n"
+ .'- **2**：运营商号码。'."\n"
+ .'- **3**：95号码。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'],
],
[
- 'name' => 'SubsId',
+ 'name' => 'City',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系ID。'."\n"
- ."\n"
- .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面筛选号码，点击**详情**查看号码的绑定关系ID，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定API时查看返回参数中的**SubsId**。'."\n"
- ."\n"
- .'> 在填写绑定关系ID时，注意填写与**PhoneNoX**参数关联的绑定关系ID。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '100000076879****',
- ],
+ 'schema' => ['description' => '指定号码的归属地。'."\n"
+ ."\n"
+ .'> - 当前仅支持设置归属地为中国大陆地区。'."\n"
+ .'> - 95号码不区分地区，如果购买95号码，则该参数应指定为**全国通用**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '杭州'],
],
[
- 'name' => 'PhoneNoX',
+ 'name' => 'SecretNo',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系中的隐私号码，即X号码。'."\n"
- ."\n"
- .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。'."\n"
- ."\n"
- .'> 在填写X号码时，注意填写与**SubsId**参数关联的X号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****1111',
- ],
+ 'schema' => ['description' => '指定号码前缀。购买号码时，如果指定**SecretNo**，会根据指定的号码前缀模糊匹配手机号。'."\n"
+ ."\n"
+ .'> 最长可指定18位号码前缀。', 'type' => 'string', 'required' => false, 'example' => '130'],
+ ],
+ [
+ 'name' => 'DisplayPool',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否将该号码置于显号池。'."\n"
+ ."\n"
+ .'> 该参数仅对开通显号功能的客户生效。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '066E6E47-04CB-4774-A976-4F73CB76D4A3',
- ],
- 'SecretBindDetailDTO' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020'],
+ 'SecretBuyInfoDTO' => [
'description' => '接口调用成功后返回的结构体。',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'description' => '该绑定关系的状态。取值：'."\n"
- .'- **0**：已失效。'."\n"
- .'- **1**：生效中。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Extension' => [
- 'description' => 'AXG分机号中的分机号码。',
- 'type' => 'string',
- 'example' => '130',
- ],
- 'PhoneNoB' => [
- 'description' => '绑定关系中的B号码。',
- 'type' => 'string',
- 'example' => '138****0000',
- ],
- 'GroupId' => [
- 'description' => '绑定关系中的G号码组ID，即GID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200001234****',
- ],
- 'NeedRecord' => [
- 'description' => '是否对该绑定关系产生的所有通话，进行通话录音。取值：'."\n"
- .'- **false**：不录音'."\n"
- .'- **true**：录音',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ASRStatus' => [
- 'description' => 'ASR状态。取值：'."\n"
- ."\n"
- .'- **false**：关闭'."\n"
- .'- **true**：开启',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'GmtCreate' => [
- 'description' => '绑定关系的创建时间。',
- 'type' => 'string',
- 'example' => '2019-03-05 12:00:00',
- ],
- 'ExpireDate' => [
- 'description' => '绑定关系的过期时间。',
- 'type' => 'string',
- 'example' => '2019-09-05 12:00:00',
- ],
- 'SubsId' => [
- 'description' => '绑定关系ID。',
- 'type' => 'string',
- 'example' => '100000076879****',
- ],
- 'PhoneNoX' => [
- 'description' => '绑定关系中的隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '139****1111',
- ],
- 'CallRestrict' => [
- 'description' => '单通呼叫限制的状态。如果没有设置单通呼叫限制，则不返回该参数。取值：'."\n"
- .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
- .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。',
- 'type' => 'string',
- 'example' => 'CONTROL_BX_DISABLE ',
- ],
- 'ASRModelId' => [
- 'description' => 'ASR模型ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- ."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- ."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
- 'PhoneNoA' => [
- 'description' => '绑定关系中的A号码。',
- 'type' => 'string',
- 'example' => '139****0000',
- ],
+ 'SecretNo' => ['description' => '隐私号码，即X号码。', 'type' => 'string', 'example' => '1390000****'],
],
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"066E6E47-04CB-4774-A976-4F73CB76D4A3\\",\\n \\"SecretBindDetailDTO\\": {\\n \\"Status\\": 1,\\n \\"Extension\\": \\"130\\",\\n \\"PhoneNoB\\": \\"138****0000\\",\\n \\"GroupId\\": 0,\\n \\"NeedRecord\\": true,\\n \\"ASRStatus\\": true,\\n \\"GmtCreate\\": \\"2019-03-05 12:00:00\\",\\n \\"ExpireDate\\": \\"2019-09-05 12:00:00\\",\\n \\"SubsId\\": \\"100000076879****\\",\\n \\"PhoneNoX\\": \\"139****1111\\",\\n \\"CallRestrict\\": \\"CONTROL_BX_DISABLE \\",\\n \\"ASRModelId\\": \\"7ee372834d2f4cc7ac0d0ab2d0ae1aac\\",\\n \\"PhoneNoA\\": \\"139****0000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySubscriptionDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>066E6E47-04CB-4774-A976-4F73CB76D4A3</RequestId>\\n <SecretBindDetailDTO>\\n <Status>1</Status>\\n <Extension>130</Extension>\\n <PhoneNoB>13900002222</PhoneNoB>\\n <GroupId>2000000130001</GroupId>\\n <NeedRecord>true</NeedRecord>\\n <ASRStatus>true</ASRStatus>\\n <GmtCreate>2019-03-05 12:00:00</GmtCreate>\\n <ExpireDate>2019-09-05 12:00:00</ExpireDate>\\n <SubsId>100000076879****</SubsId>\\n <PhoneNoX>13900001234</PhoneNoX>\\n <CallRestrict>CONTROL_BX_DISABLE </CallRestrict>\\n <ASRModelId>123456</ASRModelId>\\n <PhoneNoA>13900001111</PhoneNoA>\\n </SecretBindDetailDTO>\\n</QuerySubscriptionDetailResponse>","errorExample":""}]',
- 'title' => '查询号码绑定详情',
- 'summary' => '查询号码的绑定详情。获取号码绑定关系状态、分机号码、是否录音、ASR状态等信息。',
- 'description' => '查询前，建议您先明确需查询的隐私号码，即X号码，且该号码有绑定关系。'."\n"
- ."\n"
- .'### QPS限制 '."\n"
- .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
- ."\n"
- .'### PoolKey和ProductType限制'."\n"
- .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。'."\n"
- .'建议原阿里大于用户填ProductType参数，阿里云用户填PoolKey参数。',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\",\\n \\"SecretBuyInfoDTO\\": {\\n \\"SecretNo\\": \\"1390000****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<BuySecretNoResponse>\\r\\n\\t<SecretBuyInfoDTO>\\r\\n\\t\\t<SecretNo>17100000000</SecretNo>\\r\\n\\t</SecretBuyInfoDTO>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</BuySecretNoResponse>","errorExample":""}]',
+ 'title' => '购买号码',
+ 'summary' => '购买号码。',
+ 'description' => '- 在控制台创建号码池后，号码池默认为空，需要为号码池购买号码。'."\n"
+ .'- 购买号码操作涉及到资源资费，请确保在使用该接口前，已充分了解X号码隐私保护产品的收费方式和[价格](~~59825~~)。'."\n"
+ .'- 购买号码时，指定归属地如果没有足够号码可供购买，会造成号码购买失败。调用此接口购买号码前，请先通过[QuerySecretNoRemain](~~111699~~)查询线上可购号码余量。'."\n"
+ .'- 购买号码的账号必须已实名认证为企业账号。如何进行实名认证，请参见[企业实名认证](~~37172~~)。',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'QuerySubsId' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'dypls:BuySecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CancelPickUpWaybill' => [
+ 'summary' => '取消上门寄件订单。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72634',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '100670',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
],
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'Content-Type',
+ 'in' => 'header',
+ 'schema' => ['description' => 'HTTP请求内容类型。'."\n"
+ .'非必填，如果填，请填写application/json;chatset=UTF-8', 'type' => 'string', 'required' => false, 'example' => 'application/json;chatset=UTF-8', 'default' => 'application/json;charset=UTF-8'],
+ ],
+ [
+ 'name' => 'OuterOrderCode',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['description' => '外部订单号。', 'type' => 'string', 'required' => true, 'example' => '1145678823****'],
],
[
- 'name' => 'PhoneNoX',
+ 'name' => 'CancelDesc',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系中的隐私号码，即X号码。'."\n"
- ."\n"
- .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '139****1111',
- ],
+ 'schema' => ['description' => '取消原因。', 'type' => 'string', 'required' => true, 'example' => '不想退货了'],
],
],
'responses' => [
@@ -3284,25 +2655,21 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。返回OK代表请求成功。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'E7F99446-8191-43C0-99B5-F58A6AEAD779',
- ],
- 'SubsId' => [
- 'description' => '绑定关系ID。若隐私号码存在多个绑定关系时，会返回多个SubsId。',
- 'type' => 'string',
- 'example' => '1000******,1000******,1000******',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2'],
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => '请求成功'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => '是否取消成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '无'],
+ 'Message' => ['description' => '取消结果。', 'type' => 'string', 'example' => '取消成功'],
+ 'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
+ ],
],
],
],
@@ -3310,189 +2677,208 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'POOLKEY_NOT_EXIST',
- 'errorMessage' => 'poolKey not exsit.',
- ],
+ ['errorCode' => 'Insufficient.Balance', 'errorMessage' => 'You have an insufficient balance.', 'description' => ''],
+ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => ''],
+ ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
+ ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => ''],
+ ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'Permission.NotAuthorized', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"无\\",\\n \\"Message\\": \\"取消成功\\",\\n \\"ErrorMsg\\": \\"无\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelPickUpWaybillResponse>\\n <RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\n <Code>OK</Code>\\n <Message>请求成功</Message>\\n <Data>\\n <Success>true</Success>\\n <ErrorCode>无</ErrorCode>\\n <Message>取消成功</Message>\\n <ErrorMsg>无</ErrorMsg>\\n </Data>\\n</CancelPickUpWaybillResponse>","errorExample":""}]',
+ 'title' => '取消上门寄件订单',
+ 'description' => '### QPS限制'."\n"
+ .'本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-25T07:45:44.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:CancelPickUpWaybill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E7F99446-8191-43C0-99B5-F58A6AEAD779\\",\\n \\"SubsId\\": \\"1000******,1000******,1000******\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySubsIdResponse>\\n\\t<Message>OK</Message>\\n\\t<SubsId>117809</SubsId>\\n\\t<RequestId>F3BC6628-7976-41BA-87D0-D152BAB2A9C8</RequestId>\\n\\t<Code>OK</Code>\\n</QuerySubsIdResponse>","errorExample":""}]',
- 'title' => '查询号码绑定ID',
- 'summary' => '查询绑定关系的唯一标识SubsId。',
- 'description' => '- 支持根据X号码查询绑定关系的唯一标识SubsId。'."\n"
- .'- 查询前，建议您先明确需查询的隐私号码，即X号码。'."\n"
- .'- 在AXB中间号、AXN分机号场景中，同一个X号码可能存在多组绑定关系，查询结果会为多条，若X号码无绑定关系，查询结果会为空字符串。'."\n"
- ."\n"
- .'### QPS 限制'."\n"
- .'本接口的单用户QPS限制为 1000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'QuerySecretNoDetail' => [
- 'summary' => '查询隐私号码的属性信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'ConfigX' => [
+ 'summary' => '配置X号码，单独对工作号的话音呼叫、企业名片等通信功能进行配置操作。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '107292',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '244982',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'SecretNo',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'description' => '隐私号码，即X号码。'."\n"
- ."\n"
- .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1390000****',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，reqId最大长度为20位，接入方需要保持原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'PoolKey',
+ 'name' => 'CallerParentId',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '系统自动获取，无需输入。'],
+ ],
+ [
+ 'name' => 'CustomerPoolKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
+ ],
+ [
+ 'name' => 'TelX',
'in' => 'query',
+ 'schema' => ['title' => 'X号码', 'description' => 'X号码。', 'type' => 'string', 'required' => true, 'example' => '17*******22'],
+ ],
+ [
+ 'name' => 'GNFlag',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否透传来显为真实主叫：00-非透传：互相拨打时都显示工作号;10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号;默认为 00', 'description' => '是否透传来显为真实主叫，取值：'."\n"
+ ."\n"
+ .'- 00：非透传，互相拨打时都显示工作号。'."\n"
+ ."\n"
+ .'- 10：透传，A客户为主叫时，B员工的来显为客户A号码；B员工为主叫时，A客户的来显为工作号。'."\n"
+ ."\n"
+ .'默认为 00。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'SmsSignMode',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否透传来显为真实用户0：不透传; 1：透传默认：0不透传', 'description' => '是否透传来显为真实用户，取值：'."\n"
+ ."\n"
+ .'- 0：不透传。'."\n"
+ ."\n"
+ .' - 1：透传。'."\n"
+ ."\n"
+ .'默认为0不透传。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'SmsAbility',
+ 'in' => 'query',
+ 'schema' => ['title' => '开/关短信功能状态‘0’：禁用；‘1’：开启；', 'description' => '开/关短信功能状态，取值：'."\n"
+ ."\n"
+ .'- 0：禁用。'."\n"
+ ."\n"
+ .'- 1：开启。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'CallAbility',
+ 'in' => 'query',
+ 'schema' => ['title' => '开/关呼叫能力状态‘0’：禁用‘1’：开启', 'description' => '开/关呼叫能力状态，取值：'."\n"
+ ."\n"
+ .'- 0：禁用。'."\n"
+ ."\n"
+ .'- 1：开启。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'SequenceMode',
+ 'in' => 'query',
+ 'schema' => ['title' => '顺振模式：0-不顺振（默认）1-有条件顺振，先接续calledNo指定被叫，如果该被叫未能接通，再顺振sequenceCalls号码列表2-无条件顺振，不接续calledNo指定被叫，直接顺振sequenceCalls号码列表', 'description' => '顺振模式，取值：'."\n"
+ ."\n"
+ .'- 0：不顺振（默认）'."\n"
+ ."\n"
+ .'- 1：有条件顺振，先接续calledNo指定被叫，如果该被叫未能接通，再顺振sequenceCalls号码列表。'."\n"
+ ."\n"
+ .'- 2：无条件顺振，不接续calledNo指定被叫，直接顺振sequenceCalls号码列表。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'SequenceCalls',
+ 'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC2258****',
+ 'title' => '顺振控制参数',
+ 'description' => '顺振控制参数。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SequenceCallNoPlayCode' => ['title' => '顺振提示音放音编号，格式如callNoPlayCode', 'description' => '顺振提示音放音编号，格式如callNoPlayCode。', 'type' => 'string', 'required' => false, 'example' => '01'],
+ 'SequenceCalledNo' => ['title' => '顺振被叫号码', 'description' => '顺振被叫号码。', 'type' => 'string', 'required' => false, 'example' => '18*******33'],
+ 'SequenceCalledPlayCode' => ['title' => '接通后主被叫放音编号，格式如calledPlayCode', 'description' => '接通后主被叫放音编号，格式如calledPlayCode。', 'type' => 'string', 'required' => false, 'example' => '02'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '066E6E47-04CB-4774-A976-4F73CB76D4A3',
- ],
- 'SecretNoInfoDTO' => [
- 'description' => '号码属性。',
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Data' => [
'type' => 'object',
'properties' => [
- 'PurchaseTime' => [
- 'description' => '号码购买时间。',
- 'type' => 'string',
- 'example' => '2021-12-03 15:19:27',
- ],
- 'Vendor' => [
- 'description' => '归属运营商。取值：'."\n"
- ."\n"
- .'- **1**：中国移动'."\n"
- .'- **2**：中国联通'."\n"
- .'- **3**：中国电信',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Province' => [
- 'description' => '省份。',
- 'type' => 'string',
- 'example' => '陕西',
- ],
- 'City' => [
- 'description' => '城市。',
- 'type' => 'string',
- 'example' => '西安',
- ],
- 'SecretStatus' => [
- 'description' => '号码状态。取值：'."\n"
- ."\n"
- .'- **0**：未绑定。'."\n"
- .'- **1**：已绑定。'."\n"
- .'- **2**：已锁定。'."\n"
- .'- **3**：已冻结。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'CertifyStatus' => [
- 'description' => '号码认证状态。取值：'."\n"
- ."\n"
- .'- **0**：未认证。'."\n"
- .'- **1**：已认证。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息', 'type' => 'string', 'example' => '成功'],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码 0000表示成功 其他表示失败', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功 true 表示成功 false表示失败', 'type' => 'boolean', 'example' => 'true'],
],
- ],
+ 'description' => '',
+ ],
+ 'Code' => ['description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000表示成功。'."\n"
+ ."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ .' '."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'FlowLimited',
- 'errorMessage' => 'The operation is denied due to flow control.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '配置X号码的通信属性',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:ConfigX',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"066E6E47-04CB-4774-A976-4F73CB76D4A3\\",\\n \\"SecretNoInfoDTO\\": {\\n \\"PurchaseTime\\": \\"2021-12-03 15:19:27\\",\\n \\"Vendor\\": 1,\\n \\"Province\\": \\"陕西\\",\\n \\"City\\": \\"西安\\",\\n \\"SecretStatus\\": 0,\\n \\"CertifyStatus\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySecretNoDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>066E6E47-04CB-4774-A976-4F73CB76D4A3</RequestId>\\n <SecretNoInfoDTO>\\n <PurchaseTime>2021-12-03 15:19:27</PurchaseTime>\\n <Vendor>1</Vendor>\\n <Province>陕西省</Province>\\n <City>西安</City>\\n <SecretStatus>0</SecretStatus>\\n <CertifyStatus>0</CertifyStatus>\\n </SecretNoInfoDTO>\\n</QuerySecretNoDetailResponse>","errorExample":""}]',
- 'title' => '查询隐私号码属性',
- 'description' => '- 支持根据X号码获取号码的购买时间、归属运营商、省份、城市、状态等信息。'."\n"
- .'- 查询前，建议您先明确需查询的隐私号码，即X号码。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，请合理调用。',
],
'CreateAxgGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -3504,9 +2890,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '72614',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsNPUT41',
- ],
+ 'abilityTreeNodes' => ['FEATUREdyplsNPUT41'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -3514,48 +2898,28 @@
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'example' => 'FC10000012345****'],
],
[
'name' => 'Name',
'in' => 'query',
- 'schema' => [
- 'description' => 'G号码组名称。如果未指定G号码组名称，将以G号码组的ID作为名称。'."\n"
- ."\n"
- .'> 支持中文、英文和特殊字符（例如：!@#$^_"等），长度不超过16个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试分组',
- ],
+ 'schema' => ['description' => 'G号码组名称。如果未指定G号码组名称，将以G号码组的ID作为名称。'."\n"
+ ."\n"
+ .'> 支持中文、英文和特殊字符（例如：!@#$^_"等），长度不超过16个字符。', 'type' => 'string', 'required' => false, 'example' => '测试分组'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => 'G号码组的备注信息。'."\n"
- ."\n"
- .'> 支持中文、英文和特殊字符（例如：!@#$^_"等），长度不超过50个字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '测试用分组',
- ],
+ 'schema' => ['description' => 'G号码组的备注信息。'."\n"
+ ."\n"
+ .'> 支持中文、英文和特殊字符（例如：!@#$^_"等），长度不超过50个字符。', 'type' => 'string', 'required' => false, 'example' => '测试用分组'],
],
[
'name' => 'Numbers',
'in' => 'query',
- 'schema' => [
- 'description' => '向新建的G号码组中添加的电话号码。多个号码之间用英文逗号（,）分隔，创建时最多添加200个号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1390000****,1380000**** ',
- ],
+ 'schema' => ['description' => '向新建的G号码组中添加的电话号码。多个号码之间用英文逗号（,）分隔，创建时最多添加200个号码。', 'type' => 'string', 'required' => false, 'example' => '1390000****,1380000**** '],
],
],
'responses' => [
@@ -3564,36 +2928,17 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '635C0FDA-9EBC-43D7-B368-9F583C08A126',
- ],
- 'GroupId' => [
- 'description' => '新建的G号码组的ID，即GID。通过接口[BindAXG](~~110249~~)绑定号码时需要输入此参数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200001234****',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '635C0FDA-9EBC-43D7-B368-9F583C08A126'],
+ 'GroupId' => ['description' => '新建的G号码组的ID，即GID。通过接口[BindAXG](~~110249~~)绑定号码时需要输入此参数。', 'type' => 'integer', 'format' => 'int64', 'example' => '200001234****'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"635C0FDA-9EBC-43D7-B368-9F583C08A126\\",\\n \\"GroupId\\": 0\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<CreateAxgGroupResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>635C0FDA-9EBC-43D7-B368-9F583C08A126</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<GroupId>2000000000001</GroupId>\\r\\n</CreateAxgGroupResponse>","errorExample":""}]',
'title' => '创建G号码组',
'summary' => '创建G号码组。仅AXG隐私号类型的号码池支持设置G号码组。',
@@ -3610,782 +2955,159 @@
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
- ],
- 'OperateAxgGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72627',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsNPUT41',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC10000012345****',
- ],
- ],
- [
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'AXG中的G组ID，即GID。'."\n"
- ."\n"
- .'可以通过以下方式查看GID：'."\n"
- .'- 登录号码隐私保护控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**，单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
- .'- 如果G号码组是通过接口[CreateAxgGroup](~~110250~~)创建的，则接口的返回参数**GroupID**就是此处的请求参数**GroupID**。'."\n"
- ."\n"
- .'> G号码组中必须有一个及以上的电话号码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '200001234****',
- ],
- ],
- [
- 'name' => 'OperateType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '对G号码组的操作类型，取值：'."\n"
- .'- **addNumbers**：添加号码。'."\n"
- .'- **deleteNumbers**：删除号码。'."\n"
- .'- **overwriteNumbers**：全量替换号码。会将G号码组中原有的电话号码全部删除，并重新添加号码。'."\n"
- ."\n"
- .'> - 每次添加号码时，最多添加200个号码。'."\n"
- .'> - 全量替换号码时，G号码组中原有的号码不能超过200个。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'addNumbers',
- ],
- ],
- [
- 'name' => 'Numbers',
- 'in' => 'query',
- 'schema' => [
- 'description' => '受到操作的电话号码。'."\n"
- ."\n"
- .'多个号码之间用英文逗号（,）分隔，每次最多操作200个号码。'."\n"
- ."\n"
- .'> - 当**OperateType**参数指定为**addNumbers**时，将**Numbers**参数填写的电话号码**添加**到G号码组中。'."\n"
- .'> - 当**OperateType**参数指定为**deleteNumbers**时，将**Numbers**参数填写的电话号码从G号码组中**删除**。'."\n"
- .'> - 当**OperateType**参数指定为**overwriteNumbers**时，使用**Numbers**参数填写的电话号码**全量替换**G号码组中原有的电话号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1390000****,1380000****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A9901233D36\\"\\n}","errorExample":""},{"type":"xml","example":"<OperateAxgGroupResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\n</OperateAxgGroupResponse>","errorExample":""}]',
- 'title' => '修改G号码组',
- 'summary' => '修改G号码组中的号码，可以对号码进行添加、删除、全量替换操作。',
- 'description' => '- 创建G号码组之后，可以通过此接口修改G号码组中的号码，例如向G号码组中增加号码、删除号码、全量替换号码。'."\n"
- ."\n"
- .'- 您可以使用此接口修改G号码组中的号码，也可以登录控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**类型的号码池，单击**G号码组管理**>**G组号码管理**进行修改。'."\n"
- ."\n"
- .'- 在使用此接口前，建议您先明确需要修改的G号码组及该号码组归属的号码池。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteAxgGroup' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '175380',
- 'abilityTreeNodes' => [
- 'FEATUREdypls13M9H9',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC2235****',
- ],
- ],
- [
- 'name' => 'GroupId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'AXG中的G组ID，即GID。'."\n"
- ."\n"
- .'- 登录号码隐私保护控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**，单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
- .'- 如果G号码组是通过接口[CreateAxgGroup](~~110250~~)创建的，则接口的返回参数**GroupID**就是此处的请求参数**GroupID**。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '200001234****',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '返回结果的提示信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID，阿里云为该请求生成的标识符。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050D9369D',
- ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAxgGroup'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:CreateAxgGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050D9369D\\"\\n}","type":"json"}]',
- 'title' => '删除G号码组',
- 'summary' => '删除G号码组。仅AXG隐私号类型的号码池支持设置G号码组。',
- 'description' => '- G号码组删除后不可恢复，请谨慎操作。'."\n"
- ."\n"
- .'- 在调用此接口前，建议您先确认需要删除的G号码组及该号码组归属的号码池。'."\n"
- ."\n"
- .'- 不支持删除存在绑定关系的G号码组，删除G号码组前，建议您先解除AXG隐私号与该号码组的绑定关系。可登录控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面，筛选**AXG隐私号**，单击**详情**>**解绑**进行操作，或者调用[UnbindSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-unbindsubscription)接口解除号码的绑定关系。'."\n"
- ."\n"
- .'- 删除G号码组时，如果G号码组内存在号码，也会一并删除。'."\n"
- ."\n"
- .'### QPS 限制'."\n"
- .'本接口的单用户QPS限制为 5000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
],
- 'QueryRecordFileDownloadUrl' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreateFixedNoAReport' => [
+ 'summary' => '通过API提交A号码固话个人信息报备。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72631',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsVL8MN2',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'deprecated' => false,
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'FixedNoA',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。'."\n"
- ."\n"
- .'> 当**ProductType**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => false,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['title' => 'a号码(固话)', 'description' => 'A号码（固话）。', 'type' => 'string', 'required' => true, 'example' => '89*****1234'],
],
[
- 'name' => 'ProductType',
+ 'name' => 'ANoWhiteGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '产品类型。取值：'."\n"
- .'- **AXB_170**。'."\n"
- .'- **AXN_170**。'."\n"
- .'- **AXN_95**。'."\n"
- .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
- ."\n"
- .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
- .'> - 当**PoolKey**为空时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'AXB_170',
- ],
+ 'schema' => ['title' => '所属a号码组id', 'description' => '所属A号码组ID。在[资质管理](https://dyplsnext.console.aliyun.com/qualification)页面所属资质的A号码白名单栏单击查看详情。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12'],
],
[
- 'name' => 'CallId',
+ 'name' => 'DocumentType',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
- ."\n"
- .'获取方式如下：'."\n"
- .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫记录ID**。'."\n"
- .'- 在**录音状态报告**回执消息中查看**call_id**字段。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '416*********bd50',
- ],
+ 'schema' => ['title' => '证件类型 填写1表示身份证', 'description' => '证件类型，填写1表示身份证。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'CallTime',
+ 'name' => 'CustName',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录中的呼叫发起时间。'."\n"
- ."\n"
- .'获取方式如下：'."\n"
- ."\n"
- .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫时间**列的**呼叫发起**时间。'."\n"
- .'- 在**录音状态报告**回执消息中查看**call_time**字段。'."\n"
- ."\n"
- .'> **CallTime**不支持传入时间戳格式的参数。',
- 'type' => 'string',
- 'required' => false,
- 'docRequired' => true,
- 'example' => '2019-03-05 12:00:00 ',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1AB3CEF7-DCBE-488C-9C33-D180982CE031',
- ],
- 'DownloadUrl' => [
- 'description' => '录音文件的下载链接URL。URL链接的有效期为2小时。',
- 'type' => 'string',
- 'example' => 'http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820******_66647243838006067251************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n********7lg4/WmEA%3D',
- ],
- ],
- ],
+ 'schema' => ['title' => '姓名', 'description' => '姓名。', 'type' => 'string', 'required' => true, 'example' => '赵**'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AB3CEF7-DCBE-488C-9C33-D180982CE031\\",\\n \\"DownloadUrl\\": \\"http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820******_66647243838006067251************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n********7lg4/WmEA%3D\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordFileDownloadUrlResponse>\\n<RequestId>1AB3CEF7-DCBE-488C-9C33-D180982CE031</RequestId>\\n<Message>OK</Message>\\n<Code>OK</Code>\\n<DownloadUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&amp;OSSAccessKeyId=LTAIP00vvvvvvvvv&amp;Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</DownloadUrl>\\n</QueryRecordFileDownloadUrlResponse>","errorExample":""}]',
- 'title' => '获取录音文件的下载链接',
- 'summary' => '根据号码池Key、呼叫记录ID、呼叫发起时间等获取录音文件的下载链接。',
- 'description' => '- 如果在绑定关系中开启了录音功能，该绑定关系产生的所有通话均会被录音，可以通过此接口获取录音文件的下载链接，下载录音文件。'."\n"
- ."\n"
- .'- 您可以使用此接口获取录音文件的下载链接进行录音文件下载，也可以在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面查询呼叫记录，单击**录音文件操作**列的**下载**下拉项，单击**录音音频**进行录音文件下载。'."\n"
- ."\n"
- .'- 在使用此接口前，建议您先明确需要获取的录音文件对应的呼叫记录。'."\n"
- .'您可以在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取呼叫记录ID、呼叫发起时间等信息，或者参考[回执消息简介与配置流程](https://help.aliyun.com/zh/pnp/developer-reference/introduction-to-receipt-messages-and-receipt-message-configurations?spm=a2c4g.11186623.0.0.7b2d7fcbozUnoz)，订阅**回执消息类型**为**录音状态报告**（SecretRecording）的消息，该报告消息中的结果字段可以作为此接口的入参。'."\n"
- ."\n"
- .'### QPS 限制'."\n"
- .'本接口的单用户QPS限制为 3000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
- ."\n"
- .'### PoolKey和ProductType限制'."\n"
- .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。建议原阿里大于用户填ProductType参数，阿里云用户填PoolKey参数。'."\n"
- ."\n"
- .'### 获取录音文件步骤：'."\n"
- .'1. 在更新或绑定关系接口中选择入参需要录音。'."\n"
- .'2. 在控制台中订阅录音消息回执。'."\n"
- .'3. 录音消息回执返回后调用QueryRecordFileDownloadUrl接口下载录音。'."\n"
- ."\n"
- .'> - URL链接的有效期为2小时。获取下载链接后请尽快下载录音文件。'."\n"
- .'> - 录音文件的存储周期是30天，仅支持下载30天内通话记录的录音文件。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetTotalPublicUrl' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72621',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'CheckSubs',
+ 'name' => 'DocumentNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '是否需要校验绑定关系标识。'."\n"
- .'取值：'."\n"
- ."\n"
- .'**true**：需要校验。'."\n"
- ."\n"
- .'**false**：不需要校验。',
- 'type' => 'boolean',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '证件号码', 'description' => '证件号码。', 'type' => 'string', 'required' => true, 'example' => '370*********'],
],
[
- 'name' => 'PartnerKey',
+ 'name' => 'CustType',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC12256****',
- ],
+ 'schema' => ['title' => '固话客户类型 1:法人,2:经办人', 'description' => '固话客户类型。取值：'."\n"
+ ."\n"
+ .'- 1：法定代表人。'."\n"
+ ."\n"
+ .'- 2：经办人。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'CallId',
+ 'name' => 'FixedLineWorkId',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
- ."\n"
- .'获取方式如下：'."\n"
- .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫记录ID**。'."\n"
- .'- 在**录音状态报告**回执消息中查看**call_id**字段。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2568900****',
- ],
+ 'schema' => ['title' => '固话申请时服务大厅工单号', 'description' => '固话申请时线下服务大厅工单号。', 'type' => 'string', 'required' => false, 'example' => '45***12'],
],
[
- 'name' => 'CallTime',
+ 'name' => 'IdCardFrontPhoto',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录中的呼叫发起时间。'."\n"
- ."\n"
- .'获取方式如下：'."\n"
- ."\n"
- .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫时间**列的**呼叫发起**时间。'."\n"
- .'- 在**录音状态报告**回执消息中查看**call_time**字段。'."\n"
- ."\n"
- .'> **CallTime**不支持传入时间戳格式的参数。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2019-03-05 12:00:00 ',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1AB3CEF7-DCBE-488C-9C33-D180982CE031',
- ],
- 'Data' => [
- 'description' => '录音文件下载地址。',
- 'type' => 'object',
- 'properties' => [
- 'RingPublicUrl' => [
- 'description' => '响铃放音的录音下载URL。'."\n"
- ."\n"
- .'> URL的有效期为30天。',
- 'type' => 'string',
- 'example' => 'http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D',
- ],
- 'PhonePublicUrl' => [
- 'description' => '通话录音的下载URL。'."\n"
- ."\n"
- .'> URL的有效期为30天。',
- 'type' => 'string',
- 'example' => 'http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'FlowLimited',
- 'errorMessage' => 'The operation is denied due to flow control.',
- ],
+ 'schema' => ['title' => '身份证正面照片oss路径地址', 'description' => '身份证正面（国徽面）照片OSS路径地址。', 'type' => 'string', 'required' => false, 'example' => '123456/test1719383196031.jpg'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AB3CEF7-DCBE-488C-9C33-D180982CE031\\",\\n \\"Data\\": {\\n \\"RingPublicUrl\\": \\"http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D\\",\\n \\"PhonePublicUrl\\": \\"http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTotalPublicUrlResponse>\\n<Message>OK</Message>\\n<RequestId>1AB3CEF7-DCBE-488C-9C33-D180982CE031</RequestId>\\n<Data>\\n <RingPublicUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&amp;OSSAccessKeyId=LTAIP00vvvvvvvvv&amp;Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</RingPublicUrl>\\n <PhonePublicUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&amp;OSSAccessKeyId=LTAIP00vvvvvvvvv&amp;Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</PhonePublicUrl>\\n</Data>\\n<Code>OK</Code>\\n</GetTotalPublicUrlResponse>","errorExample":""}]',
- 'title' => '获取响铃放音的录音下载链接',
- 'summary' => '获取响铃放音的录音下载链接。',
- 'description' => '- 您可以使用此接口获取响铃放音的录音下载链接来下载响铃放音的录音。'."\n"
- .'- 若您订阅了**回执消息类型**为**录音状态报告**（SecretRecording）的消息，该报告消息中的结果字段可以作为此接口的入参，您可以参考[回执消息简介与配置流程](https://help.aliyun.com/zh/pnp/developer-reference/introduction-to-receipt-messages-and-receipt-message-configurations)进行订阅。'."\n"
- .'- 新的呼叫记录需要一段时间生成响铃放音的录音，您可以等待几分钟再调用此接口查询响铃放音的录音下载链接。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'GetSecretAsrDetail' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '72619',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsVL8MN2',
+ 'name' => 'IdCardBackPhoto',
+ 'in' => 'query',
+ 'schema' => ['title' => '身份证反面照片oss路径地址', 'description' => '身份证反面（人像面）照片OSS路径地址。', 'type' => 'string', 'required' => false, 'example' => '123456/test1719383196032.jpg'],
],
- ],
- 'parameters' => [
[
- 'name' => 'CallId',
+ 'name' => 'IdCardAlivePhoto',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
- ."\n"
- .'获取方式如下：'."\n"
- .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫记录ID**。'."\n"
- .'- 在**录音状态报告**回执消息中查看**call_id**字段。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '225625****',
- ],
+ 'schema' => ['title' => '正面人像照片 OSS 路径地址', 'description' => '正面人像照片OSS路径地址。', 'type' => 'string', 'required' => true, 'example' => '123456/test1719383196033.jpg'],
],
[
- 'name' => 'CallTime',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫记录中的呼叫发起时间。'."\n"
- ."\n"
- .'获取方式如下：'."\n"
- ."\n"
- .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫时间**列的**呼叫发起**时间。'."\n"
- .'- 在**录音状态报告**回执消息中查看**call_time**字段。'."\n"
- ."\n"
- .'> **CallTime**不支持传入时间戳格式的参数。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '2019-03-05 12:00:00',
- ],
+ 'schema' => ['title' => '备注（客户自己的业务备注，可编辑）', 'description' => '备注（用户自身的业务备注）。', 'type' => 'string', 'required' => false, 'example' => '***报备'],
],
[
- 'name' => 'PoolKey',
+ 'name' => 'CustPhoneNo',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC2267****',
- ],
+ 'schema' => ['title' => '经办人/法人电话', 'description' => '法定代表人/经办人手机号'."\n"
+ .'>若该资质下有移动X号码，则此字段必填，否则将审核不通过。', 'type' => 'string', 'required' => false, 'example' => '130*****8888'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'RequestId' => ['title' => '返回id', 'description' => '返回ID。', 'type' => 'string', 'example' => '1D73E648-0978-18A5-B089-3BB2'],
+ 'Message' => ['title' => '失败错误提示', 'description' => '失败错误提示。', 'type' => 'string', 'example' => '固话号码***已存在'],
'Data' => [
- 'description' => 'ASR详情实体类信息。',
+ 'title' => 'A号码报备结果结构体',
+ 'description' => 'A号码报备结果结构体。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8d2329d407a83447a83be441681f4872ac74nE',
- ],
- 'BusinessId' => [
- 'description' => '业务流程的ID。',
- 'type' => 'string',
- 'example' => '435ee78c7a******@!FC100000074******@!2020061522****',
- ],
- 'BusinessKey' => [
- 'description' => '业务关键字。',
- 'type' => 'string',
- 'example' => 'JCGTncltuNao****',
- ],
- 'Code' => [
- 'description' => '状态码。21050000表示请求成功。',
- 'type' => 'string',
- 'example' => '21050000',
- ],
- 'Msg' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
- 'BizDuration' => [
- 'description' => '识别的音频文件总时长，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10944',
- ],
- 'Type' => [
- 'description' => '类型。',
- 'type' => 'string',
- 'example' => 'asrResult',
- ],
- 'Sentences' => [
- 'description' => 'ASR识别结果。',
- 'type' => 'array',
- 'items' => [
- 'description' => 'ASR识别结果。',
- 'type' => 'object',
- 'properties' => [
- 'EndTime' => [
- 'description' => '该句的结束时间偏移，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1770',
- ],
- 'SilenceDuration' => [
- 'description' => '本句和上一句之间的静音时长，单位：秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'BeginTime' => [
- 'description' => '该句的起始时间偏移，单位：毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1020',
- ],
- 'Text' => [
- 'description' => '该句的识别文本结果。',
- 'type' => 'string',
- 'example' => '您好',
- ],
- 'ChannelId' => [
- 'description' => '该句所属音轨ID。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'SpeechRate' => [
- 'description' => '本句的平均语速，单位为每分钟字数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80',
- ],
- 'EmotionValue' => [
- 'description' => '情绪能量值，取值：**1~10**，值越高情绪越强烈。',
- 'type' => 'string',
- 'example' => '5.7',
- ],
- ],
- ],
- ],
+ 'CreateResult' => ['title' => '创建结果', 'description' => '创建结果。', 'type' => 'boolean', 'example' => 'true'],
+ 'FailType' => ['title' => '创建类型枚举，1为成功，负数为创建失败', 'description' => '创建类型枚举，1表示成功，负数表示创建失败。取值：'."\n"
+ ."\n"
+ .'- 1：成功。'."\n"
+ ."\n"
+ .'- -1：该手机号已经提交报备，无需再次提交报备。'."\n"
+ ."\n"
+ .'- -2：该手机号已报备成功，无需再次报备。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
- 'example' => '{"bizDuration":10944,"businessId":"435ee78c7a019650@!FC100000074672458@!20200615225802","businessKey":"JCGTncltuNaolegJ","code":"21050000","msg":"SUCCESS","requestId":"8d2329d407a83447a83be441681f4872ac74nE","sentences":[{"beginTime":1020,"channelId":0,"emotionValue":"5.7","endTime":1770,"silenceDuration":"0","speechRate":"80","text":"喂"}],"success":true,"type":"asrResult"}',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
+ 'example' => '',
],
+ 'Code' => ['title' => '请求状态码', 'description' => '请求状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'isp.RAM_PERMISSION_DENY',
- 'errorMessage' => 'RAM permission is denied.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"固话号码***已存在\\",\\n \\"Data\\": {\\n \\"CreateResult\\": true,\\n \\"FailType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '提交A号码固话个人实名信息',
+ 'description' => '在调用此接口前，您需要先调用[GetDyplsOSSInfoForUploadFile](~~2880885~~)将个人照片信息上传至OSS，具体操作流程请参见[API提交A号码个人实名信息](~~2880077~~)。'."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFixedNoAReport'],
],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"8d2329d407a83447a83be441681f4872ac74nE\\",\\n \\"BusinessId\\": \\"435ee78c7a******@!FC100000074******@!2020061522****\\",\\n \\"BusinessKey\\": \\"JCGTncltuNao****\\",\\n \\"Code\\": \\"21050000\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"BizDuration\\": 10944,\\n \\"Type\\": \\"asrResult\\",\\n \\"Sentences\\": [\\n {\\n \\"EndTime\\": 1770,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 1020,\\n \\"Text\\": \\"您好\\",\\n \\"ChannelId\\": 0,\\n \\"SpeechRate\\": 80,\\n \\"EmotionValue\\": \\"5.7\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSecretAsrDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>\\n <RequestId>8d2329d407a83447a83be441681f4872ac74nE</RequestId>\\n <BusinessId>435ee78c7a019650@!FC100000074672458@!2020061522****</BusinessId>\\n <BusinessKey>JCGTncltuNao****</BusinessKey>\\n <Code>21050000</Code>\\n <Msg>SUCCESS</Msg>\\n <BizDuration>10944</BizDuration>\\n <Type>asrResult</Type>\\n <Sentences>\\n <EndTime>1770</EndTime>\\n <SilenceDuration>0</SilenceDuration>\\n <BeginTime>1020</BeginTime>\\n <Text>您好</Text>\\n <ChannelId>0</ChannelId>\\n <SpeechRate>80</SpeechRate>\\n <EmotionValue>5.7</EmotionValue>\\n </Sentences>\\n </Data>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n</GetSecretAsrDetailResponse>","errorExample":""}]',
- 'title' => '获取ASR识别结果详情',
- 'summary' => '获取ASR识别结果详情。',
- 'description' => '- 为确保您正常获取ASR识别结果，请使用此接口前，确认ASR服务功能开启。您可以调用[QuerySubscriptionDetail](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-querysubscriptiondetail)接口查询号码绑定详情，查看返回结果的**ASRStatus**参数。若未开启，可以调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription)，修改**ASRStatus**参数为**true**。'."\n"
- ."\n"
- .'- 若您订阅了**回执消息类型**为**录音状态报告**（SecretRecording）的消息，该报告消息中的结果字段可以作为此接口的入参，您可以参考[回执消息简介与配置流程](https://help.aliyun.com/zh/pnp/developer-reference/introduction-to-receipt-messages-and-receipt-message-configurations)进行订阅。'."\n"
- ."\n"
- .'- 新的呼叫记录需要一段时间进行ASR识别，请您等待十几分钟再调用此接口查询。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'ramActions' => [],
],
- 'AddSecretBlacklist' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreatePhoneNoAReport' => [
+ 'summary' => '通过API提交A号码手机号个人信息报备。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4393,1007 +3115,342 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '72607',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- ],
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC2235****',
- ],
+ 'schema' => ['title' => '手机号', 'description' => '手机号。', 'type' => 'string', 'required' => true, 'example' => '130*****1234'],
],
[
- 'name' => 'BlackNo',
+ 'name' => 'ANoWhiteGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '黑名单号码。根据**BlackType**参数值决定取值类型：'."\n"
- ."\n"
- .'- **点对点黑名单**：一对号码（指AB号码），用英文冒号（:）分隔。'."\n"
- .'- **号池黑名单**：单个号码。'."\n"
- ."\n"
- .'>（*）不是通配符。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1825638****:1825248****',
- ],
+ 'schema' => ['title' => '所属a号码组id', 'description' => '所属A号码组ID。在[资质管理](https://dyplsnext.console.aliyun.com/qualification)页面所属资质的A号码白名单栏单击查看详情。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '19'],
],
[
- 'name' => 'Remark',
+ 'name' => 'DocumentType',
'in' => 'query',
- 'schema' => [
- 'description' => '黑名单备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '黑名单备注',
- ],
+ 'schema' => ['title' => '证件类型 填写1表示身份证', 'description' => '证件类型，填写1表示身份证。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'BlackType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '黑名单类型。取值：'."\n"
- ."\n"
- .'- **POINT_TO_POINT_BLACK**：点对点黑名单。'."\n"
- .'- **PARTNER_GLOBAL_NUMBER_BLACK**：号码池黑名单。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'POINT_TO_POINT_BLACK',
- ],
- ],
- [
- 'name' => 'WayControl',
+ 'name' => 'CustName',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫方向控制。取值：'."\n"
- ."\n"
- .'- **PHONEA_REJECT**：BlackNo中第一个号码可以呼叫第二个号码，第二个号码不能呼叫第一个。'."\n"
- .'- **PHONEB_REJECT**：BlackNo中第一个号码不可呼叫第二个号码，第二个号码可呼叫第一个号码。'."\n"
- .'- **不填**：BlackNo中两个号码不可相互呼叫。'."\n"
- ."\n"
- .'>只有在点对点黑名单时候才有用。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PHONEA_REJECT',
- 'enum' => [
- 'DUPLEX_REJECT',
- 'PHONEA_REJECT',
- 'PHONEB_REJECT',
- ],
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。取值：'."\n"
- ."\n"
- .'- OK：代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RamPermissionDenied',
- 'errorMessage' => 'RAM permission is denied.',
- ],
- ],
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<AddSecretBlacklistResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n</AddSecretBlacklistResponse>","errorExample":""}]',
- 'title' => '添加黑名单',
- 'summary' => '向号码池添加黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。',
- 'description' => '- 此接口不是批处理接口，仅支持一次添加一组**点对点黑名单**号码，或者一个**号池黑名单**号码。'."\n"
- .'- 若需删除黑名单，可调用[DeleteSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-deletesecretblacklist)接口。'."\n"
- .'### 数量限制'."\n"
- .'本接口的单号池数量限制为200万个，超过限制，API调用添加黑名单号码将会失败，这可能会影响您的业务，如需特殊要求请联系您的阿里云商务经理。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'DeleteSecretBlacklist' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'schema' => ['title' => '姓名', 'description' => '姓名。', 'type' => 'string', 'required' => true, 'example' => '赵**'],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72616',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'DocumentNumber',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC1232****',
- ],
+ 'schema' => ['title' => '证件号码', 'description' => '证件号码。', 'type' => 'string', 'required' => true, 'example' => '370*********'],
],
[
- 'name' => 'BlackNo',
+ 'name' => 'IdCardFrontPhoto',
'in' => 'query',
- 'schema' => [
- 'description' => '黑名单号码。根据**BlackType**参数值决定取值类型：'."\n"
- ."\n"
- .'- **点对点黑名单**：一对号码，用英文冒号（:）分隔。'."\n"
- .'- **号池黑名单**：单个号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1825****383:1825****483',
- ],
+ 'schema' => ['title' => '身份证正面照片oss路径地址', 'description' => '身份证正面（国徽面）照片OSS路径地址。', 'type' => 'string', 'required' => false, 'example' => '123456/test1719383196031.jpg'],
],
[
- 'name' => 'Remark',
+ 'name' => 'IdCardBackPhoto',
'in' => 'query',
- 'schema' => [
- 'description' => '黑名单备注。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '黑名单备注',
- ],
+ 'schema' => ['title' => '身份证反面照片oss路径地址', 'description' => '身份证反面（人像面）照片OSS路径地址。', 'type' => 'string', 'required' => false, 'example' => '123456/test1719383196032.jpg'],
],
[
- 'name' => 'BlackType',
+ 'name' => 'IdCardAlivePhoto',
'in' => 'query',
- 'schema' => [
- 'description' => '黑名单类型。取值：'."\n"
- ."\n"
- .'- **POINT\\_TO\\_POINT_BLACK**：点对点黑名单。'."\n"
- .'- **PARTNER\\_GLOBAL\\_NUMBER\\_BLACK**：号池黑名单。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'POINT_TO_POINT_BLACK',
- ],
+ 'schema' => ['title' => '半身照oss路径地址', 'description' => '正面人像照片OSS路径地址。', 'type' => 'string', 'required' => true, 'example' => '123456/test1719383196033.jpg'],
],
[
- 'name' => 'WayControl',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '呼叫方向控制。取值：'."\n"
- ."\n"
- .'- **PHONEA\\_REJECT**：BlackNo中第一个号码可以呼叫第二个号码，第二个号码不能呼叫第一个。'."\n"
- ."\n"
- .'- **PHONEB\\_REJECT**：BlackNo中第一个号码不可呼叫第二个号码，第二个号码可呼叫第一个号码。'."\n"
- ."\n"
- .'- **不填**：BlackNo中两个号码不可相互呼叫。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PHONEA_REJECT',
- 'enum' => [
- 'DUPLEX_REJECT',
- 'PHONEA_REJECT',
- 'PHONEB_REJECT',
- ],
- ],
+ 'schema' => ['title' => '备注（客户自己的业务备注，可编辑）', 'description' => '备注（用户自身的业务备注）。', 'type' => 'string', 'required' => false, 'example' => '***报备'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功，'."\n"
- .'- 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'RequestId' => ['title' => '返回id', 'description' => '返回ID。', 'type' => 'string', 'example' => '1D73E648-0978-18A5-B089-3BB2'],
+ 'Message' => ['title' => '失败错误提示', 'description' => '失败错误提示。', 'type' => 'string', 'example' => '手机号码***已存在'],
+ 'Data' => [
+ 'title' => 'A号码报备结果结构体',
+ 'description' => 'A号码报备结果结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateResult' => ['title' => '创建结果', 'description' => '创建结果。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'FailType' => ['title' => '创建类型枚举，1为成功，负数为创建失败', 'description' => '创建类型枚举，1表示成功，负数表示创建失败。取值：'."\n"
+ ."\n"
+ .'- 1：成功。'."\n"
+ ."\n"
+ .'- -1：该手机号已经提交报备，无需再次提交报备。'."\n"
+ ."\n"
+ .'- -2：该手机号已报备成功，无需再次报备。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'example' => '',
],
+ 'Code' => ['title' => '请求状态码', 'description' => '请求状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'RamPermissionDenied',
- 'errorMessage' => 'RAM permission is denied.',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"手机号码***已存在\\",\\n \\"Data\\": {\\n \\"CreateResult\\": true,\\n \\"FailType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '提交A号码手机号个人实名信息',
+ 'description' => '在调用此接口前，您需要先调用[GetDyplsOSSInfoForUploadFile](~~2880885~~)将个人照片信息上传至OSS，具体操作流程请参见[API提交A号码手机号个人实名信息](~~2880077~~)。'."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePhoneNoAReport'],
],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSecretBlacklistResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n</DeleteSecretBlacklistResponse>","errorExample":""}]',
- 'title' => '删除黑名单',
- 'summary' => '删除号码池的黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。',
- 'description' => '- 此接口不是批处理接口，仅支持一次删除一组点对点黑名单号码，或者一个号池黑名单号码。'."\n"
- .'- 若需添加黑名单，可调用[AddSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-addsecretblacklist)接口。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
+ 'ramActions' => [],
],
- 'OperateBlackNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'CreatePickUpWaybill' => [
+ 'summary' => '创建上门寄件订单。',
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72628',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '100665',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC123456****',
- ],
+ 'name' => 'Content-Type',
+ 'in' => 'header',
+ 'schema' => ['description' => 'HTTP请求内容类型。'."\n"
+ .'非必填，如果填，请填写application/json;chatset=UTF-8', 'type' => 'string', 'required' => false, 'example' => 'application/json;chatset=UTF-8', 'default' => 'application/json;charset=UTF-8'],
],
[
- 'name' => 'BlackNo',
+ 'name' => 'OuterOrderCode',
'in' => 'query',
- 'schema' => [
- 'description' => '需要操作的黑名单号码。'."\n"
- .'> 仅支持操作**号池黑名单**类型的号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '150****0000',
- ],
+ 'schema' => ['description' => '外部订单号。', 'type' => 'string', 'required' => true, 'example' => '143234234266****'],
],
[
- 'name' => 'OperateType',
+ 'name' => 'OrderChannels',
'in' => 'query',
- 'schema' => [
- 'description' => '黑名单操作类型。取值：'."\n"
- ."\n"
- .'- **AddBlack**：新增黑名单。'."\n"
- .'- **DeleteBlack**：删除黑名单。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AddBlack',
- ],
+ 'schema' => ['description' => '外部渠道来源。', 'type' => 'string', 'required' => true, 'example' => 'YUN_DIAN_SHANG'],
],
[
- 'name' => 'Tips',
+ 'name' => 'CpCode',
'in' => 'query',
- 'schema' => [
- 'description' => '备注信息。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '快递公司编码。', 'type' => 'string', 'required' => false, 'example' => 'YTO'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\"\\n}","errorExample":""},{"type":"xml","example":"<OperateBlackNoResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\n</OperateBlackNoResponse>","errorExample":""}]',
- 'title' => '新增或删除黑名单',
- 'summary' => '新增或删除号池黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。',
- 'description' => '- 此接口仅支持新增或删除**号池黑名单**类型的黑名单号码。'."\n"
- ."\n"
- .'- 此接口不是批处理接口，仅支持一次新增或删除一个号池黑名单号码。'."\n"
- ."\n"
- .'- 可调用[AddSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-addsecretblacklist)添加**点对点黑名单**号码，调用[DeleteSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-deletesecretblacklist)删除**点对点黑名单**号码。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'QuerySecretNoRemain' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72632',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
+ 'name' => 'SendName',
+ 'in' => 'query',
+ 'schema' => ['description' => '寄件人姓名。', 'type' => 'string', 'required' => true, 'example' => '王XX'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'SpecId',
+ 'name' => 'SendMobile',
'in' => 'query',
- 'schema' => [
- 'description' => '号码类型。取值：'."\n"
- .'- **1**：虚商号码，即170或171。'."\n"
- .'- **2**：运营商号码。'."\n"
- .'- **3**：95号码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '寄件人手机号。'."\n"
+ ."\n"
+ .'> SendMobile和SendPhone必须任选其一。', 'type' => 'string', 'required' => false, 'example' => '1596714****'],
],
[
- 'name' => 'City',
+ 'name' => 'SendPhone',
'in' => 'query',
- 'schema' => [
- 'description' => '号码的归属地。'."\n"
- ."\n"
- .'- **SpecId**设置为1或2时，可以在参数**City**中指定查询'."\n"
- ."\n"
- .'1. 支持输入单个城市名称查询。'."\n"
- .'2. 支持输入“全国”查询，可返回全国可购号码余量。'."\n"
- .'3. 支持输入“全国列表”查询，将返回全国城市中有号码的城市及数量，无号码的城市不会返回。'."\n"
- ."\n"
- .'- **SpecId**设置为3时，95号码不区分归属地，只能查询全部95号码可购余量，即必须指定**City**为**全国通用**。'."\n"
- ."\n"
- .'> 当前仅支持设置归属地为中国大陆地区。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '杭州',
- ],
+ 'schema' => ['description' => '寄件人电话。'."\n"
+ .'> SendMobile和SendPhone必须任选其一。', 'type' => 'string', 'required' => false, 'example' => '05718845****'],
],
[
- 'name' => 'SecretNo',
+ 'name' => 'SendAddress',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '号码前缀。查询可购号码余量时，如果指定**SecretNo**，表示查询指定前缀的号码余量。'."\n"
- ."\n\n"
- .'最长可指定18位号码前缀。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '130',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
+ 'description' => '寄件人地址。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2',
- ],
- 'SecretRemainDTO' => [
- 'description' => '接口调用成功后返回的结构体。',
- 'type' => 'object',
- 'properties' => [
- 'Amount' => [
- 'description' => '可购号码余量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'City' => [
- 'description' => '号码的归属地。',
- 'type' => 'string',
- 'example' => '杭州',
- ],
- 'RemainDTOList' => [
- 'type' => 'object',
- 'itemNode' => true,
- 'properties' => [
- 'remainDTO' => [
- 'description' => '可购号码余量列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '结构体。',
- 'type' => 'object',
- 'properties' => [
- 'Amount' => [
- 'description' => '城市可购号码余量。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '120',
- ],
- 'City' => [
- 'description' => '号码的归属地。',
- 'type' => 'string',
- 'example' => '武汉',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'ProvinceName' => ['description' => '省。', 'type' => 'string', 'required' => true, 'example' => '陕西省'],
+ 'CityName' => ['description' => '市。', 'type' => 'string', 'required' => true, 'example' => '西安'],
+ 'AreaName' => ['description' => '区。', 'type' => 'string', 'required' => true, 'example' => '未央区'],
+ 'TownName' => ['description' => '街道。', 'type' => 'string', 'required' => false, 'example' => 'XX街道'],
+ 'AddressDetail' => ['description' => '详细地址。', 'type' => 'string', 'required' => true, 'example' => 'XX小区XX号'],
],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"SecretRemainDTO\\": {\\n \\"Amount\\": 0,\\n \\"City\\": \\"杭州\\",\\n \\"RemainDTOList\\": {\\n \\"remainDTO\\": [\\n {\\n \\"Amount\\": 120,\\n \\"City\\": \\"武汉\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<QuerySecretNoRemainResponse>\\t\\r\\n <SecretRemainDTO>\\r\\n\\t\\t<Amount>0</Amount>\\r\\n\\t\\t<City>杭州</City>\\r\\n\\t</SecretRemainDTO>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QuerySecretNoRemainResponse>","errorExample":""}]',
- 'title' => '查询线上可购号码余量',
- 'summary' => '查询线上可购号码余量。',
- 'description' => '购买号码时，指定归属地如果没有足够号码可供购买，会造成号码购买失败。调用接口[BuySecretNo](~~BuySecretNo~~)购买号码前，请先通过接口[QuerySecretNoRemain](~~QuerySecretNoRemain~~)查询线上可购号码余量。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'BuySecretNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72612',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。请登录[号码隐私保护控制台](https://dypls.console.aliyun.com/dypls.htm#/account)，在**号码池管理**中查看号码池Key。',
- 'type' => 'string',
'required' => true,
- 'docRequired' => true,
- 'example' => 'FC123456',
],
],
[
- 'name' => 'SpecId',
+ 'name' => 'ConsigneeName',
'in' => 'query',
- 'schema' => [
- 'description' => '号码类型。取值：'."\n"
- .'- **1**：虚商号码，即170或171。'."\n"
- .'- **2**：运营商号码。'."\n"
- .'- **3**：95号码。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '收货人姓名。', 'type' => 'string', 'required' => true, 'example' => '张XX'],
],
[
- 'name' => 'City',
+ 'name' => 'ConsigneeMobile',
'in' => 'query',
- 'schema' => [
- 'description' => '指定号码的归属地。'."\n"
- ."\n"
- .'> - 当前仅支持设置归属地为中国大陆地区。'."\n"
- .'> - 95号码不区分地区，如果购买95号码，则该参数应指定为**全国通用**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '杭州',
- ],
+ 'schema' => ['description' => '收货人手机号。'."\n"
+ ."\n"
+ .'> ConsigneeMobile和ConsigneePhone必须任选其一。', 'type' => 'string', 'required' => false, 'example' => '1580000****'],
],
[
- 'name' => 'SecretNo',
+ 'name' => 'ConsigneePhone',
'in' => 'query',
- 'schema' => [
- 'description' => '指定号码前缀。购买号码时，如果指定**SecretNo**，会根据指定的号码前缀模糊匹配手机号。'."\n"
- ."\n"
- .'> 最长可指定18位号码前缀。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '130',
- ],
+ 'schema' => ['description' => '收货人电话。'."\n"
+ .'> ConsigneeMobile和ConsigneePhone必须任选其一。', 'type' => 'string', 'required' => false, 'example' => '0570000****'],
],
[
- 'name' => 'DisplayPool',
+ 'name' => 'ConsigneeAddress',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '是否将该号码置于显号池。'."\n"
- ."\n"
- .'> 该参数仅对开通显号功能的客户生效。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
+ 'description' => '收货人地址。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020',
- ],
- 'SecretBuyInfoDTO' => [
- 'description' => '接口调用成功后返回的结构体。',
- 'type' => 'object',
- 'properties' => [
- 'SecretNo' => [
- 'description' => '隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '1390000****',
- ],
- ],
- ],
+ 'ProvinceName' => ['description' => '省。', 'type' => 'string', 'required' => true, 'example' => '浙江'],
+ 'CityName' => ['description' => '市。', 'type' => 'string', 'required' => true, 'example' => '杭州'],
+ 'AreaName' => ['description' => '区。', 'type' => 'string', 'required' => true, 'example' => '西湖区'],
+ 'TownName' => ['description' => '街道。', 'type' => 'string', 'required' => false, 'example' => 'XX街道'],
+ 'AddressDetail' => ['description' => '详细地址。', 'type' => 'string', 'required' => true, 'example' => 'XX小区XX号'],
],
+ 'required' => true,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\",\\n \\"SecretBuyInfoDTO\\": {\\n \\"SecretNo\\": \\"1390000****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<BuySecretNoResponse>\\r\\n\\t<SecretBuyInfoDTO>\\r\\n\\t\\t<SecretNo>17100000000</SecretNo>\\r\\n\\t</SecretBuyInfoDTO>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</BuySecretNoResponse>","errorExample":""}]',
- 'title' => '购买号码',
- 'summary' => '购买号码。',
- 'description' => '- 在控制台创建号码池后，号码池默认为空，需要为号码池购买号码。'."\n"
- .'- 购买号码操作涉及到资源资费，请确保在使用该接口前，已充分了解X号码隐私保护产品的收费方式和[价格](~~59825~~)。'."\n"
- .'- 购买号码时，指定归属地如果没有足够号码可供购买，会造成号码购买失败。调用此接口购买号码前，请先通过[QuerySecretNoRemain](~~111699~~)查询线上可购号码余量。'."\n"
- .'- 购买号码的账号必须已实名认证为企业账号。如何进行实名认证，请参见[企业实名认证](~~37172~~)。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'ReleaseSecretNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72635',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PoolKey',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000012345****',
- ],
+ 'schema' => ['description' => '备注。打印在面单上的备注内容。', 'type' => 'string', 'required' => false, 'example' => '易碎物品'],
],
[
- 'name' => 'SecretNo',
+ 'name' => 'GoodsInfos',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'description' => '需要释放的隐私号码。'."\n"
- ."\n"
- .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取隐私号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '139****0000',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- .'* 返回OK代表请求成功。'."\n"
- .'* 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '986BCB6D-C9BF-42F9-91CE-3A990121232',
+ 'description' => '商品列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '商品列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['description' => '物品名称。', 'type' => 'string', 'required' => false, 'example' => '鞋子'],
+ 'Weight' => ['description' => '重量。单位：克。', 'type' => 'string', 'required' => false, 'example' => '1000'],
+ 'Quantity' => ['description' => '数量。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
+ 'required' => false,
],
+ 'required' => false,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A990121232\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ReleaseSecretNoResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</ReleaseSecretNoResponse>","errorExample":""}]',
- 'title' => '释放号码',
- 'summary' => '释放号码。释放后所选号码将不可继续使用。',
- 'description' => '- 释放号码之后，次月开始不再计费。'."\n"
- ."\n"
- .'- 释放号码之前，请登录[号码隐私保护控制台](https://dypls.console.aliyun.com/dypls.htm#/account)或者调用[QuerySubsId](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-querysubsid)接口，查看该号码是否有绑定关系。号码无任何绑定关系时才能释放。'."\n"
- ."\n\n"
- .'><notice>号码释放后不可继续使用，且无法找回，请谨慎操作。></notice>',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'LockSecretNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72625',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
+ 'name' => 'AppointGotStartTime',
+ 'in' => 'query',
+ 'schema' => ['description' => '预约上门取件开始时间。'."\n"
+ .'**AppointGotStartTime**的值，请从[CreatePickUpWaybillPreQuery](~~428594~~)接口返回参数**CpTimeSelectList**中**AppointTimes**的**StartTime**获取。'."\n"
+ ."\n"
+ .'> 当**bizType**为**1**时必填。', 'type' => 'string', 'required' => false, 'example' => '2021-01-01 10:00:00'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'AppointGotEndTime',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC123****',
- ],
+ 'schema' => ['description' => '预约上门取件结束时间。'."\n"
+ .'**AppointGotEndTime**的值，请从[CreatePickUpWaybillPreQuery](~~428594~~)接口返回参数**CpTimeSelectList**中**AppointTimes**的**EndTime**获取。'."\n"
+ .'> 当**bizType**为**1**时必填。', 'type' => 'string', 'required' => false, 'example' => '2021-01-01 12:00:00'],
],
[
- 'name' => 'SecretNo',
+ 'name' => 'BizType',
'in' => 'query',
- 'schema' => [
- 'description' => '需要锁定的隐私号码，需要填写完整的手机号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1300000****',
- ],
+ 'schema' => ['description' => '寄件模式。取值：'."\n"
+ ."\n"
+ .'- **0**：实时订单（默认值）。'."\n"
+ .'- **1**：预约订单。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'title' => 'Schema of Response',
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码详见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Success' => ['description' => '接口调用是否成功。', 'type' => 'string', 'example' => 'true'],
+ 'CpCode' => ['description' => '快递公司编码。', 'type' => 'string', 'example' => 'YTO'],
+ 'MailNo' => ['description' => '订单号。', 'type' => 'string', 'example' => '77312345629****'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '无'],
+ 'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
+ 'GotCode' => ['description' => '取件码。', 'type' => 'string', 'example' => '3524'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\"\\n}","errorExample":""},{"type":"xml","example":"<LockSecretNoResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\n</LockSecretNoResponse>","errorExample":""}]',
- 'title' => '锁定号码',
- 'summary' => '锁定号码。适用于需要临时屏蔽异常号码的场景。',
- 'description' => '- 号码被锁定后，调用接口创建新绑定时将不再选择已经锁定的号码。'."\n"
- ."\n"
- .'- 可调用[UnlockSecretNo](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-unlocksecretno)接口解锁号码。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
- ],
- 'UnlockSecretNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'Insufficient.Balance', 'errorMessage' => 'You have an insufficient balance.', 'description' => ''],
+ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => ''],
+ ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
+ ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => ''],
+ ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => ''],
],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '72637',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
+ 403 => [
+ ['errorCode' => 'Permission.NotAuthorized', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC2256****',
- ],
+ 500 => [
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => ''],
],
- [
- 'name' => 'SecretNo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '需要解锁的隐私号码，需要填写完整的手机号码。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '1300000****',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": \\"true\\",\\n \\"CpCode\\": \\"YTO\\",\\n \\"MailNo\\": \\"77312345629****\\",\\n \\"ErrorCode\\": \\"无\\",\\n \\"ErrorMsg\\": \\"无\\",\\n \\"GotCode\\": \\"3524\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreatePickUpWaybillResponse>\\n <RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>OK</Message>\\n <Data>\\n <Success>true</Success>\\n <CpCode>YTO</CpCode>\\n <MailNo>77312345629****</MailNo>\\n <ErrorCode>无</ErrorCode>\\n <ErrorMsg>无</ErrorMsg>\\n <GotCode>3524</GotCode>\\n </Data>\\n</CreatePickUpWaybillResponse>","errorExample":""}]',
+ 'title' => '创建上门寄件订单',
+ 'description' => '### QPS限制'."\n"
+ .'本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [
+ ['createdAt' => '2021-11-25T07:45:44.000Z', 'description' => 'OpenAPI 下线'],
+ ['createdAt' => '2021-11-25T07:45:44.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePickUpWaybill'],
],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'description' => '请求状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020',
- ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:CreatePickUpWaybill',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\"\\n}","errorExample":""},{"type":"xml","example":"<UnlockSecretNoResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\n</UnlockSecretNoResponse>","errorExample":""}]',
- 'title' => '解锁号码',
- 'summary' => '解锁号码。解除号码的临时屏蔽。',
- 'description' => '- 号码被解锁后，[添加号码绑定](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-dir-number-binding/?spm=a2c4g.11186623.0.0.149d679cBVqtij)时可重新选择已经解锁的号码。'."\n"
- ."\n"
- .'- 可调用[LockSecretNo](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-locksecretno)锁定号码。'."\n"
- ."\n"
- .'### QPS限制'."\n"
- .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
'CreatePickUpWaybillPreQuery' => [
'summary' => '寄件下单预查询。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -5406,9 +3463,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '133436',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -5416,14 +3471,8 @@
[
'name' => 'Content-Type',
'in' => 'header',
- 'schema' => [
- 'description' => 'HTTP请求内容类型。'."\n"
- .'非必填，如果填，请填写application/json;chatset=UTF-8',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'application/json;chatset=UTF-8',
- 'default' => 'application/json;charset=UTF-8',
- ],
+ 'schema' => ['description' => 'HTTP请求内容类型。'."\n"
+ .'非必填，如果填，请填写application/json;chatset=UTF-8', 'type' => 'string', 'required' => false, 'example' => 'application/json;chatset=UTF-8', 'default' => 'application/json;charset=UTF-8'],
],
[
'name' => 'SenderInfo',
@@ -5433,52 +3482,17 @@
'description' => '寄件人信息。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '寄件人姓名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '王XX',
- ],
- 'Mobile' => [
- 'description' => '寄件人手机号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1390000****',
- ],
+ 'Name' => ['description' => '寄件人姓名。', 'type' => 'string', 'required' => true, 'example' => '王XX'],
+ 'Mobile' => ['description' => '寄件人手机号。', 'type' => 'string', 'required' => true, 'example' => '1390000****'],
'AddressInfo' => [
'description' => '寄件人地址信息。',
'type' => 'object',
'properties' => [
- 'ProvinceName' => [
- 'description' => '寄件人所在省份。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '浙江省',
- ],
- 'CityName' => [
- 'description' => '寄件人所在市。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '杭州市',
- ],
- 'AreaName' => [
- 'description' => '寄件人所在区。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '西湖区',
- ],
- 'TownName' => [
- 'description' => '寄件人所在街道。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XX街道',
- ],
- 'AddressDetail' => [
- 'description' => '寄件人详细地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XX小区XX号',
- ],
+ 'ProvinceName' => ['description' => '寄件人所在省份。', 'type' => 'string', 'required' => false, 'example' => '浙江省'],
+ 'CityName' => ['description' => '寄件人所在市。', 'type' => 'string', 'required' => false, 'example' => '杭州市'],
+ 'AreaName' => ['description' => '寄件人所在区。', 'type' => 'string', 'required' => false, 'example' => '西湖区'],
+ 'TownName' => ['description' => '寄件人所在街道。', 'type' => 'string', 'required' => false, 'example' => 'XX街道'],
+ 'AddressDetail' => ['description' => '寄件人详细地址。', 'type' => 'string', 'required' => false, 'example' => 'XX小区XX号'],
],
'required' => false,
],
@@ -5494,52 +3508,17 @@
'description' => '收件人信息。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '收件人姓名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '李XX',
- ],
- 'Mobile' => [
- 'description' => '收件人手机号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1390000****',
- ],
+ 'Name' => ['description' => '收件人姓名。', 'type' => 'string', 'required' => true, 'example' => '李XX'],
+ 'Mobile' => ['description' => '收件人手机号。', 'type' => 'string', 'required' => true, 'example' => '1390000****'],
'AddressInfo' => [
'description' => '收件人地址信息。',
'type' => 'object',
'properties' => [
- 'ProvinceName' => [
- 'description' => '收件人所在省份。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '陕西省',
- ],
- 'CityName' => [
- 'description' => '收件人所在市。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '西安市',
- ],
- 'AreaName' => [
- 'description' => '收件人所在区。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '长安区',
- ],
- 'TownName' => [
- 'description' => '收件人所在街道。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XX街道',
- ],
- 'AddressDetail' => [
- 'description' => '收件人详细地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XX小区XX号',
- ],
+ 'ProvinceName' => ['description' => '收件人所在省份。', 'type' => 'string', 'required' => false, 'example' => '陕西省'],
+ 'CityName' => ['description' => '收件人所在市。', 'type' => 'string', 'required' => false, 'example' => '西安市'],
+ 'AreaName' => ['description' => '收件人所在区。', 'type' => 'string', 'required' => false, 'example' => '长安区'],
+ 'TownName' => ['description' => '收件人所在街道。', 'type' => 'string', 'required' => false, 'example' => 'XX街道'],
+ 'AddressDetail' => ['description' => '收件人详细地址。', 'type' => 'string', 'required' => false, 'example' => 'XX小区XX号'],
],
'required' => false,
],
@@ -5550,44 +3529,24 @@
[
'name' => 'CpCode',
'in' => 'query',
- 'schema' => [
- 'description' => '快递公司编码。不指定快递公司时由系统进行分配。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'YTO',
- ],
+ 'schema' => ['description' => '快递公司编码。不指定快递公司时由系统进行分配。', 'type' => 'string', 'required' => false, 'example' => 'YTO'],
],
[
'name' => 'PreWeight',
'in' => 'query',
- 'schema' => [
- 'description' => '预估重量（单位：克）。'."\n"
- ."\n"
- .'> 若您需要查询预估价格，该参数必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2000',
- ],
+ 'schema' => ['description' => '预估重量（单位：克）。'."\n"
+ ."\n"
+ .'> 若您需要查询预估价格，该参数必传。', 'type' => 'string', 'required' => false, 'example' => '2000'],
],
[
'name' => 'OuterOrderCode',
'in' => 'query',
- 'schema' => [
- 'description' => '接入方系统的订单编号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '787DFHHDS989****',
- ],
+ 'schema' => ['description' => '接入方系统的订单编号。', 'type' => 'string', 'required' => false, 'example' => '787DFHHDS989****'],
],
[
'name' => 'OrderChannels',
'in' => 'query',
- 'schema' => [
- 'description' => '外部渠道来源标识，不可包含下划线。接入时与系统约定取值。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Test',
- ],
+ 'schema' => ['description' => '外部渠道来源标识，不可包含下划线。接入时与系统约定取值。', 'type' => 'string', 'required' => true, 'example' => 'Test'],
],
],
'responses' => [
@@ -5597,52 +3556,18 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求ID。', 'type' => 'string', 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '状态码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
'description' => '结果集。',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'ErrorMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Code' => [
- 'description' => '响应码。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '响应内容。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
+ 'Success' => ['description' => '是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'ErrorCode' => ['description' => '错误码。', 'type' => 'string', 'example' => '无'],
+ 'ErrorMsg' => ['description' => '错误信息。', 'type' => 'string', 'example' => '无'],
+ 'Code' => ['description' => '响应码。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['description' => '响应内容。', 'type' => 'string', 'example' => 'Success'],
'CpTimeSelectList' => [
'description' => '查询快递公司是否可下单的信息列表。',
'type' => 'array',
@@ -5654,21 +3579,9 @@
'description' => '实时单可选信息。',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '实时单服务类型名称。',
- 'type' => 'string',
- 'example' => '2小时上门',
- ],
- 'Selectable' => [
- 'description' => '超过实时单下单的时间，是否能再下实时单。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SelectDisableTip' => [
- 'description' => '不可选文案提示。',
- 'type' => 'string',
- 'example' => '超过实时单下单时间范围',
- ],
+ 'Name' => ['description' => '实时单服务类型名称。', 'type' => 'string', 'example' => '2小时上门'],
+ 'Selectable' => ['description' => '超过实时单下单的时间，是否能再下实时单。', 'type' => 'boolean', 'example' => 'false'],
+ 'SelectDisableTip' => ['description' => '不可选文案提示。', 'type' => 'string', 'example' => '超过实时单下单时间范围'],
],
],
'AppointTimes' => [
@@ -5678,16 +3591,8 @@
'description' => '结构体',
'type' => 'object',
'properties' => [
- 'Date' => [
- 'description' => 'YYYY-MM-DD格式的日期字符串。',
- 'type' => 'string',
- 'example' => '2022-04-28',
- ],
- 'DateSelectable' => [
- 'description' => '该日期是否可选。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Date' => ['description' => 'YYYY-MM-DD格式的日期字符串。', 'type' => 'string', 'example' => '2022-04-28'],
+ 'DateSelectable' => ['description' => '该日期是否可选。', 'type' => 'boolean', 'example' => 'true'],
'TimeList' => [
'description' => '当天的下单时间段列表.',
'type' => 'array',
@@ -5695,37 +3600,17 @@
'description' => '结构体。',
'type' => 'object',
'properties' => [
- 'StartTime' => [
- 'description' => '时间段的开始时间。',
- 'type' => 'string',
- 'example' => '10:00:00',
- ],
- 'EndTime' => [
- 'description' => '时间段的结束时间。',
- 'type' => 'string',
- 'example' => '12:00:00',
- ],
- 'Selectable' => [
- 'description' => '该预约时段是否可以选择。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SelectDisableTip' => [
- 'description' => '不可选文案提示。',
- 'type' => 'string',
- 'example' => '约满',
- ],
+ 'StartTime' => ['description' => '时间段的开始时间。', 'type' => 'string', 'example' => '10:00:00'],
+ 'EndTime' => ['description' => '时间段的结束时间。', 'type' => 'string', 'example' => '12:00:00'],
+ 'Selectable' => ['description' => '该预约时段是否可以选择。', 'type' => 'boolean', 'example' => 'true'],
+ 'SelectDisableTip' => ['description' => '不可选文案提示。', 'type' => 'string', 'example' => '约满'],
],
],
],
],
],
],
- 'PrePrice' => [
- 'description' => '预估价格，单位：元，保留到小数点后两位。当入参传入预估重量时该字段有值。',
- 'type' => 'string',
- 'example' => '12.50',
- ],
+ 'PrePrice' => ['description' => '预估价格，单位：元，保留到小数点后两位。当入参传入预估重量时该字段有值。', 'type' => 'string', 'example' => '12.50'],
],
],
],
@@ -5737,57 +3622,45 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'Insufficient.Balance',
- 'errorMessage' => 'You have an insufficient balance.',
- ],
- [
- 'errorCode' => 'Product.Unsubscript',
- 'errorMessage' => 'You have not subscribed to the specified product.',
- ],
- [
- 'errorCode' => 'Ram.PermissionDeny',
- 'errorMessage' => 'You are not authorized to perform the operation.',
- ],
- [
- 'errorCode' => 'System.LimitControl',
- 'errorMessage' => 'The system is under flow control.',
- ],
- [
- 'errorCode' => 'Unknown.ResourceOwnerId',
- 'errorMessage' => 'The resource does not belong to the current user.',
- ],
+ ['errorCode' => 'Insufficient.Balance', 'errorMessage' => 'You have an insufficient balance.', 'description' => ''],
+ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => ''],
+ ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
+ ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => ''],
+ ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'Permission.NotAuthorized',
- 'errorMessage' => 'You are not authorized to perform the operation.',
- ],
+ ['errorCode' => 'Permission.NotAuthorized', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
- ],
+ ['errorCode' => 'InternalError', 'errorMessage' => 'A system error occurred.', 'description' => ''],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"无\\",\\n \\"ErrorMsg\\": \\"无\\",\\n \\"Code\\": \\"0\\",\\n \\"Message\\": \\"Success\\",\\n \\"CpTimeSelectList\\": [\\n {\\n \\"RealTime\\": {\\n \\"Name\\": \\"2小时上门\\",\\n \\"Selectable\\": false,\\n \\"SelectDisableTip\\": \\"超过实时单下单时间范围\\"\\n },\\n \\"AppointTimes\\": [\\n {\\n \\"Date\\": \\"2022-04-28\\",\\n \\"DateSelectable\\": true,\\n \\"TimeList\\": [\\n {\\n \\"StartTime\\": \\"10:00:00\\",\\n \\"EndTime\\": \\"12:00:00\\",\\n \\"Selectable\\": true,\\n \\"SelectDisableTip\\": \\"约满\\"\\n }\\n ]\\n }\\n ],\\n \\"PrePrice\\": \\"12.50\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreatePickUpWaybillPreQueryResponse>\\n <RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>OK</Message>\\n <Data>\\n <Success>true</Success>\\n <ErrorCode>无</ErrorCode>\\n <ErrorMsg>无</ErrorMsg>\\n <Code>0</Code>\\n <Message>Success</Message>\\n <CpTimeSelectList>\\n <RealTime>\\n <Name>2小时上门</Name>\\n <Selectable>false</Selectable>\\n <SelectDisableTip>超过实时单下单时间范围</SelectDisableTip>\\n </RealTime>\\n <AppointTimes>\\n <Date>2022-04-28</Date>\\n <DateSelectable>true</DateSelectable>\\n <TimeList>\\n <StartTime>10:00:00</StartTime>\\n <EndTime>12:00:00</EndTime>\\n <Selectable>true</Selectable>\\n <SelectDisableTip>约满</SelectDisableTip>\\n </TimeList>\\n </AppointTimes>\\n <PrePrice>12.50</PrePrice>\\n </CpTimeSelectList>\\n </Data>\\n</CreatePickUpWaybillPreQueryResponse>","errorExample":""}]',
'title' => '寄件下单预查询',
'description' => '### QPS限制'."\n"
.'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- ],
- 'CreatePickUpWaybill' => [
- 'summary' => '创建上门寄件订单。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
+ 'changeSet' => [
+ ['createdAt' => '2022-05-12T01:50:56.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:CreatePickUpWaybillPreQuery',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateSmsSign' => [
+ 'summary' => '员工B通过工作号X向客户A下发短信场景中，员工B使用客户端向客户A 发送短信，客户端须通过本接口获取“短信下发标签”，并在短信内容尾部中添加该“标签”。工作号平台通过“标签”解析出真实被叫A号码，下发短信到A号码。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5799,454 +3672,216 @@
'operationType' => 'create',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '100665',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '244986',
+ 'abilityTreeNodes' => ['FEATUREdyplsMM443Z'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Content-Type',
- 'in' => 'header',
- 'schema' => [
- 'description' => 'HTTP请求内容类型。'."\n"
- .'非必填，如果填，请填写application/json;chatset=UTF-8',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'application/json;chatset=UTF-8',
- 'default' => 'application/json;charset=UTF-8',
- ],
- ],
- [
- 'name' => 'OuterOrderCode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '外部订单号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '143234234266****',
- ],
- ],
- [
- 'name' => 'OrderChannels',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部渠道来源。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'YUN_DIAN_SHANG',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'CpCode',
+ 'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'description' => '快递公司编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'YTO',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
- 'name' => 'SendName',
+ 'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '寄件人姓名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '王XX',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'SendMobile',
+ 'name' => 'CalledNo',
'in' => 'query',
- 'schema' => [
- 'description' => '寄件人手机号。'."\n"
- ."\n"
- .'> SendMobile和SendPhone必须任选其一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1596714****',
- ],
+ 'schema' => ['title' => '收信人号码', 'description' => '收信人号码。', 'type' => 'string', 'required' => true, 'example' => '178****3614'],
],
[
- 'name' => 'SendPhone',
+ 'name' => 'CallingNo',
'in' => 'query',
- 'schema' => [
- 'description' => '寄件人电话。'."\n"
- .'> SendMobile和SendPhone必须任选其一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '05718845****',
- ],
+ 'schema' => ['title' => '发信人号码', 'description' => '发信人号码。', 'type' => 'string', 'required' => true, 'example' => '150****6539'],
],
- [
- 'name' => 'SendAddress',
- 'in' => 'query',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '寄件人地址。',
'type' => 'object',
'properties' => [
- 'ProvinceName' => [
- 'description' => '省。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '陕西省',
- ],
- 'CityName' => [
- 'description' => '市。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '西安',
- ],
- 'AreaName' => [
- 'description' => '区。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '未央区',
- ],
- 'TownName' => [
- 'description' => '街道。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XX街道',
- ],
- 'AddressDetail' => [
- 'description' => '详细地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'XX小区XX号',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'CalledNoSign' => ['title' => '短信接收者号码签名串(加到短信内容中供解析真实被叫号码)', 'description' => '短信接收者号码签名串(加到短信内容中供解析真实被叫号码)', 'type' => 'string', 'example' => 'sign23343466'],
+ ],
+ 'example' => '',
+ 'description' => '',
+ ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'false'],
],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'ConsigneeName',
- 'in' => 'query',
- 'schema' => [
- 'description' => '收货人姓名。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '张XX',
+ 'description' => '',
],
],
- [
- 'name' => 'ConsigneeMobile',
- 'in' => 'query',
- 'schema' => [
- 'description' => '收货人手机号。'."\n"
- ."\n"
- .'> ConsigneeMobile和ConsigneePhone必须任选其一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1580000****',
- ],
- ],
- [
- 'name' => 'ConsigneePhone',
- 'in' => 'query',
- 'schema' => [
- 'description' => '收货人电话。'."\n"
- .'> ConsigneeMobile和ConsigneePhone必须任选其一。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0570000****',
- ],
- ],
- [
- 'name' => 'ConsigneeAddress',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '收货人地址。',
- 'type' => 'object',
- 'properties' => [
- 'ProvinceName' => [
- 'description' => '省。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '浙江',
- ],
- 'CityName' => [
- 'description' => '市。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '杭州',
- ],
- 'AreaName' => [
- 'description' => '区。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '西湖区',
- ],
- 'TownName' => [
- 'description' => '街道。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XX街道',
- ],
- 'AddressDetail' => [
- 'description' => '详细地址。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'XX小区XX号',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"CalledNoSign\\": \\"sign23343466\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ 'title' => '短信下发标签生成',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:CreateSmsSign',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => true,
],
],
+ ],
+ ],
+ 'DeleteAxbBindFixedLine' => [
+ 'summary' => '解除固话AXB隐私号绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Remark',
- 'in' => 'query',
- 'schema' => [
- 'description' => '备注。打印在面单上的备注内容。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '易碎物品',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '271125',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'GoodsInfos',
+ 'name' => 'AppId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '商品列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '商品列表。',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'description' => '物品名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '鞋子',
- ],
- 'Weight' => [
- 'description' => '重量。单位：克。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1000',
- ],
- 'Quantity' => [
- 'description' => '数量。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'AppointGotStartTime',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => '预约上门取件开始时间。'."\n"
- .'**AppointGotStartTime**的值，请从[CreatePickUpWaybillPreQuery](~~428594~~)接口返回参数**CpTimeSelectList**中**AppointTimes**的**StartTime**获取。'."\n"
- ."\n"
- .'> 当**bizType**为**1**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-01 10:00:00',
- ],
+ 'schema' => ['title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'AppointGotEndTime',
+ 'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'description' => '预约上门取件结束时间。'."\n"
- .'**AppointGotEndTime**的值，请从[CreatePickUpWaybillPreQuery](~~428594~~)接口返回参数**CpTimeSelectList**中**AppointTimes**的**EndTime**获取。'."\n"
- .'> 当**bizType**为**1**时必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-01-01 12:00:00',
- ],
+ 'schema' => ['title' => '绑定id', 'description' => '绑定id。', 'type' => 'string', 'required' => true, 'example' => 'A93I******'],
],
[
- 'name' => 'BizType',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '寄件模式。取值：'."\n"
- ."\n"
- .'- **0**：实时订单（默认值）。'."\n"
- .'- **1**：预约订单。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '消息请求唯一标识。', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '错误描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'F036366A-0182-5066-A686-19C4C82F2D51'],
'Data' => [
- 'description' => '返回数据。',
+ 'description' => '命名空间列表。',
'type' => 'object',
'properties' => [
- 'Success' => [
- 'description' => '接口调用是否成功。',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'CpCode' => [
- 'description' => '快递公司编码。',
- 'type' => 'string',
- 'example' => 'YTO',
- ],
- 'MailNo' => [
- 'description' => '订单号。',
- 'type' => 'string',
- 'example' => '77312345629****',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'ErrorMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'GotCode' => [
- 'description' => '取件码。',
- 'type' => 'string',
- 'example' => '3524',
- ],
+ 'Message' => ['title' => '响应消息', 'description' => '响应消息', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ 'Code' => ['title' => '响应码 0-成功', 'description' => '响应码 0-成功', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['title' => '是否处理成功 true-成功 false-失败', 'description' => '是否处理成功 true-成功 false-失败', 'type' => 'boolean', 'example' => 'true'],
],
],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Insufficient.Balance',
- 'errorMessage' => 'You have an insufficient balance.',
- ],
- [
- 'errorCode' => 'Product.Unsubscript',
- 'errorMessage' => 'You have not subscribed to the specified product.',
- ],
- [
- 'errorCode' => 'Ram.PermissionDeny',
- 'errorMessage' => 'You are not authorized to perform the operation.',
- ],
- [
- 'errorCode' => 'System.LimitControl',
- 'errorMessage' => 'The system is under flow control.',
- ],
- [
- 'errorCode' => 'Unknown.ResourceOwnerId',
- 'errorMessage' => 'The resource does not belong to the current user.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Permission.NotAuthorized',
- 'errorMessage' => 'You are not authorized to perform the operation.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F036366A-0182-5066-A686-19C4C82F2D51\\",\\n \\"Data\\": {\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AXB固话隐私号-解绑已有绑定关系',
+ 'description' => '- 解除已有绑定关系的固话AXB隐私号后，可能影响您的业务连续性，请谨慎操作。'."\n"
+ ."\n"
+ .'- 释放号码前，需解除号码绑定关系。'."\n"
+ ."\n"
+ .'- 解除固话AXB隐私号绑定关系仅支持此接口的方式进行解除，暂不支持控制台进行解绑。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteAxbBindFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Success\\": \\"true\\",\\n \\"CpCode\\": \\"YTO\\",\\n \\"MailNo\\": \\"77312345629****\\",\\n \\"ErrorCode\\": \\"无\\",\\n \\"ErrorMsg\\": \\"无\\",\\n \\"GotCode\\": \\"3524\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreatePickUpWaybillResponse>\\n <RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Message>OK</Message>\\n <Data>\\n <Success>true</Success>\\n <CpCode>YTO</CpCode>\\n <MailNo>77312345629****</MailNo>\\n <ErrorCode>无</ErrorCode>\\n <ErrorMsg>无</ErrorMsg>\\n <GotCode>3524</GotCode>\\n </Data>\\n</CreatePickUpWaybillResponse>","errorExample":""}]',
- 'title' => '创建上门寄件订单',
- 'description' => '### QPS限制'."\n"
- .'本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
],
- 'CancelPickUpWaybill' => [
- 'summary' => '取消上门寄件订单。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteAxgGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '100670',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '175380',
+ 'abilityTreeNodes' => ['FEATUREdypls13M9H9'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'Content-Type',
- 'in' => 'header',
- 'schema' => [
- 'description' => 'HTTP请求内容类型。'."\n"
- .'非必填，如果填，请填写application/json;chatset=UTF-8',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'application/json;chatset=UTF-8',
- 'default' => 'application/json;charset=UTF-8',
- ],
- ],
- [
- 'name' => 'OuterOrderCode',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '外部订单号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1145678823****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC2235****'],
],
[
- 'name' => 'CancelDesc',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'description' => '取消原因。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '不想退货了',
- ],
+ 'schema' => ['description' => 'AXG中的G组ID，即GID。'."\n"
+ ."\n"
+ .'- 登录号码隐私保护控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**，单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
+ .'- 如果G号码组是通过接口[CreateAxgGroup](~~110250~~)创建的，则接口的返回参数**GroupID**就是此处的请求参数**GroupID**。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '200001234****'],
],
],
'responses' => [
@@ -6255,264 +3890,183 @@
'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2',
- ],
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码描述。',
- 'type' => 'string',
- 'example' => '请求成功',
- ],
- 'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'Success' => [
- 'description' => '是否取消成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ErrorCode' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => '无',
- ],
- 'Message' => [
- 'description' => '取消结果。',
- 'type' => 'string',
- 'example' => '取消成功',
- ],
- 'ErrorMsg' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '无',
- ],
- ],
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '返回结果的提示信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID，阿里云为该请求生成的标识符。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050D9369D'],
],
],
],
],
- 'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'Insufficient.Balance',
- 'errorMessage' => 'You have an insufficient balance.',
- ],
- [
- 'errorCode' => 'Product.Unsubscript',
- 'errorMessage' => 'You have not subscribed to the specified product.',
- ],
- [
- 'errorCode' => 'Ram.PermissionDeny',
- 'errorMessage' => 'You are not authorized to perform the operation.',
- ],
- [
- 'errorCode' => 'System.LimitControl',
- 'errorMessage' => 'The system is under flow control.',
- ],
- [
- 'errorCode' => 'Unknown.ResourceOwnerId',
- 'errorMessage' => 'The resource does not belong to the current user.',
- ],
- ],
- 403 => [
- [
- 'errorCode' => 'Permission.NotAuthorized',
- 'errorMessage' => 'You are not authorized to perform the operation.',
- ],
- ],
- 500 => [
- [
- 'errorCode' => 'InternalError',
- 'errorMessage' => 'A system error occurred.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050D9369D\\"\\n}","type":"json"}]',
+ 'title' => '删除G号码组',
+ 'summary' => '删除G号码组。仅AXG隐私号类型的号码池支持设置G号码组。',
+ 'description' => '- G号码组删除后不可恢复，请谨慎操作。'."\n"
+ ."\n"
+ .'- 在调用此接口前，建议您先确认需要删除的G号码组及该号码组归属的号码池。'."\n"
+ ."\n"
+ .'- 不支持删除存在绑定关系的G号码组，删除G号码组前，建议您先解除AXG隐私号与该号码组的绑定关系。可登录控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面，筛选**AXG隐私号**，单击**详情**>**解绑**进行操作，或者调用[UnbindSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-unbindsubscription)接口解除号码的绑定关系。'."\n"
+ ."\n"
+ .'- 删除G号码组时，如果G号码组内存在号码，也会一并删除。'."\n"
+ ."\n"
+ .'### QPS 限制'."\n"
+ .'本接口的单用户QPS限制为 5000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'changeSet' => [
+ ['createdAt' => '2023-04-27T09:07:17.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteAxgGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"无\\",\\n \\"Message\\": \\"取消成功\\",\\n \\"ErrorMsg\\": \\"无\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CancelPickUpWaybillResponse>\\n <RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\n <Code>OK</Code>\\n <Message>请求成功</Message>\\n <Data>\\n <Success>true</Success>\\n <ErrorCode>无</ErrorCode>\\n <Message>取消成功</Message>\\n <ErrorMsg>无</ErrorMsg>\\n </Data>\\n</CancelPickUpWaybillResponse>","errorExample":""}]',
- 'title' => '取消上门寄件订单',
- 'description' => '### QPS限制'."\n"
- .'本接口的单用户QPS限制为200次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
],
- 'AddAxnTrackNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteAxnBindFixedLine' => [
+ 'summary' => '解除固话AXN隐私号码绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72606',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsOMLRO6',
- ],
+ 'abilityTreeCode' => '271213',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。请登录[号码隐私保护控制台](https://dypls.console.aliyun.com/dypls.htm#/account)，在**号码池管理**中查看号码池Key。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => 'FC2235****',
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'PhoneNoX',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => '绑定关系中的隐私号码，即X号码。'."\n"
- ."\n"
- .'您可以通过[BindAxn](~~110258~~)接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1700000****',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'trackNo',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '运单号。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'abcde*****',
- ],
+ 'schema' => ['title' => '消息请求唯一标识', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
- 'name' => 'SubsId',
+ 'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'description' => '订购关系ID。'."\n"
- ."\n"
- .'您可以通过[BindAxn](~~110258~~)接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '15678890****',
- ],
+ 'schema' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'required' => true, 'example' => 'A93I******'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '状态码。'."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => '请求成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '1A4CADEF-8516-5890-9177-A1A4D97F****',
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '错误描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n", 'type' => 'string', 'example' => 'AE2D6997-643A-59CB-9B3C-918572E5CEAA'],
+ 'Data' => [
+ 'description' => '应用分组信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '响应码 0：成功，其它失败，具体见文档', 'description' => '响应码 0：成功，其它失败，具体见文档', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。false：表示获取失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"AE2D6997-643A-59CB-9B3C-918572E5CEAA\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '解绑已有Axn绑定',
+ 'description' => '- 解除已有绑定关系的固话AXN隐私号后，可能影响您的业务连续性，请谨慎操作。'."\n"
+ ."\n"
+ .'- 释放号码前，需解除号码绑定关系。'."\n"
+ ."\n"
+ .'- 解除固话AXN隐私号码绑定关系仅支持此接口的方式进行解绑，暂不支持控制台进行解绑。',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteAxnBindFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"1A4CADEF-8516-5890-9177-A1A4D97F****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAxnTrackNoResponse>\\n <Code>OK</Code>\\n <Message>请求成功</Message>\\n <RequestId>8906582E-6722</RequestId>\\n</AddAxnTrackNoResponse>","errorExample":""}]',
- 'title' => '为AXN隐私号添加运单号',
- 'summary' => '为AXN隐私号添加运单号。',
- 'description' => '### QPS限制'."\n"
- .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'QueryPhoneNoAByTrackNo' => [
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'http',
- 'https',
- ],
+ 'DeleteAxnExtensionBindFixedLine' => [
+ 'summary' => '解除固话AXN分机号绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '72630',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '271368',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'trackNo',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '运单号。',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'example' => '22573****',
- ],
+ 'schema' => ['title' => '号池ID', 'description' => '业务id标识，由阿里云分配给客户侧', 'type' => 'string', 'required' => true, 'example' => 'alitest'],
],
[
- 'name' => 'CabinetNo',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => '柜机号。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '25689****',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'type' => 'string', 'required' => true, 'example' => '20250421141723098'],
],
[
- 'name' => 'PhoneNoX',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '创建绑定关系API接口所返回的X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1710000****',
- ],
+ 'schema' => ['title' => '消息请求唯一标识', 'description' => '消息请求唯一标识', 'type' => 'string', 'required' => true, 'example' => '12345dkwkd99d'],
+ ],
+ [
+ 'name' => 'SubId',
+ 'in' => 'query',
+ 'schema' => ['title' => '绑定id', 'description' => '绑定id', 'type' => 'string', 'required' => true, 'example' => 'GHX0534X202504221531579290029'],
],
],
'responses' => [
@@ -6520,74 +4074,47 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '状态码。'."\n"
- ."\n"
- .'- 返回OK代表请求成功。'."\n"
- .'- 其他错误码，请参见[错误码列表](~~109196~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '状态码的描述。',
- 'type' => 'string',
- 'example' => '请求成功',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '8906582E-6722',
- ],
- 'Module' => [
- 'description' => '绑定成功后返回的结构体。',
- 'type' => 'array',
- 'items' => [
- 'description' => '绑定成功后返回的结构体。',
- 'type' => 'object',
- 'properties' => [
- 'Extension' => [
- 'description' => 'X号码的分机号码。',
- 'type' => 'string',
- 'example' => '130',
- ],
- 'PhoneNoX' => [
- 'description' => '隐私号码，即X号码。',
- 'type' => 'string',
- 'example' => '1710000****',
- ],
- 'PhoneNoA' => [
- 'description' => 'A号码。',
- 'type' => 'string',
- 'example' => '1310000****',
- ],
- ],
+ 'AccessDeniedDetail' => ['description' => '鉴权报错信息', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '短信的完整内容。说明 美国、加拿大需要填写报备的内容。', 'type' => 'string', 'example' => 'conflict with subs id=1000203635098305, phoneA conflict'],
+ 'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '3DA9D6DF-C5FA-5A0D-B6C2-547B1FD1F9B4'],
+ 'Data' => [
+ 'description' => '应用信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '响应码 0：成功，其它失败，具体见文档', 'description' => '响应码 0：成功，其它失败，具体见文档', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。 false：表示获取失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
+ 'Code' => ['description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。 false：表示获取失败。', 'type' => 'boolean', 'example' => 'True'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"conflict with subs id=1000203635098305, phoneA conflict\\",\\n \\"RequestId\\": \\"3DA9D6DF-C5FA-5A0D-B6C2-547B1FD1F9B4\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '解绑已有AXN分机号绑定',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteAxnExtensionBindFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"Module\\": [\\n {\\n \\"Extension\\": \\"130\\",\\n \\"PhoneNoX\\": \\"1710000****\\",\\n \\"PhoneNoA\\": \\"1310000****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryPhoneNoAByTrackNoResponse>\\n <Code>OK</Code>\\n <Message>请求成功</Message>\\n <RequestId>8906582E-6722</RequestId>\\n <Module>\\n <Extension>130</Extension>\\n <PhoneNoX>1710000****</PhoneNoX>\\n <PhoneNoA>1310000****</PhoneNoA>\\n </Module>\\n</QueryPhoneNoAByTrackNoResponse>","errorExample":""}]',
- 'title' => '进行运单号广播推送',
- 'summary' => '广播推送运单号。',
- 'description' => '### QPS限制'."\n"
- .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
- 'requestParamsDescription' => ' ',
- 'responseParamsDescription' => ' ',
- 'extraInfo' => ' ',
],
- 'UnBindAXB' => [
- 'summary' => '接入方调用本接口解除指定的呼叫绑定关系（A，X，B），解除呼叫绑定关系后，员工B不能通过工作号X呼叫到客户A。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteSecretAPhoneNoToCust' => [
+ 'summary' => 'A号码报备数据删除。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6595,62 +4122,17 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '244979',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ReqId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
- ],
- [
- 'name' => 'CallerParentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
- ],
- [
- 'name' => 'CustomerPoolKey',
+ 'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['title' => 'A号码', 'description' => 'A号码。', 'type' => 'string', 'required' => true, 'example' => '130*****1234'],
],
[
- 'name' => 'BindId',
+ 'name' => 'ANoWhiteGroupId',
'in' => 'query',
- 'schema' => [
- 'title' => 'bindId绑定关系AXB唯一id',
- 'description' => '绑定关系AXB唯一id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '4534543',
- ],
+ 'schema' => ['title' => 'A号码组ID', 'description' => 'A号码组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '51'],
],
],
'responses' => [
@@ -6658,79 +4140,37 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码 0000表示成功 其他表示失败',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功 true 表示成功 false表示失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'RequestId' => ['title' => '返回id', 'description' => '返回ID。', 'type' => 'string', 'example' => '1D73E648-0978-18A5-B089-3BB2'],
+ 'Message' => ['title' => '失败错误提示', 'description' => '失败错误提示。', 'type' => 'string', 'example' => '号码组不存在'],
+ 'Data' => ['title' => '删除是否成功', 'description' => '删除是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '请求状态码', 'description' => '请求状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AXB呼叫解绑',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"号码组不存在\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '删除A号码报备记录',
+ 'description' => '- 此接口只能删除报备状态为已通过审核或审核失败的A号码报备信息，不支持删除报备状态为审核中的A号码报备信息。'."\n"
+ ."\n"
+ .'- 删除A号码报备信息后运营商将直接对该号码实施限呼拦截或关停，可能影响您的业务连续性，请谨慎操作。',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'BindXB' => [
- 'summary' => '接入方调用本接口请求工作号平台为指定工作号X和员工号码B建立关联（B，X）。仅当员工（号码B）完成工作号X的实名认证之后，关系绑定才会生效。关系绑定成功后，所有对工作号X的呼叫都会转接到员工号码B。工作号平台通过“异步通知接口”，把关系绑定的结果推送到接入方。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'DeleteSecretBlacklist' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
@@ -6739,478 +4179,422 @@
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '244978',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72616',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ReqId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC1232****'],
],
[
- 'name' => 'CallerParentId',
+ 'name' => 'BlackNo',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['description' => '黑名单号码。根据**BlackType**参数值决定取值类型：'."\n"
+ ."\n"
+ .'- **点对点黑名单**：一对号码，用英文冒号（:）分隔。'."\n"
+ .'- **号池黑名单**：单个号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1825****383:1825****483'],
],
[
- 'name' => 'CustomerPoolKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
- ],
- [
- 'name' => 'TelB',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'title' => '员工真实号码',
- 'description' => '员工真实号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '18*******22',
- ],
+ 'schema' => ['description' => '黑名单备注。', 'type' => 'string', 'required' => false, 'example' => '黑名单备注'],
],
[
- 'name' => 'TelX',
+ 'name' => 'BlackType',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码',
- 'description' => 'X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '17*******22',
- ],
+ 'schema' => ['description' => '黑名单类型。取值：'."\n"
+ ."\n"
+ .'- **POINT\\_TO\\_POINT_BLACK**：点对点黑名单。'."\n"
+ .'- **PARTNER\\_GLOBAL\\_NUMBER\\_BLACK**：号池黑名单。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'POINT_TO_POINT_BLACK'],
],
[
- 'name' => 'UserData',
+ 'name' => 'WayControl',
'in' => 'query',
'schema' => [
- 'title' => '客户自定义参数回调带回',
- 'description' => '回传参数，客户可自定义。',
+ 'description' => '呼叫方向控制。取值：'."\n"
+ ."\n"
+ .'- **PHONEA\\_REJECT**：BlackNo中第一个号码可以呼叫第二个号码，第二个号码不能呼叫第一个。'."\n"
+ ."\n"
+ .'- **PHONEB\\_REJECT**：BlackNo中第一个号码不可呼叫第二个号码，第二个号码可呼叫第一个号码。'."\n"
+ ."\n"
+ .'- **不填**：BlackNo中两个号码不可相互呼叫。',
'type' => 'string',
'required' => false,
- 'example' => '000',
+ 'example' => 'PHONEA_REJECT',
+ 'enum' => ['DUPLEX_REJECT', 'PHONEA_REJECT', 'PHONEB_REJECT'],
],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'AuthId' => [
- 'title' => '工作号关系绑定的唯一标识',
- 'description' => '工作号关系绑定的唯一标识',
- 'type' => 'string',
- 'example' => '4353453456',
- ],
- 'TelX' => [
- 'title' => 'X号码',
- 'description' => 'X号码',
- 'type' => 'string',
- 'example' => '18640577897',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .'其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功，'."\n"
+ .'- 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"AuthId\\": \\"4353453456\\",\\n \\"TelX\\": \\"18640577897\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => 'XB关系绑定',
- ],
- 'BindAXBCall' => [
- 'summary' => '接入方调用本接口向工作号平台请求为员工B的工作号X建立呼叫绑定关系（B，X，A），允许员工B通过工作号X呼叫客户A。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'RamPermissionDenied', 'errorMessage' => 'RAM permission is denied.', 'description' => 'RAM权限DENY'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteSecretBlacklistResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n</DeleteSecretBlacklistResponse>","errorExample":""}]',
+ 'title' => '删除黑名单',
+ 'summary' => '删除号码池的黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。',
+ 'description' => '- 此接口不是批处理接口，仅支持一次删除一组点对点黑名单号码，或者一个号池黑名单号码。'."\n"
+ .'- 若需添加黑名单，可调用[AddSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-addsecretblacklist)接口。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteSecretBlacklist',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetDyplsOSSInfoForUploadFile' => [
+ 'summary' => '获取OSS资源配置信息，此配置信息将用于后续OSS图片上传操作。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '244980',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ReqId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
- ],
- [
- 'name' => 'CallerParentId',
+ 'name' => 'BizType',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['description' => '业务类型。'."\n"
+ .'默认值为：phone_card。', 'type' => 'string', 'required' => true, 'example' => 'phone_card'],
],
- [
- 'name' => 'CustomerPoolKey',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E2FD3B2F-5028-16E3-9F83-2F76F99B3873'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => [
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Policy' => ['description' => '签名策略。', 'type' => 'string', 'example' => 'IjoiMjAyN*****9udGV'],
+ 'StartPath' => ['description' => '策略路径。', 'type' => 'string', 'example' => '123456'],
+ 'AccessKeyId' => ['description' => '签名使用的AccessKey ID。', 'type' => 'string', 'example' => 'YOUR_ACCESS_KEY_ID'],
+ 'Signature' => ['description' => '根据**AccessKey Secret**和**Policy**计算出的签名信息。调用OSS API时，OSS验证该签名信息，从而确认Post请求的合法性。', 'type' => 'string', 'example' => 'BXwW**********aoZH'],
+ 'Host' => ['description' => 'Host 地址。', 'type' => 'string', 'example' => 'https://alicom-**********-cn-zhangjiakou.aliyuncs.com'],
+ 'ExpireTime' => ['description' => '到期时间。', 'type' => 'string', 'example' => '1744613007'],
+ ],
+ ],
+ 'Code' => ['description' => '请求状态码。取值：'."\n"
+ .'* OK：代表请求成功。'."\n"
+ .'* 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '返回是否成功。取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"E2FD3B2F-5028-16E3-9F83-2F76F99B3873\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Policy\\": \\"IjoiMjAyN*****9udGV\\",\\n \\"StartPath\\": \\"123456\\",\\n \\"AccessKeyId\\": \\"YOUR_ACCESS_KEY_ID\\",\\n \\"Signature\\": \\"BXwW**********aoZH\\",\\n \\"Host\\": \\"https://alicom-**********-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"1744613007\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '获取A号码报备OSS配置信息',
+ 'description' => '- 您在上传A号码手机号个人报备照片时，需上传正面人像（照片清晰，人脸无遮挡）照片、选择上传身份证正反面照片（非必选）。上传后有助于审核人员了解您的个人身份信息。支持png、jpg、jpeg 格式，图片大小不要超过2M。'."\n"
+ ."\n"
+ .'- 您在通过API提交A号码手机号个人实名报备时，具体操作流程请参见[API提交A号码手机号个人实名信息](~~2880077~~)。',
+ 'changeSet' => [],
+ 'ramActions' => [],
+ ],
+ 'GetSecretAsrDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'TelA',
- 'in' => 'query',
- 'schema' => [
- 'title' => '客户A号码',
- 'description' => '客户A号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '13*******43',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '72619',
+ 'abilityTreeNodes' => ['FEATUREdyplsVL8MN2'],
+ ],
+ 'parameters' => [
[
- 'name' => 'AuthId',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'title' => 'authId绑定关系BX唯一id',
- 'description' => '绑定关系BX唯一id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12353',
- ],
+ 'schema' => ['description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
+ ."\n"
+ .'获取方式如下：'."\n"
+ .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫记录ID**。'."\n"
+ .'- 在**录音状态报告**回执消息中查看**call_id**字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '225625****'],
],
[
- 'name' => 'Expiration',
+ 'name' => 'CallTime',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定关系过期失效时间： 取值必须大于0； 单位：秒，ct_time + expiration = 自动解绑时间',
- 'description' => '绑定关系过期失效时间：取值必须大于0；单位：秒，绑定时间 + 过期失效时间 = 自动解绑时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '7200',
- ],
+ 'schema' => ['description' => '呼叫记录中的呼叫发起时间。'."\n"
+ ."\n"
+ .'获取方式如下：'."\n"
+ ."\n"
+ .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫时间**列的**呼叫发起**时间。'."\n"
+ .'- 在**录音状态报告**回执消息中查看**call_time**字段。'."\n"
+ ."\n"
+ .'> **CallTime**不支持传入时间戳格式的参数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-05 12:00:00'],
],
[
- 'name' => 'UserData',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '客户自定义参数回调带回',
- 'description' => '回传参数，客户可自定义。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '000',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC2267****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'Code' => ['description' => '错误码。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '错误码描述。', 'type' => 'string', 'example' => 'OK'],
'Data' => [
+ 'description' => 'ASR详情实体类信息。',
'type' => 'object',
'properties' => [
- 'BindId' => [
- 'title' => '绑定关系ID',
- 'description' => '绑定关系ID',
- 'type' => 'string',
- 'example' => '476567566',
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8d2329d407a83447a83be441681f4872ac74nE'],
+ 'BusinessId' => ['description' => '业务流程的ID。', 'type' => 'string', 'example' => '435ee78c7a******@!FC100000074******@!2020061522****'],
+ 'BusinessKey' => ['description' => '业务关键字。', 'type' => 'string', 'example' => 'JCGTncltuNao****'],
+ 'Code' => ['description' => '状态码。21050000表示请求成功。', 'type' => 'string', 'example' => '21050000'],
+ 'Msg' => ['description' => '描述信息。', 'type' => 'string', 'example' => 'SUCCESS'],
+ 'BizDuration' => ['description' => '识别的音频文件总时长，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '10944'],
+ 'Type' => ['description' => '类型。', 'type' => 'string', 'example' => 'asrResult'],
+ 'Sentences' => [
+ 'description' => 'ASR识别结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'ASR识别结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'EndTime' => ['description' => '该句的结束时间偏移，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1770'],
+ 'SilenceDuration' => ['description' => '本句和上一句之间的静音时长，单位：秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'BeginTime' => ['description' => '该句的起始时间偏移，单位：毫秒。', 'type' => 'integer', 'format' => 'int64', 'example' => '1020'],
+ 'Text' => ['description' => '该句的识别文本结果。', 'type' => 'string', 'example' => '您好'],
+ 'ChannelId' => ['description' => '该句所属音轨ID。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'SpeechRate' => ['description' => '本句的平均语速，单位为每分钟字数。', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
+ 'EmotionValue' => ['description' => '情绪能量值，取值：**1~10**，值越高情绪越强烈。', 'type' => 'string', 'example' => '5.7'],
+ ],
+ ],
],
],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'example' => '{"bizDuration":10944,"businessId":"435ee78c7a019650@!FC100000074672458@!20200615225802","businessKey":"JCGTncltuNaolegJ","code":"21050000","msg":"SUCCESS","requestId":"8d2329d407a83447a83be441681f4872ac74nE","sentences":[{"beginTime":1020,"channelId":0,"emotionValue":"5.7","endTime":1770,"silenceDuration":"0","speechRate":"80","text":"喂"}],"success":true,"type":"asrResult"}',
],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"BindId\\": \\"476567566\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AXB呼叫绑定',
- ],
- 'UnBindXB' => [
- 'summary' => '调用本接口可取消工作号X与员工号码B的绑定。绑定解除后，对X的呼叫都不会转接给B。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'isp.RAM_PERMISSION_DENY', 'errorMessage' => 'RAM permission is denied.', 'description' => 'RAM权限DENY'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"RequestId\\": \\"8d2329d407a83447a83be441681f4872ac74nE\\",\\n \\"BusinessId\\": \\"435ee78c7a******@!FC100000074******@!2020061522****\\",\\n \\"BusinessKey\\": \\"JCGTncltuNao****\\",\\n \\"Code\\": \\"21050000\\",\\n \\"Msg\\": \\"SUCCESS\\",\\n \\"BizDuration\\": 10944,\\n \\"Type\\": \\"asrResult\\",\\n \\"Sentences\\": [\\n {\\n \\"EndTime\\": 1770,\\n \\"SilenceDuration\\": 0,\\n \\"BeginTime\\": 1020,\\n \\"Text\\": \\"您好\\",\\n \\"ChannelId\\": 0,\\n \\"SpeechRate\\": 80,\\n \\"EmotionValue\\": \\"5.7\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSecretAsrDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>\\n <RequestId>8d2329d407a83447a83be441681f4872ac74nE</RequestId>\\n <BusinessId>435ee78c7a019650@!FC100000074672458@!2020061522****</BusinessId>\\n <BusinessKey>JCGTncltuNao****</BusinessKey>\\n <Code>21050000</Code>\\n <Msg>SUCCESS</Msg>\\n <BizDuration>10944</BizDuration>\\n <Type>asrResult</Type>\\n <Sentences>\\n <EndTime>1770</EndTime>\\n <SilenceDuration>0</SilenceDuration>\\n <BeginTime>1020</BeginTime>\\n <Text>您好</Text>\\n <ChannelId>0</ChannelId>\\n <SpeechRate>80</SpeechRate>\\n <EmotionValue>5.7</EmotionValue>\\n </Sentences>\\n </Data>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n</GetSecretAsrDetailResponse>","errorExample":""}]',
+ 'title' => '获取ASR识别结果详情',
+ 'summary' => '获取ASR识别结果详情。',
+ 'description' => '- 为确保您正常获取ASR识别结果，请使用此接口前，确认ASR服务功能开启。您可以调用[QuerySubscriptionDetail](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-querysubscriptiondetail)接口查询号码绑定详情，查看返回结果的**ASRStatus**参数。若未开启，可以调用[UpdateSubscription](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-updatesubscription)，修改**ASRStatus**参数为**true**。'."\n"
+ ."\n"
+ .'- 若您订阅了**回执消息类型**为**录音状态报告**（SecretRecording）的消息，该报告消息中的结果字段可以作为此接口的入参，您可以参考[回执消息简介与配置流程](https://help.aliyun.com/zh/pnp/developer-reference/introduction-to-receipt-messages-and-receipt-message-configurations)进行订阅。'."\n"
+ ."\n"
+ .'- 新的呼叫记录需要一段时间进行ASR识别，请您等待十几分钟再调用此接口查询。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:GetSecretAsrDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetTotalPublicUrl' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '244981',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72621',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ReqId',
+ 'name' => 'CheckSubs',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
+ 'schema' => ['description' => '是否需要校验绑定关系标识。'."\n"
+ .'取值：'."\n"
+ ."\n"
+ .'**true**：需要校验。'."\n"
+ ."\n"
+ .'**false**：不需要校验。', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false'],
],
[
- 'name' => 'CallerParentId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
- ],
- [
- 'name' => 'CustomerPoolKey',
+ 'name' => 'PartnerKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC12256****'],
],
[
- 'name' => 'AuthId',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'title' => 'authId绑定关系BX唯一id',
- 'description' => '绑定关系XB唯一id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '34*****46',
- ],
+ 'schema' => ['description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
+ ."\n"
+ .'获取方式如下：'."\n"
+ .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫记录ID**。'."\n"
+ .'- 在**录音状态报告**回执消息中查看**call_id**字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2568900****'],
],
[
- 'name' => 'TelX',
+ 'name' => 'CallTime',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码',
- 'description' => 'X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '17*******22',
- ],
+ 'schema' => ['description' => '呼叫记录中的呼叫发起时间。'."\n"
+ ."\n"
+ .'获取方式如下：'."\n"
+ ."\n"
+ .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫时间**列的**呼叫发起**时间。'."\n"
+ .'- 在**录音状态报告**回执消息中查看**call_time**字段。'."\n"
+ ."\n"
+ .'> **CallTime**不支持传入时间戳格式的参数。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-05 12:00:00 '],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1AB3CEF7-DCBE-488C-9C33-D180982CE031'],
'Data' => [
+ 'description' => '录音文件下载地址。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码 0000表示成功 其他表示失败',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功 true 表示成功 false表示失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'RingPublicUrl' => ['description' => '响铃放音的录音下载URL。'."\n"
+ ."\n"
+ .'> URL的有效期为30天。', 'type' => 'string', 'example' => 'http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D'],
+ 'PhonePublicUrl' => ['description' => '通话录音的下载URL。'."\n"
+ ."\n"
+ .'> URL的有效期为30天。', 'type' => 'string', 'example' => 'http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D'],
],
],
- 'Code' => [
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => 'XB关系解绑',
- ],
- 'QuerySoundRecord' => [
- 'summary' => '企业侧通过callId查询可下载的通话录音地址。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'FlowLimited', 'errorMessage' => 'The operation is denied due to flow control.', 'description' => '限流'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AB3CEF7-DCBE-488C-9C33-D180982CE031\\",\\n \\"Data\\": {\\n \\"RingPublicUrl\\": \\"http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D\\",\\n \\"PhonePublicUrl\\": \\"http://secret-ab-reco****cn-shanghai.aliyuncs.com/10000008********_66647243838006067***************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n***************EA%3D\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTotalPublicUrlResponse>\\n<Message>OK</Message>\\n<RequestId>1AB3CEF7-DCBE-488C-9C33-D180982CE031</RequestId>\\n<Data>\\n <RingPublicUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&amp;OSSAccessKeyId=LTAIP00vvvvvvvvv&amp;Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</RingPublicUrl>\\n <PhonePublicUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&amp;OSSAccessKeyId=LTAIP00vvvvvvvvv&amp;Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</PhonePublicUrl>\\n</Data>\\n<Code>OK</Code>\\n</GetTotalPublicUrlResponse>","errorExample":""}]',
+ 'title' => '获取响铃放音的录音下载链接',
+ 'summary' => '获取响铃放音的录音下载链接。',
+ 'description' => '- 您可以使用此接口获取响铃放音的录音下载链接来下载响铃放音的录音。'."\n"
+ .'- 若您订阅了**回执消息类型**为**录音状态报告**（SecretRecording）的消息，该报告消息中的结果字段可以作为此接口的入参，您可以参考[回执消息简介与配置流程](https://help.aliyun.com/zh/pnp/developer-reference/introduction-to-receipt-messages-and-receipt-message-configurations)进行订阅。'."\n"
+ .'- 新的呼叫记录需要一段时间生成响铃放音的录音，您可以等待几分钟再调用此接口查询响铃放音的录音下载链接。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTotalPublicUrl'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:GetTotalPublicUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetXConfig' => [
+ 'summary' => '获取X号码配置信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7220,56 +4604,29 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '244987',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsVL8MN2',
- ],
+ 'abilityTreeCode' => '244983',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
],
'parameters' => [
[
'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'CallId',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => '本次呼叫唯一id',
- 'description' => '通话ID，唯一确定的一次通话。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ac445343254',
- ],
+ 'schema' => ['title' => 'X号码', 'description' => 'X号码。', 'type' => 'string', 'required' => true, 'example' => '17*******22'],
],
],
'responses' => [
@@ -7277,139 +4634,112 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
'type' => 'object',
'properties' => [
- 'FileUrl' => [
- 'title' => '通话录音url路径，最大长度1000，有效期1小时',
- 'description' => '通话录音url路径，最大长度1000，有效期1小时',
- 'type' => 'string',
- 'example' => 'http://www.oss.com/temepl/a.mp3',
+ 'SequenceStartTime' => ['title' => '顺振开启时间 格式：HH:mm:ss 09:00:00', 'description' => '顺振开启时间 格式：HH:mm:ss 09:00:00', 'type' => 'string', 'example' => '09:00:00'],
+ 'SequenceCalls' => [
+ 'title' => '顺振控制参数',
+ 'description' => '顺振控制参数',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '',
+ 'description' => '',
+ 'type' => 'object',
+ 'properties' => [
+ 'SequenceCallNoPlayCode' => ['title' => '顺振提示音放音编号，格式如callNoPlayCode', 'description' => '顺振提示音放音编号，格式如callNoPlayCode', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ 'SequenceCalledNo' => ['title' => '顺振被叫号码', 'description' => '顺振被叫号码', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ 'SequenceCalledPlayCode' => ['title' => '接通后主被叫放音编号，格式如calledPlayCode', 'description' => '接通后主被叫放音编号，格式如calledPlayCode', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ ],
+ ],
+ 'example' => '',
],
+ 'SmsAbility' => ['title' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；', 'description' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；', 'type' => 'string', 'example' => '0'],
+ 'GNFlag' => ['title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'type' => 'string', 'example' => '00'],
+ 'SmsSignMode' => ['title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'type' => 'string', 'example' => '0'],
+ 'ReachJsons' => [
+ 'title' => '企业名片规则控制参数',
+ 'description' => '企业名片规则控制参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiveDir' => ['title' => '接收方向 1:主叫 2:被叫', 'description' => '接收方向 1:主叫 2:被叫', 'type' => 'string', 'example' => '1'],
+ 'CallDir' => ['title' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B', 'description' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B', 'type' => 'string', 'example' => '1'],
+ 'TempId' => ['title' => '模板ID', 'description' => '模板ID', 'type' => 'string', 'example' => '12345'],
+ 'RuleId' => ['title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '345'],
+ 'CallStatus' => ['title' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通', 'description' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通', 'type' => 'string', 'example' => '1'],
+ 'RuleType' => ['title' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频', 'description' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频', 'type' => 'string', 'example' => '1'],
+ 'RuleName' => ['title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'example' => '企业名片-短信规则'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'CallAbility' => ['title' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；', 'description' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；', 'type' => 'string', 'example' => '0'],
+ 'SequenceEndTime' => ['title' => '顺振结束时间 格式：HH:mm:ss 18:00:00', 'description' => '顺振结束时间 格式：HH:mm:ss 18:00:00', 'type' => 'string', 'example' => '09:00:00'],
],
'example' => '',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。 '."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'description' => '',
+ ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码，取值：'."\n"
+ .' '."\n"
+ .'- 0000：表示成功。'."\n"
+ .' '."\n"
+ .'其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://www.oss.com/temepl/a.mp3\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '通话录音地址查询',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"SequenceStartTime\\": \\"09:00:00\\",\\n \\"SequenceCalls\\": [\\n {\\n \\"SequenceCallNoPlayCode\\": \\"示例值示例值示例值\\",\\n \\"SequenceCalledNo\\": \\"示例值示例值示例值\\",\\n \\"SequenceCalledPlayCode\\": \\"示例值示例值示例值\\"\\n }\\n ],\\n \\"SmsAbility\\": \\"0\\",\\n \\"GNFlag\\": \\"00\\",\\n \\"SmsSignMode\\": \\"0\\",\\n \\"ReachJsons\\": [\\n {\\n \\"ReceiveDir\\": \\"1\\",\\n \\"CallDir\\": \\"1\\",\\n \\"TempId\\": \\"12345\\",\\n \\"RuleId\\": \\"345\\",\\n \\"CallStatus\\": \\"1\\",\\n \\"RuleType\\": \\"1\\",\\n \\"RuleName\\": \\"企业名片-短信规则\\"\\n }\\n ],\\n \\"CallAbility\\": \\"0\\",\\n \\"SequenceEndTime\\": \\"09:00:00\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '查询X号码通信配置',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'CreateSmsSign' => [
- 'summary' => '员工B通过工作号X向客户A下发短信场景中，员工B使用客户端向客户A 发送短信，客户端须通过本接口获取“短信下发标签”，并在短信内容尾部中添加该“标签”。工作号平台通过“标签”解析出真实被叫A号码，下发短信到A号码。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'GetXDefaultConfig' => [
+ 'summary' => '获取X号码默认配置信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '244986',
- 'abilityTreeNodes' => [
- 'FEATUREdyplsMM443Z',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '244984',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
],
'parameters' => [
[
'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'."\n"],
],
[
'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'CalledNo',
- 'in' => 'query',
- 'schema' => [
- 'title' => '收信人号码',
- 'description' => '收信人号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '178****3614',
- ],
- ],
- [
- 'name' => 'CallingNo',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => '发信人号码',
- 'description' => '发信人号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '150****6539',
- ],
+ 'schema' => ['title' => 'X号码', 'description' => 'X号码。', 'type' => 'string', 'required' => true, 'example' => '17*******22'],
],
],
'responses' => [
@@ -7417,68 +4747,79 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
'type' => 'object',
'properties' => [
- 'CalledNoSign' => [
- 'title' => '短信接收者号码签名串(加到短信内容中供解析真实被叫号码)',
- 'description' => '短信接收者号码签名串(加到短信内容中供解析真实被叫号码)',
- 'type' => 'string',
- 'example' => 'sign23343466',
+ 'ReachJson' => [
+ 'title' => '企业名片规则控制参数',
+ 'description' => '企业名片规则控制参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ReceiveDir' => ['title' => '接收方向 1:主叫 2:被叫', 'description' => '接收方向 1:主叫 2:被叫', 'type' => 'string', 'example' => '1'],
+ 'CallDir' => ['title' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B', 'description' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B', 'type' => 'string', 'example' => '1'],
+ 'TempId' => ['title' => '模板ID', 'description' => '模板ID', 'type' => 'string', 'example' => '12345'],
+ 'RuleId' => ['title' => '规则ID', 'description' => '规则ID', 'type' => 'string', 'example' => '345'],
+ 'CallStatus' => ['title' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通', 'description' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通', 'type' => 'string', 'example' => '1'],
+ 'RuleType' => ['title' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频', 'description' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频', 'type' => 'string', 'example' => '1'],
+ 'RuleName' => ['title' => '规则名称', 'description' => '规则名称', 'type' => 'string', 'example' => '企业名片-短信规则'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
+ ],
+ 'SequenceStartTime' => ['title' => '顺振开启时间 格式：HH:mm:ss 09:00:00', 'description' => '顺振开启时间 格式：HH:mm:ss 09:00:00', 'type' => 'string', 'example' => '09:00:00'],
+ 'SmsAbility' => ['title' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；', 'description' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；', 'type' => 'string', 'example' => '0'],
+ 'GNFlag' => ['title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'type' => 'string', 'example' => '00'],
+ 'SmsSignMode' => ['title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00', 'type' => 'string', 'example' => '0'],
+ 'SequenceCall' => [
+ 'title' => '顺振控制参数',
+ 'description' => '顺振控制参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SequenceCallNoPlayCode' => ['title' => '顺振提示音放音编号，格式如callNoPlayCode', 'description' => '顺振提示音放音编号，格式如callNoPlayCode', 'type' => 'string', 'example' => '示例值'],
+ 'SequenceCalledNo' => ['title' => '顺振被叫号码', 'description' => '顺振被叫号码', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ 'SequenceCalledPlayCode' => ['title' => '接通后主被叫放音编号，格式如calledPlayCode', 'description' => '接通后主被叫放音编号，格式如calledPlayCode', 'type' => 'string', 'example' => '示例值示例值示例值'],
+ ],
+ 'description' => '',
+ ],
+ 'example' => '',
],
+ 'CallAbility' => ['title' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；', 'description' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；', 'type' => 'string', 'example' => '0'],
+ 'SequenceEndTime' => ['title' => '顺振结束时间 格式：HH:mm:ss 18:00:00', 'description' => '顺振结束时间 格式：HH:mm:ss 18:00:00', 'type' => 'string', 'example' => '09:00:00'],
],
'example' => '',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'description' => '',
+ ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000表示成功 。'."\n"
+ ."\n"
+ .'其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"CalledNoSign\\": \\"sign23343466\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => '短信下发标签生成',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"ReachJson\\": [\\n {\\n \\"ReceiveDir\\": \\"1\\",\\n \\"CallDir\\": \\"1\\",\\n \\"TempId\\": \\"12345\\",\\n \\"RuleId\\": \\"345\\",\\n \\"CallStatus\\": \\"1\\",\\n \\"RuleType\\": \\"1\\",\\n \\"RuleName\\": \\"企业名片-短信规则\\"\\n }\\n ],\\n \\"SequenceStartTime\\": \\"09:00:00\\",\\n \\"SmsAbility\\": \\"0\\",\\n \\"GNFlag\\": \\"00\\",\\n \\"SmsSignMode\\": \\"0\\",\\n \\"SequenceCall\\": [\\n {\\n \\"SequenceCallNoPlayCode\\": \\"示例值\\",\\n \\"SequenceCalledNo\\": \\"示例值示例值示例值\\",\\n \\"SequenceCalledPlayCode\\": \\"示例值示例值示例值\\"\\n }\\n ],\\n \\"CallAbility\\": \\"0\\",\\n \\"SequenceEndTime\\": \\"09:00:00\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '企业查询默认的X号码配置',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
'ListXTelephones' => [
'summary' => '查询客户名下X号码列表。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -7491,9 +4832,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '244985',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -7501,62 +4840,27 @@
[
'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => false, 'example' => 'FC5**********************a1a'],
],
[
'name' => 'PageNo',
'in' => 'query',
- 'schema' => [
- 'title' => '页码从1开始',
- 'description' => '分页查询的页码，从1开始。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['title' => '页码从1开始', 'description' => '分页查询的页码，从1开始。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
'name' => 'PageSize',
'in' => 'query',
- 'schema' => [
- 'title' => '每页条数',
- 'description' => '每页条数。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '每页条数', 'description' => '每页条数。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10'],
],
],
'responses' => [
@@ -7564,42 +4868,15 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
'description' => '数据集合。',
'type' => 'object',
'properties' => [
- 'PageSize' => [
- 'title' => '每页条数',
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '符合查询条件的总数量',
- 'description' => '符合查询条件的总数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'PageNo' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'Total' => ['title' => '符合查询条件的总数量', 'description' => '符合查询条件的总数量', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PageNo' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
'List' => [
'title' => '数据集合',
'description' => '数据集合',
@@ -7609,613 +4886,343 @@
'description' => '每个数据项的键值对',
'type' => 'object',
'properties' => [
- 'BuyTime' => [
- 'title' => '购买时间',
- 'description' => '购买时间',
- 'type' => 'string',
- 'example' => '2024-08-29 17:23:58',
- ],
- 'TelephoneStatus' => [
- 'title' => '号码状态：0 空闲中 1 调拨完成待购买 2购买完成待认证 3 实名认证中 4 实名认证成功 5 认证失败 6 解绑中 7 解绑失败 8已释放 99 超时释放',
- 'description' => '号码状态：0 空闲中 1 调拨完成待购买 2购买完成待认证 3 实名认证中 4 实名认证成功 5 认证失败 6 解绑中 7 解绑失败 8已释放 99 超时释放',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'CustomerPoolKey' => [
- 'title' => '客户号码池key',
- 'description' => '客户号码池key',
- 'type' => 'string',
- 'example' => 'FC533e6eeb81f4400c87ef3745a21a1a',
- ],
- 'BindTime' => [
- 'title' => '绑定时间',
- 'description' => '绑定时间',
- 'type' => 'string',
- 'example' => '2024-08-29 17:23:58',
- ],
- 'CustomerPoolName' => [
- 'title' => '号码池名称',
- 'description' => '号码池名称',
- 'type' => 'string',
- 'example' => '测试号码池',
- ],
- 'Telephone' => [
- 'title' => 'X号码',
- 'description' => 'X号码',
- 'type' => 'string',
- 'example' => '17816876546',
- ],
- 'SmsStatus' => [
- 'title' => '短信开通状态：0 未开通 1已开通',
- 'description' => '短信开通状态：0 未开通 1已开通',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'ReleaseTime' => [
- 'title' => '释放时间',
- 'description' => '释放时间',
- 'type' => 'string',
- 'example' => '2024-08-29 17:23:58',
- ],
- 'AuthMsg' => [
- 'title' => '绑定失败原因',
- 'description' => '绑定失败原因',
- 'type' => 'string',
- 'example' => '绑定失败用户身份证黑名单',
- ],
- 'UnbindTime' => [
- 'title' => '解绑时间',
- 'description' => '解绑时间',
- 'type' => 'string',
- 'example' => '2024-08-29 17:23:58',
- ],
+ 'BuyTime' => ['title' => '购买时间', 'description' => '购买时间', 'type' => 'string', 'example' => '2024-08-29 17:23:58'],
+ 'TelephoneStatus' => ['title' => '号码状态：0 空闲中 1 调拨完成待购买 2购买完成待认证 3 实名认证中 4 实名认证成功 5 认证失败 6 解绑中 7 解绑失败 8已释放 99 超时释放', 'description' => '号码状态：0 空闲中 1 调拨完成待购买 2购买完成待认证 3 实名认证中 4 实名认证成功 5 认证失败 6 解绑中 7 解绑失败 8已释放 99 超时释放', 'type' => 'string', 'example' => '0'],
+ 'CustomerPoolKey' => ['title' => '客户号码池key', 'description' => '客户号码池key', 'type' => 'string', 'example' => 'FC533e6eeb81f4400c87ef3745a21a1a'],
+ 'BindTime' => ['title' => '绑定时间', 'description' => '绑定时间', 'type' => 'string', 'example' => '2024-08-29 17:23:58'],
+ 'CustomerPoolName' => ['title' => '号码池名称', 'description' => '号码池名称', 'type' => 'string', 'example' => '测试号码池'],
+ 'Telephone' => ['title' => 'X号码', 'description' => 'X号码', 'type' => 'string', 'example' => '17816876546'],
+ 'SmsStatus' => ['title' => '短信开通状态：0 未开通 1已开通', 'description' => '短信开通状态：0 未开通 1已开通', 'type' => 'string', 'example' => '0'],
+ 'ReleaseTime' => ['title' => '释放时间', 'description' => '释放时间', 'type' => 'string', 'example' => '2024-08-29 17:23:58'],
+ 'AuthMsg' => ['title' => '绑定失败原因', 'description' => '绑定失败原因', 'type' => 'string', 'example' => '绑定失败用户身份证黑名单'],
+ 'UnbindTime' => ['title' => '解绑时间', 'description' => '解绑时间', 'type' => 'string', 'example' => '2024-08-29 17:23:58'],
],
],
'example' => '',
],
],
],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码。取值：'."\n"
- ."\n"
- .'- 0000：表示成功。'."\n"
- ."\n"
- .'- 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功。取值：'."\n"
- ."\n"
- .'- true ：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码。取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .'- 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功。取值：'."\n"
+ ."\n"
+ .'- true ：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 50,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"BuyTime\\": \\"2024-08-29 17:23:58\\",\\n \\"TelephoneStatus\\": \\"0\\",\\n \\"CustomerPoolKey\\": \\"FC533e6eeb81f4400c87ef3745a21a1a\\",\\n \\"BindTime\\": \\"2024-08-29 17:23:58\\",\\n \\"CustomerPoolName\\": \\"测试号码池\\",\\n \\"Telephone\\": \\"17816876546\\",\\n \\"SmsStatus\\": \\"0\\",\\n \\"ReleaseTime\\": \\"2024-08-29 17:23:58\\",\\n \\"AuthMsg\\": \\"绑定失败用户身份证黑名单\\",\\n \\"UnbindTime\\": \\"2024-08-29 17:23:58\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '企业查询名下号码信息',
- ],
- 'GetXConfig' => [
- 'summary' => '获取X号码配置信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'dypls:ListXTelephones',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'LockSecretNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '244983',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72625',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ReqId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
- ],
- [
- 'name' => 'CallerParentId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC123****'],
],
[
- 'name' => 'CustomerPoolKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
- ],
- [
- 'name' => 'TelX',
+ 'name' => 'SecretNo',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码',
- 'description' => 'X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '17*******22',
- ],
+ 'schema' => ['description' => '需要锁定的隐私号码，需要填写完整的手机号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1300000****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'SequenceStartTime' => [
- 'title' => '顺振开启时间 格式：HH:mm:ss 09:00:00',
- 'description' => '顺振开启时间 格式：HH:mm:ss 09:00:00',
- 'type' => 'string',
- 'example' => '09:00:00',
- ],
- 'SequenceCalls' => [
- 'title' => '顺振控制参数',
- 'description' => '顺振控制参数',
- 'type' => 'array',
- 'items' => [
- 'title' => '',
- 'description' => '',
- 'type' => 'object',
- 'properties' => [
- 'SequenceCallNoPlayCode' => [
- 'title' => '顺振提示音放音编号，格式如callNoPlayCode',
- 'description' => '顺振提示音放音编号，格式如callNoPlayCode',
- 'type' => 'string',
- 'example' => '示例值示例值示例值',
- ],
- 'SequenceCalledNo' => [
- 'title' => '顺振被叫号码',
- 'description' => '顺振被叫号码',
- 'type' => 'string',
- 'example' => '示例值示例值示例值',
- ],
- 'SequenceCalledPlayCode' => [
- 'title' => '接通后主被叫放音编号，格式如calledPlayCode',
- 'description' => '接通后主被叫放音编号，格式如calledPlayCode',
- 'type' => 'string',
- 'example' => '示例值示例值示例值',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'SmsAbility' => [
- 'title' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；',
- 'description' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'GNFlag' => [
- 'title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'type' => 'string',
- 'example' => '00',
- ],
- 'SmsSignMode' => [
- 'title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'ReachJsons' => [
- 'title' => '企业名片规则控制参数',
- 'description' => '企业名片规则控制参数',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ReceiveDir' => [
- 'title' => '接收方向 1:主叫 2:被叫',
- 'description' => '接收方向 1:主叫 2:被叫',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'CallDir' => [
- 'title' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B',
- 'description' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'TempId' => [
- 'title' => '模板ID',
- 'description' => '模板ID',
- 'type' => 'string',
- 'example' => '12345',
- ],
- 'RuleId' => [
- 'title' => '规则ID',
- 'description' => '规则ID',
- 'type' => 'string',
- 'example' => '345',
- ],
- 'CallStatus' => [
- 'title' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通',
- 'description' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RuleType' => [
- 'title' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频',
- 'description' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RuleName' => [
- 'title' => '规则名称',
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => '企业名片-短信规则',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'CallAbility' => [
- 'title' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；',
- 'description' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'SequenceEndTime' => [
- 'title' => '顺振结束时间 格式：HH:mm:ss 18:00:00',
- 'description' => '顺振结束时间 格式：HH:mm:ss 18:00:00',
- 'type' => 'string',
- 'example' => '09:00:00',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码，取值：'."\n"
- .' '."\n"
- .'- 0000：表示成功。'."\n"
- .' '."\n"
- .'其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020'],
],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"SequenceStartTime\\": \\"09:00:00\\",\\n \\"SequenceCalls\\": [\\n {\\n \\"SequenceCallNoPlayCode\\": \\"示例值示例值示例值\\",\\n \\"SequenceCalledNo\\": \\"示例值示例值示例值\\",\\n \\"SequenceCalledPlayCode\\": \\"示例值示例值示例值\\"\\n }\\n ],\\n \\"SmsAbility\\": \\"0\\",\\n \\"GNFlag\\": \\"00\\",\\n \\"SmsSignMode\\": \\"0\\",\\n \\"ReachJsons\\": [\\n {\\n \\"ReceiveDir\\": \\"1\\",\\n \\"CallDir\\": \\"1\\",\\n \\"TempId\\": \\"12345\\",\\n \\"RuleId\\": \\"345\\",\\n \\"CallStatus\\": \\"1\\",\\n \\"RuleType\\": \\"1\\",\\n \\"RuleName\\": \\"企业名片-短信规则\\"\\n }\\n ],\\n \\"CallAbility\\": \\"0\\",\\n \\"SequenceEndTime\\": \\"09:00:00\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询X号码通信配置',
- ],
- 'ConfigX' => [
- 'summary' => '配置X号码，单独对工作号的话音呼叫、企业名片等通信功能进行配置操作。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\"\\n}","errorExample":""},{"type":"xml","example":"<LockSecretNoResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\n</LockSecretNoResponse>","errorExample":""}]',
+ 'title' => '锁定号码',
+ 'summary' => '锁定号码。适用于需要临时屏蔽异常号码的场景。',
+ 'description' => '- 号码被锁定后，调用接口创建新绑定时将不再选择已经锁定的号码。'."\n"
+ ."\n"
+ .'- 可调用[UnlockSecretNo](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-unlocksecretno)接口解锁号码。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockSecretNo'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:LockSecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'OperateAxgGroup' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '244982',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
+ 'abilityTreeCode' => '72627',
+ 'abilityTreeNodes' => ['FEATUREdyplsNPUT41'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'ReqId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，reqId最大长度为20位，接入方需要保持原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC10000012345****'],
],
[
- 'name' => 'CallerParentId',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '系统自动获取，无需输入。',
- ],
+ 'schema' => ['description' => 'AXG中的G组ID，即GID。'."\n"
+ ."\n"
+ .'可以通过以下方式查看GID：'."\n"
+ .'- 登录号码隐私保护控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**，单击**G号码组管理**即可查看所有G号码组的GID。'."\n"
+ .'- 如果G号码组是通过接口[CreateAxgGroup](~~110250~~)创建的，则接口的返回参数**GroupID**就是此处的请求参数**GroupID**。'."\n"
+ ."\n"
+ .'> G号码组中必须有一个及以上的电话号码。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '200001234****'],
],
[
- 'name' => 'CustomerPoolKey',
+ 'name' => 'OperateType',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['description' => '对G号码组的操作类型，取值：'."\n"
+ .'- **addNumbers**：添加号码。'."\n"
+ .'- **deleteNumbers**：删除号码。'."\n"
+ .'- **overwriteNumbers**：全量替换号码。会将G号码组中原有的电话号码全部删除，并重新添加号码。'."\n"
+ ."\n"
+ .'> - 每次添加号码时，最多添加200个号码。'."\n"
+ .'> - 全量替换号码时，G号码组中原有的号码不能超过200个。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'addNumbers'],
],
[
- 'name' => 'TelX',
+ 'name' => 'Numbers',
'in' => 'query',
+ 'schema' => ['description' => '受到操作的电话号码。'."\n"
+ ."\n"
+ .'多个号码之间用英文逗号（,）分隔，每次最多操作200个号码。'."\n"
+ ."\n"
+ .'> - 当**OperateType**参数指定为**addNumbers**时，将**Numbers**参数填写的电话号码**添加**到G号码组中。'."\n"
+ .'> - 当**OperateType**参数指定为**deleteNumbers**时，将**Numbers**参数填写的电话号码从G号码组中**删除**。'."\n"
+ .'> - 当**OperateType**参数指定为**overwriteNumbers**时，使用**Numbers**参数填写的电话号码**全量替换**G号码组中原有的电话号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1390000****,1380000****'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'X号码',
- 'description' => 'X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '17*******22',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36'],
+ ],
],
],
- [
- 'name' => 'GNFlag',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否透传来显为真实主叫：00-非透传：互相拨打时都显示工作号;10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号;默认为 00',
- 'description' => '是否透传来显为真实主叫，取值：'."\n"
- ."\n"
- .'- 00：非透传，互相拨打时都显示工作号。'."\n"
- ."\n"
- .'- 10：透传，A客户为主叫时，B员工的来显为客户A号码；B员工为主叫时，A客户的来显为工作号。'."\n"
- ."\n"
- .'默认为 00。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A9901233D36\\"\\n}","errorExample":""},{"type":"xml","example":"<OperateAxgGroupResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\n</OperateAxgGroupResponse>","errorExample":""}]',
+ 'title' => '修改G号码组',
+ 'summary' => '修改G号码组中的号码，可以对号码进行添加、删除、全量替换操作。',
+ 'description' => '- 创建G号码组之后，可以通过此接口修改G号码组中的号码，例如向G号码组中增加号码、删除号码、全量替换号码。'."\n"
+ ."\n"
+ .'- 您可以使用此接口修改G号码组中的号码，也可以登录控制台，在[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面筛选出**AXG隐私号**类型的号码池，单击**G号码组管理**>**G组号码管理**进行修改。'."\n"
+ ."\n"
+ .'- 在使用此接口前，建议您先明确需要修改的G号码组及该号码组归属的号码池。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:OperateAxgGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'OperateBlackNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'SmsSignMode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '是否透传来显为真实用户0：不透传; 1：透传默认：0不透传',
- 'description' => '是否透传来显为真实用户，取值：'."\n"
- ."\n"
- .'- 0：不透传。'."\n"
- ."\n"
- .' - 1：透传。'."\n"
- ."\n"
- .'默认为0不透传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72628',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'SmsAbility',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '开/关短信功能状态‘0’：禁用；‘1’：开启；',
- 'description' => '开/关短信功能状态，取值：'."\n"
- ."\n"
- .'- 0：禁用。'."\n"
- ."\n"
- .'- 1：开启。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'example' => 'FC123456****'],
],
[
- 'name' => 'CallAbility',
+ 'name' => 'BlackNo',
'in' => 'query',
- 'schema' => [
- 'title' => '开/关呼叫能力状态‘0’：禁用‘1’：开启',
- 'description' => '开/关呼叫能力状态，取值：'."\n"
- ."\n"
- .'- 0：禁用。'."\n"
- ."\n"
- .'- 1：开启。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '需要操作的黑名单号码。'."\n"
+ .'> 仅支持操作**号池黑名单**类型的号码。', 'type' => 'string', 'required' => true, 'example' => '150****0000'],
],
[
- 'name' => 'SequenceMode',
+ 'name' => 'OperateType',
'in' => 'query',
- 'schema' => [
- 'title' => '顺振模式：0-不顺振（默认）1-有条件顺振，先接续calledNo指定被叫，如果该被叫未能接通，再顺振sequenceCalls号码列表2-无条件顺振，不接续calledNo指定被叫，直接顺振sequenceCalls号码列表',
- 'description' => '顺振模式，取值：'."\n"
- ."\n"
- .'- 0：不顺振（默认）'."\n"
- ."\n"
- .'- 1：有条件顺振，先接续calledNo指定被叫，如果该被叫未能接通，再顺振sequenceCalls号码列表。'."\n"
- ."\n"
- .'- 2：无条件顺振，不接续calledNo指定被叫，直接顺振sequenceCalls号码列表。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '黑名单操作类型。取值：'."\n"
+ ."\n"
+ .'- **AddBlack**：新增黑名单。'."\n"
+ .'- **DeleteBlack**：删除黑名单。', 'type' => 'string', 'required' => true, 'example' => 'AddBlack'],
],
[
- 'name' => 'SequenceCalls',
+ 'name' => 'Tips',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '顺振控制参数',
- 'description' => '顺振控制参数。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SequenceCallNoPlayCode' => [
- 'title' => '顺振提示音放音编号，格式如callNoPlayCode',
- 'description' => '顺振提示音放音编号，格式如callNoPlayCode。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '01',
- ],
- 'SequenceCalledNo' => [
- 'title' => '顺振被叫号码',
- 'description' => '顺振被叫号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '18*******33',
- ],
- 'SequenceCalledPlayCode' => [
- 'title' => '接通后主被叫放音编号，格式如calledPlayCode',
- 'description' => '接通后主被叫放音编号，格式如calledPlayCode。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '02',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => '备注信息。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码 0000表示成功 其他表示失败',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功 true 表示成功 false表示失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000表示成功。'."\n"
- ."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- .' '."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\"\\n}","errorExample":""},{"type":"xml","example":"<OperateBlackNoResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\n</OperateBlackNoResponse>","errorExample":""}]',
+ 'title' => '新增或删除黑名单',
+ 'summary' => '新增或删除号池黑名单。仅AXN隐私号、AXN分机号、95AXN隐私号类型的号码池支持设置黑名单。',
+ 'description' => '- 此接口仅支持新增或删除**号池黑名单**类型的黑名单号码。'."\n"
+ ."\n"
+ .'- 此接口不是批处理接口，仅支持一次新增或删除一个号池黑名单号码。'."\n"
+ ."\n"
+ .'- 可调用[AddSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-addsecretblacklist)添加**点对点黑名单**号码，调用[DeleteSecretBlacklist](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-deletesecretblacklist)删除**点对点黑名单**号码。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:OperateBlackNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '配置X号码的通信属性',
],
- 'GetXDefaultConfig' => [
- 'summary' => '获取X号码默认配置信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryAxbBindFixedLine' => [
+ 'summary' => '查询已绑定固话AXB隐私号信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8223,58 +5230,46 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '244984',
- 'abilityTreeNodes' => [
- 'FEATUREdypls9LYVYY',
- ],
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ReqId',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性',
- 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '564**********879'."\n",
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'CallerParentId',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'title' => '客户uid',
- 'description' => '客户UID，系统自动获取，无需输入。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '-',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'CustomerPoolKey',
+ 'name' => 'QueryType',
'in' => 'query',
- 'schema' => [
- 'title' => '号码池key',
- 'description' => '号码池key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC5**********************a1a',
- ],
+ 'schema' => ['title' => '查询类型 0：根据绑定id查询 1：根据X和A/B号码查询', 'description' => '查询类型。取值：'."\n"
+ ."\n"
+ .'- 0：根据绑定ID查询。'."\n"
+ ."\n"
+ .'- 1：根据X和A/B号码查询。', 'type' => 'string', 'required' => true, 'example' => '0'],
+ ],
+ [
+ 'name' => 'SubId',
+ 'in' => 'query',
+ 'schema' => ['title' => '绑定id， queryType=0时，必传', 'description' => '绑定ID。QueryType参数为0时必传。', 'type' => 'string', 'required' => false, 'example' => 'A203**************'],
+ ],
+ [
+ 'name' => 'Phone',
+ 'in' => 'query',
+ 'schema' => ['title' => 'A/B号码，queryType=1时，必传', 'description' => 'A/B号码，QueryType参数为1时必传。', 'type' => 'string', 'required' => false, 'example' => '138****6534'],
],
[
'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码',
- 'description' => 'X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '17*******22',
- ],
+ 'schema' => ['title' => 'x号码，queryType=1时，必传', 'description' => 'X号码，QueryType参数为1时必传。', 'type' => 'string', 'required' => false, 'example' => '0571******23'],
+ ],
+ [
+ 'name' => 'OrderId',
+ 'in' => 'query',
+ 'schema' => ['title' => '消息请求唯一标识。', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
],
'responses' => [
@@ -8282,428 +5277,251 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝的详细原因。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '3179F199-C6C5-5963-85A6-21CBA2F47592'],
'Data' => [
+ 'title' => '绑定信息',
+ 'description' => '绑定信息。',
'type' => 'object',
'properties' => [
- 'ReachJson' => [
- 'title' => '企业名片规则控制参数',
- 'description' => '企业名片规则控制参数',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ReceiveDir' => [
- 'title' => '接收方向 1:主叫 2:被叫',
- 'description' => '接收方向 1:主叫 2:被叫',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'CallDir' => [
- 'title' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B',
- 'description' => '呼叫方向 1:员工B呼叫客户A 2:客户A呼叫员工B',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'TempId' => [
- 'title' => '模板ID',
- 'description' => '模板ID',
- 'type' => 'string',
- 'example' => '12345',
- ],
- 'RuleId' => [
- 'title' => '规则ID',
- 'description' => '规则ID',
- 'type' => 'string',
- 'example' => '345',
- ],
- 'CallStatus' => [
- 'title' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通',
- 'description' => '通话状态 1:通话振铃 2:接通前 3:接通后 4:通话结束 5:已接通6:未接通',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RuleType' => [
- 'title' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频',
- 'description' => '规则类型： 1：企业名片-短信 2：企业名片-闪信 3：企业名片-视频 4：企业名片-音频',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'RuleName' => [
- 'title' => '规则名称',
- 'description' => '规则名称',
- 'type' => 'string',
- 'example' => '企业名片-短信规则',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'SequenceStartTime' => [
- 'title' => '顺振开启时间 格式：HH:mm:ss 09:00:00',
- 'description' => '顺振开启时间 格式：HH:mm:ss 09:00:00',
- 'type' => 'string',
- 'example' => '09:00:00',
- ],
- 'SmsAbility' => [
- 'title' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；',
- 'description' => '开/关短信功能状态： ‘0’：禁用； ‘1’：开启；',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'GNFlag' => [
- 'title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'type' => 'string',
- 'example' => '00',
- ],
- 'SmsSignMode' => [
- 'title' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'description' => '是否透传来显为真实主叫： 00-非透传：互相拨打时都显示工作号; 10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号; 默认为 00',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'SequenceCall' => [
- 'title' => '顺振控制参数',
- 'description' => '顺振控制参数',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SequenceCallNoPlayCode' => [
- 'title' => '顺振提示音放音编号，格式如callNoPlayCode',
- 'description' => '顺振提示音放音编号，格式如callNoPlayCode',
- 'type' => 'string',
- 'example' => '示例值',
- ],
- 'SequenceCalledNo' => [
- 'title' => '顺振被叫号码',
- 'description' => '顺振被叫号码',
- 'type' => 'string',
- 'example' => '示例值示例值示例值',
- ],
- 'SequenceCalledPlayCode' => [
- 'title' => '接通后主被叫放音编号，格式如calledPlayCode',
- 'description' => '接通后主被叫放音编号，格式如calledPlayCode',
- 'type' => 'string',
- 'example' => '示例值示例值示例值',
- ],
- ],
+ 'TelB' => ['title' => 'B号码', 'description' => 'B号码。', 'type' => 'string', 'example' => '155****2222'],
+ 'TelA' => ['title' => 'A号码', 'description' => 'A号码。', 'type' => 'string', 'example' => '155****1111'],
+ 'Subid' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'example' => 'GHX**************************'],
+ 'Anucodecalled' => ['title' => '接通后被叫侧放音编码', 'description' => '接通后被叫侧放音编码。', 'type' => 'string', 'example' => '10001,10002'],
+ 'Extra' => [
+ 'title' => '额外字段',
+ 'description' => '扩展参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callrecording' => ['title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'example' => '1'],
],
'example' => '',
],
- 'CallAbility' => [
- 'title' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；',
- 'description' => '开/关呼叫能力状态： ‘0’：禁用； ‘1’：开启；',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'SequenceEndTime' => [
- 'title' => '顺振结束时间 格式：HH:mm:ss 18:00:00',
- 'description' => '顺振结束时间 格式：HH:mm:ss 18:00:00',
- 'type' => 'string',
- 'example' => '09:00:00',
- ],
+ 'Subts' => ['title' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'example' => '20161114143116'],
+ 'Expiration' => ['title' => '绑定过期时间', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效；超过60s后，自动解绑。', 'type' => 'string', 'example' => '60'],
+ 'TelX' => ['title' => '小号号码', 'description' => '固话AXB隐私号的X号码。X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。', 'type' => 'string', 'example' => '0571******23'],
+ 'Areacode' => ['title' => '隐私号码区号', 'description' => '隐私号码区号。', 'type' => 'string', 'example' => '0571'],
+ 'Anucode' => ['title' => '接通前放音编码，放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', 'description' => '接通前放音编码，必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 '."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。', 'type' => 'string', 'example' => '1,2,3'],
+ 'TAnucodeConnect' => ['title' => '接通后主叫侧放音编码', 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'example' => '1,2'],
+ 'Remark' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'example' => '19394'],
],
'example' => '',
],
- 'Code' => [
- 'title' => '返回状态码 0000表示成功 其他表示失败',
- 'description' => '返回状态码，取值：'."\n"
- ."\n"
- .'- 0000表示成功 。'."\n"
- ."\n"
- .'其他表示失败。',
- 'type' => 'string',
- 'example' => '0000',
- ],
- 'Success' => [
- 'title' => '返回是否成功 true 表示成功 false表示失败',
- 'description' => '返回是否成功，取值：'."\n"
- ."\n"
- .'- true：表示成功。'."\n"
- ."\n"
- .'- false：表示失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '响应码', 'description' => '接口请求状态码。取值：'."\n"
+ .'0：成功。其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['title' => '处理是否成功 true-成功', 'description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"ReachJson\\": [\\n {\\n \\"ReceiveDir\\": \\"1\\",\\n \\"CallDir\\": \\"1\\",\\n \\"TempId\\": \\"12345\\",\\n \\"RuleId\\": \\"345\\",\\n \\"CallStatus\\": \\"1\\",\\n \\"RuleType\\": \\"1\\",\\n \\"RuleName\\": \\"企业名片-短信规则\\"\\n }\\n ],\\n \\"SequenceStartTime\\": \\"09:00:00\\",\\n \\"SmsAbility\\": \\"0\\",\\n \\"GNFlag\\": \\"00\\",\\n \\"SmsSignMode\\": \\"0\\",\\n \\"SequenceCall\\": [\\n {\\n \\"SequenceCallNoPlayCode\\": \\"示例值\\",\\n \\"SequenceCalledNo\\": \\"示例值示例值示例值\\",\\n \\"SequenceCalledPlayCode\\": \\"示例值示例值示例值\\"\\n }\\n ],\\n \\"CallAbility\\": \\"0\\",\\n \\"SequenceEndTime\\": \\"09:00:00\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '企业查询默认的X号码配置',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3179F199-C6C5-5963-85A6-21CBA2F47592\\",\\n \\"Data\\": {\\n \\"TelB\\": \\"155****2222\\",\\n \\"TelA\\": \\"155****1111\\",\\n \\"Subid\\": \\"GHX**************************\\",\\n \\"Anucodecalled\\": \\"10001,10002\\",\\n \\"Extra\\": {\\n \\"Callrecording\\": \\"1\\"\\n },\\n \\"Subts\\": \\"20161114143116\\",\\n \\"Expiration\\": \\"60\\",\\n \\"TelX\\": \\"0571******23\\",\\n \\"Areacode\\": \\"0571\\",\\n \\"Anucode\\": \\"1,2,3\\",\\n \\"TAnucodeConnect\\": \\"1,2\\",\\n \\"Remark\\": \\"19394\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AXB固话隐私号-查询已有绑定关系',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'BindAxb700' => [
- 'summary' => '700AXB中间号，是将拨打关系限定在一对一关系中，用户A可以通过700开头的中间号码X联系到用户B，用户B也可以通过700开头的中间号码X联系到用户A。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryAxnBindFixedLine' => [
+ 'summary' => '查询已绑定固话AXN隐私号码信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '283900',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC2258****',
- ],
- ],
- [
- 'name' => 'Expiration',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码绑定的过期时间。'."\n"
- ."\n"
- .'> - 必须晚于当前绑定时间1分钟以上，时间精确到秒。'."\n"
- .'>- 号码绑定过期时间内，您可随时进行手动解绑。'."\n"
- .'>- 若您对正在通话中的号码进行解绑，不会影响本次通话。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021-09-05 12:00:00',
- ],
- ],
- [
- 'name' => 'TelA',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户A号码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '139****0000',
- ],
- ],
- [
- 'name' => 'TelB',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '用户B号码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '136****0000',
- ],
+ 'schema' => ['title' => '号池id。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'TelX',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => '可选 中间号X。'."\n"
- .'> - 业务使用方未指定X号码时，'."\n"
- .'> - 由应用平台从号码池中指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '700********0000',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'NeedRecord',
+ 'name' => 'QueryType',
'in' => 'query',
- 'schema' => [
- 'description' => '用于表示业务使用方是否需要该号码绑定关系产生的所有通话媒体文件。取值：'."\n"
- ."\n"
- .'- true：录音。'."\n"
- ."\n"
- .'- false：不录音（默认值）。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '查询类型 0：根据绑定id查询 1：根据A号码查询 2：根据X查询', 'description' => '查询类型。取值：'."\n"
+ ."\n"
+ .'- 0：根据绑定ID查询。'."\n"
+ ."\n"
+ .'- 1：根据X和A/B号码查询。', 'type' => 'string', 'required' => true, 'example' => '0'],
],
[
- 'name' => 'RecType',
+ 'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'description' => '录音类型，mp3、wav。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mp3',
- ],
+ 'schema' => ['title' => '绑定id queryType=0时，必传', 'description' => '绑定ID。QueryType参数为1时必传。', 'type' => 'string', 'required' => false, 'example' => 'A203**************'],
],
[
- 'name' => 'CallRestrict',
+ 'name' => 'Phone',
'in' => 'query',
- 'schema' => [
- 'description' => '单通呼叫限制逻辑。取值：'."\n"
- ."\n"
- .'- CONTROL_AX_DISABLE：A号码无法呼叫 X 号码。'."\n"
- ."\n"
- .'- CONTROL_BX_DISABLE：B号码无法呼叫 X 号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
- ],
+ 'schema' => ['title' => 'A号码，queryType=1时，必传', 'description' => 'A/B号码，QueryType参数为1时必传。', 'type' => 'string', 'required' => false, 'example' => '138****6534'],
],
[
- 'name' => 'Audio',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'description' => '放音编码。'."\n"
- ."\n"
- .'- ACallX_Apre A呼叫X号码时，呼叫接通前，向A播放的语音提示放音编码。'."\n"
- .'- ACallX_Ain A呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
- .'- ACallX_Bin A呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
- .'- BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
- .'- BCallX_Ain B呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
- .'- BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => ' {'."\n"
- .'"ACallX_Apre":"185"'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '隐私号码', 'description' => 'X号码，QueryType参数为1时必传。', 'type' => 'string', 'required' => false, 'example' => '0571******23'],
],
[
'name' => 'OrderId',
'in' => 'query',
+ 'schema' => ['title' => '消息请求唯一标识', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '业务订单编码。'."\n"
- ."\n"
- .'- 该编码与真实业务订单是一一对应关系，且不可重复。'."\n"
- ."\n"
- .'- 编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
- ."\n"
- .'- 当业务使用方提交业务订单编码，由应用平台生成工业互联网标识编码时，该字段必选。'."\n"
- .'> '."\n"
- .'> - OrderId与IndustrialId两个字段按业务情况必选其一',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345678',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => 'E8B9C3ED-D9BD-5E27-9588-6D84D3070160'],
+ 'Data' => [
+ 'title' => '绑定对象',
+ 'description' => '绑定对象列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对象详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TelB' => ['title' => 'N号码', 'description' => 'N号码。', 'type' => 'string', 'example' => '155****2222'],
+ 'TelA' => ['title' => 'A号码', 'description' => 'A号码。', 'type' => 'string', 'example' => '155****1111'],
+ 'Subid' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'example' => 'GHX**************************'],
+ 'Anucodecalled' => ['title' => '被叫侧放音编码', 'description' => '被叫侧放音编码。', 'type' => 'string', 'example' => '10001,10002'],
+ 'Extra' => [
+ 'title' => '额外字段',
+ 'description' => '扩展参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callback' => ['title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB', 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不能外呼。'."\n"
+ ."\n"
+ .'- 1：接续最近的N号码。'."\n"
+ ."\n"
+ .'- 2：回拨固定号码TelB。', 'type' => 'string', 'example' => '1'],
+ 'Callrecording' => ['title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'example' => '1'],
+ ],
+ 'example' => '',
+ ],
+ 'Subts' => ['title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'example' => '20161114143116'],
+ 'Expiration' => ['title' => '过期时间', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。', 'type' => 'string', 'example' => '60'],
+ 'TelX' => ['title' => '隐私号码', 'description' => '隐私号码。', 'type' => 'string', 'example' => '0571******23'],
+ 'Areacode' => ['title' => '隐私号码区号', 'description' => '隐私号码区号。', 'type' => 'string', 'example' => '0571'],
+ 'Anucode' => ['title' => '接通前放音啊编码', 'description' => '接通前放音编码，必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 '."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。', 'type' => 'string', 'example' => '1,2,3'],
+ 'TAnucodeConnect' => ['title' => '接通后主叫侧放音编码', 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'example' => '1,2'],
+ 'Remark' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'example' => '19394'],
+ ],
+ ],
+ 'example' => '',
+ ],
+ 'Code' => ['title' => '响应码', 'description' => '接口请求状态码。取值：'."\n"
+ .'0：成功。其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['title' => '', 'description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E8B9C3ED-D9BD-5E27-9588-6D84D3070160\\",\\n \\"Data\\": [\\n {\\n \\"TelB\\": \\"155****2222\\",\\n \\"TelA\\": \\"155****1111\\",\\n \\"Subid\\": \\"GHX**************************\\",\\n \\"Anucodecalled\\": \\"10001,10002\\",\\n \\"Extra\\": {\\n \\"Callback\\": \\"1\\",\\n \\"Callrecording\\": \\"1\\"\\n },\\n \\"Subts\\": \\"20161114143116\\",\\n \\"Expiration\\": \\"60\\",\\n \\"TelX\\": \\"0571******23\\",\\n \\"Areacode\\": \\"0571\\",\\n \\"Anucode\\": \\"1,2,3\\",\\n \\"TAnucodeConnect\\": \\"1,2\\",\\n \\"Remark\\": \\"19394\\"\\n }\\n ],\\n \\"Code\\": \\"0\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ 'title' => 'AXN固话隐私号-查询已有绑定关系',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'QueryAxnExtensionBindFixedLine' => [
+ 'summary' => '查询已绑定固话AXN分机号信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'IndustrialId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '工业互联网标识编码，与OrderID保持一一对应关系。'."\n"
- ."\n"
- .'编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
- ."\n"
- .'当业务使用方自行生成工业互联网标识编码时，该字段必选。'."\n"
- ."\n"
- .'> '."\n"
- .'> - OrderId与IndustrialId两个字段按业务情况必选其一',
- 'type' => 'string',
- 'required' => false,
- 'example' => '700.100.1/12345678',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'OutId',
+ 'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['title' => '号池ID', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'OutOrderId',
+ 'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdefgh',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'NeedAsr',
+ 'name' => 'QueryType',
'in' => 'query',
- 'schema' => [
- 'description' => '是否开启 ASR 服务功能。取值：'."\n"
- ."\n"
- .'- false：关闭（默认值）。'."\n"
- ."\n"
- .'- true：开启。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '查询类型。取值： 0：根据绑定ID查询。1：根据X和A/B号码查询', 'description' => '查询类型。取值：'."\n"
+ ."\n"
+ .'- 0：根据绑定ID查询。'."\n"
+ ."\n"
+ .'- 1：根据X和A/B号码查询。', 'type' => 'string', 'required' => true, 'example' => '0'],
],
[
- 'name' => 'AsrModelId',
+ 'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'description' => '可选 ASR 模型 ID。取值：'."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'schema' => ['title' => '绑定ID。QueryType参数为0时必传。', 'description' => '绑定ID。QueryType参数为0时必传。', 'type' => 'string', 'required' => false, 'example' => 'A203**************'],
],
[
- 'name' => 'CallTimeout',
+ 'name' => 'TelA',
'in' => 'query',
- 'schema' => [
- 'description' => '顺振时长。单位：秒。取值范围为 5~20。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => 'A号码。QueryType参数为1时必传。', 'description' => 'A号码。QueryType参数为1时必传。', 'type' => 'string', 'required' => false, 'example' => '155****1111'],
],
[
- 'name' => 'DtmfConfig',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'description' => '可选 dtmf 按键配置，设置 AXB 中间号号码绑定时使用，可配置内容如下：'."\n"
- ."\n"
- .'- endCallIvrPhoneNo：放音对象 A 或 B。'."\n"
- .'- waitingDtmfTime：放完第一段音后的最大等待时长，最大时长为 30 秒。'."\n"
- .'- maxLoop dtmf：按键不匹配，循环播放第一个放音文件的最大次数，最大循环次数为 5 次。'."\n"
- .'- step1File：第一个放音文件名称。'."\n"
- .'- step2File：第二个放音文件名称。'."\n"
- .'- validKey：合法按键值定义，如：1,2 只允许配置两个有效键值，用","分隔。'."\n"
- .'- waitingEndCall：运营商挂机等待时长，最大等待时长为 10 秒。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .' "endCallIvrPhoneNo":"A",'."\n"
- .' "waitingDtmfTime":10,'."\n"
- .' "maxLoop":3,'."\n"
- .' "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav",'."\n"
- .' "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav",'."\n"
- .' "validKey":"1,2",'."\n"
- .' "waitingEndCall":2'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '消息请求唯一标识。', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
],
'responses' => [
@@ -8711,332 +5529,318 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050******',
- ],
- 'Message' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息。', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '74EFA0E8-CFCA-54D9-BFE5-904F9FA88DBD'],
'Data' => [
- 'description' => '返回数据。',
- 'type' => 'object',
- 'properties' => [
- 'SecretNo' => [
- 'description' => '已购买的700隐私号码，即 X 号码。',
- 'type' => 'string',
- 'example' => '700********0001',
- ],
- 'SubsId' => [
- 'description' => '号码绑定 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123*******',
+ 'title' => '查询绑定对象集合，具体对象字段见绑定请求',
+ 'description' => '绑定对象列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '查询绑定对象',
+ 'description' => '对象详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'TelA' => ['title' => 'A号码', 'description' => 'A号码。', 'type' => 'string', 'example' => '155****1111'],
+ 'Extraaxx' => [
+ 'title' => '额外字段',
+ 'description' => '拓展字段。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callback' => ['title' => '回拨控制', 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不能外呼。'."\n"
+ ."\n"
+ .'- 1：接续最近的N号码。'."\n"
+ ."\n"
+ .'- 2：回拨固定号码TelB。', 'type' => 'string', 'example' => '0'],
+ 'Callrecording' => ['title' => '录音控制', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'example' => '0'],
+ ],
+ 'example' => '',
+ ],
+ 'Subid' => ['title' => '绑定ID', 'description' => '绑定ID。', 'type' => 'string', 'example' => 'A203**************'],
+ 'TelXext' => ['title' => '分机号', 'description' => '分机号。', 'type' => 'string', 'example' => '1009'],
+ 'Anucodecalled' => ['title' => '被叫侧放音', 'description' => '被叫侧放音。', 'type' => 'string', 'example' => '10001,10002'],
+ 'Subts' => ['title' => '绑定时间', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'example' => '20161114143116'],
+ 'Expiration' => ['title' => '过期时间', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。', 'type' => 'string', 'example' => '60'],
+ 'TelX' => ['title' => '小号号码', 'description' => '隐私号码。', 'type' => 'string', 'example' => '0571******23'],
+ 'Areacode' => ['title' => '隐私号码区号', 'description' => '隐私号码区号。', 'type' => 'string', 'example' => '0571'],
+ 'Anucode' => ['title' => '放音编码', 'description' => '放音编码。', 'type' => 'string', 'example' => '10001,10002,10003'],
+ 'TAnucodeConnect' => ['title' => '接通后主叫侧放音编码', 'description' => '接通后主叫侧放音编码。', 'type' => 'string', 'example' => '10001,10002'],
+ 'Remark' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'example' => '19394'],
],
],
+ 'example' => '',
],
- 'Code' => [
- 'description' => '返回状态码，取值：'."\n"
- .'- OK：表示成功。'."\n"
- .' 其他表示失败。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'- true：成功。'."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '响应码', 'description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"74EFA0E8-CFCA-54D9-BFE5-904F9FA88DBD\\",\\n \\"Data\\": [\\n {\\n \\"TelA\\": \\"155****1111\\",\\n \\"Extraaxx\\": {\\n \\"Callback\\": \\"0\\",\\n \\"Callrecording\\": \\"0\\"\\n },\\n \\"Subid\\": \\"A203**************\\",\\n \\"TelXext\\": \\"1009\\",\\n \\"Anucodecalled\\": \\"10001,10002\\",\\n \\"Subts\\": \\"20161114143116\\",\\n \\"Expiration\\": \\"60\\",\\n \\"TelX\\": \\"0571******23\\",\\n \\"Areacode\\": \\"0571\\",\\n \\"Anucode\\": \\"10001,10002,10003\\",\\n \\"TAnucodeConnect\\": \\"10001,10002\\",\\n \\"Remark\\": \\"19394\\"\\n }\\n ],\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '查询AXN分机号绑定关系',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SecretNo\\": \\"700********0001\\",\\n \\"SubsId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '700AXB中间号-号码绑定',
- 'description' => '在调用此接口前，请确保您已在控制台购买隐私号。'."\n"
- .'您可以使用此接口给700AXB中间号绑定号码，也可以在控制台号码管理页面给700AXB中间号绑定A、B号码。'."\n"
- .'700AXB中间号，绑定号码前建议您先明确业务场景中的A角色和B角色。例如：在打车应用场景中，A是乘客角色，B是司机角色。'."\n"
- ."\n"
- .'700AXB中间号主要应用在1对1场景下的隐私保护，客户把A号码和B号码通过号码隐私服务实现绑定关系，A拨打X转接到B，B拨打X转接到A；一个X号码可以供200对绑定关系复用，如A1XB1、A2XB2、A3XB3......，只要A、B用户手机号码不重复，一个X号码可同时绑定200组手机号码，通话也可以同时进行。'."\n"
- ."\n"
- .'QPS限制'."\n"
- ."\n"
- .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'ramActions' => [],
],
- 'BindGxb700' => [
- 'summary' => '添加700GXB号码的绑定关系。700GXB产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案，其中G代表一个号码组，可以根据需要添加号码。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QueryPhoneNoAByTrackNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '285985',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72630',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolKey',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码池 Key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
- ],
- [
- 'name' => 'Expiration',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码绑定的过期时间。'."\n"
- ."\n"
- .'> 说明'."\n"
- .'必须晚于当前绑定时间 1 分钟以上，时间精确到秒。'."\n"
- .'号码绑定过期时间内，您可随时进行手动解绑。'."\n"
- .'若您对正在通话中的号码进行解绑，不会影响本次通话。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2021-09-05 12:00:00',
- ],
- ],
- [
- 'name' => 'TelB',
- 'in' => 'query',
- 'schema' => [
- 'description' => '用户B号码',
- 'type' => 'string',
- 'required' => true,
- 'example' => '136****0000',
- ],
- ],
- [
- 'name' => 'DefaultA',
+ 'name' => 'trackNo',
'in' => 'query',
- 'schema' => [
- 'description' => 'A号码'."\n"
- .'GXB 隐私号的 DefaultA号码。'."\n"
- ."\n"
- .'> 说明'."\n"
- .'支持在号池维度设置回拨模式，当回拨模式为默认模式时，此字段生效，即 B 号码拨打 X 号码时，默认会转接到 此 A 号码，如 A 号码未设置，则无法接通。'."\n"
- .'如需更新 A 号码，请调用 号码绑定修改接口',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'schema' => ['description' => '运单号。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '22573****'],
],
[
- 'name' => 'GroupId',
+ 'name' => 'CabinetNo',
'in' => 'query',
- 'schema' => [
- 'description' => '号码组G的ID。'."\n"
- ."\n"
- .'其中，号码组G是通过“G号码组创建”消息创建的。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10000*****',
- ],
+ 'schema' => ['description' => '柜机号。', 'type' => 'string', 'required' => false, 'example' => '25689****'],
],
[
- 'name' => 'TelX',
+ 'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'description' => '中间号X。业务使用方未指定X号码时，由应用平台从号码池中指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '700********0000',
- ],
+ 'schema' => ['description' => '创建绑定关系API接口所返回的X号码。', 'type' => 'string', 'required' => false, 'example' => '1710000****'],
],
- [
- 'name' => 'NeedRecord',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '用于表示业务使用方是否需要该号码绑定关系产生的所有通话媒体文件，取值：'."\n"
- ."\n"
- .'- true：录音。'."\n"
- .'- false：不录音（默认值）。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => '请求成功'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '8906582E-6722'],
+ 'Module' => [
+ 'description' => '绑定成功后返回的结构体。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '绑定成功后返回的结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Extension' => ['description' => 'X号码的分机号码。', 'type' => 'string', 'example' => '130'],
+ 'PhoneNoX' => ['description' => '隐私号码，即X号码。', 'type' => 'string', 'example' => '1710000****'],
+ 'PhoneNoA' => ['description' => 'A号码。', 'type' => 'string', 'example' => '1310000****'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
],
],
- [
- 'name' => 'RecType',
- 'in' => 'query',
- 'schema' => [
- 'description' => '录音类型，mp3、wav',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'mp3',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"8906582E-6722\\",\\n \\"Module\\": [\\n {\\n \\"Extension\\": \\"130\\",\\n \\"PhoneNoX\\": \\"1710000****\\",\\n \\"PhoneNoA\\": \\"1310000****\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QueryPhoneNoAByTrackNoResponse>\\n <Code>OK</Code>\\n <Message>请求成功</Message>\\n <RequestId>8906582E-6722</RequestId>\\n <Module>\\n <Extension>130</Extension>\\n <PhoneNoX>1710000****</PhoneNoX>\\n <PhoneNoA>1310000****</PhoneNoA>\\n </Module>\\n</QueryPhoneNoAByTrackNoResponse>","errorExample":""}]',
+ 'title' => '进行运单号广播推送',
+ 'summary' => '广播推送运单号。',
+ 'description' => '### QPS限制'."\n"
+ .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2023-03-16T05:32:10.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QueryPhoneNoAByTrackNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'QueryRecordFileDownloadUrl' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'CallRestrict',
- 'in' => 'query',
- 'schema' => [
- 'description' => '单通呼叫限制逻辑，取值：'."\n"
- ."\n"
- .'- CONTROL_BX_DISABLE：B 号码无法呼叫 X 号码。'."\n"
- .'- CONTROL_GX_DISABLE：号码组G号码无法呼叫 X 号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72631',
+ 'abilityTreeNodes' => ['FEATUREdyplsVL8MN2'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'Audio',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '放音编码。'."\n"
- ."\n\n"
- .'- GCallX_Gpre 号码组G中的号码呼叫X号码时，呼叫接通前，向主叫播放的语音提示放音编码。'."\n"
- .'- GCallX_Gin 号码组G中的号码呼叫X号码时，呼叫接通后，向主叫播放的语音提示放音编码。'."\n"
- .'- GCallX_Bin 号码组G中的号码呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
- .'- BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
- .'- BCallX_Gin 呼叫X号码时，呼叫接通后，向被叫播放的语音提示放音编码。'."\n"
- .'- BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .'"GCallX_Gpre":"185"'."\n"
- .'}',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。'."\n"
+ ."\n"
+ .'> 当**ProductType**为空时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'FC10000012345****'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'description' => '业务订单编码。'."\n"
- ."\n"
- .'- 该编码与真实业务订单是一一对应关系，且不可重复。'."\n"
- ."\n"
- .'- 编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
- ."\n"
- .'- 当业务使用方提交业务订单编码，由应用平台生成工业互联网标识编码时，该字段必选。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345678',
- ],
+ 'schema' => ['description' => '产品类型。取值：'."\n"
+ .'- **AXB_170**。'."\n"
+ .'- **AXN_170**。'."\n"
+ .'- **AXN_95**。'."\n"
+ .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
+ ."\n"
+ .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
+ .'> - 当**PoolKey**为空时必填。', 'type' => 'string', 'required' => false, 'example' => 'AXB_170'],
],
[
- 'name' => 'IndustrialId',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'description' => '- 工业互联网标识编码，与OrderID保持一一对应关系。'."\n"
- ."\n"
- .'- 编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
- ."\n"
- .'- 当业务使用方自行生成工业互联网标识编码时，该字段必选。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '700.100.1/12345678',
- ],
+ 'schema' => ['description' => '呼叫记录ID，用于标识一条通话记录。'."\n"
+ ."\n"
+ .'获取方式如下：'."\n"
+ .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫记录ID**。'."\n"
+ .'- 在**录音状态报告**回执消息中查看**call_id**字段。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '416*********bd50'],
],
[
- 'name' => 'OutId',
+ 'name' => 'CallTime',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['description' => '呼叫记录中的呼叫发起时间。'."\n"
+ ."\n"
+ .'获取方式如下：'."\n"
+ ."\n"
+ .'- 在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取**呼叫时间**列的**呼叫发起**时间。'."\n"
+ .'- 在**录音状态报告**回执消息中查看**call_time**字段。'."\n"
+ ."\n"
+ .'> **CallTime**不支持传入时间戳格式的参数。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2019-03-05 12:00:00 '],
],
- [
- 'name' => 'OutOrderId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '外部业务 ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdefgh',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '1AB3CEF7-DCBE-488C-9C33-D180982CE031'],
+ 'DownloadUrl' => ['description' => '录音文件的下载链接URL。URL链接的有效期为2小时。', 'type' => 'string', 'example' => 'http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820******_66647243838006067251************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n********7lg4/WmEA%3D'],
+ ],
],
],
- [
- 'name' => 'NeedAsr',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否开启 ASR 服务功能。取值： '."\n"
- ."\n"
- .'- false：关闭（默认值）。'."\n"
- ."\n"
- .' - true：开启。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"1AB3CEF7-DCBE-488C-9C33-D180982CE031\\",\\n \\"DownloadUrl\\": \\"http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820******_66647243838006067251************.mp3?Expires=1551******&OSSAccessKeyId=yourAccessKeyID&Signature=tK6Yq9KusU4n********7lg4/WmEA%3D\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryRecordFileDownloadUrlResponse>\\n<RequestId>1AB3CEF7-DCBE-488C-9C33-D180982CE031</RequestId>\\n<Message>OK</Message>\\n<Code>OK</Code>\\n<DownloadUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&amp;OSSAccessKeyId=LTAIP00vvvvvvvvv&amp;Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</DownloadUrl>\\n</QueryRecordFileDownloadUrlResponse>","errorExample":""}]',
+ 'title' => '获取录音文件的下载链接',
+ 'summary' => '根据号码池Key、呼叫记录ID、呼叫发起时间等获取录音文件的下载链接。',
+ 'description' => '- 如果在绑定关系中开启了录音功能，该绑定关系产生的所有通话均会被录音，可以通过此接口获取录音文件的下载链接，下载录音文件。'."\n"
+ ."\n"
+ .'- 您可以使用此接口获取录音文件的下载链接进行录音文件下载，也可以在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面查询呼叫记录，单击**录音文件操作**列的**下载**下拉项，单击**录音音频**进行录音文件下载。'."\n"
+ ."\n"
+ .'- 在使用此接口前，建议您先明确需要获取的录音文件对应的呼叫记录。'."\n"
+ .'您可以在控制台[呼叫记录查询](https://dyplsnext.console.aliyun.com/call)页面进行查询，获取呼叫记录ID、呼叫发起时间等信息，或者参考[回执消息简介与配置流程](https://help.aliyun.com/zh/pnp/developer-reference/introduction-to-receipt-messages-and-receipt-message-configurations?spm=a2c4g.11186623.0.0.7b2d7fcbozUnoz)，订阅**回执消息类型**为**录音状态报告**（SecretRecording）的消息，该报告消息中的结果字段可以作为此接口的入参。'."\n"
+ ."\n"
+ .'### QPS 限制'."\n"
+ .'本接口的单用户QPS限制为 3000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
+ ."\n"
+ .'### PoolKey和ProductType限制'."\n"
+ .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。建议原阿里大于用户填ProductType参数，阿里云用户填PoolKey参数。'."\n"
+ ."\n"
+ .'### 获取录音文件步骤：'."\n"
+ .'1. 在更新或绑定关系接口中选择入参需要录音。'."\n"
+ .'2. 在控制台中订阅录音消息回执。'."\n"
+ .'3. 录音消息回执返回后调用QueryRecordFileDownloadUrl接口下载录音。'."\n"
+ ."\n"
+ .'> - URL链接的有效期为2小时。获取下载链接后请尽快下载录音文件。'."\n"
+ .'> - 录音文件的存储周期是30天，仅支持下载30天内通话记录的录音文件。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-22T06:27:00.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QueryRecordFileDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'QuerySecretAPhoneNoToCust' => [
+ 'summary' => 'A号码报备状态查询。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'AsrModelId',
- 'in' => 'query',
- 'schema' => [
- 'description' => 'ASR 模型 ID。取值： '."\n"
- ."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac '."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77 '."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'CallTimeout',
+ 'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'description' => '顺振时长。单位：秒。取值范围为 5~20。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => 'A号码', 'description' => 'A号码。', 'type' => 'string', 'required' => true, 'example' => '130*****8888'],
],
[
- 'name' => 'DtmfConfig',
+ 'name' => 'ANoWhiteGroupId',
'in' => 'query',
- 'schema' => [
- 'description' => 'dtmf 按键配置，设置 AXB 中间号号码绑定时使用，可配置内容如下：'."\n"
- ."\n"
- .'- endCallIvrPhoneNo：放音对象 A 或 B。 '."\n"
- .'- waitingDtmfTime：放完第一段音后的最大等待时长，最大时长为 30 秒。 '."\n"
- .'- maxLoop dtmf：按键不匹配，循环播放第一个放音文件的最大次数，最大循环次数为 5 次。 '."\n"
- .'- step1File：第一个放音文件名称。 '."\n"
- .'- step2File：第二个放音文件名称。'."\n"
- .'- validKey：合法按键值定义，如：1,2 只允许配置两个有效键值，用","分隔。 '."\n"
- .'- waitingEndCall：运营商挂机等待时长，最大等待时长为 10 秒。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{ "endCallIvrPhoneNo":"A", "waitingDtmfTime":10, "maxLoop":3, "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav", "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav", "validKey":"1,2", "waitingEndCall":2 }',
- ],
+ 'schema' => ['title' => '号码组ID', 'description' => '号码组ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '58'],
],
],
'responses' => [
@@ -9044,840 +5848,706 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝详细信息。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n",
- ],
- 'Message' => [
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'RequestId' => ['title' => '返回id', 'description' => '返回ID。', 'type' => 'string', 'example' => '1D73E648-0978-18A5-B089-3BB2'],
+ 'Message' => ['title' => '失败错误提示', 'description' => '失败错误提示。', 'type' => 'string', 'example' => '号码组不存在'],
'Data' => [
- 'description' => '返回数据。',
+ 'title' => 'A号码报备状态查询结构体',
+ 'description' => 'A号码报备状态查询结构体。',
'type' => 'object',
'properties' => [
- 'SecretNo' => [
- 'description' => '已购买的700隐私号码，即 X 号码。',
- 'type' => 'string',
- 'example' => '700********0001',
- ],
- 'SubsId' => [
- 'description' => '号码绑定 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '123*******',
- ],
+ 'NoType' => ['title' => '号码类型', 'description' => '号码类型。取值：'."\n"
+ ."\n"
+ .'- Mobile：手机号。'."\n"
+ ."\n"
+ .'- Fixed：固话。', 'type' => 'string', 'example' => 'Mobile'],
+ 'CustPhoneNo' => ['title' => '固话报备的经办人/法人电话', 'description' => '固话报备的经办人/法定代表人电话。', 'type' => 'string', 'example' => '130*****8888'],
+ 'ReportResult' => ['title' => '报备失败原因', 'description' => '审核失败原因。', 'type' => 'string', 'example' => '["系统判断为不同人"]'],
+ 'ReportStatus' => ['title' => '报备结果', 'description' => '报备结果。取值：'."\n"
+ ."\n"
+ .'- REVIEWING：审核中。'."\n"
+ ."\n"
+ .'- PASS：审核通过。'."\n"
+ ."\n"
+ .'- FAIL：审核不通过。', 'type' => 'string', 'example' => 'REVIEWING'],
+ 'ANoWhiteGroupId' => ['title' => '所属a号码组id', 'description' => '所属A号码组ID。', 'type' => 'string', 'example' => '19'],
+ 'PhoneNoA' => ['title' => 'A号码', 'description' => 'A号码。', 'type' => 'string', 'example' => '130*****1234'],
+ 'Remark' => ['title' => '备注（客户自己的业务备注，可编辑）', 'description' => '备注（用户自身的业务备注）。', 'type' => 'string', 'example' => '***报备'],
],
- 'example' => '',
- ],
- 'Code' => [
- 'description' => '返回状态码，取值：'."\n"
- .'OK：表示成功。'."\n"
- .'其他表示失败。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'true：成功。'."\n"
- .'false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
],
+ 'Code' => ['title' => '请求状态码', 'description' => '请求状态码。', 'type' => 'string', 'example' => '200'],
+ 'Success' => ['title' => '请求是否成功', 'description' => '请求是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"RequestId\\": \\"1D73E648-0978-18A5-B089-3BB2\\",\\n \\"Message\\": \\"号码组不存在\\",\\n \\"Data\\": {\\n \\"NoType\\": \\"Mobile\\",\\n \\"CustPhoneNo\\": \\"130*****8888\\",\\n \\"ReportResult\\": \\"[\\\\\\"系统判断为不同人\\\\\\"]\\",\\n \\"ReportStatus\\": \\"REVIEWING\\",\\n \\"ANoWhiteGroupId\\": \\"19\\",\\n \\"PhoneNoA\\": \\"130*****1234\\",\\n \\"Remark\\": \\"***报备\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '查询A号码报备状态',
+ 'description' => '您在调用此接口查询A号码报备状态前，请先调用[CreatePhoneNoAReport](~~2880908~~)或[CreateFixedNoAReport](~~2881429~~)接口进行提交A号码手机号或固话个人实名信息。具体操作请参见[API提交A号码个人实名信息](~~2880077~~)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySecretAPhoneNoToCust'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SecretNo\\": \\"700********0001\\",\\n \\"SubsId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '700GXB中间号-号码绑定',
- 'description' => '在调用此接口前，请确保您已在控制台购买隐私号。'."\n"
- ."\n"
- .'您可以使用此接口给700GXB隐私号绑定号码，也可以在控制台号码管理页面给700GXB隐私号绑定号码。'."\n"
- ."\n"
- .'700GXB隐私号，绑定号码前建议您先明确业务场景中的G角色、B角色。例如：在招聘平台中，B是应聘者，G是招聘团队。'."\n"
- ."\n"
- .'QPS限制'."\n"
- .'本接口的单用户QPS限制为5000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'ramActions' => [],
],
- 'UpdateSubs700' => [
- 'summary' => '修改700号码的绑定关系。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QuerySecretNoDetail' => [
+ 'summary' => '查询隐私号码的属性信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '287501',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '107292',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'PoolKey',
+ 'name' => 'SecretNo',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['description' => '隐私号码，即X号码。'."\n"
+ ."\n"
+ .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。', 'type' => 'string', 'required' => true, 'example' => '1390000****'],
],
[
- 'name' => 'OperateType',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '- updateNoA：修改 A 号码。'."\n"
- .'- updateNoB：修改 B 号码。'."\n"
- .'- updateExpire：修改绑定关系有效期。'."\n"
- .'- updateGroup：修改 G 号码组。'."\n"
- .'- updateNoDefaultA：GXB模式中修改默认回呼叫A号码。'."\n"
- .'- updateCallRestrict：设置单通呼叫限制。'."\n"
- .'- updateOutId：更新 OutId 字段。'."\n"
- .'- updateIsRecordingEnabled：更新绑定中录音状态。'."\n"
- .'- updateAsr：更新绑定中 ASR 状态。'."\n"
- .'- updateAudio：更新绑定铃音配置。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'updateNoA',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'example' => 'FC2258****'],
],
- [
- 'name' => 'SubsId',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '绑定关系ID，用于唯一识别号码绑定关系。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10000*****',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '066E6E47-04CB-4774-A976-4F73CB76D4A3'],
+ 'SecretNoInfoDTO' => [
+ 'description' => '号码属性。',
+ 'type' => 'object',
+ 'properties' => [
+ 'PurchaseTime' => ['description' => '号码购买时间。', 'type' => 'string', 'example' => '2021-12-03 15:19:27'],
+ 'Vendor' => ['description' => '归属运营商。取值：'."\n"
+ ."\n"
+ .'- **1**：中国移动'."\n"
+ .'- **2**：中国联通'."\n"
+ .'- **3**：中国电信', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Province' => ['description' => '省份。', 'type' => 'string', 'example' => '陕西'],
+ 'City' => ['description' => '城市。', 'type' => 'string', 'example' => '西安'],
+ 'SecretStatus' => ['description' => '号码状态。取值：'."\n"
+ ."\n"
+ .'- **0**：未绑定。'."\n"
+ .'- **1**：已绑定。'."\n"
+ .'- **2**：已锁定。'."\n"
+ .'- **3**：已冻结。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'CertifyStatus' => ['description' => '号码认证状态。取值：'."\n"
+ ."\n"
+ .'- **0**：未认证。'."\n"
+ .'- **1**：已认证。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
+ ],
],
],
- [
- 'name' => 'TelX',
- 'in' => 'query',
- 'schema' => [
- 'description' => '中间号X。业务使用方未指定X号码时，由应用平台从号码池中指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '700********0000',
- ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'FlowLimited', 'errorMessage' => 'The operation is denied due to flow control.', 'description' => '限流'],
],
- [
- 'name' => 'OrderId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '订单 ID(实际上必填， 建议客户进行订单号加密，用于报送监管平台)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345678',
- ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"066E6E47-04CB-4774-A976-4F73CB76D4A3\\",\\n \\"SecretNoInfoDTO\\": {\\n \\"PurchaseTime\\": \\"2021-12-03 15:19:27\\",\\n \\"Vendor\\": 1,\\n \\"Province\\": \\"陕西\\",\\n \\"City\\": \\"西安\\",\\n \\"SecretStatus\\": 0,\\n \\"CertifyStatus\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySecretNoDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>066E6E47-04CB-4774-A976-4F73CB76D4A3</RequestId>\\n <SecretNoInfoDTO>\\n <PurchaseTime>2021-12-03 15:19:27</PurchaseTime>\\n <Vendor>1</Vendor>\\n <Province>陕西省</Province>\\n <City>西安</City>\\n <SecretStatus>0</SecretStatus>\\n <CertifyStatus>0</CertifyStatus>\\n </SecretNoInfoDTO>\\n</QuerySecretNoDetailResponse>","errorExample":""}]',
+ 'title' => '查询隐私号码属性',
+ 'description' => '- 支持根据X号码获取号码的购买时间、归属运营商、省份、城市、状态等信息。'."\n"
+ .'- 查询前，建议您先明确需查询的隐私号码，即X号码。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，请合理调用。',
+ 'changeSet' => [
+ ['createdAt' => '2021-12-08T02:26:32.000Z', 'description' => 'OpenAPI 下线'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySecretNoDetail'],
],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'IndustrialId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '可选 工业互联网标识编码，与OrderID保持一一对应关系。编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
- .'当业务使用方自行生成工业互联网标识编码时，该字段必选。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '700.100.1/12345678',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySecretNoDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'QuerySecretNoRemain' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'TelA',
- 'in' => 'query',
- 'schema' => [
- 'description' => '修改绑定关系中的A号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72632',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'DefaultA',
+ 'name' => 'SpecId',
'in' => 'query',
- 'schema' => [
- 'description' => 'A号码'."\n"
- .'GXB 隐私号的 DefaultA号码。'."\n"
- .'说明'."\n"
- .'支持在号池维度设置回拨模式，当回拨模式为默认模式时，此字段生效，即 B 号码拨打 X 号码时，默认会转接到 此 A 号码，如 A 号码未设置，则无法接通。'."\n"
- .'如需更新 A 号码，请调用 号码绑定修改接口',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****0000',
- ],
+ 'schema' => ['description' => '号码类型。取值：'."\n"
+ .'- **1**：虚商号码，即170或171。'."\n"
+ .'- **2**：运营商号码。'."\n"
+ .'- **3**：95号码。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
[
- 'name' => 'TelB',
+ 'name' => 'City',
'in' => 'query',
- 'schema' => [
- 'description' => '修改绑定关系中的B号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '136****0000',
- ],
+ 'schema' => ['description' => '号码的归属地。'."\n"
+ ."\n"
+ .'- **SpecId**设置为1或2时，可以在参数**City**中指定查询'."\n"
+ ."\n"
+ .'1. 支持输入单个城市名称查询。'."\n"
+ .'2. 支持输入“全国”查询，可返回全国可购号码余量。'."\n"
+ .'3. 支持输入“全国列表”查询，将返回全国城市中有号码的城市及数量，无号码的城市不会返回。'."\n"
+ ."\n"
+ .'- **SpecId**设置为3时，95号码不区分归属地，只能查询全部95号码可购余量，即必须指定**City**为**全国通用**。'."\n"
+ ."\n"
+ .'> 当前仅支持设置归属地为中国大陆地区。', 'type' => 'string', 'required' => true, 'example' => '杭州'],
],
[
- 'name' => 'GroupId',
+ 'name' => 'SecretNo',
'in' => 'query',
- 'schema' => [
- 'description' => '修改绑定关系中的GroupID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '示例值示例值',
- ],
+ 'schema' => ['description' => '号码前缀。查询可购号码余量时，如果指定**SecretNo**，表示查询指定前缀的号码余量。'."\n"
+ ."\n\n"
+ .'最长可指定18位号码前缀。', 'type' => 'string', 'required' => false, 'example' => '130'],
],
- [
- 'name' => 'Expiration',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '修改绑定关系的有效时间。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2021-09-05 12:00:00',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2'],
+ 'SecretRemainDTO' => [
+ 'description' => '接口调用成功后返回的结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Amount' => ['description' => '可购号码余量。', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'City' => ['description' => '号码的归属地。', 'type' => 'string', 'example' => '杭州'],
+ 'RemainDTOList' => [
+ 'type' => 'object',
+ 'itemNode' => true,
+ 'properties' => [
+ 'remainDTO' => [
+ 'description' => '可购号码余量列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '结构体。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Amount' => ['description' => '城市可购号码余量。', 'type' => 'integer', 'format' => 'int64', 'example' => '120'],
+ 'City' => ['description' => '号码的归属地。', 'type' => 'string', 'example' => '武汉'],
+ ],
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
],
],
- [
- 'name' => 'CallRestrict',
- 'in' => 'query',
- 'schema' => [
- 'description' => '修改单通呼叫限制逻辑。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CONTROL_AX_DISABLE',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9FC30594-3841-43AD-9008-03393BCB5CD2\\",\\n \\"SecretRemainDTO\\": {\\n \\"Amount\\": 0,\\n \\"City\\": \\"杭州\\",\\n \\"RemainDTOList\\": {\\n \\"remainDTO\\": [\\n {\\n \\"Amount\\": 120,\\n \\"City\\": \\"武汉\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<QuerySecretNoRemainResponse>\\t\\r\\n <SecretRemainDTO>\\r\\n\\t\\t<Amount>0</Amount>\\r\\n\\t\\t<City>杭州</City>\\r\\n\\t</SecretRemainDTO>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>9FC30594-3841-43AD-9008-03393BCB5CD2</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</QuerySecretNoRemainResponse>","errorExample":""}]',
+ 'title' => '查询线上可购号码余量',
+ 'summary' => '查询线上可购号码余量。',
+ 'description' => '购买号码时，指定归属地如果没有足够号码可供购买，会造成号码购买失败。调用接口[BuySecretNo](~~BuySecretNo~~)购买号码前，请先通过接口[QuerySecretNoRemain](~~QuerySecretNoRemain~~)查询线上可购号码余量。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySecretNoRemain'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySecretNoRemain',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'QuerySoundRecord' => [
+ 'summary' => '企业侧通过callId查询可下载的通话录音地址。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NeedRecord',
- 'in' => 'query',
- 'schema' => [
- 'description' => '修改中绑定关系中的媒体选择。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '244987',
+ 'abilityTreeNodes' => ['FEATUREdyplsVL8MN2'],
+ ],
+ 'parameters' => [
[
- 'name' => 'Audio',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'description' => '可选 放音编码'."\n"
- .'- AXB模式'."\n"
- ."\n"
- .'ACallX_Apre A呼叫X号码时，呼叫接通前，向A播放的语音提示放音编码。'."\n"
- ."\n"
- .'ACallX_Ain A呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
- ."\n"
- .'ACallX_Bin A呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
- ."\n"
- .'BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
- ."\n"
- .'BCallX_Ain B呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
- ."\n"
- .'BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
- ."\n"
- .'- GXB模式'."\n"
- ."\n"
- .'GCallX_Gpre 号码组G中的号码呼叫X号码时，呼叫接通前，向主叫播放的语音提示放音编码。'."\n"
- ."\n"
- .'GCallX_Gin 号码组G中的号码呼叫X号码时，呼叫接通后，向主叫播放的语音提示放音编码。'."\n"
- ."\n"
- .'GCallX_Bin 号码组G中的号码呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
- ."\n"
- .'BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
- ."\n"
- .'BCallX_Gin 呼叫X号码时，呼叫接通后，向被叫播放的语音提示放音编码。'."\n"
- ."\n"
- .'BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{'."\n"
- .'"ACallX_Apre":"185"'."\n"
- .'}',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'OutId',
+ 'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'abcdef',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
- 'name' => 'NeedAsr',
+ 'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '是否开启 ASR 服务功能。取值：'."\n"
- .'false：关闭（默认值）。'."\n"
- .'true：开启',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'AsrModelId',
+ 'name' => 'CallId',
'in' => 'query',
- 'schema' => [
- 'description' => 'ASR 模型 ID。取值：'."\n"
- .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
- .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
- .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac',
- ],
+ 'schema' => ['title' => '本次呼叫唯一id', 'description' => '通话ID，唯一确定的一次通话。', 'type' => 'string', 'required' => true, 'example' => 'ac445343254'],
],
],
'responses' => [
200 => [
'schema' => [
- 'description' => '响应数据',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '请求 ID。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n",
- ],
- 'Message' => [
- 'description' => '返回消息',
- 'type' => 'string',
- 'example' => 'OK',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
'Data' => [
- 'description' => '默认返回格式，实际无值',
'type' => 'object',
- 'example' => '{}',
- ],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- .'- OK：成功。'."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- .'true：成功。'."\n"
- .'false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'properties' => [
+ 'FileUrl' => ['title' => '通话录音url路径，最大长度1000，有效期1小时', 'description' => '通话录音url路径，最大长度1000，有效期1小时', 'type' => 'string', 'example' => 'http://www.oss.com/temepl/a.mp3'],
+ ],
+ 'example' => '',
+ 'description' => '',
+ ],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。 '."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {},\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '700中间号-号码绑定更新',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://www.oss.com/temepl/a.mp3\\"\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '通话录音地址查询',
+ 'changeSet' => [],
+ 'ramActions' => [],
],
- 'UnbindSubs700' => [
- 'summary' => '解除700号码的绑定关系。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'QuerySubsId' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '287502',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72634',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
- 'tenantRelevance' => 'tenant',
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'description' => '号码池Key。'."\n"
- ."\n"
- .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'FC10000012345****'],
],
[
- 'name' => 'SubsId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '号码绑定 ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '100000****',
- ],
- ],
- [
- 'name' => 'TelX',
- 'in' => 'query',
- 'schema' => [
- 'description' => '中间号X。业务使用方未指定X号码时，由应用平台从号码池中指定一个号码作为X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '700********0000',
- ],
- ],
- [
- 'name' => 'OrderId',
- 'in' => 'query',
- 'schema' => [
- 'description' => '订单 ID(实际上必填， 建议客户进行订单号加密，用于报送监管平台)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345678',
- ],
- ],
- [
- 'name' => 'IndustrialId',
+ 'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'description' => '可选 工业互联网标识编码，与OrderID保持一一对应关系。编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
- .'当业务使用方自行生成工业互联网标识编码时，该字段必选。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '700.100.1/12345678',
- ],
+ 'schema' => ['description' => '绑定关系中的隐私号码，即X号码。'."\n"
+ ."\n"
+ .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****1111'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n",
- ],
- 'Message' => [
- 'description' => '响应信息。',
- 'type' => 'string',
- 'example' => '成功',
- ],
- 'Data' => [
- 'description' => '默认返回格式，实际无值',
- 'type' => 'object',
- 'example' => '{}',
- ],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- .'- OK：成功。'."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。返回OK代表请求成功。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => 'E7F99446-8191-43C0-99B5-F58A6AEAD779'],
+ 'SubsId' => ['description' => '绑定关系ID。若隐私号码存在多个绑定关系时，会返回多个SubsId。', 'type' => 'string', 'example' => '1000******,1000******,1000******'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\\\n\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {},\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '700中间号-号码解绑',
- ],
- 'DeleteAxnExtensionBindFixedLine' => [
- 'summary' => '解除固话AXN分机号绑定关系。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'POOLKEY_NOT_EXIST', 'errorMessage' => 'poolKey not exsit.', 'description' => '号池key不存在'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"E7F99446-8191-43C0-99B5-F58A6AEAD779\\",\\n \\"SubsId\\": \\"1000******,1000******,1000******\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySubsIdResponse>\\n\\t<Message>OK</Message>\\n\\t<SubsId>117809</SubsId>\\n\\t<RequestId>F3BC6628-7976-41BA-87D0-D152BAB2A9C8</RequestId>\\n\\t<Code>OK</Code>\\n</QuerySubsIdResponse>","errorExample":""}]',
+ 'title' => '查询号码绑定ID',
+ 'summary' => '查询绑定关系的唯一标识SubsId。',
+ 'description' => '- 支持根据X号码查询绑定关系的唯一标识SubsId。'."\n"
+ .'- 查询前，建议您先明确需查询的隐私号码，即X号码。'."\n"
+ .'- 在AXB中间号、AXN分机号场景中，同一个X号码可能存在多组绑定关系，查询结果会为多条，若X号码无绑定关系，查询结果会为空字符串。'."\n"
+ ."\n"
+ .'### QPS 限制'."\n"
+ .'本接口的单用户QPS限制为 1000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySubsId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'QuerySubscriptionDetail' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'read',
'systemTags' => [
- 'operationType' => 'delete',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '271368',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72633',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID',
- 'description' => '业务id标识，由阿里云分配给客户侧',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'alitest',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。'."\n"
+ ."\n"
+ .'> 当**ProductType**为空时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'FC10000012345****'],
],
[
- 'name' => 'Ts',
+ 'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20250421141723098',
- ],
+ 'schema' => ['description' => '产品类型。取值：'."\n"
+ .'- **AXB_170**。'."\n"
+ .'- **AXN_170**。'."\n"
+ .'- **AXN_95**。'."\n"
+ .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
+ ."\n"
+ .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
+ .'> - 当**PoolKey**为空时必填。', 'type' => 'string', 'required' => false, 'example' => 'AXB_170'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'SubsId',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识',
- 'description' => '消息请求唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345dkwkd99d',
- ],
+ 'schema' => ['description' => '绑定关系ID。'."\n"
+ ."\n"
+ .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面筛选号码，点击**详情**查看号码的绑定关系ID，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定API时查看返回参数中的**SubsId**。'."\n"
+ ."\n"
+ .'> 在填写绑定关系ID时，注意填写与**PhoneNoX**参数关联的绑定关系ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100000076879****'],
],
[
- 'name' => 'SubId',
+ 'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定id',
- 'description' => '绑定id',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'GHX0534X202504221531579290029',
- ],
+ 'schema' => ['description' => '绑定关系中的隐私号码，即X号码。'."\n"
+ ."\n"
+ .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。'."\n"
+ ."\n"
+ .'> 在填写X号码时，注意填写与**SubsId**参数关联的X号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****1111'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '鉴权报错信息',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '短信的完整内容。说明 美国、加拿大需要填写报备的内容。',
- 'type' => 'string',
- 'example' => 'conflict with subs id=1000203635098305, phoneA conflict',
- ],
- 'RequestId' => [
- 'description' => '请求ID，阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '3DA9D6DF-C5FA-5A0D-B6C2-547B1FD1F9B4',
- ],
- 'Data' => [
- 'description' => '应用信息。',
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '066E6E47-04CB-4774-A976-4F73CB76D4A3'],
+ 'SecretBindDetailDTO' => [
+ 'description' => '接口调用成功后返回的结构体。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '响应码 0：成功，其它失败，具体见文档',
- 'description' => '响应码 0：成功，其它失败，具体见文档',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。 false：表示获取失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Status' => ['description' => '该绑定关系的状态。取值：'."\n"
+ .'- **0**：已失效。'."\n"
+ .'- **1**：生效中。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Extension' => ['description' => 'AXG分机号中的分机号码。', 'type' => 'string', 'example' => '130'],
+ 'PhoneNoB' => ['description' => '绑定关系中的B号码。', 'type' => 'string', 'example' => '138****0000'],
+ 'GroupId' => ['description' => '绑定关系中的G号码组ID，即GID。', 'type' => 'integer', 'format' => 'int64', 'example' => '200001234****'],
+ 'NeedRecord' => ['description' => '是否对该绑定关系产生的所有通话，进行通话录音。取值：'."\n"
+ .'- **false**：不录音'."\n"
+ .'- **true**：录音', 'type' => 'boolean', 'example' => 'true'],
+ 'ASRStatus' => ['description' => 'ASR状态。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭'."\n"
+ .'- **true**：开启', 'type' => 'boolean', 'example' => 'true'],
+ 'GmtCreate' => ['description' => '绑定关系的创建时间。', 'type' => 'string', 'example' => '2019-03-05 12:00:00'],
+ 'ExpireDate' => ['description' => '绑定关系的过期时间。', 'type' => 'string', 'example' => '2019-09-05 12:00:00'],
+ 'SubsId' => ['description' => '绑定关系ID。', 'type' => 'string', 'example' => '100000076879****'],
+ 'PhoneNoX' => ['description' => '绑定关系中的隐私号码，即X号码。', 'type' => 'string', 'example' => '139****1111'],
+ 'CallRestrict' => ['description' => '单通呼叫限制的状态。如果没有设置单通呼叫限制，则不返回该参数。取值：'."\n"
+ .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。', 'type' => 'string', 'example' => 'CONTROL_BX_DISABLE '],
+ 'ASRModelId' => ['description' => 'ASR模型ID。取值：'."\n"
+ ."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ ."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ ."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
+ 'PhoneNoA' => ['description' => '绑定关系中的A号码。', 'type' => 'string', 'example' => '139****0000'],
],
],
- 'Code' => [
- 'description' => '状态码。返回OK代表请求成功，其他错误码详见错误码列表。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。 false：表示获取失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"066E6E47-04CB-4774-A976-4F73CB76D4A3\\",\\n \\"SecretBindDetailDTO\\": {\\n \\"Status\\": 1,\\n \\"Extension\\": \\"130\\",\\n \\"PhoneNoB\\": \\"138****0000\\",\\n \\"GroupId\\": 0,\\n \\"NeedRecord\\": true,\\n \\"ASRStatus\\": true,\\n \\"GmtCreate\\": \\"2019-03-05 12:00:00\\",\\n \\"ExpireDate\\": \\"2019-09-05 12:00:00\\",\\n \\"SubsId\\": \\"100000076879****\\",\\n \\"PhoneNoX\\": \\"139****1111\\",\\n \\"CallRestrict\\": \\"CONTROL_BX_DISABLE \\",\\n \\"ASRModelId\\": \\"7ee372834d2f4cc7ac0d0ab2d0ae1aac\\",\\n \\"PhoneNoA\\": \\"139****0000\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySubscriptionDetailResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>066E6E47-04CB-4774-A976-4F73CB76D4A3</RequestId>\\n <SecretBindDetailDTO>\\n <Status>1</Status>\\n <Extension>130</Extension>\\n <PhoneNoB>13900002222</PhoneNoB>\\n <GroupId>2000000130001</GroupId>\\n <NeedRecord>true</NeedRecord>\\n <ASRStatus>true</ASRStatus>\\n <GmtCreate>2019-03-05 12:00:00</GmtCreate>\\n <ExpireDate>2019-09-05 12:00:00</ExpireDate>\\n <SubsId>100000076879****</SubsId>\\n <PhoneNoX>13900001234</PhoneNoX>\\n <CallRestrict>CONTROL_BX_DISABLE </CallRestrict>\\n <ASRModelId>123456</ASRModelId>\\n <PhoneNoA>13900001111</PhoneNoA>\\n </SecretBindDetailDTO>\\n</QuerySubscriptionDetailResponse>","errorExample":""}]',
+ 'title' => '查询号码绑定详情',
+ 'summary' => '查询号码的绑定详情。获取号码绑定关系状态、分机号码、是否录音、ASR状态等信息。',
+ 'description' => '查询前，建议您先明确需查询的隐私号码，即X号码，且该号码有绑定关系。'."\n"
+ ."\n"
+ .'### QPS限制 '."\n"
+ .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
+ ."\n"
+ .'### PoolKey和ProductType限制'."\n"
+ .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。'."\n"
+ .'建议原阿里大于用户填ProductType参数，阿里云用户填PoolKey参数。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-22T06:27:00.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySubscriptionDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"conflict with subs id=1000203635098305, phoneA conflict\\",\\n \\"RequestId\\": \\"3DA9D6DF-C5FA-5A0D-B6C2-547B1FD1F9B4\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '解绑已有AXN分机号绑定',
],
- 'UpdateAxnExtensionBindFixedLine' => [
- 'summary' => '修改固话AXN分机号码绑定关系。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ReleaseSecretNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
+ 'operationType' => 'write',
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '271366',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72635',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号池ID',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
- ],
- [
- 'name' => 'Ts',
- 'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
- ],
- [
- 'name' => 'OrderId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识。',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'example' => 'FC10000012345****'],
],
[
- 'name' => 'Subts',
- 'in' => 'query',
- 'schema' => [
- 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116',
- ],
- ],
- [
- 'name' => 'SubId',
+ 'name' => 'SecretNo',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'GHX0*************************',
- ],
+ 'schema' => ['description' => '需要释放的隐私号码。'."\n"
+ ."\n"
+ .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取隐私号码，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定接口时查看返回参数中的**SecretNo**。', 'type' => 'string', 'required' => true, 'example' => '139****0000'],
],
- [
- 'name' => 'TelA',
- 'in' => 'query',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => 'A号码',
- 'description' => '固话AXN分机的A号码。'."\n"
- ."\n"
- .'> A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '986BCB6D-C9BF-42F9-91CE-3A990121232'],
+ ],
],
],
- [
- 'name' => 'Anucode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 AXN分机号业务的放音编码,B->X和其他号码->X的编码一致 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3',
- 'description' => '主叫侧放音编码，AXB业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2,3',
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A990121232\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<ReleaseSecretNoResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</ReleaseSecretNoResponse>","errorExample":""}]',
+ 'title' => '释放号码',
+ 'summary' => '释放号码。释放后所选号码将不可继续使用。',
+ 'description' => '- 释放号码之后，次月开始不再计费。'."\n"
+ ."\n"
+ .'- 释放号码之前，请登录[号码隐私保护控制台](https://dypls.console.aliyun.com/dypls.htm#/account)或者调用[QuerySubsId](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-querysubsid)接口，查看该号码是否有绑定关系。号码无任何绑定关系时才能释放。'."\n"
+ ."\n\n"
+ .'><notice>号码释放后不可继续使用，且无法找回，请谨慎操作。></notice>',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseSecretNo'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:ReleaseSecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'UnBindAXB' => [
+ 'summary' => '接入方调用本接口解除指定的呼叫绑定关系（A，X，B），解除呼叫绑定关系后，员工B不能通过工作号X呼叫到客户A。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Anucodecalled',
- 'in' => 'query',
- 'schema' => [
- 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2',
- 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '244979',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'TAnucodeConnect',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2',
- 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'Expiration',
+ 'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'title' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '60',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
- 'name' => 'Remark',
+ 'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19394',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'Extraaxx',
+ 'name' => 'BindId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => 'AXx的扩展参数项',
- 'description' => '扩展参数。',
- 'type' => 'object',
- 'properties' => [
- 'Callback' => [
- 'title' => '可选。 A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码',
- 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不能外呼。'."\n"
- ."\n"
- .'- 1：接续最近的N号码。'."\n"
- ."\n"
- .'- 2：回拨固定号码TelB。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- 'Callrecording' => [
- 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['title' => 'bindId绑定关系AXB唯一id', 'description' => '绑定关系AXB唯一id。', 'type' => 'string', 'required' => true, 'example' => '4534543'],
],
],
'responses' => [
@@ -9885,175 +6555,96 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '鉴权报错信息。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '调用结果信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '请求ID，阿里云为该请求生成的唯一标识符。'."\n"
- ."\n",
- 'type' => 'string',
- 'example' => '31031C54-7727-5057-9ED1-FA276B64205E',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
'Data' => [
- 'description' => '应用信息。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '响应码 0：成功，其它失败，具体见文档',
- 'description' => '响应码 0：成功，其它失败，具体见文档',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '获取应用配置信息是否成功。取值说明如下：true：获取成功。false：获取失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息', 'type' => 'string', 'example' => '成功'],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码 0000表示成功 其他表示失败', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功 true 表示成功 false表示失败', 'type' => 'boolean', 'example' => 'true'],
],
- ],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'description' => '',
+ ],
+ 'Code' => ['description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => 'AXB呼叫解绑',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UnBindAXB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"31031C54-7727-5057-9ED1-FA276B64205E\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": false\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新AXN分机号绑定关系',
],
- 'QueryAxbBindFixedLine' => [
- 'summary' => '查询已绑定固话AXB隐私号信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UnBindXB' => [
+ 'summary' => '调用本接口可取消工作号X与员工号码B的绑定。绑定解除后，对X的呼叫都不会转接给B。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '244981',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
- ],
- [
- 'name' => 'Ts',
+ 'name' => 'ReqId',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', 'description' => '请求去重ID，最大长度为20位，请确保请求ID的原子性。', 'type' => 'string', 'required' => true, 'example' => '564**********879'],
],
[
- 'name' => 'QueryType',
+ 'name' => 'CallerParentId',
'in' => 'query',
- 'schema' => [
- 'title' => '查询类型 0：根据绑定id查询 1：根据X和A/B号码查询',
- 'description' => '查询类型。取值：'."\n"
- ."\n"
- .'- 0：根据绑定ID查询。'."\n"
- ."\n"
- .'- 1：根据X和A/B号码查询。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '客户uid', 'description' => '客户UID，系统自动获取，无需输入。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-'],
],
[
- 'name' => 'SubId',
+ 'name' => 'CustomerPoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定id， queryType=0时，必传',
- 'description' => '绑定ID。QueryType参数为0时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A203**************',
- ],
+ 'schema' => ['title' => '号码池key', 'description' => '号码池key。', 'type' => 'string', 'required' => true, 'example' => 'FC5**********************a1a'],
],
[
- 'name' => 'Phone',
+ 'name' => 'AuthId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A/B号码，queryType=1时，必传',
- 'description' => 'A/B号码，QueryType参数为1时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****6534',
- ],
+ 'schema' => ['title' => 'authId绑定关系BX唯一id', 'description' => '绑定关系XB唯一id。', 'type' => 'string', 'required' => true, 'example' => '34*****46'],
],
[
'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => 'x号码，queryType=1时，必传',
- 'description' => 'X号码，QueryType参数为1时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571******23',
- ],
- ],
- [
- 'name' => 'OrderId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识。',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['title' => 'X号码', 'description' => 'X号码。', 'type' => 'string', 'required' => true, 'example' => '17*******22'],
],
],
'responses' => [
@@ -10061,160 +6652,59 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '访问被拒绝的详细原因。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '3179F199-C6C5-5963-85A6-21CBA2F47592',
- ],
+ 'AccessDeniedDetail' => ['description' => '访问被拒绝详细信息。', 'type' => 'string', 'example' => '0'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => '成功'],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
'Data' => [
- 'title' => '绑定信息',
- 'description' => '绑定信息。',
'type' => 'object',
'properties' => [
- 'TelB' => [
- 'title' => 'B号码',
- 'description' => 'B号码。',
- 'type' => 'string',
- 'example' => '155****2222',
- ],
- 'TelA' => [
- 'title' => 'A号码',
- 'description' => 'A号码。',
- 'type' => 'string',
- 'example' => '155****1111',
- ],
- 'Subid' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'example' => 'GHX**************************',
- ],
- 'Anucodecalled' => [
- 'title' => '接通后被叫侧放音编码',
- 'description' => '接通后被叫侧放音编码。',
- 'type' => 'string',
- 'example' => '10001,10002',
- ],
- 'Extra' => [
- 'title' => '额外字段',
- 'description' => '扩展参数。',
- 'type' => 'object',
- 'properties' => [
- 'Callrecording' => [
- 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- 'example' => '',
- ],
- 'Subts' => [
- 'title' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'example' => '20161114143116',
- ],
- 'Expiration' => [
- 'title' => '绑定过期时间',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效；超过60s后，自动解绑。',
- 'type' => 'string',
- 'example' => '60',
- ],
- 'TelX' => [
- 'title' => '小号号码',
- 'description' => '固话AXB隐私号的X号码。X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。',
- 'type' => 'string',
- 'example' => '0571******23',
- ],
- 'Areacode' => [
- 'title' => '隐私号码区号',
- 'description' => '隐私号码区号。',
- 'type' => 'string',
- 'example' => '0571',
- ],
- 'Anucode' => [
- 'title' => '接通前放音编码，放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3',
- 'description' => '接通前放音编码，必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 '."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。',
- 'type' => 'string',
- 'example' => '1,2,3',
- ],
- 'TAnucodeConnect' => [
- 'title' => '接通后主叫侧放音编码',
- 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'example' => '1,2',
- ],
- 'Remark' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'example' => '19394',
- ],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息', 'type' => 'string', 'example' => '成功'],
+ 'Code' => ['title' => '返回状态码 0000表示成功 其他表示失败', 'description' => '返回状态码 0000表示成功 其他表示失败', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['title' => '返回是否成功 true 表示成功 false表示失败', 'description' => '返回是否成功 true 表示成功 false表示失败', 'type' => 'boolean', 'example' => 'false'],
],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '接口请求状态码。取值：'."\n"
- .'0：成功。其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'title' => '处理是否成功 true-成功',
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'description' => '',
+ ],
+ 'Code' => ['description' => '返回状态码，取值：'."\n"
+ ."\n"
+ .'- 0000：表示成功。'."\n"
+ ."\n"
+ .' 其他表示失败。', 'type' => 'string', 'example' => '0000'],
+ 'Success' => ['description' => '返回是否成功，取值：'."\n"
+ ."\n"
+ .'- true：表示成功。'."\n"
+ ."\n"
+ .'- false：表示失败。', 'type' => 'boolean', 'example' => 'false'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"0\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"Message\\": \\"成功\\",\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n },\\n \\"Code\\": \\"0000\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ 'title' => 'XB关系解绑',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UnBindXB',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3179F199-C6C5-5963-85A6-21CBA2F47592\\",\\n \\"Data\\": {\\n \\"TelB\\": \\"155****2222\\",\\n \\"TelA\\": \\"155****1111\\",\\n \\"Subid\\": \\"GHX**************************\\",\\n \\"Anucodecalled\\": \\"10001,10002\\",\\n \\"Extra\\": {\\n \\"Callrecording\\": \\"1\\"\\n },\\n \\"Subts\\": \\"20161114143116\\",\\n \\"Expiration\\": \\"60\\",\\n \\"TelX\\": \\"0571******23\\",\\n \\"Areacode\\": \\"0571\\",\\n \\"Anucode\\": \\"1,2,3\\",\\n \\"TAnucodeConnect\\": \\"1,2\\",\\n \\"Remark\\": \\"19394\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AXB固话隐私号-查询已有绑定关系',
],
- 'UpdateAxnBindFixedLine' => [
- 'summary' => '修改固话AXN隐私号码绑定信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UnbindSubs700' => [
+ 'summary' => '解除700号码的绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10223,284 +6713,273 @@
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
+ 'operationType' => 'delete',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '271211',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '287502',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'Ts',
+ 'name' => 'SubsId',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['description' => '号码绑定 ID。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000****'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['description' => '中间号X。业务使用方未指定X号码时，由应用平台从号码池中指定一个号码作为X号码。', 'type' => 'string', 'required' => true, 'example' => '700********0000'],
],
[
- 'name' => 'Subts',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116',
- 'default' => '',
- ],
+ 'schema' => ['description' => '订单 ID(实际上必填， 建议客户进行订单号加密，用于报送监管平台)。', 'type' => 'string', 'required' => false, 'example' => '12345678'],
],
[
- 'name' => 'SubId',
+ 'name' => 'IndustrialId',
'in' => 'query',
+ 'schema' => ['description' => '可选 工业互联网标识编码，与OrderID保持一一对应关系。编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
+ .'当业务使用方自行生成工业互联网标识编码时，该字段必选。', 'type' => 'string', 'required' => false, 'example' => '700.100.1/12345678'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'GHX0*************************',
+ 'type' => 'object',
+ 'properties' => [
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{}'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n"],
+ 'Message' => ['description' => '响应信息。', 'type' => 'string', 'example' => '成功'],
+ 'Data' => ['description' => '默认返回格式，实际无值', 'type' => 'object', 'example' => '{}'],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ .'- OK：成功。'."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'description' => '',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\\\n\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {},\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '700中间号-号码解绑',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [],
+ ],
+ 'UnbindSubscription' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'TelA',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'A号码',
- 'description' => '固话AXN隐私号的A号码。'."\n"
- ."\n"
- .'> A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72636',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
[
- 'name' => 'TelB',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => 'B号码',
- 'description' => '固话AXN隐私号的N号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '155****2222',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。'."\n"
+ ."\n"
+ .'> 当**ProductType**为空时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'FC10000012345****'],
],
[
- 'name' => 'Anucode',
+ 'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'title' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。',
- 'description' => '主叫侧放音编码，AXB业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2,3',
- ],
+ 'schema' => ['description' => '产品类型。取值：'."\n"
+ .'- **AXB_170**。'."\n"
+ .'- **AXN_170**。'."\n"
+ .'- **AXN_95**。'."\n"
+ .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
+ ."\n"
+ .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
+ .'> - 当**PoolKey**为空时必填。', 'type' => 'string', 'required' => false, 'example' => 'AXB_170'],
],
[
- 'name' => 'Anucodecalled',
+ 'name' => 'SubsId',
'in' => 'query',
- 'schema' => [
- 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2。',
- 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['description' => '绑定关系ID。'."\n"
+ ."\n"
+ .'请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页筛选号码，点击**详情**查看号码的绑定关系ID，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定API时查看返回参数中的**SubsId**。'."\n"
+ .'> 在填写绑定关系ID时，注意填写与**SecretNo**参数关联的绑定关系ID。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1************2'],
],
[
- 'name' => 'TAnucodeConnect',
+ 'name' => 'SecretNo',
'in' => 'query',
+ 'schema' => ['description' => '隐私号码。'."\n"
+ ."\n"
+ .'调用[BindAXG](~~110249~~)等号码绑定接口时指定或自动分配的X号码。'."\n"
+ ."\n"
+ .'登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码。'."\n"
+ .'> 在填写X号码时，注意填写与**SubsId**参数关联的X号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****1111'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2',
- 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['description' => '请求状态码。'."\n"
+ .'* 返回OK代表请求成功。'."\n"
+ .'* 其他错误码详见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36'],
+ 'ChargeId' => ['description' => '废弃参数。', 'type' => 'string', 'example' => 'true'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A9901233D36\\",\\n \\"ChargeId\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UnbindSubscriptionResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>9B2757F9-8FD0-48B9-9640-EF54783A06C4</RequestId>\\r\\n\\t<ChargeId>true</ChargeId>\\r\\n\\t<Code>OK</Code>\\r\\n</UnbindSubscriptionResponse>","errorExample":""}]',
+ 'title' => '解除已绑定的号码',
+ 'summary' => '解除号码的绑定关系。',
+ 'description' => '- 在解绑前，建议您明确需解除绑定关系的隐私号码，即X号码。'."\n"
+ ."\n"
+ .'- 释放号码前，需解除号码绑定关系。'."\n"
+ ."\n"
+ .'- 您可以使用此接口解除号码绑定关系，也可以在控制台[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面>**详情**>**解绑**>**确定**解除号码绑定关系。'."\n"
+ ."\n"
+ .'### QPS 限制'."\n"
+ .'本接口的单用户QPS限制为 5000 次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
+ ."\n"
+ .'### PoolKey和ProductType限制'."\n"
+ .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。 建议原阿里大于用户填ProductType参数，现阿里云用户填PoolKey参数。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-15T07:50:47.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindSubscription'],
+ ],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Expiration',
- 'in' => 'query',
- 'schema' => [
- 'title' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '60',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UnbindSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'UnlockSecretNo' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
+ 'security' => [
[
- 'name' => 'Remark',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeCode' => '72637',
+ 'abilityTreeNodes' => ['FEATUREdypls9LYVYY'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19394',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool)页面获取**号码池Key**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'FC2256****'],
],
[
- 'name' => 'Extra',
+ 'name' => 'SecretNo',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '额外字段',
- 'description' => '扩展参数。',
- 'type' => 'object',
- 'properties' => [
- 'Callback' => [
- 'title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB',
- 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不能外呼。'."\n"
- ."\n"
- .'- 1：接续最近的N号码。'."\n"
- ."\n"
- .'- 2：回拨固定号码TelB。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- 'Callrecording' => [
- 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => '需要解锁的隐私号码，需要填写完整的手机号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1300000****'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '调用结果信息。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '3FDD0A8F-34F1-5BD4-AF9F-CD90B3DE7C06',
- ],
- 'Data' => [
- 'description' => '应用信息。',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '响应码 0：成功，其它失败，具体见文档',
- 'description' => '响应码 0：成功，其它失败，具体见文档',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。false：表示获取失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"2D1AEB96-96D0-454E-B0DC-AE2A8DF08020\\"\\n}","errorExample":""},{"type":"xml","example":"<UnlockSecretNoResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>2D1AEB96-96D0-454E-B0DC-AE2A8DF08020</RequestId>\\n</UnlockSecretNoResponse>","errorExample":""}]',
+ 'title' => '解锁号码',
+ 'summary' => '解锁号码。解除号码的临时屏蔽。',
+ 'description' => '- 号码被解锁后，[添加号码绑定](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-dir-number-binding/?spm=a2c4g.11186623.0.0.149d679cBVqtij)时可重新选择已经解锁的号码。'."\n"
+ ."\n"
+ .'- 可调用[LockSecretNo](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-locksecretno)锁定号码。'."\n"
+ ."\n"
+ .'### QPS限制'."\n"
+ .'本接口的单用户QPS限制为500次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UnlockSecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"3FDD0A8F-34F1-5BD4-AF9F-CD90B3DE7C06\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新Axn绑定关系',
],
'UpdateAxbBindFixedLine' => [
'summary' => '修改固话AXB隐私号绑定信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10513,9 +6992,7 @@
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeCode' => '271215',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -10523,152 +7000,80 @@
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定id',
- 'description' => '绑定id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A100***************',
- ],
+ 'schema' => ['title' => '绑定id', 'description' => '绑定id。', 'type' => 'string', 'required' => true, 'example' => 'A100***************'],
],
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识。',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['title' => '消息请求唯一标识。', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
'name' => 'TelA',
'in' => 'query',
- 'schema' => [
- 'title' => '真实号码，telA,telB不允许同时更新',
- 'description' => '设置绑定关系中的 A 号码。'."\n"
- ."\n\n"
- .'> - A 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- .'> - TelA，TelB不允许同时更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'schema' => ['title' => '真实号码，telA,telB不允许同时更新', 'description' => '设置绑定关系中的 A 号码。'."\n"
+ ."\n\n"
+ .'> - A 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ .'> - TelA，TelB不允许同时更新。', 'type' => 'string', 'required' => false, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
],
[
'name' => 'TelB',
'in' => 'query',
- 'schema' => [
- 'title' => '对端号码，telA,telB不允许同时更新',
- 'description' => '对设置绑定关系中的 B 号码。'."\n"
- ."\n\n"
- .'> - B 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- .'> - TelA，TelB不允许同时更新。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'schema' => ['title' => '对端号码，telA,telB不允许同时更新', 'description' => '对设置绑定关系中的 B 号码。'."\n"
+ ."\n\n"
+ .'> - B 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
+ .'> - TelA，TelB不允许同时更新。', 'type' => 'string', 'required' => false, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
],
[
'name' => 'Subts',
'in' => 'query',
- 'schema' => [
- 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116',
- ],
+ 'schema' => ['title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'required' => true, 'example' => '20161114143116'],
],
[
'name' => 'Anucode',
'in' => 'query',
- 'schema' => [
- 'title' => '主叫侧放音编码',
- 'description' => '主叫侧放音编码，固话AXB隐私号业务时必须设置。放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2,3',
- ],
+ 'schema' => ['title' => '主叫侧放音编码', 'description' => '主叫侧放音编码，固话AXB隐私号业务时必须设置。放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。', 'type' => 'string', 'required' => false, 'example' => '1,2,3'],
],
[
'name' => 'Anucodecalled',
'in' => 'query',
- 'schema' => [
- 'title' => '被叫侧放音编码',
- 'description' => '接通后被叫侧放音编码，被叫放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['title' => '被叫侧放音编码', 'description' => '接通后被叫侧放音编码，被叫放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
[
'name' => 'TAnucodeConnect',
'in' => 'query',
- 'schema' => [
- 'title' => '接通后主叫侧的放音编码',
- 'description' => '接通后主叫侧的放音编码，接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['title' => '接通后主叫侧的放音编码', 'description' => '接通后主叫侧的放音编码，接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
[
'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'title' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19394',
- ],
+ 'schema' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'required' => false, 'example' => '19394'],
],
[
'name' => 'Extra',
@@ -10679,17 +7084,11 @@
'description' => '扩展参数。',
'type' => 'object',
'properties' => [
- 'Callrecording' => [
- 'title' => '录音控制， 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'Callrecording' => ['title' => '录音控制， 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。', 'type' => 'string', 'required' => false, 'example' => '0'],
],
'required' => false,
'example' => '',
@@ -10701,98 +7100,69 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '无权限信息。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '错误信息描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '73A5C73A-1D97-54B6-B47C-541BE59F84D9',
- ],
+ 'AccessDeniedDetail' => ['description' => '无权限信息。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '错误信息描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', 'type' => 'string', 'example' => '73A5C73A-1D97-54B6-B47C-541BE59F84D9'],
'Data' => [
'description' => '应用列表。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '响应消息',
- 'description' => '响应消息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '响应码 0-成功',
- 'description' => '响应码 0-成功',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'title' => '是否处理成功 true-成功',
- 'description' => '是否处理成功 true-成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['title' => '响应消息', 'description' => '响应消息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '响应码 0-成功', 'description' => '响应码 0-成功', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['title' => '是否处理成功 true-成功', 'description' => '是否处理成功 true-成功', 'type' => 'boolean', 'example' => 'true'],
],
],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"73A5C73A-1D97-54B6-B47C-541BE59F84D9\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => 'AXB固话隐私号-更新已有绑定',
'description' => '在修改固话AXB隐私号时，A号码和B号码不能同时进行修改。如原有绑定关系A1、B1可以修改为A1、B2或A2、B1。',
- ],
- 'BindAxnExtensionFixedLine' => [
- 'summary' => '固话AXN分机号在固话AXN隐私号基础上引入了分机号，从而降低X号码的使用量，在呼叫时候首先拨打X号码，听到提示音后输入对应分机号转接到A。固话AXN分机号目前为邀约制，请联系您的技术支持进行服务开通，并提供对接支持。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UpdateAxbBindFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateAxnBindFixedLine' => [
+ 'summary' => '修改固话AXN隐私号码绑定信息。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '271367',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '271211',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
@@ -10800,209 +7170,99 @@
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['title' => '号池ID。', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
- ],
- [
- 'name' => 'BindType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码',
- 'description' => '绑定类型。取值：'."\n"
- ."\n"
- .'- mode101：客户指定X号码。'."\n"
- ."\n"
- .'- mode102：平台分配X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mode101',
- ],
+ 'schema' => ['title' => '消息请求唯一标识', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
'name' => 'Subts',
'in' => 'query',
- 'schema' => [
- 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116',
- ],
+ 'schema' => ['title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'required' => true, 'example' => '20161114143116', 'default' => ''],
],
[
- 'name' => 'TelA',
+ 'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A号码',
- 'description' => '固话AXN分机号的A号码。'."\n"
- ."\n"
- .'> A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'schema' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'required' => true, 'example' => 'GHX0*************************'],
],
[
- 'name' => 'TelX',
+ 'name' => 'TelA',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码；平台分配号码模式下，该参数可不带，系统忽略该参数',
- 'description' => '固话AXN分机号的X号码。X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571******23',
- ],
+ 'schema' => ['title' => 'A号码', 'description' => '固话AXN隐私号的A号码。'."\n"
+ ."\n"
+ .'> A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => false, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
],
[
- 'name' => 'TelXext',
+ 'name' => 'TelB',
'in' => 'query',
- 'schema' => [
- 'title' => '分机号；平台分配号码模式下，该参数可不带，系统忽略该参数',
- 'description' => '分机号。BindType参数为mode101时此参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1009',
- ],
+ 'schema' => ['title' => 'B号码', 'description' => '固话AXN隐私号的N号码。', 'type' => 'string', 'required' => false, 'example' => '155****2222'],
],
[
'name' => 'Anucode',
'in' => 'query',
- 'schema' => [
- 'title' => '',
- 'description' => '主叫侧放音编码，AXB业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1,2,3',
- ],
+ 'schema' => ['title' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。', 'description' => '主叫侧放音编码，AXB业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。', 'type' => 'string', 'required' => false, 'example' => '1,2,3'],
],
[
'name' => 'Anucodecalled',
'in' => 'query',
- 'schema' => [
- 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2',
- 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2。', 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
[
'name' => 'TAnucodeConnect',
'in' => 'query',
- 'schema' => [
- 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2',
- 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2', 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
[
'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'title' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效；超过60s后，自动解绑。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '60',
- ],
- ],
- [
- 'name' => 'Areacode',
- 'in' => 'query',
- 'schema' => [
- 'title' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费',
- 'description' => '区号。支持指定X号码归属地（指定城市->省会->全国路由）。不指定归属地，全国随机。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571',
- ],
+ 'schema' => ['title' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。', 'type' => 'string', 'required' => false, 'example' => '60'],
],
[
'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19394',
- ],
+ 'schema' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'required' => false, 'example' => '19394'],
],
[
- 'name' => 'Extraaxx',
+ 'name' => 'Extra',
'in' => 'query',
'style' => 'json',
'schema' => [
'title' => '额外字段',
- 'description' => '拓展参数。',
+ 'description' => '扩展参数。',
'type' => 'object',
'properties' => [
- 'Callback' => [
- 'title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码',
- 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不能外呼。'."\n"
- ."\n"
- .'- 1：接续最近的N号码。'."\n"
- ."\n"
- .'- 2：回拨固定号码TelB。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- 'Callrecording' => [
- 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'Callback' => ['title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB', 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不能外呼。'."\n"
+ ."\n"
+ .'- 1：接续最近的N号码。'."\n"
+ ."\n"
+ .'- 2：回拨固定号码TelB。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ 'Callrecording' => ['title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'required' => false, 'example' => '1'],
],
'required' => false,
'example' => '',
@@ -11014,422 +7274,166 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => 'AE2D6997-643A-59CB-9B3C-918572E5CEAA',
- ],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '调用结果信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '阿里云为该请求生成的唯一标识符。', 'type' => 'string', 'example' => '3FDD0A8F-34F1-5BD4-AF9F-CD90B3DE7C06'],
'Data' => [
- 'title' => '响应信息',
- 'description' => '响应信息。',
+ 'description' => '应用信息。',
'type' => 'object',
'properties' => [
- 'Subid' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'example' => 'GHX0**********************',
- ],
- 'TelXext' => [
- 'title' => '分机号，只有4位',
- 'description' => '分机号，只有4位。',
- 'type' => 'string',
- 'example' => '1001',
- ],
- 'TelX' => [
- 'title' => '隐私号码',
- 'description' => '隐私号码。',
- 'type' => 'string',
- 'example' => '0571******23',
- ],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '响应码 0：成功，其它失败，具体见文档', 'description' => '响应码 0：成功，其它失败，具体见文档', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。false：表示获取失败。', 'type' => 'boolean', 'example' => 'true'],
],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '响应码 0：成功，其它失败，具体见文档',
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'string',
- 'example' => 'true',
],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"3FDD0A8F-34F1-5BD4-AF9F-CD90B3DE7C06\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '更新Axn绑定关系',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UpdateAxnBindFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"AE2D6997-643A-59CB-9B3C-918572E5CEAA\\",\\n \\"Data\\": {\\n \\"Subid\\": \\"GHX0**********************\\",\\n \\"TelXext\\": \\"1001\\",\\n \\"TelX\\": \\"0571******23\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]',
- 'title' => 'AXN分机号绑定',
- 'description' => '- 在调用此接口前，请确保您已在控制台[购买隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
- ."\n"
- .'- 您可以使用此接口给固话AXN分机号绑定号码，暂不支持在控制台给固话AXN分机号绑定号码。'."\n"
- ."\n"
- .'- 绑定号码前建议您先明确业务场景中的A角色和N角色。例如：A号码是客户，则X号码是为客户分配的隐私号，其他的任何号码拨打X号码+分机号码都会转接到A号码，A拨打X的时候呼叫会转接到绑定时所传入的默认B号码。',
],
- 'QueryAxnBindFixedLine' => [
- 'summary' => '查询已绑定固话AXN隐私号码信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateAxnExtensionBindFixedLine' => [
+ 'summary' => '修改固话AXN分机号码绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '271366',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'AppId',
'in' => 'query',
- 'schema' => [
- 'title' => '号池id。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['title' => '号池ID', 'description' => '号池ID。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
'name' => 'Ts',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。', 'type' => 'string', 'required' => true, 'example' => '20161114143116123'],
],
[
- 'name' => 'QueryType',
+ 'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '查询类型 0：根据绑定id查询 1：根据A号码查询 2：根据X查询',
- 'description' => '查询类型。取值：'."\n"
- ."\n"
- .'- 0：根据绑定ID查询。'."\n"
- ."\n"
- .'- 1：根据X和A/B号码查询。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '消息请求唯一标识。', 'description' => '消息请求唯一标识。', 'type' => 'string', 'required' => true, 'example' => '123*******'],
],
[
- 'name' => 'SubId',
+ 'name' => 'Subts',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定id queryType=0时，必传',
- 'description' => '绑定ID。QueryType参数为1时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A203**************',
- ],
+ 'schema' => ['title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', 'type' => 'string', 'required' => true, 'example' => '20161114143116'],
],
[
- 'name' => 'Phone',
+ 'name' => 'SubId',
'in' => 'query',
- 'schema' => [
- 'title' => 'A号码，queryType=1时，必传',
- 'description' => 'A/B号码，QueryType参数为1时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '138****6534',
- ],
+ 'schema' => ['title' => '绑定id', 'description' => '绑定ID。', 'type' => 'string', 'required' => true, 'example' => 'GHX0*************************'],
],
[
- 'name' => 'TelX',
+ 'name' => 'TelA',
'in' => 'query',
- 'schema' => [
- 'title' => '隐私号码',
- 'description' => 'X号码，QueryType参数为1时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571******23',
- ],
+ 'schema' => ['title' => 'A号码', 'description' => '固话AXN分机的A号码。'."\n"
+ ."\n"
+ .'> A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。', 'type' => 'string', 'required' => true, 'example' => '手机号：182****2371'."\n"
+ .'固话：0571******36'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'Anucode',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['title' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 AXN分机号业务的放音编码,B->X和其他号码->X的编码一致 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', 'description' => '主叫侧放音编码，AXB业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。', 'type' => 'string', 'required' => false, 'example' => '1,2,3'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'E8B9C3ED-D9BD-5E27-9588-6D84D3070160',
- ],
- 'Data' => [
- 'title' => '绑定对象',
- 'description' => '绑定对象列表。',
- 'type' => 'array',
- 'items' => [
- 'description' => '对象详情。',
- 'type' => 'object',
- 'properties' => [
- 'TelB' => [
- 'title' => 'N号码',
- 'description' => 'N号码。',
- 'type' => 'string',
- 'example' => '155****2222',
- ],
- 'TelA' => [
- 'title' => 'A号码',
- 'description' => 'A号码。',
- 'type' => 'string',
- 'example' => '155****1111',
- ],
- 'Subid' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'example' => 'GHX**************************',
- ],
- 'Anucodecalled' => [
- 'title' => '被叫侧放音编码',
- 'description' => '被叫侧放音编码。',
- 'type' => 'string',
- 'example' => '10001,10002',
- ],
- 'Extra' => [
- 'title' => '额外字段',
- 'description' => '扩展参数。',
- 'type' => 'object',
- 'properties' => [
- 'Callback' => [
- 'title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB',
- 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不能外呼。'."\n"
- ."\n"
- .'- 1：接续最近的N号码。'."\n"
- ."\n"
- .'- 2：回拨固定号码TelB。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Callrecording' => [
- 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- 'example' => '',
- ],
- 'Subts' => [
- 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'example' => '20161114143116',
- ],
- 'Expiration' => [
- 'title' => '过期时间',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。',
- 'type' => 'string',
- 'example' => '60',
- ],
- 'TelX' => [
- 'title' => '隐私号码',
- 'description' => '隐私号码。',
- 'type' => 'string',
- 'example' => '0571******23',
- ],
- 'Areacode' => [
- 'title' => '隐私号码区号',
- 'description' => '隐私号码区号。',
- 'type' => 'string',
- 'example' => '0571',
- ],
- 'Anucode' => [
- 'title' => '接通前放音啊编码',
- 'description' => '接通前放音编码，必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 '."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。',
- 'type' => 'string',
- 'example' => '1,2,3',
- ],
- 'TAnucodeConnect' => [
- 'title' => '接通后主叫侧放音编码',
- 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'example' => '1,2',
- ],
- 'Remark' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'example' => '19394',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '接口请求状态码。取值：'."\n"
- .'0：成功。其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'title' => '',
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"E8B9C3ED-D9BD-5E27-9588-6D84D3070160\\",\\n \\"Data\\": [\\n {\\n \\"TelB\\": \\"155****2222\\",\\n \\"TelA\\": \\"155****1111\\",\\n \\"Subid\\": \\"GHX**************************\\",\\n \\"Anucodecalled\\": \\"10001,10002\\",\\n \\"Extra\\": {\\n \\"Callback\\": \\"1\\",\\n \\"Callrecording\\": \\"1\\"\\n },\\n \\"Subts\\": \\"20161114143116\\",\\n \\"Expiration\\": \\"60\\",\\n \\"TelX\\": \\"0571******23\\",\\n \\"Areacode\\": \\"0571\\",\\n \\"Anucode\\": \\"1,2,3\\",\\n \\"TAnucodeConnect\\": \\"1,2\\",\\n \\"Remark\\": \\"19394\\"\\n }\\n ],\\n \\"Code\\": \\"0\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => 'AXN固话隐私号-查询已有绑定关系',
- ],
- 'DeleteAxnBindFixedLine' => [
- 'summary' => '解除固话AXN隐私号码绑定关系。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '271213',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
+ 'name' => 'Anucodecalled',
+ 'in' => 'query',
+ 'schema' => ['title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'TAnucodeConnect',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2', 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
+ ."\n"
+ .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', 'type' => 'string', 'required' => false, 'example' => '1,2'],
],
[
- 'name' => 'Ts',
+ 'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['title' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', 'description' => '过期时间，单位：秒，取值：'."\n"
+ ."\n"
+ .'- 0：永不过期。'."\n"
+ ."\n"
+ .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。', 'type' => 'string', 'required' => false, 'example' => '60'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'Remark',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['title' => '接入商自有字段，最大250字符长度', 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。', 'type' => 'string', 'required' => false, 'example' => '19394'],
],
[
- 'name' => 'SubId',
+ 'name' => 'Extraaxx',
'in' => 'query',
+ 'style' => 'json',
'schema' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A93I******',
+ 'title' => 'AXx的扩展参数项',
+ 'description' => '扩展参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Callback' => ['title' => '可选。 A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码', 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不能外呼。'."\n"
+ ."\n"
+ .'- 1：接续最近的N号码。'."\n"
+ ."\n"
+ .'- 2：回拨固定号码TelB。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ 'Callrecording' => ['title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', 'description' => '录音控制。取值：'."\n"
+ ."\n"
+ .'- 0（默认值）：不录音。'."\n"
+ ."\n"
+ .'- 1：录音。'."\n"
+ ."\n"
+ .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ 'required' => false,
+ 'example' => '',
],
],
],
@@ -11438,1315 +7442,991 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '错误描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。'."\n",
- 'type' => 'string',
- 'example' => 'AE2D6997-643A-59CB-9B3C-918572E5CEAA',
- ],
+ 'AccessDeniedDetail' => ['description' => '鉴权报错信息。', 'type' => 'string', 'example' => 'None'],
+ 'Message' => ['description' => '调用结果信息。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID，阿里云为该请求生成的唯一标识符。'."\n"
+ ."\n", 'type' => 'string', 'example' => '31031C54-7727-5057-9ED1-FA276B64205E'],
'Data' => [
- 'description' => '应用分组信息。',
+ 'description' => '应用信息。',
'type' => 'object',
'properties' => [
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Code' => [
- 'title' => '响应码 0：成功，其它失败，具体见文档',
- 'description' => '响应码 0：成功，其它失败，具体见文档',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '获取应用实例分组是否成功。取值说明如下：true：表示获取成功。false：表示获取失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Message' => ['title' => '描述信息', 'description' => '描述信息', 'type' => 'string', 'example' => 'success'],
+ 'Code' => ['title' => '响应码 0：成功，其它失败，具体见文档', 'description' => '响应码 0：成功，其它失败，具体见文档', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '获取应用配置信息是否成功。取值说明如下：true：获取成功。false：获取失败。', 'type' => 'boolean', 'example' => 'false'],
],
],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ ."\n"
+ .'- 0：成功。'."\n"
+ ."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => '0'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ ."\n"
+ .'- true：成功。'."\n"
+ ."\n"
+ .'- false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"31031C54-7727-5057-9ED1-FA276B64205E\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": false\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '更新AXN分机号绑定关系',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UpdateAxnExtensionBindFixedLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"AE2D6997-643A-59CB-9B3C-918572E5CEAA\\",\\n \\"Data\\": {\\n \\"Message\\": \\"success\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '解绑已有Axn绑定',
- 'description' => '- 解除已有绑定关系的固话AXN隐私号后，可能影响您的业务连续性，请谨慎操作。'."\n"
- ."\n"
- .'- 释放号码前，需解除号码绑定关系。'."\n"
- ."\n"
- .'- 解除固话AXN隐私号码绑定关系仅支持此接口的方式进行解绑，暂不支持控制台进行解绑。',
],
- 'QueryAxnExtensionBindFixedLine' => [
- 'summary' => '查询已绑定固话AXN分机号信息。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateSubs700' => [
+ 'summary' => '修改700号码的绑定关系。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeCode' => '287501',
+ 'abilityTreeNodes' => ['FEATUREdypls1W5H18'],
+ 'autoTest' => true,
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号池ID',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
- ],
- [
- 'name' => 'Ts',
- 'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
- ],
- [
- 'name' => 'QueryType',
- 'in' => 'query',
- 'schema' => [
- 'title' => '查询类型。取值： 0：根据绑定ID查询。1：根据X和A/B号码查询',
- 'description' => '查询类型。取值：'."\n"
- ."\n"
- .'- 0：根据绑定ID查询。'."\n"
- ."\n"
- .'- 1：根据X和A/B号码查询。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0',
- ],
- ],
- [
- 'name' => 'SubId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '绑定ID。QueryType参数为0时必传。',
- 'description' => '绑定ID。QueryType参数为0时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A203**************',
- ],
- ],
- [
- 'name' => 'TelA',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => 'A号码。QueryType参数为1时必传。',
- 'description' => 'A号码。QueryType参数为1时必传。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '155****1111',
- ],
+ 'schema' => ['description' => '号码池Key。', 'type' => 'string', 'required' => true, 'example' => 'FC10000016848****'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'OperateType',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识。',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '74EFA0E8-CFCA-54D9-BFE5-904F9FA88DBD',
- ],
- 'Data' => [
- 'title' => '查询绑定对象集合，具体对象字段见绑定请求',
- 'description' => '绑定对象列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => '查询绑定对象',
- 'description' => '对象详情。',
- 'type' => 'object',
- 'properties' => [
- 'TelA' => [
- 'title' => 'A号码',
- 'description' => 'A号码。',
- 'type' => 'string',
- 'example' => '155****1111',
- ],
- 'Extraaxx' => [
- 'title' => '额外字段',
- 'description' => '拓展字段。',
- 'type' => 'object',
- 'properties' => [
- 'Callback' => [
- 'title' => '回拨控制',
- 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不能外呼。'."\n"
- ."\n"
- .'- 1：接续最近的N号码。'."\n"
- ."\n"
- .'- 2：回拨固定号码TelB。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Callrecording' => [
- 'title' => '录音控制',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'example' => '0',
- ],
- ],
- 'example' => '',
- ],
- 'Subid' => [
- 'title' => '绑定ID',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'example' => 'A203**************',
- ],
- 'TelXext' => [
- 'title' => '分机号',
- 'description' => '分机号。',
- 'type' => 'string',
- 'example' => '1009',
- ],
- 'Anucodecalled' => [
- 'title' => '被叫侧放音',
- 'description' => '被叫侧放音。',
- 'type' => 'string',
- 'example' => '10001,10002',
- ],
- 'Subts' => [
- 'title' => '绑定时间',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'example' => '20161114143116',
- ],
- 'Expiration' => [
- 'title' => '过期时间',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。',
- 'type' => 'string',
- 'example' => '60',
- ],
- 'TelX' => [
- 'title' => '小号号码',
- 'description' => '隐私号码。',
- 'type' => 'string',
- 'example' => '0571******23',
- ],
- 'Areacode' => [
- 'title' => '隐私号码区号',
- 'description' => '隐私号码区号。',
- 'type' => 'string',
- 'example' => '0571',
- ],
- 'Anucode' => [
- 'title' => '放音编码',
- 'description' => '放音编码。',
- 'type' => 'string',
- 'example' => '10001,10002,10003',
- ],
- 'TAnucodeConnect' => [
- 'title' => '接通后主叫侧放音编码',
- 'description' => '接通后主叫侧放音编码。',
- 'type' => 'string',
- 'example' => '10001,10002',
- ],
- 'Remark' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'example' => '19394',
- ],
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '响应码',
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'schema' => ['description' => '- updateNoA：修改 A 号码。'."\n"
+ .'- updateNoB：修改 B 号码。'."\n"
+ .'- updateExpire：修改绑定关系有效期。'."\n"
+ .'- updateGroup：修改 G 号码组。'."\n"
+ .'- updateNoDefaultA：GXB模式中修改默认回呼叫A号码。'."\n"
+ .'- updateCallRestrict：设置单通呼叫限制。'."\n"
+ .'- updateOutId：更新 OutId 字段。'."\n"
+ .'- updateIsRecordingEnabled：更新绑定中录音状态。'."\n"
+ .'- updateAsr：更新绑定中 ASR 状态。'."\n"
+ .'- updateAudio：更新绑定铃音配置。', 'type' => 'string', 'required' => true, 'example' => 'updateNoA'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"74EFA0E8-CFCA-54D9-BFE5-904F9FA88DBD\\",\\n \\"Data\\": [\\n {\\n \\"TelA\\": \\"155****1111\\",\\n \\"Extraaxx\\": {\\n \\"Callback\\": \\"0\\",\\n \\"Callrecording\\": \\"0\\"\\n },\\n \\"Subid\\": \\"A203**************\\",\\n \\"TelXext\\": \\"1009\\",\\n \\"Anucodecalled\\": \\"10001,10002\\",\\n \\"Subts\\": \\"20161114143116\\",\\n \\"Expiration\\": \\"60\\",\\n \\"TelX\\": \\"0571******23\\",\\n \\"Areacode\\": \\"0571\\",\\n \\"Anucode\\": \\"10001,10002,10003\\",\\n \\"TAnucodeConnect\\": \\"10001,10002\\",\\n \\"Remark\\": \\"19394\\"\\n }\\n ],\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询AXN分机号绑定关系',
- ],
- 'BindAxnFixedLine' => [
- 'summary' => '固话绑定AXN隐私号，是将A用户分配到一个专属的隐私号，任何号码N通过拨打X号码都可以转接到A。固话隐私号目前为邀约制，请联系您的技术支持进行服务开通，并提供对接支持。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AppId',
+ 'name' => 'SubsId',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
+ 'schema' => ['description' => '绑定关系ID，用于唯一识别号码绑定关系。', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000*****'],
],
[
- 'name' => 'Ts',
+ 'name' => 'TelX',
'in' => 'query',
- 'schema' => [
- 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒',
- 'description' => '业务时间戳，格式为yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['description' => '中间号X。业务使用方未指定X号码时，由应用平台从号码池中指定一个号码作为X号码。', 'type' => 'string', 'required' => true, 'example' => '700********0000'],
],
[
'name' => 'OrderId',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['description' => '订单 ID(实际上必填， 建议客户进行订单号加密，用于报送监管平台)。', 'type' => 'string', 'required' => false, 'example' => '12345678'],
],
[
- 'name' => 'BindType',
+ 'name' => 'IndustrialId',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码',
- 'description' => '绑定类型，取值：'."\n"
- ."\n"
- .'- mode101：客户指定X号码。'."\n"
- ."\n"
- .'- mode102：平台分配X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mode101',
- ],
+ 'schema' => ['description' => '可选 工业互联网标识编码，与OrderID保持一一对应关系。编码支持“.”、“/”等字符分割编码域，编码中不得含有不可显示类字符，如空格符、换行符等。'."\n"
+ .'当业务使用方自行生成工业互联网标识编码时，该字段必选。', 'type' => 'string', 'required' => false, 'example' => '700.100.1/12345678'],
],
[
- 'name' => 'Subts',
+ 'name' => 'TelA',
'in' => 'query',
- 'schema' => [
- 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116',
- ],
+ 'schema' => ['description' => '修改绑定关系中的A号码。', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
- 'name' => 'TelA',
+ 'name' => 'DefaultA',
'in' => 'query',
- 'schema' => [
- 'title' => 'A号码',
- 'description' => '固话AXN隐私号的A号码。'."\n"
- ."\n\n"
- .'> - A号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。'."\n"
- .'> - 如果您的业务需要修改已绑定的号码，可以调用[UpdateAxnBindFixedLine](~~2883049~~)接口进行修改。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'schema' => ['description' => 'A号码'."\n"
+ .'GXB 隐私号的 DefaultA号码。'."\n"
+ .'说明'."\n"
+ .'支持在号池维度设置回拨模式，当回拨模式为默认模式时，此字段生效，即 B 号码拨打 X 号码时，默认会转接到 此 A 号码，如 A 号码未设置，则无法接通。'."\n"
+ .'如需更新 A 号码，请调用 号码绑定修改接口', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
- 'name' => 'TelX',
+ 'name' => 'TelB',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数',
- 'description' => '固话AXN隐私号的X号码。X号码是您在控制台已购买的隐私号。'."\n"
- ."\n"
- .'> 客户指定X号码模式下（即BindType参数为mode101），本参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571******23',
- ],
+ 'schema' => ['description' => '修改绑定关系中的B号码。', 'type' => 'string', 'required' => false, 'example' => '136****0000'],
],
[
- 'name' => 'TelB',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'title' => 'N号码',
- 'description' => '固话AXN隐私号的N号码。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '155****2222',
- ],
+ 'schema' => ['description' => '修改绑定关系中的GroupID。', 'type' => 'string', 'required' => false, 'example' => '示例值示例值'],
],
[
- 'name' => 'Anucode',
+ 'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'title' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3',
- 'description' => '主叫侧放音编码，必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1,2,3',
- ],
+ 'schema' => ['description' => '修改绑定关系的有效时间。', 'type' => 'string', 'required' => false, 'example' => '2021-09-05 12:00:00'],
],
[
- 'name' => 'Anucodecalled',
+ 'name' => 'CallRestrict',
'in' => 'query',
- 'schema' => [
- 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2',
- 'description' => '被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['description' => '修改单通呼叫限制逻辑。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_AX_DISABLE'],
],
[
- 'name' => 'TAnucodeConnect',
+ 'name' => 'NeedRecord',
'in' => 'query',
- 'schema' => [
- 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2',
- 'description' => '接通后主叫侧放音编码，必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['description' => '修改中绑定关系中的媒体选择。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Areacode',
+ 'name' => 'Audio',
'in' => 'query',
- 'schema' => [
- 'title' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费',
- 'description' => '区号。支持指定X号码归属地（指定城市->省会->全国路由）。不指定归属地，全国随机。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571',
- ],
+ 'schema' => ['description' => '可选 放音编码'."\n"
+ .'- AXB模式'."\n"
+ ."\n"
+ .'ACallX_Apre A呼叫X号码时，呼叫接通前，向A播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'ACallX_Ain A呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'ACallX_Bin A呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'BCallX_Ain B呼叫X号码时，呼叫接通后，向A播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'- GXB模式'."\n"
+ ."\n"
+ .'GCallX_Gpre 号码组G中的号码呼叫X号码时，呼叫接通前，向主叫播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'GCallX_Gin 号码组G中的号码呼叫X号码时，呼叫接通后，向主叫播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'GCallX_Bin 号码组G中的号码呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'BCallX_Bpre B呼叫X号码时，呼叫接通前，向B播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'BCallX_Gin 呼叫X号码时，呼叫接通后，向被叫播放的语音提示放音编码。'."\n"
+ ."\n"
+ .'BCallX_Bin B呼叫X号码时，呼叫接通后，向B播放的语音提示放音编码。', 'type' => 'string', 'required' => false, 'example' => '{'."\n"
+ .'"ACallX_Apre":"185"'."\n"
+ .'}'],
],
[
- 'name' => 'Expiration',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'title' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效；超过60s后，自动解绑。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '60',
- ],
+ 'schema' => ['description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
- 'name' => 'Remark',
+ 'name' => 'NeedAsr',
'in' => 'query',
- 'schema' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19394',
- ],
+ 'schema' => ['description' => '是否开启 ASR 服务功能。取值：'."\n"
+ .'false：关闭（默认值）。'."\n"
+ .'true：开启', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'Extra',
+ 'name' => 'AsrModelId',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '扩展参数',
- 'description' => '扩展参数。',
- 'type' => 'object',
- 'properties' => [
- 'Callback' => [
- 'title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB',
- 'description' => '回拨控制。A通过X呼叫，即A主叫X。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不能外呼。'."\n"
- ."\n"
- .'- 1：接续最近的N号码。'."\n"
- ."\n"
- .'- 2：回拨固定号码TelB。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- 'Callrecording' => [
- 'title' => '仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- ."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'ASR 模型 ID。取值：'."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '响应数据',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'title' => '描述信息',
- 'description' => '描述信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => '4D690962-08CE-5D38-A65A-AB247D7DF7A2',
- ],
- 'Data' => [
- 'description' => '响应信息。',
- 'type' => 'object',
- 'properties' => [
- 'Subid' => [
- 'title' => '绑定id',
- 'description' => '绑定ID。',
- 'type' => 'string',
- 'example' => 'GHX0*************************',
- ],
- 'TelX' => [
- 'title' => '隐私号码',
- 'description' => '隐私号码。',
- 'type' => 'string',
- 'example' => '0571******23',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '响应码 0：成功，其它失败，具体见文档',
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'AccessDeniedDetail' => ['description' => '权限校验失败详情。', 'type' => 'string', 'example' => '{}'],
+ 'RequestId' => ['description' => '请求 ID。', 'type' => 'string', 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n"],
+ 'Message' => ['description' => '返回消息', 'type' => 'string', 'example' => 'OK'],
+ 'Data' => ['description' => '默认返回格式，实际无值', 'type' => 'object', 'example' => '{}'],
+ 'Code' => ['description' => '接口请求状态码。取值：'."\n"
+ .'- OK：成功。'."\n"
+ .'- 其他错误码，请参见[API错误码](~~59892~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Success' => ['description' => '接口调用是否成功。取值：'."\n"
+ .'true：成功。'."\n"
+ .'false：失败。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050******\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {},\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ 'title' => '700中间号-号码绑定更新',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"4D690962-08CE-5D38-A65A-AB247D7DF7A2\\",\\n \\"Data\\": {\\n \\"Subid\\": \\"GHX0*************************\\",\\n \\"TelX\\": \\"0571******23\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AXN固话隐私号-号码绑定',
- 'description' => '- 在调用此接口前，请确保您已在控制台购买隐私号。您可以使用此接口给固话AXN隐私号绑定号码，控制台暂不支持固话AXN隐私号绑定。'."\n"
- ."\n"
- .'- 绑定号码前建议您先明确业务场景中的A角色。例如：在二手车信息发布场景中，A是房东或经纪人联系方式。',
+ 'ramActions' => [],
],
- 'BindAxbFixedLine' => [
- 'summary' => '固话绑定AXB隐私号，是将拨打关系限定在一对一关系中，用户A可以通过固话中间号码X联系到用户B，用户B也可以通过中间号码X联系到用户A。固话隐私号目前为邀约制，请联系您的技术支持进行服务开通，并提供对接支持。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateSubscription' => [
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['http', 'https'],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
- 'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
- 'abilityTreeCode' => '271000',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
- ],
+ 'abilityTreeCode' => '72641',
+ 'abilityTreeNodes' => ['FEATUREdypls13M9H9'],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'AppId',
+ 'name' => 'PoolKey',
'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- 'default' => '',
- ],
+ 'schema' => ['description' => '号码池Key。'."\n"
+ ."\n"
+ .'>在号码隐私保护控制台，[号码池管理](https://dyplsnext.console.aliyun.com/number-pool?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)页面获取**号码池Key**。当**ProductType**为空时必填。', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'FC122356****'],
],
[
- 'name' => 'Ts',
+ 'name' => 'ProductType',
'in' => 'query',
- 'schema' => [
- 'title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
+ 'schema' => ['description' => '产品类型。取值：'."\n"
+ .'- **AXB_170**。'."\n"
+ .'- **AXN_170**。'."\n"
+ .'- **AXN_95**。'."\n"
+ .'- **AXN\\_EXTENSION\\_REUSE**。'."\n"
+ ."\n"
+ .'> - 适用于原阿里大于客户，阿里云用户可忽略。'."\n"
+ .'> - 当**PoolKey**为空时必填。', 'type' => 'string', 'required' => false, 'example' => 'AXB_170'],
],
[
- 'name' => 'BindType',
+ 'name' => 'SubsId',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码',
- 'description' => '绑定类型，取值：'."\n"
- ."\n"
- .'- mode101：客户指定X号码。'."\n"
- ."\n"
- .'- mode102：平台分配X号码。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'mode101',
- ],
+ 'schema' => ['description' => '绑定关系ID。'."\n"
+ ."\n"
+ .'> 请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页筛选号码，点击**详情**查看号码的绑定关系ID，或者在调用[BindAxb](https://help.aliyun.com/zh/pnp/developer-reference/api-dyplsapi-2017-05-25-bindaxb?spm=a2c4g.11186623.0.0.6a807e38uud6C5)等号码绑定API时查看返回参数中的**SubsId**。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100000076879****'],
],
[
- 'name' => 'OrderId',
+ 'name' => 'PhoneNoX',
'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识。',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
+ 'schema' => ['description' => '号码绑定关系中的X号码。'."\n"
+ ."\n"
+ .'>X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy?spm=a2c4g.11186623.0.0.7e6449bbtiHP8m)。请登录号码隐私保护控制台，在[号码管理](https://dyplsnext.console.aliyun.com/number/list)页面获取X号码。在填写X号码时，注意填写与**SubsId**参数关联的X号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '139****1111'],
],
[
- 'name' => 'TelA',
+ 'name' => 'PhoneNoA',
'in' => 'query',
- 'schema' => [
- 'title' => '真实号码',
- 'description' => '固话AXB隐私号的A号码。'."\n"
- ."\n"
- .'> - A号码可设置为手机号码或固定电话，固定电话请加区号，区号和固定电话之间不需要连字符。 '."\n"
- .'>- 如果您的业务需要修改已绑定的号码，可以调用[UpdateAxbBindFixedLine](~~2883050~~)接口进行修改。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'schema' => ['description' => '设置绑定关系中的A号码。'."\n"
+ ."\n"
+ .'>A 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。当**OperateType**指定为**updateNoA**时必填。', 'type' => 'string', 'required' => false, 'example' => '139****0000'],
],
[
- 'name' => 'TelX',
+ 'name' => 'PhoneNoB',
'in' => 'query',
- 'schema' => [
- 'title' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数 格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '固话AXB隐私号的X号码。X号码是您在控制台已[购买的隐私号](https://dyplsnext.console.aliyun.com/numberbuy)。'."\n"
- ."\n"
- .'> 客户指定X号码模式下（即BindType参数为mode101），本参数必填。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571******23',
- ],
+ 'schema' => ['description' => '设置绑定关系中的B号码。'."\n"
+ ."\n"
+ .'>B 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。当**OperateType**指定为**updateNoB**时必填。', 'type' => 'string', 'required' => false, 'example' => '138****0000'],
],
[
- 'name' => 'TelB',
+ 'name' => 'GroupId',
'in' => 'query',
- 'schema' => [
- 'title' => '对端号码',
- 'description' => '固话AXB隐私号的B号码。'."\n"
- ."\n"
- .'> - B号码可设置为手机号码或固定电话，固定电话请加区号，区号和固定电话中间不需要连字符。'."\n"
- .'> - 如果您的业务需要修改已绑定的号码，可以调用[UpdateAxbBindFixedLine](~~2883050~~)接口进行修改。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '手机号：182****2371'."\n"
- .'固话：0571******36',
- ],
+ 'schema' => ['description' => '设置绑定关系中的G号码组ID。'."\n"
+ ."\n"
+ .'> 当**OperateType**指定为**updateAxgGroup**时必填。', 'type' => 'string', 'required' => false, 'example' => '200001234****'],
],
[
- 'name' => 'Subts',
+ 'name' => 'CallRestrict',
'in' => 'query',
- 'schema' => [
- 'title' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116',
- ],
+ 'schema' => ['description' => '设置单通呼叫限制。取值：'."\n"
+ .'- **CONTROL_AX_DISABLE**：A号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_BX_DISABLE**：B号码无法呼叫X号码。'."\n"
+ .'- **CONTROL_CLEAR_DISABLE**：清除呼叫限制。'."\n"
+ ."\n"
+ .'> 当**OperateType**指定为**updateCallRestrict**时必填。', 'type' => 'string', 'required' => false, 'example' => 'CONTROL_BX_DISABLE '],
],
[
- 'name' => 'Anucode',
+ 'name' => 'Expiration',
'in' => 'query',
- 'schema' => [
- 'title' => '主叫侧放音编码，AXB业务时必须设置。 放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3',
- 'description' => '主叫侧放音编码，固话AXB隐私号业务时必须设置。必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2,3”表示B->X放音编号为1，A->X放音编号为2，其他号码->X放音编号为3。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1,2,3',
- ],
+ 'schema' => ['description' => '重新设置绑定关系的过期时间。'."\n"
+ ."\n"
+ .'> - **OperateType**为**updateExpire**时必填。'."\n"
+ .'> - 过期时间必须晚于当前时间1分钟以上。', 'type' => 'string', 'required' => false, 'example' => '2019-09-05 12:00:00'],
],
[
- 'name' => 'Anucodecalled',
+ 'name' => 'CallDisplayType',
'in' => 'query',
- 'schema' => [
- 'title' => '接通后被叫侧放音编码,接通后被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。',
- 'description' => '接通后被叫侧放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['description' => '重置绑定关系中的号码显示逻辑。固定取值：**1**（主被叫显示中间号码X）。'."\n"
+ ."\n"
+ .'> 由于运营商监管限制，暂时关闭透传功能。呼叫时，显示真实号码的设置不生效。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'TAnucodeConnect',
+ 'name' => 'OutId',
'in' => 'query',
- 'schema' => [
- 'title' => '接通后主叫侧的放音编码,接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'description' => '接通后主叫侧的放音编码，必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。'."\n"
- ."\n"
- .'> “1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1,2',
- ],
+ 'schema' => ['description' => '重新设置绑定关系中的OutId。', 'type' => 'string', 'required' => false, 'example' => 'abcdef'],
],
[
- 'name' => 'Areacode',
+ 'name' => 'IsRecordingEnabled',
'in' => 'query',
- 'schema' => [
- 'title' => '区号,去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费。',
- 'description' => '区号。支持指定X号码归属地（指定城市->省会->全国路由）。不指定归属地，全国随机。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0571',
- ],
+ 'schema' => ['description' => '重新设置绑定关系中的录音状态。取值：'."\n"
+ ."\n"
+ .'- **true**：录音。'."\n"
+ ."\n"
+ .'- **false**：不录音。'."\n"
+ ."\n"
+ .'> 该参数没有默认值，不传该参数就不更新对应字段。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'Expiration',
+ 'name' => 'OperateType',
'in' => 'query',
- 'schema' => [
- 'title' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期',
- 'description' => '过期时间，单位：秒，取值：'."\n"
- ."\n"
- .'- 0：永不过期。'."\n"
- ."\n"
- .'- 其他数值：传其它数值时，比如60s，分配X号码成功的60秒内，绑定有效，超过60s后，自动解绑。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '60',
- ],
+ 'schema' => ['description' => '修改绑定关系的操作。取值：'."\n"
+ .'- **updateNoA**：修改A号码。'."\n"
+ .'- **updateNoB**：修改B号码。'."\n"
+ .'- **updateExpire**：修改绑定关系有效期。'."\n"
+ .'- **updateAxgGroup**：修改G号码组。'."\n"
+ .'- **updateCallRestrict**：设置单通呼叫限制。'."\n"
+ .'- **updateCallDisplayType**：更新呼叫显号逻辑。'."\n"
+ .'- **updateOutId**：更新OutId字段。'."\n"
+ .'- **updateIsRecordingEnabled**：更新绑定中录音状态。'."\n"
+ .'- **updateAsr**：更新绑定中ASR状态。'."\n"
+ .'> 在修改已绑定的号码时，一次只能修改一个已绑定的号码，若您需要同时修改两个已绑定的A号码和B号码，需要调用两次接口进行修改，或者您也可对A号码和B号码先进行解绑，然后再绑定C号码和D号码。', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'updateNoA'],
],
[
- 'name' => 'Remark',
+ 'name' => 'RingConfig',
'in' => 'query',
- 'schema' => [
- 'title' => '接入商自有字段，最大250字符长度',
- 'description' => '外部业务扩展字段，通话记录回执消息中会回传此参数。不能超过100个字符长度。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19394',
- ],
+ 'schema' => ['description' => '更新绑定关系中的企业彩铃放音编码，此参数请填写**铃音字段**和**彩铃编码**。**铃音字段**取值：'."\n"
+ ."\n"
+ .'AXB产品：'."\n"
+ .'- AXB中，A号码打X的铃音设置：AXBRing_A'."\n"
+ .'- AXB中，B号码打X的铃音设置：AXBRing_B'."\n"
+ .'- AXB中，A号码拨打X接通后的铃音设置：AXBRing_A_PICKUP'."\n"
+ .'- AXB中，B号码拨打X接通后的铃音设置：AXBRing_B_PICKUP'."\n"
+ ."\n"
+ .'AXN产品（含AXN隐私号、AXN分机号）：'."\n"
+ .'- AXN中，A号码打X接通前的铃音设置（有回拨号码）：AXNRing_AB'."\n"
+ .'- AXN中，A号码打X接通前的铃音设置（无回拨号码）：AXNRing_A'."\n"
+ .'- AXN中，N侧号码打X接通前的铃音设置：AXNRing_N'."\n"
+ .'- AXN中，A号码打X接通后的铃音设置：AXNRing_A_PICKUP'."\n"
+ .'- AXN中，N号码打X接通后的铃音设置：AXNRing_N_PICKUP'."\n"
+ ."\n"
+ .'AXG产品：'."\n"
+ .'- AXG中，A号码打X的铃音设置（有回拨号码）：AXGRing_AB'."\n"
+ .'- AXG中，A号码打X的铃音设置（无回拨号码）：AXGRing_A'."\n"
+ .'- AXG中，G组号码打X的铃音设置：AXGRing_G'."\n"
+ ."\n"
+ .'**填写示例**：'."\n"
+ .'如设置AXN分机号，A号码拨打X接通前的铃音（无回拨号码），填写："AXNRing_A": "1000****1"。'."\n"
+ ."\n"
+ .'**彩铃编码**：'."\n"
+ .'在号码隐私保护控制台[企业彩铃管理](https://dyplsnext.console.aliyun.com/number-pool/ringtone?resType=1)页面获取企业彩铃编码。'."\n"
+ ."\n"
+ .'> 企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。', 'type' => 'string', 'required' => false, 'example' => '{"AXBRing_B":"1000****1","AXBRing_A":"1000****1"}'],
],
[
- 'name' => 'Extra',
+ 'name' => 'ASRStatus',
'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'title' => '扩展参数',
- 'description' => '扩展参数。',
- 'type' => 'object',
- 'properties' => [
- 'Callrecording' => [
- 'title' => '录音控制，默认是0（不开通录音功能）。 0：不录音 1：录音',
- 'description' => '录音控制。取值：'."\n"
- ."\n"
- .'- 0（默认值）：不录音。'."\n"
- ."\n"
- .'- 1：录音。'."\n"
- .'> 开启通话录音功能后，可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费0.010元/分钟。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- 'example' => '',
- ],
+ 'schema' => ['description' => 'ASR状态。取值：'."\n"
+ ."\n"
+ .'- **false**：关闭（默认值）。'."\n"
+ .'- **true**：开启。'."\n"
+ ."\n"
+ .'> 当OperateType为updateAsr时此参数必填。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'ASRModelId',
+ 'in' => 'query',
+ 'schema' => ['description' => 'ASR模型ID。取值：'."\n"
+ .'- 通用-电话-中文普通话模型 ID：7ee372834d2f4cc7ac0d0ab2d0ae1aac'."\n"
+ .'- 通用-电话-中文粤语模型 ID：9b4afe3d224e4fa3bf963697113e2f77'."\n"
+ .'- 通用-电话-地方口音模型 ID：3655a6cb94764145a1f9a38a3c3b3b4b'."\n"
+ ."\n"
+ .'> 当ASRStatus为true时此参数必填。', 'type' => 'string', 'required' => false, 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac'],
],
],
'responses' => [
200 => [
'schema' => [
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'title' => '响应消息',
- 'description' => '响应消息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'description' => '请求ID，阿里云为该请求生成的唯一标识符。',
- 'type' => 'string',
- 'example' => '649E9EB5-9436-53CF-B41A-C4F0433212E7',
- ],
- 'Data' => [
- 'title' => '响应内容',
- 'description' => '响应内容。',
- 'type' => 'object',
- 'properties' => [
- 'Subid' => [
- 'title' => '绑定id',
- 'description' => '绑定id。',
- 'type' => 'string',
- 'example' => 'GHX0*************************',
- ],
- 'TelX' => [
- 'title' => 'X号码',
- 'description' => 'X号码。',
- 'type' => 'string',
- 'example' => '0571******23',
- ],
- ],
- 'example' => '',
- ],
- 'Code' => [
- 'title' => '响应码 0-成功',
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'title' => '是否处理成功 true-成功',
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '请求状态码。'."\n"
+ ."\n"
+ .'- 返回OK代表请求成功。'."\n"
+ .'- 其他错误码，请参见[错误码列表](~~109196~~)。', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '状态码的描述。', 'type' => 'string', 'example' => 'OK'],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"649E9EB5-9436-53CF-B41A-C4F0433212E7\\",\\n \\"Data\\": {\\n \\"Subid\\": \\"GHX0*************************\\",\\n \\"TelX\\": \\"0571******23\\"\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AXB固话隐私号-号码绑定',
- 'description' => '- 在调用此接口前，请确保您已在控制台购买隐私号。您可以使用此接口给固话AXB中间号绑定号码，暂时不支持控制台号码管理页面给固话AXB中间号绑定A、B号码。'."\n"
- ."\n"
- .'- 绑定号码前建议您先明确业务场景中的A角色和B角色。例如：在打车应用场景中，A是乘客角色，B是司机角色。'."\n"
- ."\n"
- .'- 固话AXB中间号主要应用在1对1场景下的隐私保护，把A号码和B号码通过号码隐私服务实现绑定关系，A拨打X转接到B，B拨打X转接到A。一个固话X号码可以供N对绑定关系复用，如A1XB1、A2XB2、A3XB3......，只要A、B用户手机号码不重复，一个固话X号码可同时绑定N组手机号码，通话也可以同时进行。'."\n"
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"986BCB6D-C9BF-42F9-91CE-3A9901233D36\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\\"1.0\\" encoding=\\"UTF-8\\" ?>\\r\\n<UpdateSubscriptionResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</UpdateSubscriptionResponse>","errorExample":""}]',
+ 'title' => '修改已绑定的号码',
+ 'summary' => '修改号码的绑定关系。',
+ 'description' => '### QPS限制'."\n"
+ .'本接口的单用户QPS限制为10000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n"
."\n"
- .'- 号码复用次数根据您购买的号码有所不同，具体复用次数可以在号码购买时与您的技术支持确认。',
- ],
- 'DeleteAxbBindFixedLine' => [
- 'summary' => '解除固话AXB隐私号绑定关系。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ .'### PoolKey和ProductType限制'."\n"
+ .'PoolKey和ProductType参数请至少填写一个，若两个参数都不填，调用接口时会报错。 建议原阿里大于客户填ProductType参数，阿里云用户填PoolKey参数。',
+ 'requestParamsDescription' => ' ',
+ 'responseParamsDescription' => ' ',
+ 'extraInfo' => ' ',
+ 'changeSet' => [
+ ['createdAt' => '2022-02-15T07:50:47.000Z', 'description' => '请求参数发生变更、错误码发生变更'],
],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeCode' => '271125',
- 'abilityTreeNodes' => [
- 'FEATUREdypls1W5H18',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '12000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'],
],
- 'autoTest' => true,
- 'tenantRelevance' => 'publicInformation',
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'AppId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '号池ID。',
- 'description' => '号池ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'FC10000016848****',
- ],
- ],
- [
- 'name' => 'Ts',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ',
- 'description' => '业务时间戳，格式：yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '20161114143116123',
- ],
- ],
- [
- 'name' => 'SubId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '绑定id',
- 'description' => '绑定id。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'A93I******',
- ],
- ],
- [
- 'name' => 'OrderId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '消息请求唯一标识。',
- 'description' => '消息请求唯一标识。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123*******',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'type' => 'object',
- 'properties' => [
- 'AccessDeniedDetail' => [
- 'description' => '权限校验失败详情。',
- 'type' => 'string',
- 'example' => 'None',
- ],
- 'Message' => [
- 'description' => '错误描述。',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'RequestId' => [
- 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。',
- 'type' => 'string',
- 'example' => 'F036366A-0182-5066-A686-19C4C82F2D51',
- ],
- 'Data' => [
- 'description' => '命名空间列表。',
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '响应消息',
- 'description' => '响应消息',
- 'type' => 'string',
- 'example' => '示例值示例值示例值',
- ],
- 'Code' => [
- 'title' => '响应码 0-成功',
- 'description' => '响应码 0-成功',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'title' => '是否处理成功 true-成功 false-失败',
- 'description' => '是否处理成功 true-成功 false-失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '接口请求状态码。取值：'."\n"
- ."\n"
- .'- 0：成功。'."\n"
- ."\n"
- .'- 其他错误码，请参见[API错误码](~~59892~~)。',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Success' => [
- 'description' => '接口调用是否成功。取值：'."\n"
- ."\n"
- .'- true：成功。'."\n"
- ."\n"
- .'- false：失败。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UpdateSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F036366A-0182-5066-A686-19C4C82F2D51\\",\\n \\"Data\\": {\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AXB固话隐私号-解绑已有绑定关系',
- 'description' => '- 解除已有绑定关系的固话AXB隐私号后，可能影响您的业务连续性，请谨慎操作。'."\n"
- ."\n"
- .'- 释放号码前，需解除号码绑定关系。'."\n"
- ."\n"
- .'- 解除固话AXB隐私号绑定关系仅支持此接口的方式进行解除，暂不支持控制台进行解绑。',
],
],
'endpoints' => [
+ ['regionId' => 'ap-northeast-1', 'regionName' => '日本（东京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-3', 'regionName' => '马来西亚（吉隆坡）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'ap-southeast-5', 'regionName' => '印度尼西亚（雅加达）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2（北京）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-chengdu', 'regionName' => '西南1（成都）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hongkong', 'regionName' => '中国香港', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-huhehaote', 'regionName' => '华北5（呼和浩特）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-qingdao', 'regionName' => '华北1（青岛）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2（上海）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen', 'regionName' => '华南1（深圳）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-zhangjiakou', 'regionName' => '华北3（张家口）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-west-1', 'regionName' => '美国（硅谷）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'us-east-1', 'regionName' => '美国（弗吉尼亚）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-west-1', 'regionName' => '英国（伦敦）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'eu-central-1', 'regionName' => '德国（法兰克福）', 'areaId' => 'europeAmerica', 'areaName' => '欧洲与美洲', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'me-east-1', 'regionName' => '阿联酋（迪拜）', 'areaId' => 'middleEast', 'areaName' => '中东', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => '华南1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai-finance-1', 'regionName' => '华东2 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-north-2-gov-1', 'regionName' => '北京政务云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou-finance', 'regionName' => '华东1 金融云', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-beijing-finance-1', 'regionName' => '华北2 金融云（邀测）', 'areaId' => 'industryCloud', 'areaName' => '行业云', 'public' => 'dyplsapi.aliyuncs.com', 'endpoint' => 'dyplsapi.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'BlackKeyControlLimit', 'message' => 'You are under blacklist control, Please contact relevant personnel to cancel the operation.', 'http_code' => 400, 'description' => '黑名单管控。'],
+ ['code' => 'ConfigError', 'message' => 'A configuration error occurred.', 'http_code' => 400, 'description' => '配置错误'],
+ ['code' => 'ContentUnsupported', 'message' => 'There is unsupported content, please check the incoming content.', 'http_code' => 400, 'description' => '存在不支持的内容'],
+ ['code' => 'FaceVerifyException', 'message' => 'An error occurred while performing face verification.', 'http_code' => 400, 'description' => '实名认证异常'],
+ ['code' => 'FaceVerifyFail', 'message' => 'Face verification failed.', 'http_code' => 400, 'description' => '实名结果认证失败或者为空'],
+ ['code' => 'FaceVerifyNotCompleted', 'message' => 'You must complete the face verification.', 'http_code' => 400, 'description' => '实名认证未完成'],
+ ['code' => 'FlowLimited', 'message' => 'The operation is denied due to flow control.', 'http_code' => 400, 'description' => '限流'],
+ ['code' => 'ForbiddenAction', 'message' => 'The operation is forbidden.', 'http_code' => 400, 'description' => '非法操作'],
+ ['code' => 'InvalidJsonParam', 'message' => 'There are unavailable parameters, please check the parameter list.', 'http_code' => 400, 'description' => '存在不可用的参数'],
+ ['code' => 'isp.DAO_EXCEPTION', 'message' => 'A database error occurred.', 'http_code' => 400, 'description' => '数据库异常'],
+ ['code' => 'isp.RAM_PERMISSION_DENY', 'message' => 'RAM permission is denied.', 'http_code' => 400, 'description' => 'RAM权限DENY'],
+ ['code' => 'isp.SYSTEM_ERROR', 'message' => 'A system error occurred.', 'http_code' => 400, 'description' => '系统错误'],
+ ['code' => 'isp.UNKNOWN_ERR_CODE', 'message' => 'An error occurred to the vendor.', 'http_code' => 400, 'description' => '运营商未知错误'],
+ ['code' => 'isp.VENDOR_UNAVAILABLE', 'message' => 'The vendor is unavailable.', 'http_code' => 400, 'description' => '运营商降级'],
+ ['code' => 'isv.ACCOUNT_ABNORMAL', 'message' => 'The account status is abnormal.', 'http_code' => 400, 'description' => '账户异常'],
+ ['code' => 'isv.ACCOUNT_NOT_EXISTS', 'message' => 'The account does not exist.', 'http_code' => 400, 'description' => '账户不存在'],
+ ['code' => 'isv.BIND_CONFLICT', 'message' => 'An error occurred while performing binding.', 'http_code' => 400, 'description' => '绑定冲突'],
+ ['code' => 'isv.CUSTOMER_REFUSED', 'message' => 'This operation is refused by the customer.', 'http_code' => 400, 'description' => '客户拒绝'],
+ ['code' => 'isv.ERROR_POINT_TO_POINT_BLACK', 'message' => '点对点黑名单号码个数错误', 'http_code' => 400, 'description' => '点对点黑名单号码个数错误'],
+ ['code' => 'isv.EXPIRE_DATE_ILLEGAL', 'message' => 'The expiration date is invalid.', 'http_code' => 400, 'description' => '过期时间非法'],
+ ['code' => 'isv.FLOW_LIMIT', 'message' => 'Business flow control is in progress.', 'http_code' => 400, 'description' => '业务流控'],
+ ['code' => 'isv.FORBIDDEN_ACTION', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 400, 'description' => '无权操作'],
+ ['code' => 'isv.ILLEGAL_ARGUMENT', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '参数非法'],
+ ['code' => 'isv.INVALID_PARAMETERS', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => '无效的参数'],
+ ['code' => 'isv.MOBILE_NUMBER_ILLEGAL', 'message' => 'The mobile number format is invalid.', 'http_code' => 400, 'description' => '号码格式非法'],
+ ['code' => 'isv.NO_AVAILABLE_NUMBER', 'message' => 'No number is available.', 'http_code' => 400, 'description' => '无可用号码'],
+ ['code' => 'isv.NO_NOT_EXIST', 'message' => 'The number does not exist.', 'http_code' => 400, 'description' => '号码不存在'],
+ ['code' => 'isv.NO_USED_BY_OTHERS', 'message' => 'The number is used by another user.', 'http_code' => 400, 'description' => '号码被其他业务方占用'],
+ ['code' => 'isv.OUT_OF_SERVICE', 'message' => 'The business is out of service.', 'http_code' => 400, 'description' => '业务停机'],
+ ['code' => 'isv.PARTNER_IS_CLOSED', 'message' => 'The partner is deactivated.', 'http_code' => 400, 'description' => 'partner被关停'],
+ ['code' => 'isv.PARTNER_NOT_EXIST', 'message' => 'The specified partner does not exist.', 'http_code' => 400, 'description' => '未知合作伙伴'],
+ ['code' => 'isv.PRODUCT_UNSUBSCRIBE', 'message' => 'poolKey not exist', 'http_code' => 400, 'description' => '号池key不存在'],
+ ['code' => 'isv.PRODUCT_UN_SUBSCRIPT', 'message' => 'You have not activated Cloud Communications products.', 'http_code' => 400, 'description' => '未开通云通信产品的阿里云客户'],
+ ['code' => 'isv.VENDOR_BIND_FAILED', 'message' => 'Failed to bind the vendor.', 'http_code' => 400, 'description' => '运营商绑定失败'],
+ ['code' => 'MallAxnModeLimited', 'message' => 'The operation is not supported by Mall AXN mode.', 'http_code' => 400, 'description' => '商城号限制'],
+ ['code' => 'MissingParameterPoolKey', 'message' => 'The specified PoolKey does not exist.', 'http_code' => 400, 'description' => '号池不存在'],
+ ['code' => 'NoAvailableNumber', 'message' => 'No available number exists.', 'http_code' => 400, 'description' => '没有可用号码'],
+ ['code' => 'NumberExceed', 'message' => 'The upper limit of privacy numbers you can bind is exceeded.', 'http_code' => 400, 'description' => '一证五号认证失败'],
+ ['code' => 'partnerKey.NotFound', 'message' => 'The resource of "partnerKey" is not found..', 'http_code' => 400, 'description' => '号池key不存在'],
+ ['code' => 'PoolKeyNotFound', 'message' => 'The specified poolKey does not exist.', 'http_code' => 400, 'description' => '号池不存在'],
+ ['code' => 'POOLKEY_NOT_EXIST', 'message' => 'poolKey not exsit.', 'http_code' => 400, 'description' => '号池key不存在'],
+ ['code' => 'ProductUnsubscribe', 'message' => 'The specified poolKey does not exist.', 'http_code' => 400, 'description' => '号池不存在'],
+ ['code' => 'RamPermissionDenied', 'message' => 'RAM permission is denied.', 'http_code' => 400, 'description' => 'RAM权限DENY'],
+ ['code' => 'SmartSmsContentNotWhite', 'message' => 'Smart SMS content is not configured in the white list.', 'http_code' => 400, 'description' => '智能短信内容未在白名单中配置。'],
+ ['code' => 'SmsContenIllegal', 'message' => 'The SMS content is illegal, Please check and adjust it and try again.', 'http_code' => 400, 'description' => '短信内容非法。'],
+ ['code' => 'SmsSignllegal', 'message' => 'The SMS sign is illegal, Please check and adjust it and try again.', 'http_code' => 400, 'description' => '短信签名非法。'],
+ ['code' => 'SystemErrorOccurred', 'message' => 'A system error occurred.', 'http_code' => 400, 'description' => '系统错误'],
+ ['code' => 'UnbindLockFailed', 'message' => 'Failed to unbind the lock.', 'http_code' => 400, 'description' => '解绑取锁失败'],
+ ['code' => 'UpdateConflict', 'message' => 'An update conflict occurred.', 'http_code' => 400, 'description' => '更新冲突'],
+ ['code' => 'UpdateLockFailed', 'message' => 'Failed to update the lock.', 'http_code' => 400, 'description' => '更新取锁失败'],
+ ['code' => 'XModeLimited', 'message' => 'The operation is not supported by X mode.', 'http_code' => 400, 'description' => '当前操作不支持X模式'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'ap-northeast-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-northeast-2-pop',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-3',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'ap-southeast-5',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-finance-pop',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-gov-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing-nu16-b01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-chengdu',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-edge-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-fujian',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-haidian-cm12-c01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-bj-b01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-finance',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-prod-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-2',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-internal-test-3',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou-test-306',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hongkong-finance-pop',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-huhehaote',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-north-2-gov-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-qingdao-nebula',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et15-b01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-et2-b01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-finance-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-inner',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai-internal-test-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-finance-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-inner',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-st4-d01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shenzhen-su18-b01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-wuhan',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'BindBatchAxg'],
+ ],
+ 'createdAt' => '2026-04-14T12:23:31.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-yushanfang',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'BindAxn'],
+ ],
+ 'createdAt' => '2024-07-24T08:45:29.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhangbei-na61-b01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'BindAxnExtension'],
+ ],
+ 'createdAt' => '2024-06-07T02:40:44.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhangjiakou',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'BindBatchAxg'],
+ ['description' => 'OpenAPI 下线', 'api' => 'DeleteAxgGroup'],
+ ],
+ 'createdAt' => '2023-04-27T09:07:22.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhangjiakou-na62-a01',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'QueryPhoneNoAByTrackNo'],
+ ],
+ 'createdAt' => '2023-03-24T08:21:53.000Z',
+ 'description' => '',
],
[
- 'regionId' => 'cn-zhengzhou-nebula-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'CreatePickUpWaybill'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreatePickUpWaybillPreQuery'],
+ ],
+ 'createdAt' => '2022-05-13T03:11:26.000Z',
+ 'description' => '新增openAPI',
],
[
- 'regionId' => 'eu-central-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'QueryRecordFileDownloadUrl'],
+ ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'QuerySubscriptionDetail'],
+ ],
+ 'createdAt' => '2022-02-22T11:34:12.000Z',
+ 'description' => '部分字段文档非必填调整',
],
[
- 'regionId' => 'eu-west-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'UnbindSubscription'],
+ ['description' => '请求参数发生变更、错误码发生变更', 'api' => 'UpdateSubscription'],
+ ],
+ 'createdAt' => '2022-02-15T07:51:20.000Z',
+ 'description' => '修改文档必填项',
],
[
- 'regionId' => 'eu-west-1-oxs',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'QuerySecretNoDetail'],
+ ],
+ 'createdAt' => '2021-12-08T02:27:12.000Z',
+ 'description' => '增加号码属性查询接口',
],
[
- 'regionId' => 'me-east-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'QueryCallStatus'],
+ ],
+ 'createdAt' => '2021-12-08T02:21:10.000Z',
+ 'description' => '添加extension分机号字段',
],
[
- 'regionId' => 'rus-west-1-pop',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'apis' => [
+ ['description' => 'OpenAPI 下线', 'api' => 'CancelPickUpWaybill'],
+ ['description' => 'OpenAPI 下线', 'api' => 'CreatePickUpWaybill'],
+ ],
+ 'createdAt' => '2021-11-25T07:46:29.000Z',
+ 'description' => '添加电商智能隐私通讯API',
],
- [
- 'regionId' => 'us-east-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAxnExtension'],
+ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BuySecretNo'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateBlackNo'],
+ ['threshold' => '12000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateSubscription'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFixedNoAReport'],
+ ['threshold' => '1500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySecretAPhoneNoToCust'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ReleaseSecretNo'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OperateAxgGroup'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePhoneNoAReport'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSecretAPhoneNoToCust'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAxnTrackNo'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySecretNoRemain'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySecretNoDetail'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAxb'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindBatchAxg'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySubsId'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAxg'],
+ ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRecordFileDownloadUrl'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePickUpWaybillPreQuery'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAxgGroup'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindAxn'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddSecretBlacklist'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSecretBlacklist'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTotalPublicUrl'],
+ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QuerySubscriptionDetail'],
+ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSecretAsrDetail'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LockSecretNo'],
+ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnlockSecretNo'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPhoneNoAByTrackNo'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAxgGroup'],
+ ['threshold' => '5000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UnbindSubscription'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelPickUpWaybill'],
+ ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePickUpWaybill'],
],
- [
- 'regionId' => 'us-west-1',
- 'endpoint' => 'dyplsapi.aliyuncs.com',
+ 'product' => ['code' => 'dypls', 'title' => '号码隐私保护'],
+ ],
+ 'ram' => [
+ 'productCode' => 'PhoneNumberProtection',
+ 'productName' => '号码隐私保护',
+ 'ramCodes' => ['dypls'],
+ 'ramLevel' => '服务级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'QueryPhoneNoAByTrackNo',
+ 'description' => '进行运单号广播推送',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QueryPhoneNoAByTrackNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QuerySubsId',
+ 'description' => '查询号码绑定ID',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySubsId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddAxnTrackNo',
+ 'description' => '为AXN隐私号添加运单号',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:AddAxnTrackNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSecretAsrDetail',
+ 'description' => '获取ASR识别结果详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:GetSecretAsrDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QuerySubscriptionDetail',
+ 'description' => '查询号码绑定详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySubscriptionDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BindAxn',
+ 'description' => 'AXN隐私号-号码绑定',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxn',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnbindSubscription',
+ 'description' => '解除已绑定的号码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UnbindSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UnlockSecretNo',
+ 'description' => '解锁号码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UnlockSecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'OperateBlackNo',
+ 'description' => '新增或删除黑名单',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:OperateBlackNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddSecretBlacklist',
+ 'description' => '添加黑名单',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:AddSecretBlacklist',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BindBatchAxg',
+ 'description' => '批量添加AXG号码的绑定关系',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:BindBatchAxg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateSubscription',
+ 'description' => '修改已绑定的号码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:UpdateSubscription',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTotalPublicUrl',
+ 'description' => '获取响铃放音的录音下载链接',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:GetTotalPublicUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAxgGroup',
+ 'description' => '删除G号码组',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteAxgGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'OperateAxgGroup',
+ 'description' => '修改G号码组',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:OperateAxgGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QuerySecretNoDetail',
+ 'description' => '查询隐私号码属性',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QuerySecretNoDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BindAxb',
+ 'description' => 'AXB中间号-号码绑定',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxb',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BindAxnExtension',
+ 'description' => 'AXN分机号-号码绑定',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxnExtension',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BindAxg',
+ 'description' => 'AXG隐私号-号码绑定',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:BindAxg',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateAxgGroup',
+ 'description' => '创建G号码组',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'dypls:CreateAxgGroup',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ReleaseSecretNo',
+ 'description' => '释放号码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:ReleaseSecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteSecretBlacklist',
+ 'description' => '删除黑名单',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'dypls:DeleteSecretBlacklist',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryRecordFileDownloadUrl',
+ 'description' => '获取录音文件的下载链接',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'dypls:QueryRecordFileDownloadUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'LockSecretNo',
+ 'description' => '锁定号码',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'dypls:LockSecretNo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'PhoneNumberProtection', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 18:37:05 +0000