'1.0', 'info' => ['style' => 'ROA', 'product' => 'PaiPlugin', 'version' => '2022-01-12'], 'directories' => [ [ 'children' => ['GetMessageConfig'], 'type' => 'directory', 'title' => 'Basic information', ], [ 'children' => ['CreateSignature', 'DeleteSignature', 'ListSignatures', 'GetSignature'], 'type' => 'directory', 'title' => 'SMS signature', ], [ 'children' => ['SendMessage', 'ListMessages', 'ListMessageMetrics'], 'type' => 'directory', 'title' => 'Send SMS', ], [ 'children' => ['CreateCampaign', 'DeleteCampaign', 'ListCampaigns', 'GetCampaign', 'UpdateCampaign'], 'type' => 'directory', 'title' => 'Algorithm task', ], [ 'children' => ['ListAlgorithms', 'GetAlgorithm', 'CreateTrainingJob', 'DeleteTrainingJob', 'ListTrainingJobs', 'GetTrainingJob', 'CreateInferenceJob', 'DeleteInferenceJob', 'ListInferenceJobs', 'GetInferenceJob'], 'type' => 'directory', 'title' => 'Audience management', ], [ 'children' => ['CreateSchedule', 'DeleteSchedule', 'GetSchedule', 'CreateGroup', 'CreateTemplate', 'DeleteGroup', 'DeleteTemplate', 'GetGroup', 'GetTemplate', 'GetUser', 'ListGroups', 'ListSchedules', 'ListTemplates'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'CreateCampaign' => [ 'summary' => 'CreateCampaign', 'path' => '/api/v2/campaigns', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131222', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Entity information of the request parameters.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'Operational activity name.', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => '双十一活动'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The operational activity was created successfully.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Id' => ['title' => '', 'description' => 'Operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Operational activity name.', 'type' => 'string', 'example' => 'VIP客户'], 'Remark' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'example' => '双十一活动'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Create operational activity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'], ], ], 'translator' => 'machine', ], 'CreateGroup' => [ 'summary' => 'CreateGroup', 'path' => '/api/v2/groups', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129051', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Body information of the request parameters. ', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'The associated algorithm. You must specify this parameter if the audience source is an algorithm.', 'type' => 'string', 'required' => false, 'example' => 'user_recall'], 'Column' => ['title' => '', 'description' => 'Phone number column name. Required when the audience source is a CSV file or MaxCompute and includes phone numbers. ', 'type' => 'string', 'required' => false, 'example' => 'phone'], 'Filter' => ['title' => '', 'description' => 'Filter condition. Optional when the audience source is MaxCompute. ', 'type' => 'string', 'required' => false, 'example' => 'ds=20220101'], 'InferenceJobId' => ['title' => '', 'description' => 'Prediction task ID. Required when the audience source is an algorithm. ', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'The audience name.', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], 'PhoneNumber' => ['title' => '', 'description' => 'Indicates whether the audience contains phone numbers. Audiences containing phone numbers can be used in Reach campaigns. ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'Project' => ['title' => '', 'description' => 'MaxCompute (ODPS) project name. Required when the audience source is MaxCompute. ', 'type' => 'string', 'required' => false, 'example' => 'project'], 'Remark' => ['title' => '', 'description' => 'The audience remark.', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 100,000'], 'Source' => ['title' => '', 'description' => 'The audience source.'."\n" .'- 0: Text. Each line contains one phone number. A maximum of 100 phone numbers is allowed.'."\n" .'- 1: Text file. Each line contains one phone number. You can upload the file in the console or specify a custom OSS URI. Before specifying a custom OSS URI, you must complete one-click authorization in the console.'."\n" .'- 2: CSV file. You must specify the column name for phone numbers. You can upload the file in the console or specify a custom OSS URI. Before specifying a custom OSS URI, you must complete one-click authorization in the console.'."\n" .'- 3: MaxCompute (ODPS) table. You must specify the column name for phone numbers.'."\n" .'- 4: Algorithm.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], 'Table' => ['title' => '', 'description' => 'MaxCompute (ODPS) table name. Required when the audience source is MaxCompute. ', 'type' => 'string', 'required' => false, 'example' => 'vip_recall'], 'Text' => ['title' => '', 'description' => 'Text content. Required when the audience source is text. ', 'type' => 'string', 'required' => false, 'example' => '1390000****'], 'Uri' => ['title' => '', 'description' => 'The file URI. You must specify this parameter if the audience source is a text file or a CSV file.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/file'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request to register an audience has been successfully initiated. You can check the audience status via the console or by calling GetGroup.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm. This parameter is used when the audience source is an algorithm.', 'type' => 'string', 'example' => 'user_recall'], 'Amount' => ['title' => '', 'description' => 'Audience quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Column' => ['title' => '', 'description' => 'The column name for phone numbers. This must be specified when the Audience source is a CSV file or MaxCompute and contains phone numbers.', 'type' => 'string', 'example' => 'phone'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Filter' => ['title' => '', 'description' => 'The filter condition. This can be specified when the Audience source is MaxCompute.', 'type' => 'string', 'example' => 'ds=20220101'], 'Id' => ['title' => '', 'description' => 'The Audience ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'InferenceJobId' => ['title' => '', 'description' => 'Prediction Job ID. Required when the audience source is an algorithm.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Audience Name.', 'type' => 'string', 'example' => 'VIP客户'], 'PhoneNumber' => ['title' => '', 'description' => 'Indicates whether the Audience contains phone numbers. Audiences that include phone numbers can be used in Reach campaigns.', 'type' => 'boolean', 'example' => '1390000****'], 'Project' => ['title' => '', 'description' => 'MaxCompute (ODPS) project name. Required when the audience source is MaxCompute.', 'type' => 'string', 'example' => 'project'], 'Remark' => ['title' => '', 'description' => 'Audience remark.', 'type' => 'string', 'example' => '充值大于10万'], 'Source' => ['title' => '', 'description' => 'Audience source.'."\n" .'- 0: Text. Each line contains one phone number, with a maximum of 100 numbers.'."\n" .'- 1: Text file. Each line contains one phone number. You can upload the file via the console or specify a custom OSS URI. Before specifying a custom OSS URI, you must complete one-click authorization in the console.'."\n" .'- 2: CSV file. You must specify the column name for phone numbers. You can upload the file via the console or specify a custom OSS URI. Before specifying a custom OSS URI, you must complete one-click authorization in the console.'."\n" .'- 3: MaxCompute (ODPS) table. You must specify the column name for phone numbers.'."\n" .'- 4: Algorithm.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Status' => ['title' => '', 'description' => 'Audience status. '."\n" .'- 0: Checking. '."\n" .'- 1: Passed. '."\n" .'- 2: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Table' => ['title' => '', 'description' => 'MaxCompute (ODPS) table name. This parameter is required when the audience source is MaxCompute.', 'type' => 'string', 'example' => 'recall'], 'Text' => ['title' => '', 'description' => 'Text content. This parameter is required when the audience source is text.', 'type' => 'string', 'example' => '1390000****'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Uri' => ['title' => '', 'description' => 'File URI. Required when the audience source is a text file or a CSV file.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/file'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"Column\\": \\"phone\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=20220101\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"充值大于10万\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Create Audience ', 'description' => 'Before using this feature, you must grant OSS access permissions with one click on the web console and add the label pai=plugin to the OSS Bucket that needs to be accessed. For more information, see [Add a label to an OSS bucket](https://help.aliyun.com/document_detail/133826.html).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'], ], ], 'translator' => 'machine', ], 'CreateInferenceJob' => [ 'summary' => 'CreateInferenceJob', 'path' => '/api/v2/inference/jobs', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129052', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Body information of the request parameters.', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm ID.', 'type' => 'string', 'required' => false, 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'Associated operational activity ID.', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'DataPath' => ['title' => '', 'description' => 'Prediction data path.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'Name' => ['title' => '', 'description' => 'Prediction job name.', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'], 'TargetPath' => ['title' => '', 'description' => 'Output data path, which must be an empty folder.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'TrainingJobId' => ['title' => '', 'description' => 'Associated training job.', 'type' => 'string', 'required' => false, 'example' => '123'], 'UserConfig' => ['title' => '', 'description' => 'User configuration.', 'type' => 'string', 'required' => false, 'example' => '{}'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The request to register a prediction job has been successfully submitted. You can check the task execution status in the console or by calling GetInferenceJob. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm ID.', 'type' => 'string', 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'Associated operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'DataPath' => ['title' => '', 'description' => 'Prediction data path.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'GroupId' => ['title' => '', 'description' => 'Associated Audience ID. If the job fails, the audience is invalid.', 'type' => 'string', 'example' => 'bdb0b117-3354-4ceb-ba75-e022dd9370d8'], 'History' => ['title' => '', 'description' => 'Prediction task logs. ', 'type' => 'string', 'example' => 'Error: Missing Column.'], 'Id' => ['title' => '', 'description' => 'Prediction Task ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Prediction Task Name.', 'type' => 'string', 'example' => 'VIP客户'], 'Remark' => ['title' => '', 'description' => 'Remark.', 'type' => 'string', 'example' => '充值大于一万'], 'Status' => ['title' => '', 'description' => 'Prediction job status. '."\n" .'- 0: In queue. '."\n" .'- 1: Submitted. '."\n" .'- 2: Running. '."\n" .'- 3: Succeeded. '."\n" .'- 4: Failed. ', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'TargetPath' => ['title' => '', 'description' => 'Output data path, which must be an empty folder. ', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'TrainingJobId' => ['title' => '', 'description' => 'Associated training job. ', 'type' => 'string', 'example' => '123'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'UserConfig' => ['title' => '', 'description' => 'User configuration.', 'type' => 'string', 'example' => '{}'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"bdb0b117-3354-4ceb-ba75-e022dd9370d8\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Create Prediction Task', 'description' => 'Before using this feature, you must grant OSS access permissions with one click on the web console and add the label `pai=plugin` to the OSS bucket you want to access. For more information, see [Add a label to an OSS bucket](https://help.aliyun.com/document_detail/133826.html). '."\n" .'The output CSV file of the prediction job does not contain a header. Each column represents the following fields in order: `user_id`, `item_id`, `phone`, and `score`. ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInferenceJob'], ], ], 'translator' => 'machine', ], 'CreateSchedule' => [ 'summary' => 'Create a reach plan to engage and recall churned users, using the parameter settings detailed in this topic.', 'path' => '/api/v2/schedules', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129053', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The main entity of the request parameters.', 'type' => 'object', 'properties' => [ 'EndTime' => ['description' => 'End time (UTC+8).', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01', 'title' => '', 'required' => false], 'ExecuteTime' => ['description' => 'Execution time (UTC+8):'."\n" ."\n" .'- If empty, execute immediately.'."\n" ."\n" .'- If you set an execution time, set the recurrence (RepeatCycle).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => '', 'required' => false], 'GroupId' => ['description' => 'Group ID. For more information on how to get a group ID, see [ListGroups]().', 'type' => 'string', 'required' => true, 'example' => '0****195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Name' => ['description' => 'Reach plan name. The length is 2 to 30 characters. It supports letters, numbers, Chinese characters, and underscores (\\_).', 'type' => 'string', 'example' => 'Growth-2021-0101', 'required' => true, 'title' => ''], 'RepeatCycle' => ['description' => 'Recurrence. Execute based on the recurrence and recurrence unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], 'RepeatCycleUnit' => ['description' => 'Recurrence unit. If you specify an execution time (ExecuteTime), execute based on the recurrence unit.'."\n" ."\n" .'- 0: Never (default).'."\n" ."\n" .'- 1: Hour.'."\n" ."\n" .'- 2: Day.'."\n" ."\n" .'- 3: Week.'."\n" ."\n" .'- 4: Month.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], 'RepeatTimes' => ['description' => 'Number of recurrences. Values are as follows:'."\n" ."\n" .'- -1: No end time (default).'."\n" ."\n" .'- 0: No recurrence.'."\n" ."\n" .'- N: Stop after N recurrences.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => '', 'required' => false], 'SignName' => ['description' => 'Signature name. For more information on how to get a signature name, see [ListSignatures]().', 'type' => 'string', 'example' => 'PAI', 'title' => '', 'required' => false], 'SignatureId' => ['description' => 'Signature ID. For more information on how to get a signature ID, see [ListSignatures]().', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302****', 'title' => '', 'required' => false], 'TemplateCode' => ['description' => 'Template Code. For more information on how to get a template Code, see [ListTemplates]().', 'type' => 'string', 'example' => 'SMS_123***', 'title' => '', 'required' => false], 'TemplateId' => ['description' => 'The ID or code of the template. For more information, see [ListTemplates](~~413414~~).', 'type' => 'string', 'example' => '0a54e***-03e2-40bd-869d-b71cb30*****', 'title' => '', 'required' => false], 'AISendStartDate' => ['description' => 'Smart send start time.', 'type' => 'string', 'example' => '2020-01-01 12:00:00'."\n", 'required' => false, 'title' => ''], 'AISendEndDate' => ['description' => 'Smart send end time.', 'type' => 'string', 'example' => '2020-01-01 12:00:00'."\n", 'required' => false, 'title' => ''], 'PaymentType' => ['description' => 'Billing type (defaults to pay-as-you-go if empty). Values are as follows:'."\n" ."\n" .'- PayAsYouGo: Pay-as-you-go'."\n" ."\n" .'- Subscription: Subscription'."\n" ."\n" .'- MixPay: Mixed payment', 'type' => 'string', 'example' => 'PayAsYouGo', 'required' => false, 'title' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Successfully registered the reach plan. Use the console or GetSchedule to check the reach plan and its status.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['description' => 'Creation time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'EndTime' => ['description' => 'End time (UTC+8).', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01', 'title' => ''], 'ExecuteTime' => ['description' => 'Execution time (UTC+8). If empty, execute immediately.', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '0****195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Id' => ['description' => 'Reach plan ID.', 'type' => 'string', 'example' => '0a54****-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Name' => ['description' => 'Reach plan name.', 'type' => 'string', 'example' => '增长-2021-0101', 'title' => ''], 'RepeatCycle' => ['description' => 'Recurrence. Execute based on the recurrence and recurrence unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RepeatCycleUnit' => ['description' => 'Recurrence unit. If you specify an execution time, execute based on the recurrence unit. Possible values:'."\n" ."\n" .'- 0: Never (default).'."\n" ."\n" .'- 1: Hour.'."\n" ."\n" .'- 2: Day.'."\n" ."\n" .'- 3: Week.'."\n" ."\n" .'- 4: Month.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RepeatTimes' => ['description' => 'Number of recurrences. Possible values:'."\n" ."\n" .'- -1: No end time (default).'."\n" ."\n" .'- 0: No recurrence.'."\n" ."\n" .'- N: Stop after N recurrences.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], 'SignName' => ['description' => 'Signature.', 'type' => 'string', 'example' => 'PAI', 'title' => ''], 'SignatureId' => ['description' => 'Signature ID, or specify a signature.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302****', 'title' => ''], 'Status' => ['description' => 'Status. Possible values:'."\n" ."\n" .'- 0: Checking.'."\n" ."\n" .'- 1: Check successful.'."\n" ."\n" .'- 2: Check failed.'."\n" ."\n" .'- 3: Sending.'."\n" ."\n" .'- 4: Send successful.'."\n" ."\n" .'- 5: Send failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'TemplateCode' => ['description' => 'Template Code.', 'type' => 'string', 'example' => 'SMS_123***', 'title' => ''], 'TemplateId' => ['description' => 'Template ID, or specify a template Code.', 'type' => 'string', 'example' => '0a54e***-03e2-40bd-869d-b71cb30*****', 'title' => ''], 'UpdatedTime' => ['description' => 'Update time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85****', 'title' => ''], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0****195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Id\\": \\"0a54****-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"增长-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": -1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302****\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123***\\",\\n \\"TemplateId\\": \\"0a54e***-03e2-40bd-869d-b71cb30*****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85****\\"\\n}","type":"json"}]', 'title' => 'Create Reach Plan', 'changeSet' => [ ['createdAt' => '2023-03-09T08:29:49.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSchedule'], ], ], 'translator' => 'machine', ], 'CreateSignature' => [ 'summary' => 'CreateSignature', 'path' => '/api/v2/signatures', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123190', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Entity information of the request parameters.', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'Request description.', 'type' => 'string', 'required' => false, 'example' => 'Application description'], 'Name' => ['title' => '', 'description' => 'Sign name.', 'type' => 'string', 'required' => true, 'example' => 'User growth'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Successfully initiated the signature registration request. You can obtain the review status in the console or by using GetSignature.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Id' => ['title' => '', 'description' => 'Signature ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Signature Name.', 'type' => 'string', 'example' => '用户增长'], 'Status' => ['title' => '', 'description' => 'Signature review status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '0'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID', 'type' => 'string', 'example' => '0'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"用户增长\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"0\\"\\n}","type":"json"}]', 'title' => 'Register Sign', 'changeSet' => [ ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'], ], ], 'translator' => 'machine', ], 'CreateTemplate' => [ 'summary' => 'CreateTemplate', 'path' => '/api/v2/templates', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123191', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Body information of the request parameters.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Template content. Note that the total number of characters must not exceed 70. Any excess will be billed as a long text message, with each segment of 67 characters counted as one message. Marketing messages must end with "Reply T to unsubscribe."', 'type' => 'string', 'required' => false, 'example' => '模板内容'], 'Description' => ['title' => '', 'description' => 'Application description.', 'type' => 'string', 'required' => false, 'example' => 'Application description'], 'Name' => ['title' => '', 'description' => 'Template name.', 'type' => 'string', 'required' => false, 'example' => '模板召回-20220101'], 'Signature' => ['title' => '', 'description' => 'Signature name.', 'type' => 'string', 'required' => false, 'example' => 'PAI'], 'SignatureId' => ['title' => '', 'description' => 'Signature ID. You can obtain a list of signatures with the review status set to Pass by calling ListSignatures, and then retrieve the signature ID.', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'], 'Type' => ['title' => '', 'description' => 'Template type.'."\n" .'- 0: verification code.'."\n" .'- 1: notification.'."\n" .'- 2: promotional message.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'The request to register a template has been successfully initiated. You can obtain the review status in the console or by using GetTemplate. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Template Content.', 'type' => 'string', 'example' => '模板内容'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Description' => ['title' => '', 'description' => 'Request description. ', 'type' => 'string', 'example' => '申请说明'], 'Id' => ['title' => '', 'description' => 'Template ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Template Name.', 'type' => 'string', 'example' => '模板召回-20220101'], 'Reason' => ['title' => '', 'description' => 'Review comments.', 'type' => 'string', 'example' => 'Agree'], 'Signature' => ['title' => '', 'description' => 'Sign.', 'type' => 'string', 'example' => 'PAI notification'], 'SignatureId' => ['title' => '', 'description' => 'Signature ID. ', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'], 'Status' => ['title' => '', 'description' => 'Review Status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'TemplateCode' => ['title' => '', 'description' => 'Template Code. ', 'type' => 'string', 'example' => 'SMS_123456'], 'Type' => ['title' => '', 'description' => 'templatetype. '."\n" .'- 0: verification code. '."\n" .'- 1: notification. '."\n" .'- 2: promotional message. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": \\"模板内容\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"申请说明\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"Signature\\": \\"PAI notification\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Register template', 'changeSet' => [ ['createdAt' => '2023-01-06T06:53:58.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'], ], ], 'translator' => 'machine', ], 'CreateTrainingJob' => [ 'summary' => 'CreateTrainingJob', 'path' => '/api/v2/training/jobs', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129054', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Body information of the request parameters.', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'ID of the associated algorithm.', 'type' => 'string', 'required' => false, 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'ID of the associated operational activity.', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'DataPath' => ['title' => '', 'description' => 'Training data path.', 'type' => 'string', 'required' => false, 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'Name' => ['title' => '', 'description' => 'Training job name.', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'], 'UserConfig' => ['title' => '', 'description' => 'User configuration used to set parameters such as start_date and end_date to define the time range of modeling data.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "start_date": "20210101",'."\n" .' "end_date": "20210131"'."\n" .'}'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The training Job is registered successfully. You can obtain the task execution status from the console or by calling GetTrainingJob. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned Data. ', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'The associated algorithm ID.', 'type' => 'string', 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'The associated operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'DataPath' => ['title' => '', 'description' => 'The training data path.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'History' => ['title' => '', 'description' => 'Training Job logs. ', 'type' => 'string', 'example' => 'Error: Parameter are not found.'], 'Id' => ['title' => '', 'description' => 'The training job ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'The job name.', 'type' => 'string', 'example' => 'VIP客户'], 'Remark' => ['title' => '', 'description' => 'Remarks.', 'type' => 'string', 'example' => '充值大于一万'], 'Status' => ['title' => '', 'description' => 'Training Job status. '."\n" .'- 0: In queue. '."\n" .'- 1: Submitted. '."\n" .'- 2: Running. '."\n" .'- 3: Succeeded. '."\n" .'- 4: Failed. ', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'TrainingScheduleId' => ['title' => '', 'description' => 'Associated training schedule ID. ', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'UpdatedTime' => ['title' => '', 'description' => 'Update time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'UserConfig' => ['title' => '', 'description' => 'User configuration. ', 'type' => 'string', 'example' => '{'."\n" .' "start_date": "20210101",'."\n" .' "end_date": "20210131"'."\n" .'}'], 'HasModelInfo' => ['description' => 'Indicates whether feature information such as feature importance, pattern, and decision tree is stored.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'The request failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Parameter are not found.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"充值大于一万\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{\\\\n \\\\\\"start_date\\\\\\": \\\\\\"20210101\\\\\\",\\\\n \\\\\\"end_date\\\\\\": \\\\\\"20210131\\\\\\"\\\\n}\\",\\n \\"HasModelInfo\\": false\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Create Training Job', 'description' => 'Before using this feature, you must grant OSS access permissions with one click on the web console and add the label pai=plugin to the OSS Bucket that needs to be accessed. For more information, see [Add a label to an OSS bucket](https://help.aliyun.com/document_detail/133826.html). ', 'changeSet' => [ ['createdAt' => '2022-12-23T03:09:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-12-22T06:31:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'], ], ], 'translator' => 'machine', ], 'DeleteCampaign' => [ 'summary' => 'DeleteCampaign', 'path' => '/api/v2/campaigns/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131223', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => 'path', 'description' => 'The operational activity ID. You can obtain the ID by calling ListCampaigns to retrieve the operational activity list.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The operational activity is deleted successfully.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'string', 'example' => 'OK'], 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. Check the ErrorMessage for the reason and the Data field for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'The returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete an operational activity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCampaign'], ], ], ], 'DeleteGroup' => [ 'summary' => 'DeleteGroup', 'path' => '/api/v2/groups/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129055', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => 'path', 'description' => 'Audience ID. You can obtain the audience list by calling ListGroups to get the corresponding ID.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Succeeded.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '', 'description' => 'Returned data.', 'type' => 'string', 'example' => 'OK'], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete an audience', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'], ], ], ], 'DeleteInferenceJob' => [ 'summary' => 'DeleteInferenceJob', 'path' => '/api/v2/inference/jobs/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129056', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Prediction task ID. You can call ListInferenceJobs to query the list of prediction tasks under your account and obtain the prediction task ID.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The prediction task is deleted successfully.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '', 'description' => 'Returned data.', 'type' => 'string', 'example' => 'OK'], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete Prediction Task', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInferenceJob'], ], ], ], 'DeleteSchedule' => [ 'summary' => 'You can delete a schedule if your business needs change or you need to cancel a send.', 'path' => '/api/v2/schedules/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129057', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['description' => 'The schedule ID. For more information, see [ListSchedules](~~429073~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The schedule was successfully deleted.', 'type' => 'object', 'properties' => [ 'Data' => ['description' => 'The data returned.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'ErrorCode' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a', 'title' => ''], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. Check the ErrorMessage for the reason and the Data field for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'The returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete a sending schedule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSchedule'], ], ], ], 'DeleteSignature' => [ 'summary' => 'DeleteSignature', 'path' => '/api/v2/signatures/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123196', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The signature ID. You can call ListSignatures to query the signature list under your account and obtain the signature ID.', 'type' => 'string', 'required' => true, 'example' => '996e466b-6808-49c7-998c-47b57bb85dd4'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The signature is deleted successfully.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'string', 'example' => 'OK'], 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. For details, see the error message.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'The returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete a signature', 'changeSet' => [ ['createdAt' => '2023-01-06T04:01:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'], ], ], ], 'DeleteTemplate' => [ 'summary' => 'DeleteTemplate', 'path' => '/api/v2/templates/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123197', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The Template ID. You can call ListTemplates to query the template list under your account and obtain the Template ID.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The template is deleted successfully.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'string', 'example' => 'OK'], 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'The returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete a template', 'changeSet' => [ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], ], ], ], 'DeleteTrainingJob' => [ 'summary' => 'DeleteTrainingJob', 'path' => '/api/v2/training/jobs/{Id}', 'methods' => ['delete'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129058', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'The training job ID. You can call ListTrainingJobs to query the list of training jobs under your account and obtain the training job ID.', 'type' => 'string', 'required' => false, 'example' => 'b8e300a1-ff80-4ae4-bdc5-0c33dbcd76db'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The training job is deleted successfully.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'string', 'example' => 'OK'], 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. Check the ErrorMessage for the reason and the Data field for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'The returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'The error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"OK\\",\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Delete a training job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'], ], ], ], 'GetAlgorithm' => [ 'summary' => 'GetAlgorithm', 'path' => '/api/v2/algorithms/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129059', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Algorithm ID. You can query currently active algorithms by using ListAlgorithms and use the obtained algorithm ID.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Succeeded in obtaining algorithm details. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'Algorithm description. ', 'type' => 'string', 'example' => '算法说明'], 'Id' => ['title' => '', 'description' => 'Algorithm ID. ', 'type' => 'string', 'example' => 'sms_recall'], 'InferUserConfigMap' => ['title' => '', 'description' => 'Parameter names required for prediction and their corresponding parameter guides. ', 'type' => 'string', 'example' => '{}'], 'Name' => ['title' => '', 'description' => 'Algorithm name. ', 'type' => 'string', 'example' => '短信召回'], 'TrainUserConfigMap' => ['title' => '', 'description' => 'Parameter names required for training and their corresponding parameter guides. ', 'type' => 'string', 'example' => '{}'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. For the reason, see ErrorMessage. For the error code, see Data.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned Data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Description\\": \\"算法说明\\",\\n \\"Id\\": \\"sms_recall\\",\\n \\"InferUserConfigMap\\": \\"{}\\",\\n \\"Name\\": \\"短信召回\\",\\n \\"TrainUserConfigMap\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Get algorithm details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'], ], ], ], 'GetCampaign' => [ 'summary' => 'GetCampaign', 'path' => '/api/v2/campaigns/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131224', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Operational activity ID. You can call ListCampaigns to query the list of operational activities under the account and obtain the operational activity ID.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The operational activity details were successfully retrieved. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Id' => ['title' => '', 'description' => 'Operational activity ID. ', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Operational activity name. ', 'type' => 'string', 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remark. ', 'type' => 'string', 'example' => '双十一活动'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Obtain operational activity details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'], ], ], 'translator' => 'machine', ], 'GetGroup' => [ 'summary' => 'GetGroup', 'path' => '/api/v2/groups/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129060', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Audience ID, which can be obtained by calling ListGroups.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved audience details.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm. Required when the audience source is an algorithm.', 'type' => 'string', 'example' => 'user_recall'], 'Amount' => ['title' => '', 'description' => 'Audience quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'CampaignId' => ['title' => '', 'description' => 'Associated operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Column' => ['title' => '', 'description' => 'Phone number column name. This must be specified when the audience source is a CSV file or MaxCompute and includes phone numbers.', 'type' => 'string', 'example' => 'education'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Filter' => ['title' => '', 'description' => 'Filter condition. This can be specified when the audience source is MaxCompute.', 'type' => 'string', 'example' => 'ds=2022'], 'History' => ['title' => '', 'description' => 'History.', 'type' => 'string', 'example' => 'Project not found - \'sms_test\''], 'Id' => ['title' => '', 'description' => 'Audience ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'InferenceJobId' => ['title' => '', 'description' => 'Prediction task ID. Required when the audience source is an algorithm.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Audience Name.', 'type' => 'string', 'example' => 'VIP customer'], 'PhoneNumber' => ['title' => '', 'description' => 'Indicates whether the audience contains phone numbers. Audiences containing phone numbers can be used in Reach campaigns.', 'type' => 'boolean', 'example' => 'true'], 'Project' => ['title' => '', 'description' => 'MaxCompute (ODPS) project name. Required when the audience source is MaxCompute.', 'type' => 'string', 'example' => 'project'], 'Remark' => ['title' => '', 'description' => 'Audience remark.', 'type' => 'string', 'example' => 'Recharge amount exceeds 100,000'], 'Source' => ['title' => '', 'description' => 'Audience source. '."\n" .'- 0: Text. Each line contains one phone number, with a maximum of 100 numbers. '."\n" .'- 1: Text file. Each line contains one phone number. You can upload it via the console or specify a custom OSS URI. Before specifying a custom OSS URI, you must complete one-click authorization in the console. '."\n" .'- 2: CSV file. You must specify the column name for phone numbers. You can upload it via the console or specify a custom OSS URI. Before specifying a custom OSS URI, you must complete one-click authorization in the console. '."\n" .'- 3: MaxCompute (ODPS) table. You must specify the column name for phone numbers. '."\n" .'- 4: Algorithm.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Status' => ['title' => '', 'description' => 'Audience status. '."\n" .'- 0: Checking. '."\n" .'- 1: Passed. '."\n" .'- 2: Not passed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Table' => ['title' => '', 'description' => 'MaxCompute (ODPS) table name. Required when the audience source is MaxCompute.', 'type' => 'string', 'example' => 'recall'], 'Text' => ['title' => '', 'description' => 'Text. Required when the audience source is text.', 'type' => 'string', 'example' => '1390000****'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Uri' => ['title' => '', 'description' => 'File URI. Required when the audience source is a text file, CSV file, or MaxCompute.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/file'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Column\\": \\"education\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=2022\\",\\n \\"History\\": \\"Project not found - \'sms_test\'\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"Recharge amount exceeds 100,000\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Obtain audience details', 'changeSet' => [ ['createdAt' => '2022-06-07T08:36:04.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'], ], ], 'translator' => 'machine', ], 'GetInferenceJob' => [ 'summary' => 'GetInferenceJob', 'path' => '/api/v2/inference/jobs/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129061', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Prediction job ID. You can call ListInferenceJobs to query the list of prediction jobs under your account and obtain the prediction job ID.', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the details of the prediction job.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm.', 'type' => 'string', 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'Associated operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'DataPath' => ['title' => '', 'description' => 'Prediction data path.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'GroupId' => ['title' => '', 'description' => 'Associated Audience ID. If the job fails, the audience is invalid.', 'type' => 'string', 'example' => '0197261b-30e6-467b-83d6-7f72af868b03'], 'History' => ['title' => '', 'description' => 'Task logs of the prediction job.', 'type' => 'string', 'example' => 'Error: Missing Column.'], 'Id' => ['title' => '', 'description' => 'Prediction Task ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Prediction Task Name.', 'type' => 'string', 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remark.', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'], 'Status' => ['title' => '', 'description' => 'Prediction job status. '."\n" .'- 0: In queue. '."\n" .'- 1: Submitted. '."\n" .'- 2: Running. '."\n" .'- 3: Succeeded. '."\n" .'- 4: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'TargetPath' => ['title' => '', 'description' => 'Output data path, which must be an empty folder.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'TrainingJobId' => ['title' => '', 'description' => 'Associated training job.', 'type' => 'string', 'example' => '123'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'UserConfig' => ['title' => '', 'description' => 'User configuration.', 'type' => 'string', 'example' => '{}'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"0197261b-30e6-467b-83d6-7f72af868b03\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Get Prediction Job Details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInferenceJob'], ], ], 'translator' => 'machine', ], 'GetMessageConfig' => [ 'summary' => 'GetMessageConfig', 'path' => '/api/v2/users/messageConfig', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129012', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The text message configuration was obtained successfully.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'SmsReportUrl' => ['title' => '', 'description' => 'Endpoint for receiving text message sending status receipts.', 'type' => 'string', 'example' => 'http://example.com'], 'SmsUpUrl' => ['title' => '', 'description' => 'Endpoint for receiving mobile-originated (MO) text message messages.', 'type' => 'string', 'example' => 'http://example.com'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"SmsReportUrl\\": \\"http://example.com\\",\\n \\"SmsUpUrl\\": \\"http://example.com\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve text message configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageConfig'], ], ], ], 'GetSchedule' => [ 'summary' => 'Retrieves details about a delivery schedule, such as its scheduled time, content, and status.', 'path' => '/api/v2/schedules/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129062', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['description' => 'Delivery schedule ID. To get this ID, see [ListSchedules](~~429073~~).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the delivery schedule details.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['description' => 'Creation time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'EndTime' => ['description' => 'End time (UTC+8).', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01', 'title' => ''], 'ExecuteTime' => ['description' => 'Execution time (UTC+8). If empty, the schedule runs immediately.', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'History' => ['description' => 'History record.', 'type' => 'string', 'example' => 'string', 'title' => ''], 'Id' => ['description' => 'Delivery schedule ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Name' => ['description' => 'Delivery schedule name.', 'type' => 'string', 'example' => 'Growth-2021-0101', 'title' => ''], 'RepeatCycle' => ['description' => 'Recurrence interval. The schedule repeats based on this value and the recurrence unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RepeatCycleUnit' => ['description' => 'Recurrence unit. This setting takes effect only if you specify an execution time (ExecuteTime). Valid values:'."\n" ."\n" .'- 0: Never (default).'."\n" ."\n" .'- 1: Hour.'."\n" ."\n" .'- 2: Day.'."\n" ."\n" .'- 3: Week.'."\n" ."\n" .'- 4: Month.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RepeatTimes' => ['description' => 'Number of times to repeat. Valid values:'."\n" ."\n" .'- -1: No end time (default).'."\n" ."\n" .'- 0: Do not repeat.'."\n" ."\n" .'- N: Stop after N repetitions.', 'type' => 'integer', 'format' => 'int32', 'example' => '-1', 'title' => ''], 'SignName' => ['description' => 'Signature.', 'type' => 'string', 'example' => 'PAI', 'title' => ''], 'SignatureId' => ['description' => 'Signature ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Status' => ['description' => 'Status. Valid values:'."\n" ."\n" .'- 0: Checking.'."\n" ."\n" .'- 1: Check succeeded.'."\n" ."\n" .'- 2: Check failed.'."\n" ."\n" .'- 3: Sending.'."\n" ."\n" .'- 4: Send succeeded.'."\n" ."\n" .'- 5: Send failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'TemplateCode' => ['description' => 'Template code.', 'type' => 'string', 'example' => 'SMS_123456', 'title' => ''], 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'UpdatedTime' => ['description' => 'Update time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'PaymentType' => ['description' => 'Billing type. If empty, the default is pay-as-you-go. Valid values:'."\n" ."\n" .'- PayAsYouGo: Pay-as-you-go (postpaid).'."\n" ."\n" .'- Subscription: Subscription (prepaid).', 'type' => 'string', 'example' => 'Subscription', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a', 'title' => ''], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"History\\": \\"string\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"Growth-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": -1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"PaymentType\\": \\"Subscription\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Get Send Plan Details', 'changeSet' => [ ['createdAt' => '2023-03-09T08:29:49.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSchedule'], ], ], 'translator' => 'machine', ], 'GetSignature' => [ 'summary' => 'GetSignature', 'path' => '/api/v2/signatures/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123202', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Signature ID. You can call ListSignatures to query the signature list under your account and obtain the signature ID.', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the signature details.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Description' => ['title' => '', 'description' => 'Request description.', 'type' => 'string', 'example' => 'Application description'], 'Id' => ['title' => '', 'description' => 'Signature ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Signature name.', 'type' => 'string', 'example' => 'User growth'], 'Reason' => ['title' => '', 'description' => 'Review comments.', 'type' => 'string', 'example' => 'Agree'], 'Status' => ['title' => '', 'description' => 'Signature review status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"Application description\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"User growth\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Obtain signature details', 'changeSet' => [ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSignature'], ], ], 'translator' => 'machine', ], 'GetTemplate' => [ 'summary' => 'GetTemplate', 'path' => '/api/v2/templates/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123203', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Template ID. You can call ListTemplates to query the template list under your account and obtain the Template ID. ', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The template details were successfully retrieved. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Template Content.', 'type' => 'string', 'example' => 'Your crush just left you a message.'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Description' => ['title' => '', 'description' => 'Request description. ', 'type' => 'string', 'example' => 'Application description'], 'Id' => ['title' => '', 'description' => 'Template ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Template Name.', 'type' => 'string', 'example' => '模板召回-20220101'], 'Reason' => ['title' => '', 'description' => 'Review comments.', 'type' => 'string', 'example' => 'Agree'], 'SignatureId' => ['title' => '', 'description' => 'Signature ID. ', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'], 'Status' => ['title' => '', 'description' => 'Review Status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'TemplateCode' => ['title' => '', 'description' => 'Template Code. ', 'type' => 'string', 'example' => 'SMS_123456'], 'Type' => ['title' => '', 'description' => 'templatetype. '."\n" .'- 0: verification code. '."\n" .'- 1: notification. '."\n" .'- 2: promotional message. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for details.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Content\\": \\"Your crush just left you a message.\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"Application description\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve template details ', 'changeSet' => [ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'], ], ], 'translator' => 'machine', ], 'GetTrainingJob' => [ 'summary' => 'GetTrainingJob', 'path' => '/api/v2/training/jobs/{Id}', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129063', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Training job ID. For information about how to obtain a training job ID, see [ListTrainingJobs](~~429059~~).', 'type' => 'string', 'required' => false, 'example' => '0bddaf8f-5628-427a-8652-5e24f6b4c35d'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the training job details.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm ID.', 'type' => 'string', 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'Associated operational activity ID. ', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'DataPath' => ['title' => '', 'description' => 'Training data path. ', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'History' => ['title' => '', 'description' => 'Training job logs.', 'type' => 'string', 'example' => 'Error: Missing column.'], 'Id' => ['title' => '', 'description' => 'Job ID. ', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Job name. ', 'type' => 'string', 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remark. ', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'], 'Status' => ['title' => '', 'description' => 'Training job status. Possible values: '."\n" .'- 0: In queue. '."\n" .'- 1: Submitted. '."\n" .'- 2: Running. '."\n" .'- 3: Succeeded. '."\n" .'- 4: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'TrainingScheduleId' => ['title' => '', 'description' => 'Associated training schedule ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'UserConfig' => ['title' => '', 'description' => 'User configuration.', 'type' => 'string', 'example' => '{}'], 'HasModelInfo' => ['type' => 'boolean', 'description' => 'Indicates whether feature information such as feature importance, pattern, and decision tree exists.', 'example' => 'false', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code. ', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Missing column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\",\\n \\"HasModelInfo\\": false\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Obtain training job details', 'changeSet' => [ ['createdAt' => '2022-12-22T06:31:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'], ], ], 'translator' => 'machine', ], 'GetUser' => [ 'summary' => 'GetUser', 'path' => '/api/v2/users', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '128719', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully obtained basic information.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned Data.', 'type' => 'object', 'properties' => [ 'AccountStatus' => ['title' => '', 'description' => 'Account status. '."\n" .'- 0: Normal usage. '."\n" .'- 1: Temporarily suspended due to overdue payment or other reasons. '."\n" .'- 2: Product has been released. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned Data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"AccountStatus\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Obtain basic information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'], ], ], ], 'ListAlgorithms' => [ 'summary' => 'ListAlgorithms', 'path' => '/api/v2/algorithms', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129064', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by algorithm ID. ', 'type' => 'string', 'required' => false, 'example' => 'sms_recall'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by algorithm name. ', 'type' => 'string', 'required' => false, 'example' => '短信召回'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The algorithm list was retrieved successfully.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Algorithms' => [ 'title' => '', 'description' => 'The algorithm list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The algorithm ID.', 'type' => 'string', 'example' => 'sms_recall'], 'Name' => ['title' => '', 'description' => 'The algorithm name.', 'type' => 'string', 'example' => '短信召回'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'The page number. Pages start from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'The page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'TotalCount' => ['title' => '', 'description' => 'The total number of algorithms.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code. ', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data. ', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Algorithms\\": [\\n {\\n \\"Id\\": \\"sms_recall\\",\\n \\"Name\\": \\"短信召回\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve algorithm list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'], ], ], ], 'ListCampaigns' => [ 'summary' => 'ListCampaigns', 'path' => '/api/v2/campaigns', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131225', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by operational activity name. ', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number, starting from 1. Default value: 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size. Default value: 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by operational activity remark. ', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the operational activity list.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Campaigns' => [ 'title' => '', 'description' => 'Operational activity list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Id' => ['title' => '', 'description' => 'Operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Operational activity name. ', 'type' => 'string', 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remark. ', 'type' => 'string', 'example' => '双十一活动'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'Page number, starting from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'TotalCount' => ['title' => '', 'description' => 'Total number of operational activities.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code. ', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data. ', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Campaigns\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve operational activity list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'], ], ], 'translator' => 'machine', ], 'ListGroups' => [ 'summary' => 'ListGroups', 'path' => '/api/v2/groups', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129065', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Audience name filter. ', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number, starting from 1, default is 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size, default is 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by whether the audience includes phone numbers. ', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Audience remark filter. ', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'], ], [ 'name' => 'Source', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Source filter. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Review status filter. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the Audience List.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Groups' => [ 'title' => '', 'description' => 'Audience List.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'The associate algorithm. This parameter is required when the audience Source is algorithm. ', 'type' => 'string', 'example' => 'user_recall'], 'Amount' => ['title' => '', 'description' => 'The audience Quantity. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Column' => ['title' => '', 'description' => 'Phone number column name. This is required when the audience source is a CSV file or MaxCompute and contains phone numbers. '."\n", 'type' => 'string', 'example' => 'phone'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Filter' => ['title' => '', 'description' => 'Filter condition, which can be specified when the audience source is MaxCompute.', 'type' => 'string', 'example' => 'ds=2022'], 'Id' => ['title' => '', 'description' => 'Audience ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'InferenceJobId' => ['title' => '', 'description' => 'Prediction Tasks ID. This is required when the audience source is an algorithm. '."\n", 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Audience Name. '."\n", 'type' => 'string', 'example' => 'VIP customer'], 'PhoneNumber' => ['title' => '', 'description' => 'Indicates whether the audience contains phone numbers. Audiences containing phone numbers can be used in Reach campaigns.', 'type' => 'boolean', 'example' => 'true'], 'Project' => ['title' => '', 'description' => 'MaxCompute (ODPS) project name. This is required when the audience source is MaxCompute. '."\n", 'type' => 'string', 'example' => 'project'], 'Remark' => ['title' => '', 'description' => 'Audience remark. '."\n", 'type' => 'string', 'example' => 'Recharge amount exceeds 100,000'], 'Source' => ['title' => '', 'description' => 'The audience Source. '."\n" .'- 0: Text. Each line contains one Phone number. A maximum of 100 numbers are allowed. '."\n" .'- 1: Text file. Each line contains one Phone number. You can upload the file in the console or specify a Custom OSS URI. Before you specify a Custom OSS URI, ensure that you have completed one-click authorization in the console. '."\n" .'- 2: CSV file. You must specify the column name for Phone numbers. You can upload the file in the console or specify a Custom OSS URI. Before you specify a Custom OSS URI, ensure that you have completed one-click authorization in the console. '."\n" .'- 3: MaxCompute (ODPS) Table. You must specify the column name for Phone numbers. '."\n" .'- 4: Algorithm.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Status' => ['title' => '', 'description' => 'Audience status. '."\n" .'- 0: Checking. '."\n" .'- 1: Passed. '."\n" .'- 2: Not passed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Table' => ['title' => '', 'description' => 'The MaxCompute (ODPS) table name. This parameter is required when the audience Source is MaxCompute. ', 'type' => 'string', 'example' => 'recall'], 'Text' => ['title' => '', 'description' => 'The text content. This parameter is required when the audience Source is text. ', 'type' => 'string', 'example' => '1390000****'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Uri' => ['title' => '', 'description' => 'The file URI. This parameter is required when the audience Source is a text file, a CSV file, or MaxCompute. ', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/file'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Paging size. Default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'TotalCount' => ['title' => '', 'description' => 'Total Audience Quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Groups\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"Amount\\": 0,\\n \\"Column\\": \\"phone\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Filter\\": \\"ds=2022\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"InferenceJobId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"PhoneNumber\\": true,\\n \\"Project\\": \\"project\\",\\n \\"Remark\\": \\"Recharge amount exceeds 100,000\\",\\n \\"Source\\": 0,\\n \\"Status\\": 0,\\n \\"Table\\": \\"recall\\",\\n \\"Text\\": \\"1390000****\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Uri\\": \\"https://bucket.region.aliyuncs.com/folder/file\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve Audience List ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'], ], ], 'translator' => 'machine', ], 'ListInferenceJobs' => [ 'summary' => 'Lists inference jobs.', 'path' => '/api/v2/inference/jobs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129066', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'Filters prediction tasks by operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => '', 'required' => false], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Filters prediction tasks by name.', 'type' => 'string', 'example' => 'VIP customer', 'title' => '', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number, starting from 1. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'Filters prediction tasks by remark.', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'Filters prediction tasks by status.'."\n" ."\n" .'- 0: Queued.'."\n" ."\n" .'- 1: Submitted.'."\n" ."\n" .'- 2: Running.'."\n" ."\n" .'- 3: Succeeded.'."\n" ."\n" .'- 4: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], ], [ 'name' => 'CampaignName', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => '双11活动', 'description' => '', 'required' => false, 'title' => ''], ], [ 'name' => 'TrainingJobName', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'test_job', 'description' => '', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Returns the list of prediction tasks.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'InferenceJobs' => [ 'title' => '', 'description' => 'The list of prediction tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Algorithm' => ['description' => 'The associated algorithm.', 'type' => 'string', 'example' => 'user_recall', 'title' => ''], 'CampaignId' => ['description' => 'The associated operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'CreatedTime' => ['description' => 'The creation time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'DataPath' => ['description' => 'The path to the prediction data.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/', 'title' => ''], 'GroupId' => ['description' => 'The associated audience group ID. If the task fails, this group is invalid.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'History' => ['description' => 'The task logs.', 'type' => 'string', 'example' => 'Error: Missing Column.', 'title' => ''], 'Id' => ['description' => 'The prediction task ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Name' => ['description' => 'The prediction task name.', 'type' => 'string', 'example' => 'VIP customer', 'title' => ''], 'Remark' => ['description' => 'The remark.', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000', 'title' => ''], 'Status' => ['description' => 'The prediction task status.'."\n" ."\n" .'- 0: Queued.'."\n" ."\n" .'- 1: Submitted.'."\n" ."\n" .'- 2: Running.'."\n" ."\n" .'- 3: Succeeded.'."\n" ."\n" .'- 4: Failed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], 'TargetGroupId' => ['description' => 'The associated target audience group ID. If the task fails, this group is invalid.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'TargetPath' => ['description' => 'The output data path. This must be an empty folder.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/', 'title' => ''], 'TrainingJobId' => ['description' => 'The associated training task.', 'type' => 'string', 'example' => '123', 'title' => ''], 'UpdatedTime' => ['description' => 'The update time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'UserConfig' => ['description' => 'The user configuration.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['description' => 'The page number, starting from 1. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], 'PageSize' => ['description' => 'The number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => ''], 'TotalCount' => ['description' => 'The total number of prediction tasks.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['description' => 'The error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a', 'title' => ''], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"InferenceJobs\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"History\\": \\"Error: Missing Column.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TargetGroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"TargetPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"TrainingJobId\\": \\"123\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'List Prediction Tasks', 'changeSet' => [ ['createdAt' => '2022-09-28T06:02:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInferenceJobs'], ], ], 'translator' => 'machine', ], 'ListMessageMetrics' => [ 'summary' => 'ListMessageMetrics', 'path' => '/api/v2/messages/metrics', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123209', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'End date, in the format 20220102.', 'type' => 'string', 'required' => true, 'example' => '20210321'], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Associated Audience ID.', 'type' => 'string', 'required' => false, 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size. Default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'ScheduleId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Associated Reach plan ID.', 'type' => 'string', 'required' => false, 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1'], ], [ 'name' => 'Signature', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Signature name.', 'type' => 'string', 'required' => false, 'example' => 'PAI通知'], ], [ 'name' => 'SignatureId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Signature ID. You can specify either the signature name or the signature ID, but not both.', 'type' => 'string', 'required' => false, 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3'], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Start date, in the format YYYYMMDD (for example, 20220102).', 'type' => 'string', 'required' => true, 'example' => '20210321'], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template ID.', 'type' => 'string', 'required' => false, 'example' => 'SMS_123456'], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template ID. You can specify either Template Code or Template ID, but not both.', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template type.'."\n" .'- 0: verification code.'."\n" .'- 1: notification.'."\n" .'- 2: promotional message.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully obtained the text message sending statistics list.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Metrics' => [ 'title' => '', 'description' => 'List of paginated statistical data entries.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Date' => ['title' => '', 'description' => 'Sending date.', 'type' => 'string', 'example' => '20210321'], 'Fail' => ['title' => '', 'description' => 'Failed to Send.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Pending' => ['title' => '', 'description' => 'Sending in progress.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Rate' => ['title' => '', 'description' => 'Sending success rate.', 'type' => 'number', 'format' => 'float', 'example' => '0.8'], 'Success' => ['title' => '', 'description' => 'Succeeded to Send.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Total' => ['title' => '', 'description' => 'Total quantity of text messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'Page number, starting from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'TotalCount' => ['title' => '', 'description' => 'Total number of statistics entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Metrics\\": [\\n {\\n \\"Date\\": \\"20210321\\",\\n \\"Fail\\": 0,\\n \\"Pending\\": 0,\\n \\"Rate\\": 0.8,\\n \\"Success\\": 0,\\n \\"Total\\": 0\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve text message sending statistics', 'description' => 'Obtain data within the closed interval [Start Date, End Date]. The returned data is sorted in ascending order by date. Dates with empty sending statistics are not returned.'."\n" ."\n" .'Sending data is continuously updated based on the actual text message sending status within 48 hours. The final data is determined by the data after 48 hours.', 'changeSet' => [ ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-03-01T09:43:48.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessageMetrics'], ], ], ], 'ListMessages' => [ 'summary' => 'ListMessages', 'path' => '/api/v2/messages', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123210', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Datetime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Date of sending, in the format yyyymmdd.', 'type' => 'string', 'required' => true, 'example' => '20220101'], ], [ 'name' => 'ErrorCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Text message error code filter.', 'type' => 'string', 'required' => false, 'example' => 'DELIVERED'], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by associated Audience ID. ', 'type' => 'string', 'required' => false, 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241'], ], [ 'name' => 'MessageId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Text message ID filter. The message ID is the ID returned upon successful execution of SendMessage.', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Phone number.', 'type' => 'string', 'required' => false, 'example' => '1234567890'], ], [ 'name' => 'RequestId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by text message batch processing ID. The batch processing ID is the RequestId returned upon successful SendMessage. ', 'type' => 'string', 'required' => false, 'example' => '62a72a20-8a9b-4060-a510-0c30a9340cba'], ], [ 'name' => 'ScheduleId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Associated sending schedule ID. ', 'type' => 'string', 'required' => false, 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1'], ], [ 'name' => 'Signature', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Signature name. ', 'type' => 'string', 'required' => false, 'example' => 'PAI通知'], ], [ 'name' => 'SignatureId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Signature ID. You can specify either the signature name or the signature ID, but not both. ', 'type' => 'string', 'required' => false, 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Text message sending status. '."\n" .'- 0: Sending. '."\n" .'- 1: Succeeded to Send. '."\n" .'- 2: Failed to Send. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template code. ', 'type' => 'string', 'required' => false, 'example' => 'SMS_123456'], ], [ 'name' => 'TemplateId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template ID. You can specify either the template code or the template ID, but not both.', 'type' => 'string', 'required' => false, 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3'], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by template type. '."\n" .'- 0: Verification code. '."\n" .'- 1: Notification. '."\n" .'- 2: Promotional message. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Succeeded. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data. ', 'type' => 'object', 'properties' => [ 'Messages' => [ 'title' => '', 'description' => 'List of text messages. ', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Text message error code.', 'type' => 'string', 'example' => 'DELIVERED'], 'GroupId' => ['title' => '', 'description' => 'Associated Audience ID.', 'type' => 'string', 'example' => '51d20163-1b10-4af2-8a23-58ad52201f2f'], 'Id' => ['title' => '', 'description' => 'Text message serial number.', 'type' => 'string', 'example' => '92d05e19-751b-4346-a7c5-8808bb49b8a2'], 'OutId' => ['title' => '', 'description' => 'External extension field.', 'type' => 'string', 'example' => '1234567890'], 'PhoneNumber' => ['title' => '', 'description' => 'Phone number.', 'type' => 'string', 'example' => '1234567890'], 'ScheduleId' => ['title' => '', 'description' => 'Associated schedule ID.', 'type' => 'string', 'example' => '0604d49d-fd23-4515-bb26-9b537cbf1f6d'], 'Signature' => ['title' => '', 'description' => 'Signature name.', 'type' => 'string', 'example' => 'PAI通知'], 'Status' => ['title' => '', 'description' => 'Text message sending status. '."\n" .'- 0: Sending. '."\n" .'- 1: Succeeded to Send. '."\n" .'- 2: Failed to Send. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'TemplateCode' => ['title' => '', 'description' => 'Template code. ', 'type' => 'string', 'example' => 'SMS_123456'], 'TemplateParams' => ['title' => '', 'description' => 'Template parameters. ', 'type' => 'string', 'example' => '{}'], 'TemplateType' => ['title' => '', 'description' => 'Template type.'."\n" .'- 0: verification code.'."\n" .'- 1: notification.'."\n" .'- 2: promotional message.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size. Default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'TotalCount' => ['title' => '', 'description' => 'Quantity of text messages. ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"ErrorCode\\": \\"DELIVERED\\",\\n \\"GroupId\\": \\"51d20163-1b10-4af2-8a23-58ad52201f2f\\",\\n \\"Id\\": \\"92d05e19-751b-4346-a7c5-8808bb49b8a2\\",\\n \\"OutId\\": \\"1234567890\\",\\n \\"PhoneNumber\\": \\"1234567890\\",\\n \\"ScheduleId\\": \\"0604d49d-fd23-4515-bb26-9b537cbf1f6d\\",\\n \\"Signature\\": \\"PAI通知\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateParams\\": \\"{}\\",\\n \\"TemplateType\\": 2\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve text message list ', 'changeSet' => [ ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-22T11:45:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessages'], ], ], ], 'ListSchedules' => [ 'summary' => 'Retrieve a list of sending schedules.', 'path' => '/api/v2/schedules', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129067', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'Filter by outreach schedule name.', 'type' => 'string', 'example' => 'User growth', 'title' => '', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['description' => 'The page number, starting from 1. The default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The page size. The default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'required' => false], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'Filter by sending status.'."\n" ."\n" .'- 0: Checking.'."\n" ."\n" .'- 1: Check successful.'."\n" ."\n" .'- 2: Check failed.'."\n" ."\n" .'- 3: Sending.'."\n" ."\n" .'- 4: Send successful.'."\n" ."\n" .'- 5: Send failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Successfully retrieved the list of outreach schedules.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['description' => 'The page number, starting from 1. The default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], 'PageSize' => ['description' => 'The page size. The default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => ''], 'Schedules' => [ 'title' => '', 'description' => 'List of outreach schedules.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreatedTime' => ['description' => 'Creation time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'EndTime' => ['description' => 'End time (UTC+8).', 'type' => 'string', 'format' => 'int32', 'example' => '2020-01-01', 'title' => ''], 'ExecuteTime' => ['description' => 'Execution time (UTC+8). If empty, execute immediately.', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], 'GroupId' => ['description' => 'Group ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Id' => ['description' => 'Outreach schedule ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Name' => ['description' => 'Outreach schedule name.', 'type' => 'string', 'example' => 'Growth-2021-0101', 'title' => ''], 'RepeatCycle' => ['description' => 'Recurrence, executed according to the recurrence and recurrence unit.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RepeatCycleUnit' => ['description' => 'Recurrence unit. If an execution time is specified, the recurrence takes effect.'."\n" ."\n" .'- 0: Never (default).'."\n" ."\n" .'- 1: Hour.'."\n" ."\n" .'- 2: Day.'."\n" ."\n" .'- 3: Week.'."\n" ."\n" .'- 4: Month.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'RepeatTimes' => ['description' => 'Number of repetitions.'."\n" ."\n" .'- -1: No end time (default).'."\n" ."\n" .'- 0: No repetition.'."\n" ."\n" .'- N: Stop after N repetitions.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'SignName' => ['description' => 'Signature.', 'type' => 'string', 'example' => 'PAI', 'title' => ''], 'SignatureId' => ['description' => 'Signature ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'Status' => ['description' => 'Status.'."\n" ."\n" .'- 0: Checking.'."\n" ."\n" .'- 1: Check successful.'."\n" ."\n" .'- 2: Check failed.'."\n" ."\n" .'- 3: Sending.'."\n" ."\n" .'- 4: Send successful.'."\n" ."\n" .'- 5: Send failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'TemplateCode' => ['description' => 'Template Code.', 'type' => 'string', 'example' => 'SMS_123456', 'title' => ''], 'TemplateId' => ['description' => 'Template ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'UpdatedTime' => ['description' => 'Update time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'Number of outreach schedules.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a', 'title' => ''], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Schedules\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"EndTime\\": \\"2020-01-01\\",\\n \\"ExecuteTime\\": \\"2020-01-01 12:00:00\\",\\n \\"GroupId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"Growth-2021-0101\\",\\n \\"RepeatCycle\\": 0,\\n \\"RepeatCycleUnit\\": 0,\\n \\"RepeatTimes\\": 1,\\n \\"SignName\\": \\"PAI\\",\\n \\"SignatureId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"TemplateId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 0\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Obtain the send plan list', 'changeSet' => [ ['createdAt' => '2022-12-23T03:09:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchedules'], ], ], 'translator' => 'machine', ], 'ListSignatures' => [ 'summary' => 'ListSignatures', 'path' => '/api/v2/signatures', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123212', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by sign name.', 'type' => 'string', 'required' => false, 'example' => 'User growth'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number. Starts from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by sign review status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The signature list was successfully retrieved.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size. Default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'Signatures' => [ 'title' => '', 'description' => 'List of signatures returned by pagination.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Id' => ['title' => '', 'description' => 'Signature ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Signature Name.', 'type' => 'string', 'example' => 'User growth'], 'Status' => ['title' => '', 'description' => 'Signature review status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'Total number of signature registration records under the account.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Signatures\\": [\\n {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"User growth\\",\\n \\"Status\\": 0,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve the sign list', 'changeSet' => [ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSignatures'], ], ], 'translator' => 'machine', ], 'ListTemplates' => [ 'summary' => 'ListTemplates', 'path' => '/api/v2/templates', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '123213', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Content', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template content filter. ', 'type' => 'string', 'required' => false, 'example' => 'Qixi Festival'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template name filter. ', 'type' => 'string', 'required' => false, 'example' => 'Recall'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page number, starting from 1. Default value is 1. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Page size. Default value is 10. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Review status filter. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Template type filter. '."\n" .'- 0: Verification code. '."\n" .'- 1: Notification. '."\n" .'- 2: Promotional message. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The template list is successfully retrieved. You can obtain the review status via the console or the GetTemplate operation.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['title' => '', 'description' => 'Page number, starting from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'Templates' => [ 'title' => '', 'description' => 'List of templates returned in the current page.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Template Content. ', 'type' => 'string', 'example' => '模板内容'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Description' => ['title' => '', 'description' => 'Request description. ', 'type' => 'string', 'example' => 'Application description'], 'Id' => ['title' => '', 'description' => 'Template ID. ', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Template Name. ', 'type' => 'string', 'example' => '模板召回-20220101'], 'Reason' => ['title' => '', 'description' => 'Review comments. ', 'type' => 'string', 'example' => 'Agree'], 'SignatureId' => ['title' => '', 'description' => 'Signature ID.', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6'], 'Status' => ['title' => '', 'description' => 'Review status. '."\n" .'- 0: Under review. '."\n" .'- 1: Pass. '."\n" .'- 2: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'TemplateCode' => ['title' => '', 'description' => 'Template Code. ', 'type' => 'string', 'example' => 'SMS_123456'], 'Type' => ['title' => '', 'description' => 'templatetype. '."\n" .'- 0: verification code. '."\n" .'- 1: notification. '."\n" .'- 2: promotional message. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['title' => '', 'description' => 'Total quantity of all template registration records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason. ', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data. ', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Templates\\": [\\n {\\n \\"Content\\": \\"模板内容\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Description\\": \\"Application description\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"模板召回-20220101\\",\\n \\"Reason\\": \\"Agree\\",\\n \\"SignatureId\\": \\"5480e3e7-f578-42d2-8ce8-217dec75f2e6\\",\\n \\"Status\\": 0,\\n \\"TemplateCode\\": \\"SMS_123456\\",\\n \\"Type\\": 1,\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 10\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Retrieve template list ', 'changeSet' => [ ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T08:18:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'], ], ], 'translator' => 'machine', ], 'ListTrainingJobs' => [ 'summary' => 'ListTrainingJobs', 'path' => '/api/v2/training/jobs', 'methods' => ['get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '129068', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by associated operational activity.', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by training job name. ', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], ], [ 'name' => 'PageNumber', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number of the training job list. Starts from 1. Default value is 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of training jobs to display per page in a paged query. Default value is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by training job remark. ', 'type' => 'string', 'required' => false, 'example' => 'Recharge amount exceeds 10,000'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Filter by training job status. Valid values:'."\n" .'- 0: In queue.'."\n" .'- 1: Submitted.'."\n" .'- 2: Running.'."\n" .'- 3: Succeeded.'."\n" .'- 4: Failed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ 'name' => 'TrainingScheduleId', 'in' => 'query', 'schema' => ['title' => '归属训练计划过滤。', 'description' => 'Filter by associated training schedule.', 'type' => 'string', 'required' => false, 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], ], [ 'name' => 'CampaignName', 'in' => 'query', 'allowEmptyValue' => false, 'schema' => ['title' => '关联运营活动名称', 'description' => 'Name of the associated operational activity.', 'type' => 'string', 'required' => false, 'example' => '双11活动'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The training job list is successfully retrieved.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'PageNumber' => ['title' => '', 'description' => 'Page number of the returned training job list.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1'], 'PageSize' => ['title' => '', 'description' => 'Number of training jobs displayed per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10'], 'TotalCount' => ['title' => '', 'description' => 'Total number of training jobs.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TrainingJobs' => [ 'title' => '', 'description' => 'Training job list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Algorithm' => ['title' => '', 'description' => 'Associated algorithm ID.', 'type' => 'string', 'example' => 'user_recall'], 'CampaignId' => ['title' => '', 'description' => 'Associated operational activity ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'CreatedTime' => ['title' => '', 'description' => 'Creation Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'DataPath' => ['title' => '', 'description' => 'Training data path.', 'type' => 'string', 'example' => 'https://bucket.region.aliyuncs.com/folder/'], 'History' => ['title' => '', 'description' => 'Training job logs.', 'type' => 'string', 'example' => 'Error: Unknown parameter.'], 'Id' => ['title' => '', 'description' => 'Training job ID.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'Training job name.', 'type' => 'string', 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remark.', 'type' => 'string', 'example' => 'Recharge amount exceeds 10,000'], 'Status' => ['title' => '', 'description' => 'Training job status. Valid values:'."\n" .'- 0: In queue.'."\n" .'- 1: Submitted.'."\n" .'- 2: Running.'."\n" .'- 3: Succeeded.'."\n" .'- 4: Failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'TrainingScheduleId' => ['title' => '关联训练计划ID。', 'description' => '关联训练计划ID。', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'UpdatedTime' => ['title' => '', 'description' => 'Update Time (UTC+8).', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'UserConfig' => ['title' => '', 'description' => 'User configuration.', 'type' => 'string', 'example' => '{\\"end_date\\":\\"20220408\\",\\"op_target\\":\\"sms\\",\\"start_date\\":\\"20220101\\"}'], 'HasModelInfo' => ['type' => 'boolean', 'default' => 'true', 'description' => 'Indicates whether feature information such as feature importance, pattern, and decision tree is available.', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => '""'], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'Failed. See ErrorMessage for the reason and Data for the error code.', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"TrainingJobs\\": [\\n {\\n \\"Algorithm\\": \\"user_recall\\",\\n \\"CampaignId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"DataPath\\": \\"https://bucket.region.aliyuncs.com/folder/\\",\\n \\"History\\": \\"Error: Unknown parameter.\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP customer\\",\\n \\"Remark\\": \\"Recharge amount exceeds 10,000\\",\\n \\"Status\\": 3,\\n \\"TrainingScheduleId\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"UserConfig\\": \\"{\\\\\\\\\\\\\\"end_date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20220408\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"op_target\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sms\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"start_date\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20220101\\\\\\\\\\\\\\"}\\",\\n \\"HasModelInfo\\": true\\n }\\n ]\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'List Training Jobs', 'changeSet' => [ ['createdAt' => '2022-12-22T06:31:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-09-28T06:02:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'], ], ], 'translator' => 'machine', ], 'SendMessage' => [ 'summary' => 'Send text messages. Before you send a message, you must register a signature and a template.', 'path' => '/api/v2/messages', 'methods' => ['post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'abilityTreeCode' => '123215', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The entity information of the request parameter.', 'type' => 'object', 'properties' => [ 'GroupId' => ['description' => 'The group ID. Use it to associate groups.', 'type' => 'string', 'example' => '10ed87f5-3ca8-4a43-9d83-b30519be7241', 'title' => '', 'required' => false], 'OutIds' => [ 'title' => '', 'description' => 'External extension field. Example: \\["1234567890"].', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1234567890', 'title' => ''], 'required' => false, 'example' => '', ], 'PhoneNumbers' => [ 'title' => '', 'description' => 'Mobile phone number. Each mobile phone number corresponds to a template variable, an upstream extension code, and an external extension field. The maximum number of mobile phone numbers is 1000. Example: \\["1234567890"].', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1234567890', 'title' => ''], 'required' => false, 'example' => '', ], 'ScheduleId' => ['description' => 'The send schedule ID. Use it to associate send schedules.', 'type' => 'string', 'example' => '08d19262-bd76-48fd-80e8-6a225ac388c1', 'title' => '', 'required' => false], 'SignName' => ['description' => 'Signature name.', 'type' => 'string', 'example' => 'PAI通知', 'title' => '', 'required' => false], 'SignatureId' => ['description' => 'Signature ID. Specify either the signature name or the signature ID.', 'type' => 'string', 'example' => '5480e3e7-f578-42d2-8ce8-217dec75f2e6', 'title' => '', 'required' => false], 'SmsUpExtendCodes' => [ 'title' => '', 'description' => 'SMS upstream extension code. Example: \\["1234567890"].', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '1234567890', 'title' => ''], 'required' => false, 'example' => '', ], 'TemplateCode' => ['description' => 'Template Code.', 'type' => 'string', 'example' => 'SMS_123456', 'title' => '', 'required' => false], 'TemplateId' => ['description' => 'Template ID. Specify either the template Code or the template ID.', 'type' => 'string', 'example' => 'b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3', 'title' => '', 'required' => false], 'TemplateParams' => [ 'title' => '', 'description' => 'The actual value corresponding to the SMS template variable, in JSON format. Supports multiple parameters. Example: \\[{"name":"Zhang San","number":"15038\\*\\*\\*\\*76"}].', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '{"name":"张三","number":"15038****76"}', 'title' => ''], 'required' => false, 'example' => '{"name":" John Doe","number":"15038****76"}', ], 'PaymentType' => ['description' => 'Billing type (pay-as-you-go by default if empty).'."\n" ."\n" .'- PayAsYouGo: Pay-as-you-go'."\n" ."\n" .'- Subscription: Subscription', 'type' => 'string', 'example' => 'PayAsYouGo', 'required' => false, 'title' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'headers' => [], 'schema' => [ 'title' => '', 'description' => 'Successfully send text messages.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'Returned data.', 'type' => 'object', 'properties' => [ 'Messages' => [ 'title' => '', 'description' => 'List of text message results. The order of mobile phone numbers in the list corresponds to the order of input request mobile phone numbers.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'SMS ID. Use ListMessages to query SMS status.', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e', 'title' => ''], 'PhoneNumber' => ['description' => 'Mobile phone number.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'RequestId' => ['description' => 'SMS batch processing ID. Use ListMessages to query SMS status.', 'type' => 'string', 'example' => '62a72a20-8a9b-4060-a510-0c30a9340cba', 'title' => ''], ], 'example' => '', ], 'ErrorCode' => ['description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a', 'title' => ''], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Messages\\": [\\n {\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"PhoneNumber\\": \\"1234567890\\"\\n }\\n ],\\n \\"RequestId\\": \\"62a72a20-8a9b-4060-a510-0c30a9340cba\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Send text message ', 'changeSet' => [ ['createdAt' => '2023-03-09T08:29:49.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-08-26T11:51:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-02-21T04:43:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-02-21T04:43:53.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-02-21T04:43:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendMessage'], ], ], 'translator' => 'machine', ], 'UpdateCampaign' => [ 'summary' => 'UpdateCampaign', 'path' => '/api/v2/campaigns/{Id}', 'methods' => ['put'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '131226', 'abilityTreeNodes' => ['FEATURElearn5SOS0Q'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'path', 'schema' => ['title' => '', 'description' => 'Operational activity ID. You can call ListCampaigns to query the list of operational activities under your account and obtain the operational activity ID.', 'type' => 'string', 'required' => false, 'example' => '996e466b-6808-49c7-998c-47b57bb85dd4'], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Entity of the request parameters.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'Operational activity name.', 'type' => 'string', 'required' => false, 'example' => 'VIP customer'], 'Remark' => ['title' => '', 'description' => 'Remark.', 'type' => 'string', 'required' => false, 'example' => '双十一活动'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The operational activity is updated successfully. ', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The returned data. ', 'type' => 'object', 'properties' => [ 'CreatedTime' => ['title' => '', 'description' => 'The creation time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], 'Id' => ['title' => '', 'description' => 'The operational activity ID. ', 'type' => 'string', 'example' => '0a54e195-03e2-40bd-869d-b71cb302783e'], 'Name' => ['title' => '', 'description' => 'The name of the operational activity. ', 'type' => 'string', 'example' => 'VIP客户'], 'Remark' => ['title' => '', 'description' => 'The remark. ', 'type' => 'string', 'example' => '双十一活动'], 'UpdatedTime' => ['title' => '', 'description' => 'The update time (UTC+8). ', 'type' => 'string', 'example' => '2020-01-01 12:00:00'], ], 'example' => '', ], 'ErrorCode' => ['title' => '', 'description' => 'The error code. ', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message. ', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '', 'description' => 'The request ID. ', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], 400 => [ 'schema' => [ 'title' => '失败，原因见ErrorMessage，错误码见Data。', 'description' => 'The request failed. For details, see ErrorMessage. For the error code, see Data. ', 'type' => 'object', 'properties' => [ 'Data' => ['title' => '返回数据。', 'description' => 'Returned data.', 'type' => 'string', 'example' => ''], 'ErrorCode' => ['title' => '错误码。', 'description' => 'Error code.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'ErrorMessage' => ['title' => '错误信息。', 'description' => 'Error message.', 'type' => 'string', 'example' => 'OK'], 'RequestId' => ['title' => '请求ID。', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'f8651828-609d-4de8-ab49-ab781d7fd85a'], ], 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"CreatedTime\\": \\"2020-01-01 12:00:00\\",\\n \\"Id\\": \\"0a54e195-03e2-40bd-869d-b71cb302783e\\",\\n \\"Name\\": \\"VIP客户\\",\\n \\"Remark\\": \\"双十一活动\\",\\n \\"UpdatedTime\\": \\"2020-01-01 12:00:00\\"\\n },\\n \\"ErrorCode\\": 0,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"RequestId\\": \\"f8651828-609d-4de8-ab49-ab781d7fd85a\\"\\n}","type":"json"}]', 'title' => 'Update operational activity', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCampaign'], ], ], 'translator' => 'machine', ], ], 'endpoints' => [ ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'paiplugin.cn-hangzhou.aliyuncs.com', 'endpoint' => 'paiplugin.cn-hangzhou.aliyuncs.com', 'vpc' => 'paiplugin-vpc.cn-hangzhou.aliyuncs.com'], ], 'errorCodes' => [], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateSchedule'], ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'GetSchedule'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SendMessage'], ], 'createdAt' => '2023-03-24T08:23:24.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTemplate'], ], 'createdAt' => '2023-01-06T06:54:37.000Z', 'description' => '修改CreateTemplate请求参数body的“必填”为否', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'CreateSchedule'], ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'CreateSignature'], ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'CreateTemplate'], ['description' => 'Request parameters changed', 'api' => 'DeleteSignature'], ], 'createdAt' => '2023-01-06T04:03:32.000Z', 'description' => '更正了DeleteSignature、CreateTemplate、CreateSignature 、CreateSchedule 等API中请求参数的必填选项', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTrainingJob'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListSchedules'], ], 'createdAt' => '2022-12-23T03:09:55.000Z', 'description' => '完善API文档', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTrainingJob'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetTrainingJob'], ['description' => 'Response parameters changed', 'api' => 'ListTrainingJobs'], ], 'createdAt' => '2022-12-22T06:32:08.000Z', 'description' => '增加模型可视化相关API', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListInferenceJobs'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTrainingJobs'], ], 'createdAt' => '2022-09-28T06:03:10.000Z', 'description' => 'ListTrainingJob、ListInferenceJob增加过滤参数', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendMessage'], ], 'createdAt' => '2022-08-26T11:51:44.000Z', 'description' => '更新API sendMessage的参数说明', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetGroup'], ], 'createdAt' => '2022-06-07T11:37:40.000Z', 'description' => 'GetGroup增加History字段', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateTemplate'], ], 'createdAt' => '2022-05-16T04:00:45.000Z', 'description' => '发布接口', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMessages'], ], 'createdAt' => '2022-03-08T05:24:07.000Z', 'description' => 'ListMessages接口新增ErrorCode过滤', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SmsReport'], ['description' => 'OpenAPI offline', 'api' => 'SmsUp'], ], 'createdAt' => '2022-03-07T06:20:17.000Z', 'description' => '新增回执接口', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateSignature'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTemplate'], ['description' => 'Response parameters changed', 'api' => 'DeleteSignature'], ['description' => 'Response parameters changed', 'api' => 'DeleteTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetSignature'], ['description' => 'Response parameters changed', 'api' => 'GetTemplate'], ['description' => 'Response parameters changed', 'api' => 'ListMessageMetrics'], ['description' => 'Response parameters changed', 'api' => 'ListMessages'], ['description' => 'Response parameters changed', 'api' => 'ListSignatures'], ['description' => 'Response parameters changed', 'api' => 'ListTemplates'], ], 'createdAt' => '2022-03-02T08:35:20.000Z', 'description' => '更新文档说明', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListMessageMetrics'], ], 'createdAt' => '2022-03-01T16:09:12.000Z', 'description' => '新增ListMessageMetrics', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateSignature'], ['description' => 'Response parameters changed', 'api' => 'CreateTemplate'], ['description' => 'Response parameters changed', 'api' => 'DeleteSignature'], ['description' => 'Response parameters changed', 'api' => 'DeleteTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetSignature'], ['description' => 'Response parameters changed', 'api' => 'GetTemplate'], ['description' => 'Response parameters changed', 'api' => 'ListMessageMetrics'], ['description' => 'Response parameters changed', 'api' => 'ListMessages'], ['description' => 'Response parameters changed', 'api' => 'ListSignatures'], ['description' => 'Response parameters changed', 'api' => 'ListTemplates'], ], 'createdAt' => '2022-03-01T16:06:14.000Z', 'description' => '更新API，新增RequestId字段', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'CreateSignature'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateTemplate'], ['description' => 'Response parameters changed', 'api' => 'DeleteSignature'], ['description' => 'Response parameters changed', 'api' => 'DeleteTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetSignature'], ['description' => 'Response parameters changed', 'api' => 'GetTemplate'], ['description' => 'Response parameters changed', 'api' => 'ListMessageMetrics'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListMessages'], ['description' => 'Response parameters changed', 'api' => 'ListSignatures'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTemplates'], ], 'createdAt' => '2022-03-01T16:03:28.000Z', 'description' => '更新文档说明', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateSignature'], ['description' => 'OpenAPI offline', 'api' => 'CreateTemplate'], ['description' => 'OpenAPI offline', 'api' => 'DeleteSignature'], ['description' => 'OpenAPI offline', 'api' => 'DeleteTemplate'], ['description' => 'OpenAPI offline', 'api' => 'GetSignature'], ['description' => 'OpenAPI offline', 'api' => 'GetTemplate'], ['description' => 'OpenAPI offline', 'api' => 'ListSignatures'], ['description' => 'OpenAPI offline', 'api' => 'ListTemplates'], ], 'createdAt' => '2022-02-21T08:19:06.000Z', 'description' => '发布短信、签名、模板API', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSignature'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSchedule'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGroups'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTemplates'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSchedule'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInferenceJobs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSignatures'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSignature'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessageMetrics'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTrainingJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSignature'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetUser'], ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendMessage'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetInferenceJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTrainingJobs'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCampaign'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTrainingJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCampaigns'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMessageConfig'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTemplate'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlgorithm'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGroup'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMessages'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateInferenceJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSchedule'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTrainingJob'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlgorithms'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSchedules'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteInferenceJob'], ], ], ];