diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/dyplsapi/2017-05-25 | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/dyplsapi/2017-05-25')
| -rw-r--r-- | data/en_us/dyplsapi/2017-05-25/api-docs.php | 11821 |
1 files changed, 11821 insertions, 0 deletions
diff --git a/data/en_us/dyplsapi/2017-05-25/api-docs.php b/data/en_us/dyplsapi/2017-05-25/api-docs.php new file mode 100644 index 0000000..35eae38 --- /dev/null +++ b/data/en_us/dyplsapi/2017-05-25/api-docs.php @@ -0,0 +1,11821 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dyplsapi', + 'version' => '2017-05-25', + ], + 'directories' => [ + [ + 'id' => 204593, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DeleteSecretAPhoneNoToCust', + 'QuerySecretAPhoneNoToCust', + 'CreateFixedNoAReport', + 'GetDyplsOSSInfoForUploadFile', + 'CreatePhoneNoAReport', + ], + ], + [ + 'id' => 126550, + 'title' => 'Number Binding', + 'type' => 'directory', + 'children' => [ + 'BindAxb', + 'BindAxn', + 'BindAxnExtension', + 'BindAxg', + 'BindBatchAxg', + 'UpdateSubscription', + 'UnbindSubscription', + ], + ], + [ + 'id' => 126560, + 'title' => 'Status Query', + 'type' => 'directory', + 'children' => [ + 'QuerySubscriptionDetail', + 'QuerySubsId', + 'QuerySecretNoDetail', + ], + ], + [ + 'id' => 192616, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateAxgGroup', + 'OperateAxgGroup', + 'DeleteAxgGroup', + ], + ], + [ + 'id' => 126565, + 'title' => 'Recording and ASR acquisition', + 'type' => 'directory', + 'children' => [ + 'QueryRecordFileDownloadUrl', + 'GetTotalPublicUrl', + 'GetSecretAsrDetail', + ], + ], + [ + 'id' => 126575, + 'title' => 'number resource management', + 'type' => 'directory', + 'children' => [ + 'AddSecretBlacklist', + 'DeleteSecretBlacklist', + 'OperateBlackNo', + 'QuerySecretNoRemain', + 'BuySecretNo', + 'ReleaseSecretNo', + 'LockSecretNo', + 'UnlockSecretNo', + ], + ], + [ + 'id' => 126569, + 'title' => 'E-commerce logistics industry interface', + 'type' => 'directory', + 'children' => [ + 'CreatePickUpWaybillPreQuery', + 'CreatePickUpWaybill', + 'CancelPickUpWaybill', + 'AddAxnTrackNo', + 'QueryPhoneNoAByTrackNo', + ], + ], + [ + 'id' => 199020, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'UnBindAXB', + 'BindXB', + 'BindAXBCall', + 'UnBindXB', + 'QuerySoundRecord', + 'CreateSmsSign', + 'ListXTelephones', + 'GetXConfig', + 'ConfigX', + 'GetXDefaultConfig', + ], + ], + [ + 'id' => 320433, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'BindAxb700', + 'BindGxb700', + 'UpdateSubs700', + 'UnbindSubs700', + ], + ], + [ + 'id' => 205486, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'DeleteAxnExtensionBindFixedLine', + 'UpdateAxnExtensionBindFixedLine', + 'QueryAxbBindFixedLine', + 'UpdateAxnBindFixedLine', + 'UpdateAxbBindFixedLine', + 'BindAxnExtensionFixedLine', + 'QueryAxnBindFixedLine', + 'DeleteAxnBindFixedLine', + 'QueryAxnExtensionBindFixedLine', + 'BindAxnFixedLine', + 'BindAxbFixedLine', + 'DeleteAxbBindFixedLine', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'DeleteSecretAPhoneNoToCust' => [ + 'summary' => 'A号码报备数据删除', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'required' => true, + 'example' => '130*****1234', + ], + ], + [ + 'name' => 'ANoWhiteGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码组ID', + 'description' => 'A号码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '51', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '号码组不存在', + ], + 'Data' => [ + 'title' => '删除是否成功', + 'description' => '删除是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'title' => '请求状态码', + 'description' => '请求状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'QuerySecretAPhoneNoToCust' => [ + 'summary' => 'A号码报备状态查询', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'required' => true, + 'example' => '130*****8888', + ], + ], + [ + 'name' => 'ANoWhiteGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '号码组ID', + 'description' => '号码组ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '58', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '号码组不存在', + ], + 'Data' => [ + 'title' => 'A号码报备状态查询结构体', + 'description' => 'A号码报备状态查询结构体', + 'type' => 'object', + 'properties' => [ + 'NoType' => [ + 'title' => '号码类型', + 'description' => '号码类型', + 'type' => 'string', + 'example' => 'Mobile', + ], + 'CustPhoneNo' => [ + 'title' => '固话报备的经办人/法人电话', + 'description' => '固话报备的经办人/法人电话', + 'type' => 'string', + 'example' => '130*****8888', + ], + 'ReportResult' => [ + 'title' => '报备失败原因', + 'description' => '报备失败原因', + 'type' => 'string', + 'example' => '["系统判断为不同人"]', + ], + 'ReportStatus' => [ + 'title' => '报备结果', + 'description' => '报备结果', + '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' => '***报备', + ], + ], + ], + 'Code' => [ + 'title' => '请求状态码', + 'description' => '请求状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + '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 \\"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"}]', + ], + 'CreateFixedNoAReport' => [ + 'summary' => '通过API收集小号a号码固话', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'FixedNoA', + 'in' => 'query', + 'schema' => [ + 'title' => 'a号码(固话)', + 'description' => 'a号码(固话)', + 'type' => 'string', + 'required' => true, + 'example' => '89*****1234', + ], + ], + [ + 'name' => 'ANoWhiteGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '所属a号码组id', + 'description' => '所属a号码组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12', + ], + ], + [ + 'name' => 'DocumentType', + 'in' => 'query', + 'schema' => [ + 'title' => '证件类型 填写1表示身份证', + 'description' => '证件类型 填写1表示身份证', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustName', + 'in' => 'query', + 'schema' => [ + 'title' => '姓名', + 'description' => '姓名', + 'type' => 'string', + 'required' => true, + 'example' => '赵**', + ], + ], + [ + 'name' => 'DocumentNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '证件号码', + 'description' => '证件号码', + 'type' => 'string', + 'required' => true, + 'example' => '370*********', + ], + ], + [ + 'name' => 'CustType', + 'in' => 'query', + 'schema' => [ + 'title' => '固话客户类型 1:法人,2:经办人', + 'description' => '固话客户类型 1:法人,2:经办人', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'FixedLineWorkId', + 'in' => 'query', + 'schema' => [ + 'title' => '固话申请时服务大厅工单号', + 'description' => '固话申请时服务大厅工单号', + 'type' => 'string', + 'required' => false, + 'example' => '45***12', + ], + ], + [ + 'name' => 'IdCardFrontPhoto', + 'in' => 'query', + 'schema' => [ + 'title' => '身份证正面照片oss路径地址', + 'description' => '身份证正面照片oss路径地址', + 'type' => 'string', + 'required' => false, + 'example' => '123456/test1719383196031.jpg', + ], + ], + [ + 'name' => 'IdCardBackPhoto', + 'in' => 'query', + 'schema' => [ + 'title' => '身份证反面照片oss路径地址', + 'description' => '身份证反面照片oss路径地址', + 'type' => 'string', + 'required' => false, + 'example' => '123456/test1719383196032.jpg', + ], + ], + [ + 'name' => 'IdCardAlivePhoto', + 'in' => 'query', + 'schema' => [ + 'title' => '正面人像照片 OSS 路径地址', + 'description' => '正面人像照片 OSS 路径地址', + 'type' => 'string', + 'required' => true, + 'example' => '123456/test1719383196033.jpg', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '备注（客户自己的业务备注，可编辑）', + 'description' => '备注（客户自己的业务备注，可编辑）', + 'type' => 'string', + 'required' => false, + 'example' => '***报备', + ], + ], + [ + 'name' => 'CustPhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人/法人电话', + 'description' => '经办人/法人电话', + 'type' => 'string', + 'required' => false, + 'example' => '130*****8888', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '示例值示例值', + ], + 'Data' => [ + 'title' => 'A号码报备结果结构体', + 'description' => 'A号码报备结果结构体', + 'type' => 'object', + 'properties' => [ + 'CreateResult' => [ + 'title' => '创建结果', + 'description' => '创建结果', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailType' => [ + 'title' => '创建类型枚举，1为成功，负数为创建失败', + 'description' => '创建类型枚举，1为成功，负数为创建失败', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '请求状态码', + 'description' => '请求状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + '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"}]', + ], + 'GetDyplsOSSInfoForUploadFile' => [ + 'summary' => '隐私号上传文件，获取 OSS 信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'phone_card', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'LTAI***pSvPz', + ], + 'Signature' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BXwW**********aoZH', + ], + 'Host' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://alicom-**********-cn-zhangjiakou.aliyuncs.com', + ], + 'ExpireTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1744613007', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'CreatePhoneNoAReport' => [ + 'summary' => '通过API收集小号a号码手机号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'parameters' => [ + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'title' => '手机号', + 'description' => '手机号', + 'type' => 'string', + 'required' => true, + 'example' => '130*****1234', + ], + ], + [ + 'name' => 'ANoWhiteGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '所属a号码组id', + 'description' => '所属a号码组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '19', + ], + ], + [ + 'name' => 'DocumentType', + 'in' => 'query', + 'schema' => [ + 'title' => '证件类型 填写1表示身份证', + 'description' => '证件类型 填写1表示身份证', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CustName', + 'in' => 'query', + 'schema' => [ + 'title' => '姓名', + 'description' => '姓名', + 'type' => 'string', + 'required' => true, + 'example' => '赵**', + ], + ], + [ + 'name' => 'DocumentNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '证件号码', + 'description' => '证件号码', + 'type' => 'string', + 'required' => true, + 'example' => '370*********', + ], + ], + [ + 'name' => 'IdCardFrontPhoto', + 'in' => 'query', + 'schema' => [ + 'title' => '身份证正面照片oss路径地址', + 'description' => '身份证正面照片oss路径地址', + 'type' => 'string', + 'required' => false, + 'example' => '123456/test1719383196031.jpg', + ], + ], + [ + 'name' => 'IdCardBackPhoto', + 'in' => 'query', + 'schema' => [ + 'title' => '身份证反面照片oss路径地址', + 'description' => '身份证反面照片oss路径地址', + 'type' => 'string', + 'required' => false, + 'example' => '123456/test1719383196032.jpg', + ], + ], + [ + 'name' => 'IdCardAlivePhoto', + 'in' => 'query', + 'schema' => [ + 'title' => '半身照oss路径地址', + 'description' => '半身照oss路径地址', + 'type' => 'string', + 'required' => true, + 'example' => '123456/test1719383196033.jpg示例值', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '备注（客户自己的业务备注，可编辑）', + 'description' => '备注（客户自己的业务备注，可编辑）', + 'type' => 'string', + 'required' => false, + 'example' => '***报备', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '手机号码***已存在', + ], + 'Data' => [ + 'title' => 'A号码报备结果结构体', + 'description' => 'A号码报备结果结构体', + 'type' => 'object', + 'properties' => [ + 'CreateResult' => [ + 'title' => '创建结果', + 'description' => '创建结果', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailType' => [ + 'title' => '创建类型枚举，1为成功，负数为创建失败', + 'description' => '创建类型枚举，1为成功，负数为创建失败', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '请求状态码', + 'description' => '请求状态码', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => '请求是否成功', + '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"}]', + ], + 'BindAxb' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72608', + 'abilityTreeNodes' => [ + 'FEATUREdyplsU6B07Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FC5526*****', + ], + ], + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number A in the AXB binding.'."\n" + ."\n" + .'Phone number A can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'PhoneNoB', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number B in the AXB binding. If phone number A is used to call phone number X, the call is forwarded to phone number B. Phone number B can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n" + ."\n" + .'> If you need to update phone number B, call the [UpdateSubscription](~~110253~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number X in the AXB binding.'."\n" + ."\n" + .'Phone number X is the phone number that you purchased in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) or by using the [BuySecretNo](~~110266~~) operation before you bind a phone number. Phone number X is used to forward calls.'."\n" + ."\n" + .'If you do not specify this parameter, a random phone number is selected from the phone number pool based on the value of the ExpectCity parameter and is used as phone number X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the AXB binding.'."\n" + ."\n" + .'> The expiration time must be more than 1 minute later than the time when you call this API operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-05 12:00:00', + ], + ], + [ + 'name' => 'ExpectCity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the city to which phone number X to be selected belongs.'."\n" + ."\n" + .'* If no phone number for the specified city is available in the current phone number pool or this parameter is not specified, a phone number that belongs to another city is randomly selected from the current phone number pool and assigned as phone number X.'."\n" + .'* If**Number X Assignment Mode** is set to **Strict Matching Mode** and no phone number meets the requirement, the system displays an allocation error.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'IsRecordingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to record all calls made by the bound phone numbers. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field for the external business. This parameter is returned in a call record receipt.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'OutOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external business.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '34553330****', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of the one-way call restriction. Valid values:'."\n" + ."\n" + .'* **CONTROL_AX_DISABLE**: Phone number A cannot be used to call phone number X.'."\n" + .'* **CONTROL_BX_DISABLE**: Phone number B cannot be used to call phone number X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + 'enum' => [ + 'CONTROL_AX_DISABLE', + 'CONTROL_BX_DISABLE', + 'CONTROL_CLEAR_DISABLE', + ], + ], + ], + [ + 'name' => 'CallDisplayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the phone number display logic in the AXB binding. Fixed value: **1**, indicating that phone number X is displayed on both the calling phone and the called phone.'."\n" + ."\n" + .'> Due to the regulatory restrictions imposed by carriers, the setting to display real phone numbers during calls does not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the ringtone code for enterprise Color Ring Back Tone (CRBT) in the AXB binding.'."\n" + ."\n" + .'* Ringtone setting when phone number A is used to call phone number X in the AXB binding: AXBRing_A'."\n" + .'* Ringtone setting when phone number B is used to call phone number X in the AXB binding: AXBRing_B'."\n" + ."\n" + .'Enterprise CRBT codes: Enterprise CRBT codes can be queried in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account). You can choose **Number Pool Management** > **Enterprise CRBT Management** to view enterprise CRBT codes. You can also upload, delete, or perform other operations on enterprise CRBT codes.'."\n" + ."\n" + .'> The bound enterprise CRBTs are preferentially used. If no enterprise CRBT is set or the setting does not take effect, the enterprise CRBTs at the phone number pool level are used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"AXBRing_B":"1000****1","AXBRing_A":"1000****1"}', + ], + ], + [ + 'name' => 'ASRStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic speech recognition (ASR). Valid values:'."\n" + ."\n" + .'* **false** (default): disables ASR.'."\n" + .'* **true**: enables ASR.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ASRModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ASR model. On the [Automatic Speech Recognition (ASR) Model Management](https://dyplsnext.console.aliyun.com/?spm=5176.12818093.categories-n-products.ddypls.22e616d0a0tEFC#/asr) page, you can view the ID of the ASR model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac', + ], + ], + [ + 'name' => 'CallTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum ringing duration for each number in sequential ringing. Unit: seconds. The value ranges from 5 to 20.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '180', + 'minimum' => '0', + 'example' => '10', + 'default' => '15', + ], + ], + [ + 'name' => 'DtmfConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the dual tone multiple frequency (DTMF) key configuration in the AXB binding. The following content can be configured:'."\n" + ."\n" + .'* endCallIvrPhoneNo: for whom the audio is played, user A or user B.'."\n" + .'* waitingDtmfTime: the maximum waiting time after the first audio is played. The maximum waiting time is 30 seconds.'."\n" + .'* maxLoop: the maximum number of loop playback times of the first audio if the DTMF key is not matched. The maximum number of loop playback times is 5.'."\n" + .'* step1File: the name of the first audio.'."\n" + .'* step2File: the name of the second audio.'."\n" + .'* validKey: the valid key values, such as 1,2. Only two valid key values can be set, and the key values are separated by a comma (,).'."\n" + .'* waitingEndCall: The waiting duration to hang up a call. The waiting duration is allowed by a carrier. The maximum waiting duration is 10 seconds.'."\n", + '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' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050D9369D', + ], + 'SecretBindDTO' => [ + 'description' => 'The information returned after the phone numbers were bound.'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => 'The extension of the phone number.'."\n" + ."\n" + .'> The BindAxb operation does not involve an extension. Ignore this parameter.'."\n", + 'type' => 'string', + 'example' => '130', + ], + 'SubsId' => [ + 'description' => 'The binding ID.'."\n", + 'type' => 'string', + 'example' => '1**************3', + ], + 'SecretNo' => [ + 'description' => 'The private number, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '139****0000', + ], + ], + ], + ], + ], + ], + ], + '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' => 'BindAxb', + 'summary' => 'Adds an AXB binding.', + 'description' => 'Before you add an AXB binding, we recommend that you specify role A and role B in the AXB device certificate (ProductKey, DeviceName, and DeviceSecret) in your business scenario. For example, in a taxi-hailing scenario, role A is the passenger and role B is the driver.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindAxn' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72610', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console ](https://dypls.console.aliyun.com/dypls.htm#/account)and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FC2256****', + ], + ], + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number A in the AXN binding. Phone number A can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'PhoneNoB', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number B in the AXN binding. If phone number A is used to call phone number X, the call is forwarded to phone number B. Phone number B can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n" + ."\n" + .'> If phone number B is not specified in the AXN binding, the system automatically generates a nonexistent number. If phone number A is used to call phone number X, the nonexistent number is returned. If you need to update phone number B, call the [UpdateSubscription](~~110253~~) operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '138****0000', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number X in the AXN binding. Phone number X is the phone number that you purchased in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) or by using the [BuySecretNo](~~110266~~) operation before you bind a phone number. Phone number X is used to forward calls.'."\n" + ."\n" + .'> If you do not specify this parameter, a random phone number is selected from the phone number pool based on the value of the ExpectCity parameter and is used as phone number X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the AXN binding. Unit: seconds.'."\n" + ."\n" + .'> The expiration time must be more than 60 seconds later than the time when you call this API operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2021-09-05 12:00:00', + ], + ], + [ + 'name' => 'ExpectCity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the city to which phone number X to be selected belongs.'."\n" + ."\n" + .'* If no phone number for the specified city is available in the current phone number pool or this parameter is not specified, a phone number that belongs to another city is randomly selected from the current phone number pool and assigned as phone number X.'."\n" + .'* If **Number X Assignment Mode** is set to **Strict Matching Mode** and no phone number meets the requirement, the system displays an allocation error.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'IsRecordingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to record all calls made by the bound phone numbers. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'NoType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the phone number.'."\n" + ."\n" + .'> This parameter is applicable to the key accounts of Alibaba Cloud. This parameter can be ignored for Alibaba Cloud users.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AXB_170', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field for the external business. This parameter is returned in a call record receipt.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'OutOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external business.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '34553330****', + ], + ], + [ + 'name' => 'CallDisplayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the phone number display logic in the AXN binding. Fixed value: **1**, indicating that phone number X is displayed on both the calling phone and the called phone.'."\n" + ."\n" + .'> Due to the regulatory restrictions imposed by carriers, the setting to display real phone numbers during calls does not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the ringtone code for enterprise Color Ring Back Tone (CRBT) in the AXN extension binding.'."\n" + ."\n" + .'* Ringtone setting (with a callback number) when phone number A is used to call phone number X in the AXN extension binding: AXNRing_AB'."\n" + .'* Ringtone setting (without a callback number) when phone number A is used to call phone number X in the AXN extension binding: AXNRing_A'."\n" + .'* Ringtone setting when an N-side number is used to call phone number X in the AXN extension binding: AXNRing_N'."\n" + ."\n" + .'Enterprise CRBT codes: Enterprise CRBT codes can be queried in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account). You can choose **Number Pool Management > Enterprise CRBT Management** to view enterprise CRBT codes. You can also upload, delete, or perform other operations on enterprise CRBT codes.'."\n" + ."\n" + .'> The bound enterprise CRBTs are preferentially used. If no enterprise CRBT is set or the setting does not take effect, the enterprise CRBTs at the phone number pool level are used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"AXNRing_N":"100000001","AXNRing_A":"100000001"}', + ], + ], + [ + 'name' => 'ASRStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic speech recognition (ASR). Valid values:'."\n" + ."\n" + .'* **false** (default): disables ASR.'."\n" + .'* **true**: enables ASR.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ASRModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ASR model. On the [Automatic Speech Recognition (ASR) Model Management](https://dyplsnext.console.aliyun.com/?spm=5176.12818093.categories-n-products.ddypls.22e616d0a0tEFC#/asr) page, you can view the ID of the ASR model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac', + ], + ], + [ + 'name' => 'CallTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => 'The maximum ringing duration for each number in sequential ringing. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '20', + 'minimum' => '5', + 'example' => '10', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of one-way call restrictions. Valid values:'."\n" + ."\n" + .'* **CONTROL_AX_DISABLE**: Phone number A cannot be used to call phone number X.'."\n" + .'* **CONTROL_BX_DISABLE**: Phone number B cannot be used to call phone number X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'SecretBindDTO' => [ + 'description' => 'The information returned after the phone numbers were bound.'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => 'The extension of the phone number.'."\n" + ."\n" + .'> The BindAxn operation does not involve an extension. Ignore this parameter.'."\n", + 'type' => 'string', + 'example' => '130', + ], + 'SubsId' => [ + 'description' => 'The binding ID.'."\n", + 'type' => 'string', + 'example' => '1***************3', + ], + 'SecretNo' => [ + 'description' => 'The private number, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '139****0000', + ], + ], + ], + ], + ], + ], + ], + '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' => 'BindAxn', + 'summary' => 'Adds an AXN binding.', + 'description' => '> An AXN private number is a dedicated private number assigned to phone number A. When an N-side number is used to call phone number X, the call is forwarded to phone number A.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindAxnExtension' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72611', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number A in the AXN extension binding. Phone number A can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension of phone number X. The extension is 1 to 3 digits in length.'."\n" + ."\n" + .'> If you specify Extension, you must also specify PhoneNoX.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '130', + ], + ], + [ + 'name' => 'PhoneNoB', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number B in the AXN extension binding. When phone number A is used to call phone number X, the call is forwarded to phone number B. If you need to update phone number B, call the [UpdateSubscription](~~110253~~) operation.'."\n" + ."\n" + .'Phone number B can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number X in the AXN extension binding. If you do not specify this parameter, a random phone number is selected from the phone number pool based on the value of the **ExpectCity** parameter and is used as phone number X.'."\n" + ."\n" + .'> Phone number X is the phone number that you purchased in the Phone Number Protection console or by using the [BuySecretNo](~~110266~~) operation before you bind a phone number. Phone number X is used to forward calls.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the AXN extension binding. The value is accurate to seconds.'."\n" + ."\n" + .'> The expiration time must be more than 1 minute later than the time when you call this API operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-09-05 12:00:00', + ], + ], + [ + 'name' => 'ExpectCity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the city to which phone number X to be selected belongs.'."\n" + ."\n" + .'* If no phone number for the specified city is available in the current phone number pool or this parameter is not specified, a phone number that belongs to another city is randomly selected from the current phone number pool and assigned as phone number X.'."\n" + .'* If Number X Assignment Mode is set to Strict Matching Mode and no phone number meets the requirement, the system displays an allocation error.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'IsRecordingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to record all calls made by the bound phone numbers. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false** (default)'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field for the external business. This parameter is returned in a call record receipt.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'OutOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external business.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'CallDisplayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the phone number display logic in the AXN extension binding. Fixed value: **1**, indicating that phone number X is displayed on both the calling phone and the called phone.'."\n" + ."\n" + .'> Due to the regulatory restrictions imposed by carriers, the setting to display real phone numbers during calls does not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the ringtone for enterprise Color Ring Back Tone (CRBT) in the AXN extension binding.'."\n" + ."\n" + .'* Ringtone setting (with a callback number) when phone number A is used to call phone number X in the AXN extension binding: AXNRing_AB'."\n" + .'* Ringtone setting (without a callback number) when phone number A is used to call phone number X in the AXN extension binding: AXNRing_A'."\n" + .'* Ringtone setting when an N-side number is used to call phone number X in the AXN extension binding: AXNRing_N'."\n" + ."\n" + .'Enterprise CRBT codes: Enterprise CRBT codes can be queried in the Phone Number Protection console. You can choose **Number Pool Management > Enterprise CRBT Management** to view and manage enterprise CRBT codes. You can also upload, delete, or perform other operations on enterprise CRBT codes.'."\n" + ."\n" + .'> The bound enterprise CRBTs are preferentially used. If no enterprise CRBT is set or the setting does not take effect, the enterprise CRBTs at the phone number pool level are used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"AXNRing_N":"100000001","AXNRing_A":"100000001"}', + ], + ], + [ + 'name' => 'ASRStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic speech recognition (ASR). Valid values:'."\n" + ."\n" + .'* **false** (default): disables ASR.'."\n" + .'* **true**: enables ASR.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'True', + ], + ], + [ + 'name' => 'ASRModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ASR model. On the [Automatic Speech Recognition (ASR) Model Management](https://dyplsnext.console.aliyun.com/?spm=5176.12818093.categories-n-products.ddypls.22e616d0a0tEFC#/asr) page, you can view the ID of the ASR model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '980abddb908f48e8b987cb2cd303****', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of call restrictions. Valid values:'."\n" + ."\n" + .'* **CONTROL_AX_DISABLE**: Phone number A cannot be used to call phone number X.'."\n" + .'* **CONTROL_BX_DISABLE**: Phone number B cannot be used to call phone number X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + [ + 'name' => 'Extend', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050D9369D', + ], + 'SecretBindDTO' => [ + 'description' => 'The information returned after the phone numbers were bound.'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => 'The extension of the phone number.'."\n", + 'type' => 'string', + 'example' => '130', + ], + 'SubsId' => [ + 'description' => 'The binding ID.'."\n", + 'type' => 'string', + 'example' => '1***************3', + ], + 'SecretNo' => [ + 'description' => 'The private number, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '139*****0000', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'BindAxnExtension', + 'summary' => 'Adds an AXN extension binding.', + 'description' => 'Before you add an AXN extension binding, confirm phone number A and phone number N in the business scenario. Phone number A belongs to a customer, and phone number X is the private number assigned to the customer. When any other phone number is used to call phone number X and the extension, the call is transferred to phone number A. When phone number A is used to call phone number X, the call is transferred to the default phone number B that is specified during the phone number binding.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindAxg' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72609', + 'abilityTreeNodes' => [ + 'FEATUREdyplsNPUT41', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number A in the AXG binding. Phone number A can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The group ID in the AXG binding. You can view the group ID by using either of the following methods:'."\n" + ."\n" + .'* On the **Number Pool Management** page in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account), filter AXG privacy numbers and click **Number Group G Management** to view the group IDs of number groups G.****'."\n" + .'* If the [CreateAxgGroup](~~110250~~) operation is called to create number group G, the value of **GroupId** in the response of the CreateAxgGroup operation is specified as the value of the request parameter **GroupId** of the BindAxg operation.'."\n" + ."\n" + .'> Number group G must have one or more phone numbers.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PhoneNoB', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number B in the AXG binding. If phone number A is used to call phone number X, the call is forwarded to phone number B. If you need to update phone number B, call the [UpdateSubscription](~~110253~~) operation.'."\n" + ."\n" + .'Phone number B can be set to a mobile phone number or a landline phone number. The landline phone number must be added with an area code, and no hyphen is required between the area code and the landline phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number X in the AXG binding. If you do not specify this parameter, a random phone number is selected from the phone number pool based on the value of the **ExpectCity** parameter and is used as phone number X.'."\n" + ."\n" + .'> Phone number X is the phone number that you purchased in the Phone Number Protection console or by using the [BuySecretNo](~~110266~~) operation before you bind a phone number. Phone number X is used to forward calls.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => 'The expiration time of the AXG binding. The value is accurate to seconds.'."\n" + ."\n" + .'> The expiration time must be more than 1 minute later than the time when you call this API operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-09-05 12:00:00', + ], + ], + [ + 'name' => 'ExpectCity', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the city to which phone number X to be selected belongs.'."\n" + ."\n" + .'* If no phone number for the specified city is available in the current phone number pool or this parameter is not specified, a phone number that belongs to another city is randomly selected from the current phone number pool and assigned as phone number X.'."\n" + .'* If Number X Assignment Mode is set to Strict Matching Mode and no phone number meets the requirement, the system displays an allocation error.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'IsRecordingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to record all calls made by the bound phone numbers.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field for the external business. This parameter is returned in a call record receipt.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'OutOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external business.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'CallDisplayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the phone number display logic in the AXG binding. Fixed value: **1**, indicating that phone number X is displayed on both the calling phone and the called phone.'."\n" + ."\n" + .'> Due to the regulatory restrictions imposed by carriers, the setting to display real phone numbers during calls does not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Sets the ringtone for enterprise Color Ring Back Tone (CRBT) in the AXG binding.'."\n" + ."\n" + .'* Ringtone setting (with a callback number) when phone number A is used to call phone number X in the AXG binding: AXGRing_AB'."\n" + .'* Ringtone setting (without a callback number) when phone number A is used to call phone number X in the AXG binding: AXGRing_A'."\n" + .'* Ringtone setting when a phone number in number group G is used to call phone number X in the AXG binding: AXGRing_G'."\n" + .'* Enterprise CRBT codes: Enterprise CRBT codes can be queried in the Phone Number Protection console. You can choose **Number Pool Management > Enterprise CRBT Management** to view and manage enterprise CRBT codes. You can also upload, delete, or perform other operations on enterprise CRBT codes.'."\n" + ."\n" + .'> The bound enterprise CRBTs are preferentially used. If no enterprise CRBT is set or the setting does not take effect, the enterprise CRBTs at the phone number pool level are used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"AXGRing_AB":"100000001","AXGRing_A":"100000002","AXGRing_G":"100000003"}', + ], + ], + [ + 'name' => 'ASRStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic speech recognition (ASR). Valid values:'."\n" + ."\n" + .'* **False** (default): disables ASR.'."\n" + .'* **True**: enables ASR.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + ], + [ + 'name' => 'ASRModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ASR model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '980abddb908f48e8b987cb2cd303****', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => 'The status of call restrictions. Valid values:'."\n" + ."\n" + .'* **CONTROL_AX_DISABLE**: Phone number A cannot be used to call phone number X.'."\n" + .'* **CONTROL_BX_DISABLE**: Phone number B cannot be used to call phone number X.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'SecretBindDTO' => [ + 'description' => 'The information returned after the phone numbers were bound.'."\n", + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => 'The extension of the phone number.'."\n" + ."\n" + .'> The BindAxg operation does not involve an extension. Ignore this parameter.'."\n", + 'type' => 'string', + 'example' => '139****0000', + ], + 'SubsId' => [ + 'description' => 'The binding ID.'."\n", + 'type' => 'string', + 'example' => '1************3', + ], + 'SecretNo' => [ + 'description' => 'The private number, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '139****0000', + ], + ], + ], + ], + ], + ], + ], + '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' => 'BindAxg', + 'summary' => 'Adds an AXG binding.', + 'description' => 'An AXG protection solution can be configured to meet the requirements for grading users, limiting the scope of calls, and restricting order snatching. The letter G represents a phone number group to which you can add phone numbers as needed.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'BindBatchAxg' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '175378', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FC2235****', + ], + ], + [ + 'name' => 'AxgBindList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhoneNoA' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '13333333333', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + 'PhoneNoB' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '13333333333', + ], + 'PhoneNoX' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '13333333333', + ], + 'ExpectCity' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'IsRecordingEnabled' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'False', + ], + 'OutId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '18223ad447910fd', + ], + 'Expiration' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-11 01:05:15', + ], + 'OutOrderId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20220824021816883677', + ], + 'CallDisplayType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'RingConfig' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"AXBRing_B\\":\\"100000002\\",\\"AXBRing_A\\":\\"100000001\\"}', + ], + 'ASRStatus' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ASRModelId' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac', + ], + 'CallRestrict' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + '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, + 'properties' => [ + 'SecretBind' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SecretNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13333333333', + ], + 'SubsId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1000085060515673', + ], + 'Extension' => [ + 'description' => '', + 'type' => 'string', + 'example' => '257', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1234', + ], + 'PhoneNoA' => [ + 'description' => '', + 'type' => 'string', + 'example' => '13333333333', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'isv.INVALID_PARAMETERS', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ringConfig invalid', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateSubscription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72641', + 'abilityTreeNodes' => [ + 'FEATUREdypls13M9H9', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n" + ."\n" + .'> This parameter is required when **ProductType** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'FC122356****', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product type. Valid values:'."\n" + ."\n" + .'* **AXB\\_170**'."\n" + .'* **AXN\\_170**'."\n" + .'* **AXN\\_95**'."\n" + .'* **AXN_EXTENSION_REUSE**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is applicable to the original key accounts of Alibaba Cloud. This parameter can be ignored for Alibaba Cloud users.'."\n" + ."\n" + .'* This parameter is required when **PoolKey** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AXB_170', + ], + ], + [ + 'name' => 'SubsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The binding ID.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account), choose **Number and Number Pool** > **Number Management**. On the Number Management page, select the desired record and click Details to view the binding ID. Alternatively, you can view the value of the **SubsId** parameter returned by an API operation for a phone number binding such as BindAxb. The value of this parameter indicates a binding ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100000076879****', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number X in the phone number binding.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'PhoneNoA', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number A in the phone number binding.'."\n" + ."\n" + .'> This parameter is required when **OperateType** is set to **updateNoA**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'PhoneNoB', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number B in the phone number binding.'."\n" + ."\n" + .'> This parameter is required when **OperateType** is set to **updateNoB**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of number group G in the phone number binding.'."\n" + ."\n" + .'> This parameter is required when **OperateType** is set to **updateAxgGroup**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => 'One-way call restrictions. Valid values:'."\n" + ."\n" + .'* **CONTROL_AX_DISABLE**: Phone number A cannot be used to call phone number X.'."\n" + .'* **CONTROL_BX_DISABLE**: Phone number B cannot be used to call phone number X.'."\n" + .'* **CONTROL_CLEAR_DISABLE**: The call restrictions are cleared.'."\n" + ."\n" + .'> This parameter is required when **OperateType** is set to **updateCallRestrict**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_BX_DISABLE ', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the expiration time of the phone number binding.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is required when **OperateType** is set to **updateExpire**.'."\n" + ."\n" + .'* The expiration time must be more than 1 minute later than the time when you call this API operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2019-09-05 12:00:00', + ], + ], + [ + 'name' => 'CallDisplayType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the phone number display logic in the phone number binding. Fixed value: **1**, indicating that phone number X is displayed on both the calling phone and the called phone.'."\n" + ."\n" + .'> Due to the regulatory restrictions imposed by carriers, the setting to display real phone numbers during calls does not take effect.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the value of the OutId parameter in the phone number binding.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'IsRecordingEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Re-sets the recording status in the phone number binding.'."\n" + ."\n" + .'> This parameter does not have a default value. If you do not specify this parameter, the value of the corresponding field is not updated.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The operation to modify the phone number binding. Valid values:'."\n" + ."\n" + .'* **updateNoA**: modifies phone number A.'."\n" + .'* **updateNoB**: modifies phone number B.'."\n" + .'* **updateExpire**: modifies the validity period of the binding.'."\n" + .'* **updateAxgGroup**: modifies number group G.'."\n" + .'* **updateCallRestrict**: modifies one-way call restrictions.'."\n" + .'* **updateCallDisplayType**: updates the number display logic for calls.'."\n" + .'* **updateOutId**: updates the value of the OutId parameter.'."\n" + .'* **updateIsRecordingEnabled**: updates the status of the recording feature in the binding.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'updateNoA', + ], + ], + [ + 'name' => 'RingConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'Updates the ringtone code for enterprise Color Ring Back Tone (CRBT) in the phone number binding.'."\n" + ."\n" + .'AXB product:'."\n" + ."\n" + .'* Ringtone setting when phone number A is used to call phone number X in the AXB binding: AXBRing_A'."\n" + .'* Ringtone setting when phone number B is used to call phone number X in the AXB binding: AXBRing_B'."\n" + ."\n" + .'AXN product:'."\n" + ."\n" + .'* Ringtone setting (with a callback number) when phone number A is used to call phone number X in the AXN extension binding: AXNRing_AB'."\n" + .'* Ringtone setting (without a callback number) when phone number A is used to call phone number X in the AXN extension binding: AXNRing_A'."\n" + .'* Ringtone setting when phone number N is used to call phone number X in the AXN extension binding: AXNRing_N'."\n" + ."\n" + .'AXG product:'."\n" + ."\n" + .'* Ringtone setting (with a callback number) when phone number A is used to call phone number X in the AXG binding: AXGRing_AB'."\n" + .'* Ringtone setting (without a callback number) when phone number A is used to call phone number X in the AXG binding: AXGRing_A'."\n" + .'* Ringtone setting when a phone number in number group G is used to call phone number X in the AXG binding: AXGRing_G'."\n" + ."\n" + .'Enterprise CRBT codes: Enterprise CRBT codes can be queried in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account). You can choose **Number Pool Management** > **Enterprise CRBT Management** to view and manage enterprise CRBT codes. You can also upload, delete, or perform other operations on enterprise CRBT codes.'."\n" + ."\n" + .'> The bound enterprise CRBTs are preferentially used. If no enterprise CRBT is set or the setting does not take effect, the enterprise CRBTs at the phone number pool level are used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"AXBRing_B":"100000001","AXBRing_A":"100000001"}', + ], + ], + [ + 'name' => 'ASRStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable automatic speech recognition (ASR). Valid values:'."\n" + ."\n" + .'* **false** (default): disables ASR.'."\n" + .'* **true**: enables ASR.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ASRModelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the ASR model.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '980abddb908f48e8b987cb2cd303****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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":"<?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' => 'UpdateSubscription', + 'summary' => 'Modifies a phone number binding.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 10,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnbindSubscription' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72636', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n" + ."\n" + .'> This parameter is required when **ProductType** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product type. Fixed value: **AXB\\_170**.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is applicable to the original key accounts of Alibaba Cloud. This parameter can be ignored for Alibaba Cloud users.'."\n" + ."\n" + .'* This parameter is required when **PoolKey** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AXB_170', + ], + ], + [ + 'name' => 'SubsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The binding ID.'."\n" + ."\n" + .'Log on to the Phone Number Protection console, choose **Number and Number Pool** > **Number Management**. On the Number Management page, select the desired record and click Details to view the binding ID. Alternatively, you can view the value of the **SubsId** parameter returned by an API operation for a phone number binding such as BindAxb. The value of this parameter indicates a binding ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1************2', + ], + ], + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number, that is, phone number X specified in an API operation for a phone number binding such as [BindAXG](~~110249~~) or automatically assigned after such an operation is called.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1390000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36', + ], + 'ChargeId' => [ + 'description' => 'A deprecated parameter.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + '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' => 'UnbindSubscription', + 'summary' => 'Unbinds a phone number.', + 'description' => 'Before releasing a phone number, you must call the UnbindSubscription operation to unbind the phone number.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySubscriptionDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72633', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n" + ."\n" + .'> This parameter is required when **ProductType** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product type. Valid values:'."\n" + ."\n" + .'* **AXB\\_170**'."\n" + .'* **AXN\\_170**'."\n" + .'* **AXN\\_95**'."\n" + .'* **AXN_EXTENSION_REUSE**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is applicable to the original key accounts of Alibaba Cloud. This parameter can be ignored for Alibaba Cloud users.'."\n" + ."\n" + .'* This parameter is required when **PoolKey** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AXB_170', + ], + ], + [ + 'name' => 'SubsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The binding ID.'."\n" + ."\n" + .'Log on to the Phone Number Protection console, choose **Number and Number Pool** > **Number Management**. On the Number Management page, select the desired record and click Details to view the binding ID. Alternatively, you can view the value of the **SubsId** parameter returned by an API operation for a phone number binding such as [BindAxb](~~110248~~). The value of this parameter indicates a binding ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100000076879****', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number in the binding, that is, phone number X.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '13900001234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '066E6E47-04CB-4774-A976-4F73CB76D4A3', + ], + 'SecretBindDetailDTO' => [ + 'description' => 'The information returned after the QuerySubscriptionDetail operation was called.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The binding status. Valid values:'."\n" + ."\n" + .'* **0**: The binding expired.'."\n" + .'* **1**: The binding is in effect.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Extension' => [ + 'description' => 'The extension in the AXG extension binding.'."\n", + 'type' => 'string', + 'example' => '130', + ], + 'PhoneNoB' => [ + 'description' => 'Phone number B in the binding.'."\n", + 'type' => 'string', + 'example' => '13900002222', + ], + 'GroupId' => [ + 'description' => 'The ID of number group G in the binding.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000000130001', + ], + 'NeedRecord' => [ + 'description' => 'Indicates whether all calls made by the bound phone numbers are recorded. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ASRStatus' => [ + 'description' => 'Indicates whether automatic speech recognition (ASR) is enabled. Valid values:'."\n" + ."\n" + .'* **false**: ASR is disabled.'."\n" + .'* **true**: ASR is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'GmtCreate' => [ + 'description' => 'The creation time of the binding.'."\n", + 'type' => 'string', + 'example' => '2019-03-05 12:00:00', + ], + 'ExpireDate' => [ + 'description' => 'The expiration time of the binding.'."\n", + 'type' => 'string', + 'example' => '2019-09-05 12:00:00', + ], + 'SubsId' => [ + 'description' => 'The binding ID.'."\n", + 'type' => 'string', + 'example' => '100000076879****', + ], + 'PhoneNoX' => [ + 'description' => 'The private number in the binding, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '13900001234', + ], + 'CallRestrict' => [ + 'description' => 'The status of one-way call restrictions. No value is returned for this parameter if one-way call restrictions are not set. Valid values:'."\n" + ."\n" + .'* **CONTROL_AX_DISABLE**: Phone number A cannot be used to call phone number X.'."\n" + .'* **CONTROL_BX_DISABLE**: Phone number B cannot be used to call phone number X.'."\n", + 'type' => 'string', + 'example' => 'CONTROL_BX_DISABLE ', + ], + 'ASRModelId' => [ + 'description' => 'The ID of the ASR model.'."\n", + 'type' => 'string', + 'example' => '123456', + ], + 'PhoneNoA' => [ + 'description' => 'Phone number A in the binding.'."\n", + 'type' => 'string', + 'example' => '13900001111', + ], + ], + ], + ], + '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' => 'QuerySubscriptionDetail', + 'summary' => 'Queries the details about a phone number binding.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n" + ."\n" + .'### [](#poolkeyproducttype)Limits on PoolKey and ProductType'."\n" + ."\n" + .'You must specify either PoolKey or ProductType. If both parameters are not specified, an error is reported when you call the QuerySubscriptionDetail operation. We recommend that you specify the ProductType parameter for the original key accounts of Alibaba Cloud and the PoolKey parameter for Alibaba Cloud users.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySubsId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72634', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dyplsnext.console.aliyun.com/overview) and view the key of the phone number pool on the Number Pool Management page.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number in the binding, that is, phone number X.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1390000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code. The value OK indicates that the request was successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'E7F99446-8191-43C0-99B5-F58A6AEAD779', + ], + 'SubsId' => [ + 'description' => 'The binding ID.'."\n", + 'type' => 'string', + 'example' => '11111111****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'POOLKEY_NOT_EXIST', + 'errorMessage' => 'poolKey not exsit.', + ], + ], + ], + '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' => 'QuerySubsId', + 'summary' => 'Queries binding IDs.', + 'description' => 'You can query binding IDs by phone number X. In the AXB product, multiple bindings may exist for the same phone number X. In this case, multiple binding IDs may be obtained for the same phone number X.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySecretNoDetail' => [ + 'summary' => 'Queries the attributes of a private number.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '107292', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FC2258****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '066E6E47-04CB-4774-A976-4F73CB76D4A3', + ], + 'SecretNoInfoDTO' => [ + 'description' => 'The attributes of the phone number.'."\n", + 'type' => 'object', + 'properties' => [ + 'PurchaseTime' => [ + 'description' => 'The time when the phone number was purchased.'."\n", + 'type' => 'string', + 'example' => '2021-12-03 15:19:27', + ], + 'Vendor' => [ + 'description' => 'The carrier to which the phone number belongs. Valid values:'."\n" + ."\n" + .'* **1**: China Mobile'."\n" + .'* **2**: China Unicom'."\n" + .'* **3**: China Telecom'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Province' => [ + 'description' => 'The province.'."\n", + 'type' => 'string', + 'example' => 'sichuan', + ], + 'City' => [ + 'description' => 'The city.'."\n", + 'type' => 'string', + 'example' => 'chengdu', + ], + 'SecretStatus' => [ + 'description' => 'The status of the phone number. Valid values:'."\n" + ."\n" + .'* **0**: The phone number is not bound to other phone numbers.'."\n" + .'* **1**: The phone number is bound to other phone numbers.'."\n" + .'* **2**: The phone number is locked.'."\n" + .'* **3**: The phone number is frozen.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'CertifyStatus' => [ + 'description' => 'The verification status of the phone number. Valid values:'."\n" + ."\n" + .'* **0**: The phone number is not verified.'."\n" + .'* **1**: The phone number is verified.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FlowLimited', + 'errorMessage' => 'The operation is denied due to flow control.', + ], + ], + ], + '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' => 'QuerySecretNoDetail', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'CreateAxgGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72614', + 'abilityTreeNodes' => [ + 'FEATUREdyplsNPUT41', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of number group G. If the name of number group G is not specified, the ID of number group G is used as the name of number group G.'."\n" + ."\n" + .'> The value must be 1 to 128 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remarks of number group G. The value must be 0 to 256 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Numbers', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone numbers that you add to number group G. Separate multiple phone numbers with commas (,). A maximum of 200 phone numbers can be added to number group G.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1390000****,1380000**** ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '635C0FDA-9EBC-43D7-B368-9F583C08A126', + ], + 'GroupId' => [ + 'description' => 'The ID of number group G. The value of this parameter is required when the [BindAxg](~~110249~~) operation is called to add an AXG binding.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000000000001', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'CreateAxgGroup', + 'summary' => 'Creates number group G.', + 'description' => 'Before you add an AXG binding, you must purchase phone number X, create number group G, and then add phone numbers to number group G. If you do not add phone numbers to number group G after you create number group G, you can call the [OperateAxgGroup](https://help.aliyun.com/document_detail/110252.htm) operation to add phone numbers to number group G.'."\n" + ."\n" + .'> Up to 2,000 number groups G can be added for a single phone number pool.'."\n", + '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' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The group ID in the AXG binding.'."\n" + ."\n" + .'You can view the group ID by using either of the following methods:'."\n" + ."\n" + .'* On the **Number Pool Management** page in the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account), filter AXG private numbers and click **Number Group G Management** to view the group IDs of number groups G.****'."\n" + .'* If the [CreateAxgGroup](~~110250~~) operation is called to create number group G, the value of **GroupId** in the response of the CreateAxgGroup operation is specified as the value of the request parameter **GroupId** of the OperateAxgGroup operation.'."\n" + ."\n" + .'> Number group G must have one or more phone numbers.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the operation on number group G. Valid values:'."\n" + ."\n" + .'* **addNumbers**: adds phone numbers to number group G.'."\n" + .'* **deleteNumbers**: deletes phone numbers from number group G.'."\n" + .'* **overwriteNumbers**: replaces all phone numbers in number group G. All the original phone numbers are deleted from number group G, and new phone numbers are added to number group G.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* When you replace all phone numbers in number group G, the quantity of original phone numbers in number group G cannot exceed 200.'."\n" + ."\n" + .'* You can add up to 200 phone numbers to number group G at a time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'addNumbers', + ], + ], + [ + 'name' => 'Numbers', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone numbers that you add to number group G. Separate the phone numbers with commas (,). You can add up to 200 phone numbers at a time.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1390000****,1380000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '986BCB6D-C9BF-42F9-91CE-3A9901233D36', + ], + ], + '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":"<OperateAxgGroupResponse>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <RequestId>986BCB6D-C9BF-42F9-91CE-3A9901233D36</RequestId>\\n</OperateAxgGroupResponse>","errorExample":""}]', + 'title' => 'OperateAxgGroup', + 'summary' => 'Modifies number group G.', + 'description' => 'After you create number group G, you can call the OperateAxgGroup operation to modify number group G. For example, you can add phone numbers to number group G, delete phone numbers from number group G, and replace all phone numbers in number group G.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + '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' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC2235****', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050D9369D', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"9297B722-A016-43FB-B51A-E54050D9369D\\"\\n}","type":"json"}]', + ], + 'QueryRecordFileDownloadUrl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72631', + 'abilityTreeNodes' => [ + 'FEATUREdyplsVL8MN2', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n" + ."\n" + .'> This parameter is required when **ProductType** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'ProductType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The product type. Valid values:'."\n" + ."\n" + .'* **AXB\\_170**.'."\n" + .'* **AXN\\_170**.'."\n" + .'* **AXN\\_95**.'."\n" + .'* **AXN_EXTENSION_REUSE**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* This parameter is applicable to the original key accounts of Alibaba Cloud. This parameter can be ignored for Alibaba Cloud users.'."\n" + ."\n" + .'* This parameter is required when **PoolKey** is left empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AXB_170', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the call record. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view **Call Record ID** on the **Call Record Query** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'abcedf1234', + ], + ], + [ + 'name' => 'CallTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The call initiation time in the call record. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account). View **Call Initiated At** on the **Call Record Query** page, or view the call_time field in the Call Detail Record (CDR) receipt.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '2019-03-05 12:00:00 ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AB3CEF7-DCBE-488C-9C33-D180982CE031', + ], + 'DownloadUrl' => [ + 'description' => 'The download URL of the recording file. The download URL is valid for 2 hours.'."\n", + 'type' => 'string', + 'example' => 'http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=155175****&OSSAccessKeyId=LTAIP00vvvv****v&Signature=tK6Yq9KusU4n%2BZ****7lg4/WmEA%3D', + ], + ], + 'description' => '', + ], + ], + ], + '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&OSSAccessKeyId=LTAIP00vvvvvvvvv&Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</DownloadUrl>\\n</QueryRecordFileDownloadUrlResponse>","errorExample":""}]', + 'title' => 'QueryRecordFileDownloadUrl', + 'summary' => 'Obtains the download URL of a recording file.', + 'description' => 'If the recording feature is enabled for a binding, all calls made by the bound phone numbers are recorded. You can obtain the download URL of a recording file by calling the QueryRecordFileDownloadUrl operation and download the recording file.'."\n" + ."\n" + .'> We recommend that you subscribe to [the recording status report SecretRecording](~~109198~~). The values of the response parameters in SecretRecording can be used as the values of the request parameters for downloading a recording file.'."\n" + ."\n" + .'### [](#)Procedure for obtaining a recording file'."\n" + ."\n" + .'1. Specify the request parameter in an update or binding operation to enable the recording feature.'."\n" + .'2. Subscribe to recording message receipts in the Phone Number Protection console.'."\n" + .'3. After a recording message receipt is returned, call the QueryRecordFileDownloadUrl operation to obtain the download URL of the recording file, and download the recording file.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* A download URL is valid for 2 hours. Download the recording file as soon as possible after obtaining a download URL.'."\n" + ."\n" + .'* The storage period of recording files is 30 days. You can download only the recording files of calls recorded in the last 30 days.'."\n", + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether the verification on the binding ID is required.'."\n", + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + [ + 'name' => 'PartnerKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC12256****', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the call record.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view **Call Record ID** on the **Call Record Query** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2568900****', + ], + ], + [ + 'name' => 'CallTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The call initiation time in the call record.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account). View **Call Initiated At** on the **Call Record Query** page, or view the call_time field in the Call Detail Record (CDR) receipt.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-05 12:00:00 ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1AB3CEF7-DCBE-488C-9C33-D180982CE031', + ], + 'Data' => [ + 'description' => 'The download URLs of the recording files.'."\n", + 'type' => 'object', + 'properties' => [ + 'RingPublicUrl' => [ + 'description' => 'The download URL of the recorded ringing tone.'."\n" + ."\n" + .'> The download URL of the recorded ringing tone is valid for 30 days.'."\n", + 'type' => 'string', + 'example' => 'http://secret-ab-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=155175****&OSSAccessKeyId=LTAIP00vvv****vv&Signature=tK6Yq9KusU4n%2BZQW****g4/WmEA%3D', + ], + 'PhonePublicUrl' => [ + 'description' => 'The download URL of the recorded call.'."\n" + ."\n" + .'> The download URL of the recorded call is valid for 30 days.'."\n", + 'type' => 'string', + 'example' => 'http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551****07&OSSAccessKeyId=LTAIP00vvvv****v&Signature=tK6Yq9KusU4n%2BZQWX****4/WmEA%3D', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'FlowLimited', + 'errorMessage' => 'The operation is denied due to flow control.', + ], + ], + ], + '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&OSSAccessKeyId=LTAIP00vvvvvvvvv&Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</RingPublicUrl>\\n <PhonePublicUrl>http://secret-axb-reco****cn-shanghai.aliyuncs.com/1000000820257625_66647243838006067251551752068865.mp3?Expires=1551759607&OSSAccessKeyId=LTAIP00vvvvvvvvv&Signature=tK6Yq9KusU4n%2BZQWXI7lg4/WmEA%3D</PhonePublicUrl>\\n</Data>\\n<Code>OK</Code>\\n</GetTotalPublicUrlResponse>","errorExample":""}]', + 'title' => 'GetTotalPublicUrl', + 'summary' => 'Obtains the download URL of a recorded ringing tone.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSecretAsrDetail' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '72619', + 'abilityTreeNodes' => [ + 'FEATUREdyplsVL8MN2', + ], + ], + 'parameters' => [ + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the call record.'."\n" + ."\n" + .'You can log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view **Call Record ID** on the **Call Record Query** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '225625****', + ], + ], + [ + 'name' => 'CallTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The call initiation time in the call record.'."\n" + ."\n" + .'You can log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account). View **Call Initiated At** on the **Call Record Query** page, or view the call_time field in the Call Detail Record (CDR) receipt.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2019-03-05 12:00:00', + ], + ], + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'You can log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC2267****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The ASR details.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8d2329d407a83447a83be441681f4872ac74nE', + ], + 'BusinessId' => [ + 'description' => 'The ID of the business process.'."\n", + 'type' => 'string', + 'example' => '435ee78c7a019650@!FC100000074672458@!2020061522****', + ], + 'BusinessKey' => [ + 'description' => 'The business keyword.'."\n", + 'type' => 'string', + 'example' => 'JCGTncltuNao****', + ], + 'Code' => [ + 'description' => 'The status code. The status code 21050000 indicates that the request was successful.'."\n", + 'type' => 'string', + 'example' => '21050000', + ], + 'Msg' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'BizDuration' => [ + 'description' => 'The total duration of the audio file that was recognized. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10944', + ], + 'Type' => [ + 'description' => 'The type.'."\n", + 'type' => 'string', + 'example' => 'asrResult', + ], + 'Sentences' => [ + 'description' => 'The ASR result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => 'The end time offset of the sentence. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1770', + ], + 'SilenceDuration' => [ + 'description' => 'The silence duration between the current sentence and the previous sentence. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'BeginTime' => [ + 'description' => 'The start time offset of the sentence. Unit: milliseconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1020', + ], + 'Text' => [ + 'description' => 'The recognition result of the sentence.'."\n", + 'type' => 'string', + 'example' => 'Hello', + ], + 'ChannelId' => [ + 'description' => 'The ID of the audio track to which the sentence belongs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'SpeechRate' => [ + 'description' => 'The average speech rate of the sentence. Unit: number of words per minute.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '80', + ], + 'EmotionValue' => [ + 'description' => 'The emotion value. Value range: 1 to 10. The higher the value, the stronger the emotion.'."\n", + 'type' => 'string', + 'example' => '5.7', + ], + ], + ], + ], + ], + 'example' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'isp.RAM_PERMISSION_DENY', + 'errorMessage' => 'RAM permission is denied.', + ], + ], + ], + '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' => 'GetSecretAsrDetail', + 'summary' => 'Obtains the details of the automatic speech recognition (ASR) result.', + 'description' => 'Before you call the GetSecretAsrDetail operation, set the ASRStatus parameter to true in the [BindAxn operation](~~400483~~). This ensures that you can obtain the ASR result properly.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddSecretBlacklist' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '72607', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the Number Pool Management page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC2235****', + ], + ], + [ + 'name' => 'BlackNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The numbers in the blacklist. A point-to-point blacklist has a pair of numbers separated by a colon (:). A number pool blacklist has only one single number.'."\n" + ."\n" + .'> The asterisks (\\*) in the sample value are not wildcards.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1825638****:1825248****', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The blacklist remarks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Customer service feedback', + ], + ], + [ + 'name' => 'BlackType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The blacklist type. Valid values:'."\n" + ."\n" + .'* **POINT_TO_POINT_BLACK**: point-to-point blacklist.'."\n" + .'* **PARTNER_GLOBAL_NUMBER_BLACK**: number pool blacklist.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'POINT_TO_POINT_BLACK', + ], + ], + [ + 'name' => 'WayControl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The control on the call direction.'."\n" + ."\n" + .'* **PHONEA_REJECT**: The first number in the blacklist can be used to call the second number, but the second number cannot be used to call the first number.'."\n" + .'* **PHONEB_REJECT**: The first number in the blacklist cannot be used to call the second number, but the second number can be used to call the first number.'."\n" + .'* If this parameter is left empty, the two numbers in the blacklist cannot be used to call each other.'."\n" + ."\n" + .'> This parameter is available only for a point-to-point blacklist.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DUPLEX_REJECT'."\n" + .'* PHONEA_REJECT'."\n" + .'* PHONEB_REJECT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PHONEA_REJECT', + 'enum' => [ + 'DUPLEX_REJECT', + 'PHONEA_REJECT', + 'PHONEB_REJECT', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'AddSecretBlacklist', + 'summary' => 'Adds a blacklist.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteSecretBlacklist' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72616', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC1232****', + ], + ], + [ + 'name' => 'BlackNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone numbers in the blacklist. A point-to-point blacklist has a pair of numbers separated by a colon (":"). A number pool blacklist or a platform blacklist has only one single number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '18252***383:18252***483', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The remarks for the blacklist.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fragile', + ], + ], + [ + 'name' => 'BlackType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The blacklist type. Valid values:'."\n" + ."\n" + .'* **POINT_TO_POINT_BLACK**: point-to-point blacklist'."\n" + .'* **PARTNER_GLOBAL_NUMBER_BLACK**: number pool blacklist'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'POINT_TO_POINT_BLACK', + ], + ], + [ + 'name' => 'WayControl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The control on the call direction.'."\n" + ."\n" + .'* **PHONEA_REJECT**: The first phone number in the blacklist can be used to call the second phone number, but the second phone number in the blacklist cannot be used to call the first phone number.'."\n" + .'* **PHONEB_REJECT**: The first phone number in the blacklist cannot be used to call the second phone number, but the second phone number in the blacklist can be used to call the first phone number.'."\n" + .'* If this parameter is not specified, the two phone numbers in the blacklist cannot be used to call each other.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DUPLEX_REJECT'."\n" + .'* PHONEA_REJECT'."\n" + .'* PHONEB_REJECT'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'PHONEA_REJECT', + 'enum' => [ + 'DUPLEX_REJECT', + 'PHONEA_REJECT', + 'PHONEB_REJECT', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'RamPermissionDenied', + 'errorMessage' => 'RAM permission is denied.', + ], + ], + ], + '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' => 'DeleteSecretBlacklist', + 'summary' => 'Deletes a blacklist.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OperateBlackNo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72628', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FC123456****', + ], + ], + [ + 'name' => 'BlackNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number to be added to or deleted from the blacklist.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '150****0000', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the operation on the phone number. Valid values:'."\n" + ."\n" + .'* **AddBlack**: adds the phone number to the blacklist.'."\n" + .'* **DeleteBlack**: deletes the phone number from the blacklist.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'AddBlack', + ], + ], + [ + 'name' => 'Tips', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => 'OperateBlackNo', + 'summary' => 'Adds a phone number to a blacklist or deletes a phone number from a blacklist.', + 'description' => 'The OperateBlackNo operation supports the following number pool types: AXN, AXN extension, and 95AXN.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + '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', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SpecId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the phone number. Valid values:'."\n" + ."\n" + .'* **1**: a phone number assigned by a virtual network operator, that is, a phone number that belongs to the 170 or 171 number segment.'."\n" + .'* **2**: a phone number provided by a carrier.'."\n" + .'* **3**: a phone number that starts with 95.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => 'The home location of the phone number.'."\n" + ."\n" + .'* If **SpecId** is set to 1 or 2, you can specify the **City** parameter to query the quantity of available phone numbers.'."\n" + ."\n" + .'1. You can enter a single city name to perform a query.'."\n" + .'2. You can enter National to query the quantity of remaining phone numbers available in the Chinese mainland for online purchase.'."\n" + .'3. You can enter National List to query the cities with available phone numbers and the quantities of remaining phone numbers in the Chinese mainland. Cities without available phone numbers will not be returned.'."\n" + ."\n" + .'* If **SpecId** is set to 3, home locations are not distinguished for phone numbers that start with 95 and only the quantity of all the remaining phone numbers that start with 95 and are available for online purchase can be queried. If SpecId is set to 3, **City** must be set to **Nationwide**.'."\n" + ."\n" + .'> Home locations can be set to only locations in the Chinese mainland.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the phone number. When you call the QuerySecretNoRemain operation with **SecretNo** specified, the quantity of remaining phone numbers with the specified prefix that are available for online purchase is queried.'."\n" + ."\n" + .'Up to 18 digits of a phone number prefix can be specified.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '130', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2', + ], + 'SecretRemainDTO' => [ + 'description' => 'The information returned after the operation was called.'."\n", + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => 'The quantity of remaining phone numbers available for online purchase.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'City' => [ + 'description' => 'The home location of the phone numbers.'."\n", + 'type' => 'string', + 'example' => 'hangzhou', + ], + 'RemainDTOList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'remainDTO' => [ + 'description' => 'The information about remaining phone numbers available for online purchase.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Amount' => [ + 'description' => 'The quantity of remaining phone numbers available for online purchase for the city.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '120', + ], + 'City' => [ + 'description' => 'The home location of the phone numbers.'."\n", + 'type' => 'string', + 'example' => 'Wuhan', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => 'QuerySecretNoRemain', + 'summary' => 'Queries the quantity of remaining phone numbers available for online purchase.', + 'description' => 'When purchasing a phone number, specify the home location. If no sufficient phone numbers are available for purchase in the home location, the purchase of the phone number fails. Before calling the [BuySecretNo](~~BuySecretNo~~) operation to purchase a phone number, call the [QuerySecretNoRemain](~~QuerySecretNoRemain~~) operation to query the quantity of remaining phone numbers available for online purchase.'."\n", + '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' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'SpecId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the phone number. Valid values:'."\n" + ."\n" + .'* **1**: a phone number assigned by a virtual network operator, that is, a phone number that belongs to the 170 or 171 number segment.'."\n" + .'* **2**: a phone number provided by a carrier.'."\n" + .'* **3**: a phone number that starts with 95.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'City', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies the home location of the phone number.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The home location can be set only to a location in the Chinese mainland.'."\n" + ."\n" + .'* A phone number that starts with 95 does not have a home location. If you purchase a phone number that starts with 95, set this parameter to **Nationwide**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hangzhou', + ], + ], + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of the phone number. If you specify the value of **SecretNo** when you purchase a phone number, a phone number starting with the specified prefix is selected.'."\n" + ."\n" + .'> You can specify up to 18 digits of the phone number prefix.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '130', + ], + ], + [ + 'name' => 'DisplayPool', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to add the phone number to the pool of numbers that will be displayed during calls.'."\n" + ."\n" + .'> This parameter takes effect only for customers who have enabled the number display feature.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020', + ], + 'SecretBuyInfoDTO' => [ + 'description' => 'The information returned after the operation was called.'."\n", + 'type' => 'object', + 'properties' => [ + 'SecretNo' => [ + 'description' => 'The private number, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'BuySecretNo', + 'summary' => 'Purchases a phone number.', + 'description' => '* After you create a phone number pool in the Phone Number Protection console, the phone number pool is empty by default. You must purchase phone numbers and add them to the phone number pool.'."\n" + .'* Before you call this operation, make sure that you are familiar with the [pricing](~~59825~~) of Phone Number Protection.'."\n" + .'* When purchasing a phone number, specify the home location. If no sufficient phone numbers are available for purchase in the home location, the purchase of the phone number fails. Before you call this operation to purchase a phone number, check the quantity of phone numbers available for purchase by using the [QuerySecretNoRemain](~~111699~~) operation.'."\n" + .'* The account used to purchase a phone number must be an enterprise account that has passed real-name verification. For more information about how to perform real-name verification, see [Enterprise verification FAQs](~~37172~~).'."\n", + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'FC123456', + ], + ], + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The prefix of phone numbers. When you call the ReleaseSecretNo operation with **SecretNo** specified, the system performs fuzzy matching against phone numbers based on the prefix.'."\n" + ."\n" + .'> Up to 18 digits of a phone number prefix can be specified.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '130', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '986BCB6D-C9BF-42F9-91CE-3A990121232', + ], + ], + ], + ], + ], + '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' => 'ReleaseSecretNo', + 'summary' => 'Releases a phone number.', + 'description' => '* After a phone number is released, it will no longer be charged from the following month.'."\n" + .'* Before you release a phone number, log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) to check whether the phone number is bound to other phone numbers. The phone number can be released only if it is not bound to other phone numbers.'."\n", + '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', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC123****', + ], + ], + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number that you want to lock. You must enter a complete mobile phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1300000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'LockSecretNo', + 'summary' => 'Locks a phone number.', + 'description' => 'After a phone number is locked, the locked phone number cannot be selected when you call an operation to create a binding.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnlockSecretNo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + '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' => [ + 'description' => 'The key of the phone number pool.'."\n" + ."\n" + .'Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC2256****', + ], + ], + [ + 'name' => 'SecretNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number that you want to unlock. You must enter a complete mobile phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1300000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '2D1AEB96-96D0-454E-B0DC-AE2A8DF08020', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'UnlockSecretNo', + 'summary' => 'Unlocks a phone number.', + 'description' => 'After a phone number is unlocked, you can reselect the unlocked phone number when you call an operation to create a binding.'."\n" + ."\n" + .'### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 500 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreatePickUpWaybillPreQuery' => [ + 'summary' => 'Queries a pickup order.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '133436', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Content-Type', + 'in' => 'header', + 'schema' => [ + 'description' => 'The content type of the HTTP request. This parameter is optional. If you specify this parameter, enter application/json;chatset=UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'application/json;chatset=UTF-8', + 'default' => 'application/json;charset=UTF-8', + ], + ], + [ + 'name' => 'SenderInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The sender information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the sender.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Wang', + ], + 'Mobile' => [ + 'description' => 'The mobile phone number of the sender.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + 'AddressInfo' => [ + 'description' => 'The address of the sender.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => 'The province where the sender is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zhejiang', + ], + 'CityName' => [ + 'description' => 'The city where the sender is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hangzhou', + ], + 'AreaName' => [ + 'description' => 'The district where the sender is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xihu', + ], + 'TownName' => [ + 'description' => 'The street where the sender is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XX Street', + ], + 'AddressDetail' => [ + 'description' => 'The detailed address of the sender.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XX community', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ConsigneeInfo', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The consignee information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the consignee.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Li', + ], + 'Mobile' => [ + 'description' => 'The mobile phone number of the consignee.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + 'AddressInfo' => [ + 'description' => 'The address of the consignee.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => 'The province where the consignee is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Shanxi', + ], + 'CityName' => [ + 'description' => 'The city where the consignee is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Xi,an', + ], + 'AreaName' => [ + 'description' => 'The district where the consignee is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'chang,an', + ], + 'TownName' => [ + 'description' => 'The street where the consignee is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XX Street'."\n", + ], + 'AddressDetail' => [ + 'description' => 'The detailed address of the consignee.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XX community', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'CpCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the courier company. If no courier company is specified, the system allocates a courier company.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'YTO', + ], + ], + [ + 'name' => 'PreWeight', + 'in' => 'query', + 'schema' => [ + 'description' => 'The estimated weight. Unit: gram.'."\n" + ."\n" + .'> If you need to query the estimated price, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2000', + ], + ], + [ + 'name' => 'OuterOrderCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The order number of the access system.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '787DFHHDS989****', + ], + ], + [ + 'name' => 'OrderChannels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The identifier of the external channel source. It cannot contain underscores.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The result set.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'ErrorMsg' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'Code' => [ + 'description' => 'The response code.'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'description' => 'The response content.'."\n", + 'type' => 'string', + 'example' => 'Success', + ], + 'CpTimeSelectList' => [ + 'description' => 'The information about whether the courier company can accept the order.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RealTime' => [ + 'description' => 'The information about whether the real-time order can be selected.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the real-time order type.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'Selectable' => [ + 'description' => 'Indicates whether the real-time order can be placed after the deadline for placing a real-time order is reached.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'SelectDisableTip' => [ + 'description' => 'The tip displayed when the real-time order cannot be placed.'."\n", + 'type' => 'string', + 'example' => 'Exceeding the real-time ordering time range.', + ], + ], + ], + 'AppointTimes' => [ + 'description' => 'The available time for the scheduled pickup. If the current courier company cannot accept the scheduled pickup, this field is left empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Date' => [ + 'description' => 'The date in the YYYY-MM-DD format.'."\n", + 'type' => 'string', + 'example' => '2022-04-28', + ], + 'DateSelectable' => [ + 'description' => 'Indicates whether the date is selectable.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'TimeList' => [ + 'description' => 'The time range for the scheduled pickup for this date.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => 'The beginning of the time range.'."\n", + 'type' => 'string', + 'example' => '10:00:00', + ], + 'EndTime' => [ + 'description' => 'The end of the time range.'."\n", + 'type' => 'string', + 'example' => '12:00:00', + ], + 'Selectable' => [ + 'description' => 'Indicates whether the time range can be selected for the scheduled pickup.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'SelectDisableTip' => [ + 'description' => 'The tip displayed when the scheduled pickup is not available.'."\n", + 'type' => 'string', + 'example' => 'Appointment Full', + ], + ], + ], + ], + ], + ], + ], + 'PrePrice' => [ + 'description' => 'The estimated price. Unit: CNY. The value is accurate to two decimal places. The value of this parameter is displayed if an estimated weight is specified.'."\n", + 'type' => 'string', + 'example' => '12.50', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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' => 'CreatePickUpWaybillPreQuery', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'CreatePickUpWaybill' => [ + 'summary' => 'Creates a door-to-door delivery order.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '100665', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Content-Type', + 'in' => 'header', + 'schema' => [ + 'description' => 'The content type of the HTTP request. This parameter is optional. If you specify this parameter, enter application/json;chatset=UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'application/json;chatset=UTF-8', + 'default' => 'application/json;charset=UTF-8', + ], + ], + [ + 'name' => 'OuterOrderCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external order.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '143234234266****', + ], + ], + [ + 'name' => 'OrderChannels', + 'in' => 'query', + 'schema' => [ + 'description' => 'The external channel sources.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'YUN_DIAN_SHANG', + ], + ], + [ + 'name' => 'CpCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the courier company.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'YTO', + ], + ], + [ + 'name' => 'SendName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the sender.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Wang', + ], + ], + [ + 'name' => 'SendMobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number of the sender.'."\n" + ."\n" + .'> Either SendMobile or SendPhone must be set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1596714****', + ], + ], + [ + 'name' => 'SendPhone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The landline phone number of the sender.'."\n" + ."\n" + .'> Either SendMobile or SendPhone must be set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '05718845****', + ], + ], + [ + 'name' => 'SendAddress', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The address of the sender.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => 'The province where the sender is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Sichuan', + ], + 'CityName' => [ + 'description' => 'The city where the sender is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'chengdu', + ], + 'AreaName' => [ + 'description' => 'The district where the sender is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'wenjiang', + ], + 'TownName' => [ + 'description' => 'The street where the sender is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XX Street', + ], + 'AddressDetail' => [ + 'description' => 'The detailed address of the sender.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'XX community', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'ConsigneeName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the consignee.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Li', + ], + ], + [ + 'name' => 'ConsigneeMobile', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number of the consignee.'."\n" + ."\n" + .'> Either ConsigneeMobile or ConsigneePhone must be set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1580000****', + ], + ], + [ + 'name' => 'ConsigneePhone', + 'in' => 'query', + 'schema' => [ + 'description' => 'The landline phone number of the consignee.'."\n" + ."\n" + .'> Either ConsigneeMobile or ConsigneePhone must be set.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '0570000****', + ], + ], + [ + 'name' => 'ConsigneeAddress', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The address of the consignee.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProvinceName' => [ + 'description' => 'The province where the consignee is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'zhejiang', + ], + 'CityName' => [ + 'description' => 'The city where the consignee is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hangzhou', + ], + 'AreaName' => [ + 'description' => 'The district where the consignee is located.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xihu', + ], + 'TownName' => [ + 'description' => 'The street where the consignee is located.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XX Street', + ], + 'AddressDetail' => [ + 'description' => 'The detailed address of the consignee.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'XX community', + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The additional information about the order. The additional information will be printed on the order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'fragile', + ], + ], + [ + 'name' => 'GoodsInfos', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The item name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zhang', + ], + 'Weight' => [ + 'description' => 'The item weight. Unit: gram.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + 'Quantity' => [ + 'description' => 'The item quantity.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AppointGotStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The start time of the door-to-door pickup in the appointment. The value of **AppointGotStartTime** is the value of **StartTime** of **AppointTimes** in **CpTimeSelectList** returned by the [CreatePickUpWaybillPreQuery](~~CreatePickUpWaybillPreQuery~~#resultMapping) operation.'."\n" + ."\n" + .'> This parameter is required when **BizType** is set to **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-01 10:00:00', + ], + ], + [ + 'name' => 'AppointGotEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end time of the door-to-door pickup in the appointment. The value of **AppointGotEndTime** is the value of **EndTime** of **AppointTimes** in **CpTimeSelectList** returned by the [CreatePickUpWaybillPreQuery](~~CreatePickUpWaybillPreQuery~~#resultMapping) operation.'."\n" + ."\n" + .'> This parameter is required when **BizType** is set to **1**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2021-01-01 12:00:00', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The pickup mode. Valid values:'."\n" + ."\n" + .'* **0** (default): real-time order.'."\n" + .'* **1**: appointment order.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2', + ], + 'HttpStatusCode' => [ + 'description' => 'The HTTP status code.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'CpCode' => [ + 'description' => 'The code of the courier company.'."\n", + 'type' => 'string', + 'example' => 'YTO', + ], + 'MailNo' => [ + 'description' => 'The order ID.'."\n", + 'type' => 'string', + 'example' => '77312345629****', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '200', + ], + 'ErrorMsg' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'GotCode' => [ + 'description' => 'The pickup code.'."\n", + 'type' => 'string', + 'example' => '3524', + ], + ], + ], + ], + ], + ], + ], + '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' => '[{"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' => 'CreatePickUpWaybill', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'CancelPickUpWaybill' => [ + 'summary' => 'Cancels a door-to-door delivery order.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '100670', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + ], + 'parameters' => [ + [ + 'name' => 'Content-Type', + 'in' => 'header', + 'schema' => [ + 'description' => 'The content type of the HTTP request. This parameter is optional. If you specify this parameter, enter application/json;chatset=UTF-8.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'application/json;chatset=UTF-8', + 'default' => 'application/json;charset=UTF-8', + ], + ], + [ + 'name' => 'OuterOrderCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the external order.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1145678823****', + ], + ], + [ + 'name' => 'CancelDesc', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cancellation reason.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '{\\"action\\":\\"UPDATE_DESC\\",\\"value\\":\\"The courier is unable to pick up the package.\\"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '9FC30594-3841-43AD-9008-03393BCB5CD2', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the cancellation was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'Message' => [ + 'description' => 'The cancellation result.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'ErrorMsg' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => 'CancelPickUpWaybill', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'AddAxnTrackNo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72606', + 'abilityTreeNodes' => [ + 'FEATUREdyplsOMLRO6', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The key of the phone number pool. Log on to the [Phone Number Protection console](https://dypls.console.aliyun.com/dypls.htm#/account) and view the key of the phone number pool on the **Number Pool Management** page.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'FC2235****', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'The private number in the AXN binding, that is, phone number X.'."\n" + ."\n" + .'You can call the [BindAxn](~~110258~~) operation to obtain the value of PhoneNoX.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1700000****', + ], + ], + [ + 'name' => 'trackNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tracking number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'abcde*****', + ], + ], + [ + 'name' => 'SubsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The binding ID.'."\n" + ."\n" + .'You can call the [BindAxn](~~110258~~) operation to obtain the value of SubsId.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '15678890****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + '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' => 'AddAxnTrackNo', + 'summary' => 'Adds a tracking number for a private number in the AXN binding.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryPhoneNoAByTrackNo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '72630', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'trackNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tracking number.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '22573****', + ], + ], + [ + 'name' => 'CabinetNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cabinet number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '25689****', + ], + ], + [ + 'name' => 'PhoneNoX', + 'in' => 'query', + 'schema' => [ + 'description' => 'Phone number X returned by the API operation for creating a binding.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1710000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other status codes indicate that the request failed. For more information, see [Error codes](~~109196~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8906582E-6722', + ], + 'Module' => [ + 'description' => 'The information returned after the phone numbers were bound.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Extension' => [ + 'description' => 'The extension of phone number X.'."\n", + 'type' => 'string', + 'example' => '130', + ], + 'PhoneNoX' => [ + 'description' => 'The private number, that is, phone number X.'."\n", + 'type' => 'string', + 'example' => '1710000****', + ], + 'PhoneNoA' => [ + 'description' => 'Phone number A.'."\n", + 'type' => 'string', + 'example' => '1310000****', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'QueryPhoneNoAByTrackNo', + 'summary' => 'Queries the details about a tracking number.', + 'description' => '### [](#qps)QPS limits'."\n" + ."\n" + .'You can call this operation up to 5,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UnBindAXB' => [ + 'summary' => '解除指定的呼叫绑定关系（A，X，B），解决呼叫绑定关系后，员工B不能通过工作号X呼叫到客户A。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244979', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '号码池key', + 'description' => '号码池key', + 'type' => 'string', + 'required' => true, + 'example' => 'FC5**********************a1a', + ], + ], + [ + 'name' => 'BindId', + 'in' => 'query', + 'schema' => [ + 'title' => 'bindId绑定关系AXB唯一id', + 'description' => 'bindId绑定关系AXB唯一id', + 'type' => 'string', + 'required' => true, + 'example' => '4534543', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '', + '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' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindXB' => [ + 'summary' => '平台指定工作号X 和员工号B建立关联，完成X 实名认证，绑定生效后，所有X 的呼叫都会转接到B', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244978', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '号码池key', + 'description' => '号码池key', + 'type' => 'string', + 'required' => true, + 'example' => 'FC5**********************a1a', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + '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' => [ + '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' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindAXBCall' => [ + 'summary' => '调用本接口向工作号平台请求为员工B的工作号X建立呼叫绑定（B，X，A），允许B通过X呼叫客户A', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244980', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + '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' => 'authId绑定关系BX唯一id', + 'type' => 'string', + 'required' => true, + 'example' => '12353', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定关系过期失效时间： 取值必须大于0； 单位：秒，ct_time + expiration = 自动解绑时间', + 'description' => '绑定关系过期失效时间： 取值必须大于0； 单位：秒，ct_time + expiration = 自动解绑时间', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '7200', + ], + ], + [ + 'name' => 'UserData', + 'in' => 'query', + 'schema' => [ + 'title' => '客户自定义参数回调带回', + 'description' => '客户自定义参数回调带回', + 'type' => 'string', + 'required' => false, + 'example' => '000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'BindId' => [ + 'title' => '绑定关系ID', + 'description' => '绑定关系ID', + 'type' => 'string', + 'example' => '476567566', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '返回状态码 0000表示成功 其他表示失败', + 'description' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'UnBindXB' => [ + 'summary' => '调用本接口可取消工作号X与员工号码B的绑定。绑定解除后，对X的呼叫都不会转接给B。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244981', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '号码池key', + 'description' => '号码池key', + 'type' => 'string', + 'required' => true, + 'example' => 'FC5**********************a1a', + ], + ], + [ + 'name' => 'AuthId', + 'in' => 'query', + 'schema' => [ + 'title' => 'authId绑定关系BX唯一id', + 'description' => 'authId绑定关系BX唯一id', + 'type' => 'string', + 'required' => true, + 'example' => '34*****46', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'title' => 'X号码', + 'description' => 'X号码', + 'type' => 'string', + 'required' => true, + 'example' => '17*******22', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '', + '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' => 'false', + ], + ], + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + '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"}]', + ], + 'QuerySoundRecord' => [ + 'summary' => '查询通话录音链接', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244987', + 'abilityTreeNodes' => [ + 'FEATUREdyplsVL8MN2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '号码池key', + 'description' => '号码池key', + 'type' => 'string', + 'required' => true, + 'example' => 'FC5**********************a1a', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'title' => '本次呼叫唯一id', + 'description' => '本次呼叫唯一id', + 'type' => 'string', + 'required' => true, + 'example' => 'ac445343254', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '返回状态码 0000表示成功 其他表示失败', + 'description' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'CreateSmsSign' => [ + 'summary' => 'B向A 发短信，客户端获取“短信标签”，尾部添加“标签”。通过“标签”解析被叫A，发短信到A。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244986', + 'abilityTreeNodes' => [ + 'FEATUREdyplsMM443Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + 'in' => 'query', + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '发信人号码', + 'description' => '发信人号码', + 'type' => 'string', + 'required' => true, + 'example' => '150****6539', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'CalledNoSign' => [ + 'title' => '短信接收者号码签名串(加到短信内容中供解析真实被叫号码)', + 'description' => '短信接收者号码签名串(加到短信内容中供解析真实被叫号码)', + 'type' => 'string', + 'example' => 'sign23343466', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '返回状态码 0000表示成功 其他表示失败', + 'description' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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"}]', + ], + 'ListXTelephones' => [ + 'summary' => '查询客户名下X号码列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244985', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页条数', + 'description' => '每页条数', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BuyTime' => [ + 'name' => 'BuyTime', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-29 17:23:58', + 'backendName' => 'buyTime', + ], + 'TelephoneStatus' => [ + 'name' => 'TelephoneStatus', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '0', + 'backendName' => 'telephoneStatus', + ], + 'CustomerPoolKey' => [ + 'name' => 'CustomerPoolKey', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'FC5***********************a1a', + 'backendName' => 'customerPoolKey', + ], + 'BindTime' => [ + 'name' => 'BindTime', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-29 17:23:58', + 'backendName' => 'bindTime', + ], + 'CustomerPoolName' => [ + 'name' => 'CustomerPoolName', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '', + 'backendName' => 'customerPoolName', + ], + 'Telephone' => [ + 'name' => 'Telephone', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '17*******46', + 'backendName' => 'telephone', + ], + 'SmsStatus' => [ + 'name' => 'SmsStatus', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '0', + 'backendName' => 'smsStatus', + ], + 'ReleaseTime' => [ + 'name' => 'ReleaseTime', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-29 17:23:58', + 'backendName' => 'releaseTime', + ], + 'AuthMsg' => [ + 'name' => 'AuthMsg', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '', + 'backendName' => 'authMsg', + ], + 'UnbindTime' => [ + 'name' => 'UnbindTime', + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '2024-08-29 17:23:58', + 'backendName' => 'unbindTime', + ], + ], + 'backendName' => 'items', + 'extendType' => 'true', + ], + 'example' => '', + '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', + ], + 'List' => [ + 'title' => '数据集合', + 'description' => '数据集合', + 'type' => 'array', + 'items' => [ + 'title' => '每个数据项的键值对', + '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', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'title' => '返回状态码 0000表示成功 其他表示失败', + 'description' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetXConfig' => [ + 'summary' => '获取X号码配置信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244983', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => '', + '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' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'ConfigX' => [ + 'summary' => '配置X号码，单独对工作号的话音呼叫、企业名片等通信功能进行配置操作', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244982', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'type' => 'string', + 'required' => true, + 'example' => '564**********879', + ], + ], + [ + 'name' => 'CallerParentId', + 'in' => 'query', + 'schema' => [ + 'title' => '客户uid', + 'description' => '客户uid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1898871967585852', + ], + ], + [ + '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' => '是否透传来显为真实主叫：00-非透传：互相拨打时都显示工作号;10-透传：A客户为主叫时,B员工的来显为客户A号码;B员工为主叫时,A客户的来显为工作号;默认为 00', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SmsSignMode', + 'in' => 'query', + 'schema' => [ + 'title' => '是否透传来显为真实用户0：不透传; 1：透传默认：0不透传', + 'description' => '是否透传来显为真实用户0：不透传; 1：透传默认：0不透传', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SmsAbility', + 'in' => 'query', + 'schema' => [ + 'title' => '开/关短信功能状态‘0’：禁用；‘1’：开启；', + 'description' => '开/关短信功能状态‘0’：禁用；‘1’：开启；', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'CallAbility', + 'in' => 'query', + 'schema' => [ + 'title' => '开/关呼叫能力状态‘0’：禁用‘1’：开启', + 'description' => '开/关呼叫能力状态‘0’：禁用‘1’：开启', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SequenceMode', + 'in' => 'query', + 'schema' => [ + 'title' => '顺振模式：0-不顺振（默认）1-有条件顺振，先接续calledNo指定被叫，如果该被叫未能接通，再顺振sequenceCalls号码列表2-无条件顺振，不接续calledNo指定被叫，直接顺振sequenceCalls号码列表', + 'description' => '顺振模式：0-不顺振（默认）1-有条件顺振，先接续calledNo指定被叫，如果该被叫未能接通，再顺振sequenceCalls号码列表2-无条件顺振，不接续calledNo指定被叫，直接顺振sequenceCalls号码列表', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SequenceCalls', + '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' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '', + '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' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'GetXDefaultConfig' => [ + 'summary' => '获取X号码默认配置信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244984', + 'abilityTreeNodes' => [ + 'FEATUREdypls9LYVYY', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReqId', + 'in' => 'query', + 'schema' => [ + 'title' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'description' => '请求去重ID, reqId最大长度为20位,接入方需要保持原子性', + 'type' => 'string', + 'required' => true, + 'example' => '564**********879'."\n", + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'Message' => [ + 'title' => '返回信息', + 'description' => '返回信息', + 'type' => 'string', + 'example' => '成功', + ], + 'Data' => [ + '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' => '示例值示例值示例值', + ], + ], + ], + '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' => '返回状态码 0000表示成功 其他表示失败', + 'type' => 'string', + 'example' => '0000', + ], + 'Success' => [ + 'title' => '返回是否成功 true 表示成功 false表示失败', + 'description' => '返回是否成功 true 表示成功 false表示失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindAxb700' => [ + 'summary' => '创建700绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '283900', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'FC2258****', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2021-09-05 12:00:00', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '139****0000', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '136****0000', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '700********0000', + ], + ], + [ + 'name' => 'NeedRecord', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RecType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp3', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + [ + 'name' => 'Audio', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => ' {'."\n" + .'"ACallX_Apre":"185"'."\n" + .'}', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12345678', + ], + ], + [ + 'name' => 'IndustrialId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefgh', + ], + ], + [ + 'name' => 'NeedAsr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AsrModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac', + ], + ], + [ + 'name' => 'CallTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DtmfConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050******', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecretNo' => [ + 'type' => 'string', + 'example' => '700********0001', + ], + 'SubsId' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123*******', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindGxb700' => [ + 'summary' => '创建700Gxb绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '285985', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'FC10000016848****', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2021-09-05 12:00:00', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '136****0000', + ], + ], + [ + 'name' => 'DefaultA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '138****0000', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10000*****', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '700********0000', + ], + ], + [ + 'name' => 'NeedRecord', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RecType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'mp3', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + [ + 'name' => 'Audio', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .'"GCallX_Gpre":"185"'."\n" + .'}', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12345678', + ], + ], + [ + 'name' => 'IndustrialId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefgh', + ], + ], + [ + 'name' => 'NeedAsr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AsrModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac', + ], + ], + [ + 'name' => 'CallTimeout', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DtmfConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n", + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SecretNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '700********0001', + ], + 'SubsId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123*******', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateSubs700' => [ + 'summary' => '更新700绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287501', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'FC10000016848****', + ], + ], + [ + 'name' => 'OperateType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'updateNoA', + ], + ], + [ + 'name' => 'SubsId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000*****', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '700********0000', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '12345678', + ], + ], + [ + 'name' => 'IndustrialId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '700.100.1/12345678', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '138****0000', + ], + ], + [ + 'name' => 'DefaultA', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '138****0000', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '136****0000', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10000*****', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2021-09-05 12:00:00', + ], + ], + [ + 'name' => 'CallRestrict', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'CONTROL_AX_DISABLE', + ], + ], + [ + 'name' => 'NeedRecord', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Audio', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .'"ACallX_Apre":"185"'."\n" + .'}', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdef', + ], + ], + [ + 'name' => 'NeedAsr', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AsrModelId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '7ee372834d2f4cc7ac0d0ab2d0ae1aac', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n", + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'UnbindSubs700' => [ + 'summary' => '解除700绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287502', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PoolKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'FC10000016848****', + ], + ], + [ + 'name' => 'SubsId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100000****', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '700********0000', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '12345678', + ], + ], + [ + 'name' => 'IndustrialId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '700.100.1/12345678', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050******'."\n", + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9297B722-A016-43FB-B51A-E54050******', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DeleteAxnExtensionBindFixedLine' => [ + 'summary' => '解绑已有AXN分机号绑定', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271368', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID', + 'description' => '号池ID', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + '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' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'conflict with subs id=1000203635098305, phoneA conflict', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateAxnExtensionBindFixedLine' => [ + 'summary' => '更新AXN分机号绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + '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' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识。', + 'description' => '消息请求唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '12345dkwkd99d', + ], + ], + [ + 'name' => 'Subts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'required' => true, + 'example' => '可参考绑定响应', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'required' => true, + 'example' => '15500001111', + ], + ], + [ + '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' => '放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 AXN分机号业务的放音编码,B->X和其他号码->X的编码一致 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002,10003', + ], + ], + [ + 'name' => 'Anucodecalled', + 'in' => 'query', + 'schema' => [ + 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', + 'description' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'TAnucodeConnect', + 'in' => 'query', + 'schema' => [ + 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2', + 'description' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'description' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'required' => false, + 'example' => '1233', + ], + ], + [ + 'name' => 'Extraaxx', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'AXx的扩展参数项', + 'description' => 'AXx的扩展参数项', + 'type' => 'object', + 'properties' => [ + 'Callback' => [ + 'title' => '可选。 A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码', + 'description' => '可选。 A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Callrecording' => [ + 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '31031C54-7727-5057-9ED1-FA276B64205E', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'title' => '响应码 0：成功，其它失败，具体见文档', + 'description' => '响应码 0：成功，其它失败，具体见文档', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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"}]', + ], + 'QueryAxbBindFixedLine' => [ + 'summary' => '固话AxB查询', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALPT_1234', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20161114143116001', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询类型 0：根据绑定id查询 1：根据X和A/B号码查询', + 'description' => '查询类型 0：根据绑定id查询 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' => 'A20304o0200303004j', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'title' => 'A/B号码，queryType=1时，必传', + 'description' => 'A/B号码，queryType=1时，必传', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'title' => 'x号码，queryType=1时，必传', + 'description' => 'x号码，queryType=1时，必传', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识。', + 'description' => '消息请求唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '3ererrrdrrrr', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3179F199-C6C5-5963-85A6-21CBA2F47592', + ], + 'Data' => [ + 'title' => '绑定信息', + 'description' => '绑定信息', + 'type' => 'object', + 'properties' => [ + 'TelB' => [ + 'title' => 'B号码', + 'description' => 'B号码', + 'type' => 'string', + 'example' => '15500002222', + ], + 'TelA' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'example' => '15500001111', + ], + 'Subid' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'example' => 'GHX0534X202504221531579290029-2-1-aliaxb', + ], + 'Anucodecalled' => [ + 'title' => '接通后被叫侧放音编码', + 'description' => '接通后被叫侧放音编码', + 'type' => 'string', + 'example' => '10001,10002', + ], + 'Extra' => [ + 'title' => '额外字段', + 'description' => '额外字段', + 'type' => 'object', + 'properties' => [ + 'Callrecording' => [ + 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'example' => '1', + ], + ], + 'example' => '', + ], + 'Subts' => [ + 'title' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '绑定时间，格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'example' => '20250421141723', + ], + 'Expiration' => [ + 'title' => '绑定过期时间', + 'description' => '绑定过期时间', + 'type' => 'string', + 'example' => '60', + ], + 'TelX' => [ + 'title' => '小号号码', + 'description' => '小号号码', + 'type' => 'string', + 'example' => '19700002222', + ], + 'Areacode' => [ + 'title' => '隐私号码区号', + 'description' => '隐私号码区号', + 'type' => 'string', + 'example' => '010', + ], + '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”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', + 'type' => 'string', + 'example' => '10001,10002,10003', + ], + 'TAnucodeConnect' => [ + 'title' => '接通后主叫侧放音编码', + 'description' => '接通后主叫侧放音编码', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Remark' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'example' => '19394', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '响应码', + 'description' => '响应码', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'title' => '处理是否成功 true-成功', + 'description' => '处理是否成功 true-成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateAxnBindFixedLine' => [ + 'summary' => '更新Axn绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271211', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识', + 'description' => '消息请求唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '12345dkwkd99d', + ], + ], + [ + 'name' => 'Subts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + 'default' => '', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'required' => true, + 'example' => 'GHX0534X202504221531579290029-2-1-aliaxn', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'required' => false, + 'example' => '15500001111', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'title' => 'B号码', + 'description' => 'B号码', + 'type' => 'string', + 'required' => false, + 'example' => '15500002222', + ], + ], + [ + '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”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'Anucodecalled', + 'in' => 'query', + 'schema' => [ + 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2。', + 'description' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2。', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'TAnucodeConnect', + 'in' => 'query', + 'schema' => [ + 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2', + 'description' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'description' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'type' => 'string', + 'required' => false, + 'example' => '60', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Extra', + '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，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Callrecording' => [ + 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + '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' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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"}]', + ], + 'UpdateAxbBindFixedLine' => [ + 'summary' => '固话AxB绑定更新', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271215', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALPT_1234', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', + 'description' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', + 'type' => 'string', + 'required' => true, + 'example' => '20161114143116001', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'required' => true, + 'example' => 'A100X558X0000400023', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识。', + 'description' => '消息请求唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '1234567890', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'title' => '真实号码，telA,telB不允许同时更新', + 'description' => '真实号码，telA,telB不允许同时更新', + 'type' => 'string', + 'required' => false, + 'example' => '13900000000', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'title' => '对端号码，telA,telB不允许同时更新', + 'description' => '对端号码，telA,telB不允许同时更新', + 'type' => 'string', + 'required' => false, + 'example' => '13005711234', + ], + ], + [ + 'name' => 'Subts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'required' => true, + 'example' => '20150920190126', + ], + ], + [ + 'name' => 'Anucode', + 'in' => 'query', + 'schema' => [ + 'title' => '主叫侧放音编码', + 'description' => '主叫侧放音编码', + 'type' => 'string', + 'required' => false, + 'example' => '1,2,3', + ], + ], + [ + 'name' => 'Anucodecalled', + 'in' => 'query', + 'schema' => [ + 'title' => '被叫侧放音编码', + 'description' => '被叫侧放音编码', + 'type' => 'string', + 'required' => false, + 'example' => '1,2', + ], + ], + [ + 'name' => 'TAnucodeConnect', + 'in' => 'query', + 'schema' => [ + 'title' => '接通后主叫侧的放音编码', + 'description' => '接通后主叫侧的放音编码', + 'type' => 'string', + 'required' => false, + 'example' => '1,2', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'description' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展参数', + 'description' => '扩展参数', + 'type' => 'object', + 'properties' => [ + 'Callrecording' => [ + 'title' => '录音控制， 0：不录音 1：录音', + 'description' => '录音控制， 0：不录音 1：录音', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + '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', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindAxnExtensionFixedLine' => [ + 'summary' => 'AXN分机号-号码绑定', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271367', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识', + 'description' => '消息请求唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '12345dkwkd99d', + ], + ], + [ + 'name' => 'BindType', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', + 'description' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', + 'type' => 'string', + 'required' => true, + 'example' => 'mode101', + ], + ], + [ + 'name' => 'Subts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'required' => true, + 'example' => '15500001111放音编码必须包含3个场景的编码。按照“B->X,A->X,其他号码->X”的顺序填写编码，编码之间以逗号分隔。 AXN分机号业务的放音编码,B->X和其他号码->X的编码一致 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'title' => 'X号码；平台分配号码模式下，该参数可不带，系统忽略该参数', + 'description' => 'X号码；平台分配号码模式下，该参数可不带，系统忽略该参数', + 'type' => 'string', + 'required' => false, + 'example' => '0571409312', + ], + ], + [ + 'name' => 'TelXext', + 'in' => 'query', + 'schema' => [ + 'title' => '分机号；平台分配号码模式下，该参数可不带，系统忽略该参数', + 'description' => '分机号；平台分配号码模式下，该参数可不带，系统忽略该参数', + 'type' => 'string', + 'required' => false, + 'example' => '1009', + ], + ], + [ + 'name' => 'Anucode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '10001,10002,10003', + ], + ], + [ + 'name' => 'Anucodecalled', + 'in' => 'query', + 'schema' => [ + 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', + 'description' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'TAnucodeConnect', + 'in' => 'query', + 'schema' => [ + 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2', + 'description' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码为被叫时主叫侧的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'description' => '单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'type' => 'string', + 'required' => true, + 'example' => '60', + ], + ], + [ + 'name' => 'Areacode', + 'in' => 'query', + 'schema' => [ + 'title' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费', + 'description' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'required' => false, + 'example' => '12444', + ], + ], + [ + 'name' => 'Extraaxx', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '额外字段', + 'description' => '额外字段', + 'type' => 'object', + 'properties' => [ + 'Callback' => [ + 'title' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码', + 'description' => 'A通过X呼叫，即A主叫X，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的B号码', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Callrecording' => [ + 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Data' => [ + 'title' => '响应信息', + 'description' => '响应信息', + 'type' => 'object', + 'properties' => [ + 'Subid' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'example' => 'GHX0534X202504221531579290029', + ], + 'TelXext' => [ + 'title' => '分机号，只有4位', + 'description' => '分机号，只有4位', + 'type' => 'string', + 'example' => '1001', + ], + 'TelX' => [ + 'title' => '隐私号码', + 'description' => '隐私号码', + 'type' => 'string', + 'example' => '0571409312', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '响应码 0：成功，其它失败，具体见文档', + 'description' => '响应码 0：成功，其它失败，具体见文档', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'QueryAxnBindFixedLine' => [ + 'summary' => '查询Axn绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池id。', + 'description' => '号池id。', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询类型 0：根据绑定id查询 1：根据A号码查询 2：根据X查询', + 'description' => '查询类型 0：根据绑定id查询 1：根据A号码查询 2：根据X查询', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定id queryType=0时，必传', + 'description' => '绑定id queryType=0时，必传', + 'type' => 'string', + 'required' => false, + 'example' => 'GHX0534X202504221531579290029-2-1-aliaxn', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码，queryType=1时，必传', + 'description' => 'A号码，queryType=1时，必传', + 'type' => 'string', + 'required' => false, + 'example' => '15500001111', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'title' => '隐私号码', + 'description' => '隐私号码', + 'type' => 'string', + 'required' => false, + 'example' => '05718950', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识', + 'description' => '消息请求唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + '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' => '15500002222', + ], + 'TelA' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'example' => '15500001111', + ], + 'Subid' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'example' => 'GHX0534X202504221531579290029-2-1-aliaxn', + ], + '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，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB', + 'type' => 'string', + 'example' => '1', + ], + 'Callrecording' => [ + 'title' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '录音控制，仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'example' => '1', + ], + ], + 'example' => '', + ], + 'Subts' => [ + 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'example' => '20250421141723', + ], + 'Expiration' => [ + 'title' => '过期时间', + 'description' => '过期时间', + 'type' => 'string', + 'example' => '60', + ], + 'TelX' => [ + 'title' => '隐私号码', + 'description' => '隐私号码', + 'type' => 'string', + 'example' => '057112345678', + ], + 'Areacode' => [ + 'title' => '隐私号码区号', + 'description' => '隐私号码区号', + 'type' => 'string', + 'example' => '010', + ], + 'Anucode' => [ + 'title' => '接通前放音啊编码', + 'description' => '接通前放音啊编码', + 'type' => 'string', + 'example' => '10001,10002,10003', + ], + 'TAnucodeConnect' => [ + 'title' => '接通后主叫侧放音编码', + 'description' => '接通后主叫侧放音编码', + 'type' => 'string', + 'example' => '10001,10002', + ], + 'Remark' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'example' => '12444', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '响应码', + 'description' => '响应码', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + '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"}]', + ], + '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', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识', + 'description' => '消息请求唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '12345dkwkd99d', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'required' => true, + 'example' => 'GHX0534X202504221531579290029-2-1-aliaxn', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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"}]', + ], + 'QueryAxnExtensionBindFixedLine' => [ + 'summary' => '查询AXN分机号绑定关系', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID', + 'description' => '号池ID', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'title' => '查询类型。取值： 0：根据绑定ID查询。1：根据X和A/B号码查询', + 'description' => '查询类型。取值： 0：根据绑定ID查询。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', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码。QueryType参数为1时必传。', + 'description' => 'A号码。QueryType参数为1时必传。', + 'type' => 'string', + 'required' => false, + 'example' => '15500001111', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识。', + 'description' => '消息请求唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '12345dkwkd99d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + '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' => '15500001111', + ], + 'Extraaxx' => [ + 'title' => '额外字段', + 'description' => '额外字段', + 'type' => 'object', + 'properties' => [ + 'Callback' => [ + 'title' => '回拨控制', + 'description' => '回拨控制', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Callrecording' => [ + 'title' => '录音控制', + 'description' => '录音控制', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + 'example' => '', + ], + 'Subid' => [ + 'title' => '绑定ID', + 'description' => '绑定ID', + 'type' => 'string', + 'example' => '可参考绑定响应', + ], + 'TelXext' => [ + 'title' => '分机号', + 'description' => '分机号', + 'type' => 'string', + 'example' => '1009', + ], + 'Anucodecalled' => [ + 'title' => '被叫侧放音', + 'description' => '被叫侧放音', + 'type' => 'string', + 'example' => '10001,10002', + ], + 'Subts' => [ + 'title' => '绑定时间', + 'description' => '绑定时间', + 'type' => 'string', + 'example' => '20250421141723', + ], + 'Expiration' => [ + 'title' => '过期时间', + 'description' => '过期时间', + 'type' => 'string', + 'example' => '60', + ], + 'TelX' => [ + 'title' => '小号号码', + 'description' => '小号号码', + 'type' => 'string', + 'example' => '19700002222', + ], + 'Areacode' => [ + 'title' => '隐私号码区号', + 'description' => '隐私号码区号', + 'type' => 'string', + 'example' => '10', + ], + 'Anucode' => [ + 'title' => '放音编码', + 'description' => '放音编码', + 'type' => 'string', + 'example' => '10001,10002,10003', + ], + 'TAnucodeConnect' => [ + 'title' => '接通后主叫侧放音编码', + 'description' => '接通后主叫侧放音编码', + 'type' => 'string', + 'example' => '10001,10002', + ], + 'Remark' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'example' => '12444', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '响应码', + 'description' => '响应码', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindAxnFixedLine' => [ + 'summary' => 'AXN模式绑定，分配X号码', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'alitest', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'description' => '格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识', + 'description' => '消息请求唯一标识', + 'type' => 'string', + 'required' => true, + 'example' => '12345dkwkd99d', + ], + ], + [ + 'name' => 'BindType', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', + 'description' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', + 'type' => 'string', + 'required' => true, + 'example' => 'mode101', + ], + ], + [ + 'name' => 'Subts', + 'in' => 'query', + 'schema' => [ + 'title' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => '格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'required' => true, + 'example' => '20250421141723098', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'title' => 'A号码', + 'description' => 'A号码', + 'type' => 'string', + 'required' => true, + 'example' => '15500001111', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'title' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数', + 'description' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数', + 'type' => 'string', + 'required' => false, + 'example' => '0571409312', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'title' => 'N号码', + 'description' => 'N号码', + 'type' => 'string', + 'required' => false, + 'example' => '15500002222', + ], + ], + [ + '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”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2,3”表示B->X放音编号为1，A->X放音编号为2， 其他号码->X放音编号为3', + 'type' => 'string', + 'required' => true, + 'example' => '10001,10002,10003', + ], + ], + [ + 'name' => 'Anucodecalled', + 'in' => 'query', + 'schema' => [ + 'title' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', + 'description' => '被叫侧放音编码 被叫放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，其他号码为被叫侧接听时的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'TAnucodeConnect', + 'in' => 'query', + 'schema' => [ + 'title' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2', + 'description' => '接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,其他号码被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，其他号码被叫为被叫时主叫侧的放音编号为2', + 'type' => 'string', + 'required' => false, + 'example' => '10001,10002', + ], + ], + [ + 'name' => 'Areacode', + 'in' => 'query', + 'schema' => [ + 'title' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费', + 'description' => '去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'description' => '位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'required' => false, + 'example' => '12444', + ], + ], + [ + 'name' => 'Extra', + '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，仅下列值有效。默认是0。 0：不能外呼 1：接续最近的N号码 2：回拨固定号码：telB', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'Callrecording' => [ + 'title' => '仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '仅下列值有效。默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'title' => '描述信息', + 'description' => '描述信息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '4D690962-08CE-5D38-A65A-AB247D7DF7A2', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Subid' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'example' => 'GHX0534X202504221531579290029-2-1-aliaxn', + ], + 'TelX' => [ + 'title' => '隐私号码', + 'description' => '隐私号码', + 'type' => 'string', + 'example' => '0571409312', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '响应码 0：成功，其它失败，具体见文档', + 'description' => '响应码 0：成功，其它失败，具体见文档', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'BindAxbFixedLine' => [ + 'summary' => '固话AxB绑定', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271000', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALPT_1234', + 'default' => '', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', + 'description' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', + 'type' => 'string', + 'required' => true, + 'example' => '20161114143116001', + ], + ], + [ + 'name' => 'BindType', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', + 'description' => '绑定类型，值如下： mode101：客户携带X号码 mode102：平台分配X号码', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识。', + 'description' => '消息请求唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '15433678436', + ], + ], + [ + 'name' => 'TelA', + 'in' => 'query', + 'schema' => [ + 'title' => '真实号码', + 'description' => '真实号码', + 'type' => 'string', + 'required' => true, + 'example' => '18456713271', + ], + ], + [ + 'name' => 'TelX', + 'in' => 'query', + 'schema' => [ + 'title' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数 格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'description' => 'X号码； 平台分配号码模式下，该参数可不带，系统忽略该参数 格式为yyyyMMddHHmmss。时间采用北京时间，24小时制。', + 'type' => 'string', + 'required' => false, + 'example' => '19767562345', + ], + ], + [ + 'name' => 'TelB', + 'in' => 'query', + 'schema' => [ + 'title' => '对端号码', + 'description' => '对端号码', + 'type' => 'string', + 'required' => true, + 'example' => '18971362645', + ], + ], + [ + 'name' => 'Subts', + 'in' => 'query', + '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”的顺序填写编码，编码之间以逗号分隔。 比如：“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被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫侧接听时的放音编号为1，B号码为被叫侧接听时的放音编号为2。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TAnucodeConnect', + 'in' => 'query', + 'schema' => [ + 'title' => '接通后主叫侧的放音编码,接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', + 'description' => '接通后主叫侧的放音编码,接通后主叫侧放音编码 接通后主叫侧放音编码必须包含2个场景的编码。按照“A被叫,B被叫”的顺序填写编码，编码之间以逗号分隔。 比如：“1,2”表示A号码为被叫时主叫侧的放音编号为1，B号码为被叫时主叫侧的放音编号为2。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'Areacode', + 'in' => 'query', + 'schema' => [ + 'title' => '区号,去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费。', + 'description' => '区号,去掉“0” 例如：北京（10）；在平台分配X号码模式中，平台从号码池中分配该地区的X号码，避免产生呼叫长途费。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Expiration', + 'in' => 'query', + 'schema' => [ + 'title' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'description' => '过期时间,单位：秒，必须为数字 0：不会自动解绑 非0：自动解绑周期', + 'type' => 'string', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '接入商自有字段，最大250字符长度', + 'description' => '接入商自有字段，最大250字符长度', + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '扩展参数', + 'description' => '扩展参数', + 'type' => 'object', + 'properties' => [ + 'Callrecording' => [ + 'title' => '录音控制，默认是0（不开通录音功能）。 0：不录音 1：录音', + 'description' => '录音控制，默认是0（不开通录音功能）。 0：不录音 1：录音', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'title' => '响应消息', + 'description' => '响应消息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '649E9EB5-9436-53CF-B41A-C4F0433212E7', + ], + 'Data' => [ + 'title' => '响应内容', + 'description' => '响应内容', + 'type' => 'object', + 'properties' => [ + 'Subid' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'example' => '示例值', + ], + 'TelX' => [ + 'title' => 'X号码', + 'description' => 'X号码', + 'type' => 'string', + 'example' => '示例值', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '响应码 0-成功', + 'description' => '响应码 0-成功', + 'type' => 'string', + 'example' => '0', + ], + 'Success' => [ + 'title' => '是否处理成功 true-成功', + 'description' => '是否处理成功 true-成功', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DeleteAxbBindFixedLine' => [ + 'summary' => '固话AxB解绑', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271125', + 'abilityTreeNodes' => [ + 'FEATUREdypls1W5H18', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'title' => '号池ID。', + 'description' => '号池ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ALPT_1234', + ], + ], + [ + 'name' => 'Ts', + 'in' => 'query', + 'schema' => [ + 'title' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', + 'description' => '业务时间戳，格式yyyyMMddHHmmssSSS，时间采用北京时间，24小时制，精确至毫秒 ', + 'type' => 'string', + 'required' => true, + 'example' => '20161114143116001', + ], + ], + [ + 'name' => 'SubId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定id', + 'description' => '绑定id', + 'type' => 'string', + 'required' => true, + 'example' => 'A93IOELD93', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '消息请求唯一标识。', + 'description' => '消息请求唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'isp.SYSTEM_ERROR', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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"}]', + ], + ], + 'endpoints' => [ + [ + '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', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'dyplsapi.aliyuncs.com', + ], + ], +]; |