diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/dysmsapi/2018-05-01 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/dysmsapi/2018-05-01')
| -rw-r--r-- | data/zh_cn/dysmsapi/2018-05-01/api-docs.php | 1201 |
1 files changed, 1201 insertions, 0 deletions
diff --git a/data/zh_cn/dysmsapi/2018-05-01/api-docs.php b/data/zh_cn/dysmsapi/2018-05-01/api-docs.php new file mode 100644 index 0000000..0705fca --- /dev/null +++ b/data/zh_cn/dysmsapi/2018-05-01/api-docs.php @@ -0,0 +1,1201 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dysmsapi', + 'version' => '2018-05-01', + ], + 'directories' => [ + [ + 'id' => 349009, + 'title' => '发送', + 'type' => 'directory', + 'children' => [ + 'BatchSendMessageToGlobe', + 'SendMessageWithTemplate', + 'SendMessageToGlobe', + ], + ], + [ + 'id' => 349013, + 'title' => '查询', + 'type' => 'directory', + 'children' => [ + 'QueryMessage', + ], + ], + [ + 'id' => 349015, + 'title' => '短信转化率', + 'type' => 'directory', + 'children' => [ + 'ConversionData', + 'SmsConversion', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'BatchSendMessageToGlobe' => [ + 'summary' => '批量发送短信到中国境外。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13267', + 'abilityTreeNodes' => [ + 'FEATUREdysms1SWWZV', + ], + ], + 'parameters' => [ + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '接收方号码。号码格式为:国际区号+号码。'."\n" + ."\n" + .'电话代码详情,请参见电话代码。', + 'description' => '接收方号码。号码格式为:国际区号+号码。'."\n" + ."\n" + .'电话代码详情,请参见[电话代码](https://www.alibabacloud.com/help/zh/short-message-service/latest/dialing-codes)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\\"931520581****\\",\\"931530581****\\",\\"931540581****\\",\\"931550581****\\"]', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方号码。支持SenderID的发送,只允许数字+字母,含有字母标识最长11位,纯数字标识支持15位。', + 'description' => '发送方号码。支持Sender ID的发送,只允许数字、字母,含有字母标识最长11位,纯数字标识支持15位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '短信内容。', + 'description' => '短信内容。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\\"message to 931520581****\\",\\"message to 931530581****\\",\\"message to 931540581****\\",\\"message to 931550581****\\"]', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '短信类型。取值:'."\n" + ."\n" + .'NOTIFY:通知短信。'."\n" + .'MKT:推广短信。', + 'description' => '短信类型。取值:'."\n" + ."\n\n" + .'- **NOTIFY**:通知短信。'."\n" + ."\n" + .'- **MKT**:推广短信。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'NOTIFY', + 'enum' => [], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。长度不超过255个字符。可以在回执的TaskId获取。', + 'description' => '任务ID。长度不超过255个字符。可以在短信回执消息体的TaskId字段获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123789****', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => '短信有效时长,单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信通道id', + 'description' => '短信通道id', + 'type' => 'string', + 'required' => false, + 'example' => 'sms-djnfjn344', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功,其他错误码,请参见错误码列表。', + 'description' => '状态码。返回OK代表请求成功,其他错误码,请参见[错误码列表](https://www.alibabacloud.com/help/zh/short-message-service/latest/error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D3', + ], + 'FailedList' => [ + 'title' => '发送失败的号码列表。', + 'description' => '发送失败的号码列表。', + 'type' => 'string', + 'example' => '["931520581****","931530581****"]', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'From' => [ + 'title' => '发送方标识,返回传入的SenderID。', + 'description' => '发送方标识,返回传入的Sender ID。', + 'type' => 'string', + 'example' => 'Alicloud321', + ], + 'MessageIdList' => [ + 'title' => '发送成功的消息ID。', + 'description' => '发送成功的消息ID。', + 'type' => 'string', + 'example' => '["123****","124****"]', + ], + 'SuccessCount' => [ + 'title' => '成功发送条数。', + 'description' => '成功发送条数。', + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D28D3\\",\\n \\"FailedList\\": \\"[\\\\\\"931520581****\\\\\\",\\\\\\"931530581****\\\\\\"]\\",\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"From\\": \\"Alicloud321\\",\\n \\"MessageIdList\\": \\"[\\\\\\"123****\\\\\\",\\\\\\"124****\\\\\\"]\\",\\n \\"SuccessCount\\": \\"2\\"\\n}","type":"json"}]', + 'title' => '批量发送短信到中国境外', + 'description' => '- 该接口不支持往中国内地发送短信。'."\n" + .'- BatchSendMessageToGlobe接口主要小批量发送推广类、通知类短信。大批量发送短信请使用短信控制台的快速发送功能。'."\n" + .'- 若对短信时效性有要求,请使用[SendMessageToGlobe](https://www.alibabacloud.com/help/zh/sms/developer-reference/api-dysmsapi-2018-05-01-batchsendmessagetoglobe)接口。'."\n" + .'- 在一次请求中,最多可以向1000个手机号码分别发送短信。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户(同一个阿里云账号)QPS限制为1次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。', + 'extraInfo' => "\n", + ], + 'SendMessageWithTemplate' => [ + 'summary' => '使用短信模板发送短信,只支持发往中国内地。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13271', + 'abilityTreeNodes' => [ + 'FEATUREdysmsDXU0GD', + ], + ], + 'parameters' => [ + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '接收短信号码。号码格式为:国际区号+号码。', + 'description' => '接收短信号码。号码格式为:国际区号+号码。例如:861503871\\*\\*\\*\\*。'."\n" + ."\n" + .'电话代码详情,请参见[电话代码](https://www.alibabacloud.com/help/zh/short-message-service/latest/dialing-codes)。', + 'type' => 'string', + 'required' => true, + 'example' => '861503871****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方标识,请传入短信签名名称。您可以登录短信服务控制台,选择发往中国大陆 > 短信签名,在短信签名列表查看签名名称。', + 'description' => '发送方标识,请传入短信签名名称。您可以登录[短信服务控制台](https://sms-intl.console.aliyun.com/overview),选择**发往中国大陆** > **短信签名**,在短信签名列表查看签名名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '短信模板编码。您可以登录短信服务控制台,选择发往中国大陆 > 短信内容,在短信内容列表查看短信模板编码。', + 'description' => '短信模板编码。您可以登录[短信服务控制台](https://sms-intl.console.aliyun.com/overview),选择**发往中国大陆** > **短信内容**,在短信内容列表查看短信模板编码。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'title' => '短信模板变量对应的实际值。如果模板中存在变量,该参数为必填项。', + 'description' => '短信模板变量对应的实际值。如果模板中存在变量,该参数为必填项。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234","product":"ytx"}', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'title' => '上行短信扩展码。', + 'description' => '上行短信扩展码。', + 'type' => 'string', + 'required' => false, + 'example' => '90999', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => '短信有效时长', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '通道ID', + 'type' => 'string', + 'required' => false, + 'example' => '5739', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => '短信提交状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => '号码明细。', + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => '号码所属的运营商网络。', + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => '号码所属地区。', + 'type' => 'string', + 'example' => 'Nanjing, Jiangsu', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => '号码所属国家。', + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态的详细描述。', + 'description' => '短信提交状态的详细描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'Segments' => [ + 'title' => '短信计费条数。', + 'description' => '短信计费条数。', + 'type' => 'string', + 'example' => '1', + ], + 'To' => [ + 'title' => '接收短信号码。号码格式为:国际区号+号码。', + 'description' => '接收短信号码。号码格式为:国际区号+号码。例如:861503871\\*\\*\\*\\*。', + 'type' => 'string', + 'example' => '861503871****', + ], + 'MessageId' => [ + 'title' => '短信消息ID。由阿里云国际短信平台生成。', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '1**************3', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D23D6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"NumberDetail\\": {\\n \\"Carrier\\": \\"China Mobile\\",\\n \\"Region\\": \\"Nanjing, Jiangsu\\",\\n \\"Country\\": \\"China\\"\\n },\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"Segments\\": \\"1\\",\\n \\"To\\": \\"861503871****\\",\\n \\"MessageId\\": \\"1**************3\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D23D6\\"\\n}","errorExample":""},{"type":"xml","example":"<SendMessageWithTemplateResponse>\\n <ResponseCode>OK</ResponseCode>\\n <NumberDetail>\\n <Carrier>China Mobile</Carrier>\\n <Region>Nanjing, Jiangsu</Region>\\n <Country>China</Country>\\n </NumberDetail>\\n <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>\\n <Segments>1</Segments>\\n <To>861503871****</To>\\n <MessageId>1**************3</MessageId>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D23D6</RequestId>\\n</SendMessageWithTemplateResponse>","errorExample":""}]', + 'title' => '使用短信模板发送短信', + 'description' => '### 使用说明'."\n" + .'SendMessageWithTemplate接口仅支持往中国内地发送短信。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SendMessageToGlobe' => [ + 'summary' => '发送短信到中国香港、中国澳门、中国台湾以及中国境外地区。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13270', + 'abilityTreeNodes' => [ + 'FEATUREdysms1SWWZV', + ], + ], + 'parameters' => [ + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '接收方号码。号码格式为:国际区号+号码。', + 'description' => '接收方号码。号码格式为:`国际区号+号码`。例如:8521245567\\*\\*\\*\\*。'."\n" + ."\n" + .'电话代码详情,请参见[电话代码](https://www.alibabacloud.com/help/zh/short-message-service/latest/dialing-codes)。'."\n" + ."\n" + .'> SendMessageToGlobe接口不支持往中国内地发送短信。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8521245567****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方号码。支持SenderId的发送,只允许数字+字母,含有字母标识最长11位,纯数字标识支持15位。', + 'description' => '发送方号码。支持Sender ID的发送,只允许数字、字母,含有字母标识最长11位,纯数字标识支持15位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '短信的内容。', + 'description' => '短信的内容。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hello', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '短信类型。取值:'."\n" + .'OTP:验证码短信。'."\n" + .'NOTIFY:通知短信。'."\n" + .'MKT:推广短信。', + 'description' => '短信类型。取值:'."\n" + .'- OTP:验证码短信。'."\n" + .'- NOTIFY:通知短信。'."\n" + .'- MKT:推广短信。', + 'type' => 'string', + 'required' => false, + 'example' => 'NOTIFY', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。长度不超过255个字符。可以从回执的TaskId字段获取。', + 'description' => '任务ID。长度不超过255个字符。可以在短信回执消息体的TaskId字段获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123****789', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => '短信有效时长,单位:秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '通道ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3790', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => '短信提交状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => '号码明细。', + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => '号码所属的运营商网络。', + 'type' => 'string', + 'example' => 'CMI', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => '号码所属地区。', + 'type' => 'string', + 'example' => 'HongKong', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => '号码所属国家。', + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Segments' => [ + 'title' => '短信计费条数。', + 'description' => '短信计费条数。', + 'type' => 'string', + 'example' => '1', + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态码描述。', + 'description' => '短信提交状态码描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'From' => [ + 'title' => '发送方号码,返回传入的SenderId。', + 'description' => '发送方号码,返回传入的Sender ID。', + 'type' => 'string', + 'example' => 'Alicloud321', + ], + 'To' => [ + 'title' => '接收方号码。', + 'description' => '接收方号码。', + 'type' => 'string', + 'example' => '1380000****', + ], + 'MessageId' => [ + 'title' => '短信消息ID。由阿里云国际短信平台生成', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '1008030300****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"NumberDetail\\": {\\n \\"Carrier\\": \\"CMI\\",\\n \\"Region\\": \\"HongKong\\",\\n \\"Country\\": \\"China\\"\\n },\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Segments\\": \\"1\\",\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"From\\": \\"Alicloud321\\",\\n \\"To\\": \\"1380000****\\",\\n \\"MessageId\\": \\"1008030300****\\"\\n}","errorExample":""},{"type":"xml","example":"<SendMessageToGlobeResponse>\\n <ResponseCode>OK</ResponseCode>\\n <NumberDetail>\\n <Carrier>CMI</Carrier>\\n <Region>HongKong</Region>\\n <Country>Hongkong, China</Country>\\n </NumberDetail>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n <Segments>1</Segments>\\n <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>\\n <From>Alicloud</From>\\n <To>\\"123\\"</To>\\n <MessageId>1008030300****</MessageId>\\n</SendMessageToGlobeResponse>","errorExample":""}]', + 'title' => '发送短信到港澳台及中国境外', + 'description' => '- 您可调用此接口发送短信至港澳台及中国境外,或在[发送任务](https://sms.console.alibabacloud.com/batch)界面手动发送短信至港澳台及中国境外。'."\n" + ."\n" + .'- 此接口不支持往中国内地发送短信。'."\n" + ."\n" + .'- 套餐包在账户欠费时不可使用,请在调用接口前检查[账户余额](https://home.console.alibabacloud.com/home/dashboard/ProductAndService)及[套餐包余量](https://sms-intl.console.aliyun.com/expense)。'."\n" + ."\n" + .'- 国际站短信服务按照短信提交状态计费,即便运营商回执为“失败”,仍然收费。套餐包及按量计费详情请参见[产品计费](https://www.alibabacloud.com/help/zh/sms/product-overview/pricing)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户(同一个阿里云账号)QPS限制为2000次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。', + ], + 'QueryMessage' => [ + 'summary' => '使用短信MessageId查询短信发送记录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13268', + 'abilityTreeNodes' => [ + 'FEATUREdysmsRZSVOZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信消息ID。', + 'description' => '消息ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1008030xxx3003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '短信的发送状态。'."\n" + ."\n" + .'1:成功(Delivered)'."\n" + .'2:失败(Delivery Failed)'."\n" + .'3:发送中(Delivering)', + 'description' => '短信的发送状态。'."\n" + .'- 1:成功(Delivered)'."\n" + .'- 2:失败(Delivery Failed) '."\n" + .'- 3:发送中(Delivering)', + 'type' => 'string', + 'example' => '1', + ], + 'ErrorDescription' => [ + 'title' => '短信发送状态码的描述。', + 'description' => '短信发送状态码的描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => '短信提交状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ReceiveDate' => [ + 'title' => '发送短信收到运营商回执的时间。', + 'description' => '发送短信收到运营商回执的时间。', + 'type' => 'string', + 'example' => 'Mon, 24 Dec 2018 16:58:22 +0800', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => '号码明细。', + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => '号码所属的运营商网络。', + 'type' => 'string', + 'example' => 'CMI', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => '号码所属地区。', + 'type' => 'string', + 'example' => 'HongKong', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => '号码所属国家。', + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'Message' => [ + 'title' => '短信内容。', + 'description' => '短信内容。', + 'type' => 'string', + 'example' => 'Hello!', + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态的详细描述。', + 'description' => '短信提交状态的详细描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'ErrorCode' => [ + 'title' => '短信发送状态码。', + 'description' => '短信发送状态码。', + 'type' => 'string', + 'example' => 'DELIVERED', + ], + 'SendDate' => [ + 'title' => '短信转发给运营商的时间。', + 'description' => '短信转发给运营商的时间。', + 'type' => 'string', + 'example' => 'Mon, 24 Dec 2018 16:58:22 +0800', + ], + 'To' => [ + 'title' => '接收方号码。', + 'description' => '接收方号码。', + 'type' => 'string', + 'example' => '6581xxx810', + ], + 'MessageId' => [ + 'title' => '短信消息ID。', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '1008030xxx3003', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"1\\",\\n \\"ErrorDescription\\": \\"success\\",\\n \\"ResponseCode\\": \\"OK\\",\\n \\"ReceiveDate\\": \\"Mon, 24 Dec 2018 16:58:22 +0800\\",\\n \\"NumberDetail\\": {\\n \\"Carrier\\": \\"CMI\\",\\n \\"Region\\": \\"HongKong\\",\\n \\"Country\\": \\"China\\"\\n },\\n \\"Message\\": \\"Hello!\\",\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"ErrorCode\\": \\"DELIVERED\\",\\n \\"SendDate\\": \\"Mon, 24 Dec 2018 16:58:22 +0800\\",\\n \\"To\\": \\"6581xxx810\\",\\n \\"MessageId\\": \\"1008030xxx3003\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D28D0\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMessageResponse>\\n <Status>1</Status>\\n <ErrorDescription>success</ErrorDescription>\\n <ResponseCode>OK</ResponseCode>\\n <ReceiveDate>Mon, 24 Dec 2018 16:58:22 +0800</ReceiveDate>\\n <NumberDetail>\\n <Carrier>CMI</Carrier>\\n <Region>HongKong</Region>\\n <Country>Hongkong, China</Country>\\n </NumberDetail>\\n <Message>Hello!</Message>\\n <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>\\n <ErrorCode>DELIVERED</ErrorCode>\\n <SendDate>Mon, 24 Dec 2018 16:58:22 +0800</SendDate>\\n <To>6581xxx810</To>\\n <MessageId>1008030xxx3003</MessageId>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D28D0</RequestId>\\n</QueryMessageResponse>","errorExample":""}]', + 'title' => '查询短信发送记录', + 'description' => '### QPS限制'."\n" + .'本接口的单用户(同一个阿里云账号)QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConversionData' => [ + 'summary' => '将短信转化率统计数据反馈给阿里云国际短信平台。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '31341', + 'abilityTreeNodes' => [ + 'FEATUREdysmsL8BKKM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReportTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '转化率观测的时间点。必须是Unix时间戳,毫秒级别长整型。如果不指定该字段,默认当前的时间戳。', + 'description' => '转化率观测的时间点。必须是Unix时间戳,毫秒级别长整型。'."\n" + ."\n" + .'>如果不指定该字段:默认当前的时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'ConversionRate', + 'in' => 'formData', + 'schema' => [ + 'title' => '转化率监控回报值。该参数取值为double类型 ,区间是[0,1]。', + 'description' => '转化率监控回报值。'."\n" + .'>该参数取值为double类型 ,区间是\\[0,1]。', + 'type' => 'string', + 'required' => true, + 'example' => '0.53', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功,其他错误码,请参见错误码列表。', + 'description' => '状态码。返回OK代表请求成功,其他错误码,请参见[错误码列表](https://www.alibabacloud.com/help/zh/doc-detail/180674.html)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"ResponseDescription\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConversionDataResponse>\\n <ResponseCode>OK</ResponseCode>\\n <ResponseDescription>OK</ResponseDescription>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>\\n</ConversionDataResponse>","errorExample":""}]', + 'title' => '转化率数据接入API', + 'description' => '指标说明:'."\n" + ."\n" + .'- OTP发送量:验证码发送量。'."\n" + ."\n" + .'- OTP转化量:验证码转换量。(用户成功获取验证码,并进行回传)'."\n" + ."\n" + .'转化率=OTP转化量/OTP发送量。', + ], + 'SmsConversion' => [ + 'summary' => '将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13273', + 'abilityTreeNodes' => [ + 'FEATUREdysmsL8BKKM', + ], + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信消息ID。', + 'description' => '消息ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1008030300****', + ], + ], + [ + 'name' => 'Delivered', + 'in' => 'query', + 'schema' => [ + 'title' => '如果您的用户确认接收到了您发送的消息,例如,回填了短信验证码,则设置为 true。否则,设置为 false。', + 'description' => '如果您的用户回复了您发送的消息,则设置为 true。否则,设置为 false。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConversionTime', + 'in' => 'query', + 'schema' => [ + 'title' => '触达发送目标的时间戳。必须是Unix时间戳,毫秒级别长整型。'."\n" + ."\n" + .'如果不指定该字段:默认当前的时间戳。'."\n" + .'如果指定该字段:该时间戳必须大于发送时间并且小于当前时间戳。', + 'description' => '触达发送目标的时间戳。必须是Unix时间戳,毫秒级别长整型。'."\n" + ."\n" + .'- 如果不指定该字段:默认当前的时间戳。'."\n" + ."\n" + .'- 如果指定该字段:该时间戳必须大于发送时间并且小于当前时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '短信手机号', + 'description' => '接收方号码。号码格式为:国际区号+号码。'."\n" + ."\n" + .'电话代码详情,请参见[电话代码](~~158400~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '8521245567****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功,其他错误码,请参见错误码列表。', + 'description' => '状态码。返回OK代表请求成功,其他错误码,请参见[错误码列表](https://www.alibabacloud.com/help/zh/doc-detail/180674.html)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"ResponseDescription\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\"\\n}","errorExample":""},{"type":"xml","example":"<SmsConversionResponse>\\n <ResponseCode>OK</ResponseCode>\\n <ResponseDescription>OK</ResponseDescription>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>\\n</SmsConversionResponse>","errorExample":""}]', + 'title' => '短信转化反馈', + 'description' => '指标说明:'."\n" + ."\n" + .'- OTP发送量:验证码发送量。'."\n" + ."\n" + .'- OTP转化量:验证码转换量。(用户成功获取验证码,并进行回传)'."\n" + ."\n" + .'转化率=OTP转化量/OTP发送量。'."\n" + ."\n" + .'> 转化率反馈功能会对业务系统有一定的侵入性,为了防止调用转化率API的抖动影响业务逻辑,请考虑: - 使用异步模式(例如:队列或事件驱动)调用API。 - 添加可降级的方案保护业务逻辑(例如:手动降级开工或者使用断路器自动降级)。', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'dysmsapi.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote-nebula-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dysmsapi.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + ], +]; |
