path: root/data/en_us/dysmsapi/2018-05-01/api-docs.php

<?php return [
    'version' => '1.0',
    'info' => [
        'style' => 'RPC',
        'product' => 'Dysmsapi',
        'version' => '2018-05-01',
    ],
    'directories' => [
        [
            'id' => 349009,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'BatchSendMessageToGlobe',
                'SendMessageWithTemplate',
                'SendMessageToGlobe',
            ],
        ],
        [
            'id' => 349013,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'QueryMessage',
            ],
        ],
        [
            'id' => 349015,
            'title' => null,
            'type' => 'directory',
            'children' => [
                'ConversionData',
                'SmsConversion',
            ],
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'BatchSendMessageToGlobe' => [
            'summary' => 'Sends a message to multiple recipients in countries or regions outside the Chinese mainland.',
            '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' => 'The mobile phone number of the recipient. You must add the dialing code to the beginning of each mobile phone number.'."\n"
                            ."\n"
                            .'For more information, see [Dialing codes](~~158400~~).',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '[\\"931520581****\\",\\"931530581****\\",\\"931540581****\\",\\"931550581****\\"]',
                    ],
                ],
                [
                    'name' => 'From',
                    'in' => 'query',
                    'schema' => [
                        'title' => '发送方号码。支持SenderID的发送，只允许数字+字母，含有字母标识最长11位，纯数字标识支持15位。',
                        'description' => 'The mobile phone number of the sender. You can specify the sender ID when you call the API operation. The sender ID can contain only digits and letters. If the sender ID contains letters, it can be a maximum of 11 characters in length. If the sender ID contains only digits, it can be a maximum of 15 characters in length.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => 'Alicloud321',
                    ],
                ],
                [
                    'name' => 'Message',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信内容。',
                        'description' => 'The content of the message.'."\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' => 'The type of the message. Valid values:'."\n"
                            ."\n"
                            .'*   **NOTIFY**: notification'."\n"
                            .'*   **MKT**: promotional message'."\n",
                        'type' => 'string',
                        'required' => false,
                        'docRequired' => true,
                        'example' => 'NOTIFY',
                        'enum' => [],
                    ],
                ],
                [
                    'name' => 'TaskId',
                    'in' => 'query',
                    'schema' => [
                        'title' => '任务ID。长度不超过255个字符。可以在回执的TaskId获取。',
                        'description' => 'The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery receipt of the message.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'docRequired' => false,
                        'example' => '123789****',
                    ],
                ],
                [
                    'name' => 'ValidityPeriod',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信有效时长',
                        'description' => 'The validity period of the message. Unit: seconds.',
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '600',
                    ],
                ],
                [
                    'name' => 'ChannelId',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信通道id',
                        'description' => 'The ID of the delivery channel.',
                        'type' => 'string',
                        'required' => false,
                        'example' => 'sms-djnfjn344',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'ResponseCode' => [
                                'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。',
                                'description' => 'The HTTP status code. If OK is returned, the request is successful. For more information, see [Error codes](~~180674~~).',
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'RequestId' => [
                                'title' => '请求ID。',
                                'description' => 'The ID of the request.'."\n",
                                'type' => 'string',
                                'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D3',
                            ],
                            'FailedList' => [
                                'title' => '发送失败的号码列表。',
                                'description' => 'The list of the mobile phone numbers that failed to receive the messages.'."\n",
                                'type' => 'string',
                                'example' => '["931520581****","931530581****"]',
                            ],
                            'ResponseDescription' => [
                                'title' => '状态码描述。',
                                'description' => 'The description of the status code.'."\n",
                                'type' => 'string',
                                'example' => 'The SMS Send Request was accepted',
                            ],
                            'From' => [
                                'title' => '发送方标识，返回传入的SenderID。',
                                'description' => 'The sender ID that was returned. The API operation returns the sender ID that you have specified in the request parameters.'."\n",
                                'type' => 'string',
                                'example' => 'Alicloud321',
                            ],
                            'MessageIdList' => [
                                'title' => '发送成功的消息ID。',
                                'description' => 'The ID of the sent message.'."\n",
                                'type' => 'string',
                                'example' => '["123****","124****"]',
                            ],
                            'SuccessCount' => [
                                'title' => '成功发送条数。',
                                'description' => 'The number of sent messages.'."\n",
                                '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' => 'BatchSendMessageToGlobe',
            'description' => '## Usage notes'."\n"
                ."\n"
                .'*   You cannot call the BatchSendMessageToGlobe operation to send messages to the Chinese mainland.'."\n"
                .'*   You can call the BatchSendMessageToGlobe operation to send notifications and promotional messages to a small number of mobile phone numbers at a time. To send messages to a large number of mobile phone numbers at a time, use the mass messaging feature of the SMS console.'."\n"
                .'*   To ensure that messages can be sent on time, call the [SendMessageToGlobe](~~406238~~) operation.'."\n"
                .'*   In each request, you can send messages to up to 1,000 mobile phone numbers.',
            'extraInfo' => "\n",
        ],
        'SendMessageWithTemplate' => [
            'summary' => 'Sends a message to the Chinese mainland by using a message template.',
            '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' => 'The mobile phone number to which the message is sent. You must add the country code to the beginning of the mobile phone number. Example: 861503871\\*\\*\\*\\*.'."\n"
                            ."\n"
                            .'For more information, see [Dialing codes](https://www.alibabacloud.com/help/en/sms/product-overview/dialing-codes?spm=a2c63.p38356.0.0.367279cbwQFoeM).',
                        'type' => 'string',
                        'required' => true,
                        'example' => '861503871****',
                    ],
                ],
                [
                    'name' => 'From',
                    'in' => 'query',
                    'schema' => [
                        'title' => '发送方标识，请传入短信签名名称。您可以登录短信服务控制台，选择发往中国大陆 > 短信签名，在短信签名列表查看签名名称。',
                        'description' => 'The signature. To query the signature, log on to the [Short Message Service (SMS) console](https://sms-intl.console.aliyun.com/overview) and navigate to the **Signatures** tab of the **Go China** page.'."\n",
                        'type' => 'string',
                        'required' => true,
                        'example' => 'Alicloud321',
                    ],
                ],
                [
                    'name' => 'TemplateCode',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信模板编码。您可以登录短信服务控制台，选择发往中国大陆 > 短信内容，在短信内容列表查看短信模板编码。',
                        'description' => 'The code of the message template. To query the code, log on to the [SMS console](https://sms-intl.console.aliyun.com/overview) and navigate to the **Templates** tab of the **Go China** page.'."\n",
                        'type' => 'string',
                        'required' => true,
                        'example' => 'SMS_****',
                    ],
                ],
                [
                    'name' => 'TemplateParam',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信模板变量对应的实际值。如果模板中存在变量，该参数为必填项。',
                        'description' => 'The value of the variable in the message template. If a variable exists in the template, the parameter is required.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => '{"code":"1234","product":"ytx"}',
                    ],
                ],
                [
                    'name' => 'SmsUpExtendCode',
                    'in' => 'query',
                    'schema' => [
                        'title' => '上行短信扩展码。',
                        'description' => 'The extension code of the MO message.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => '90999',
                    ],
                ],
                [
                    'name' => 'ValidityPeriod',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信有效时长',
                        'description' => 'The validity period of the message.'."\n",
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '1',
                    ],
                ],
                [
                    'name' => 'ChannelId',
                    'in' => 'query',
                    'schema' => [
                        'description' => 'The ID of the channel.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => '5739',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'ResponseCode' => [
                                'title' => '短信提交状态码。',
                                'description' => 'The status code of the delivery request.'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'NumberDetail' => [
                                'title' => '号码明细。',
                                'description' => 'The details about the mobile phone number of the recipient.'."\n",
                                'type' => 'object',
                                'properties' => [
                                    'Carrier' => [
                                        'title' => '号码所属的运营商网络。',
                                        'description' => 'The carrier that owns the mobile phone number.'."\n",
                                        'type' => 'string',
                                        'example' => 'China Mobile',
                                    ],
                                    'Region' => [
                                        'title' => '号码所属地区。',
                                        'description' => 'The region to which the mobile phone number belongs.'."\n",
                                        'type' => 'string',
                                        'example' => 'Nanjing, Jiangsu',
                                    ],
                                    'Country' => [
                                        'title' => '号码所属国家。',
                                        'description' => 'The country to which the mobile phone number belongs.'."\n",
                                        'type' => 'string',
                                        'example' => 'China',
                                    ],
                                ],
                            ],
                            'ResponseDescription' => [
                                'title' => '短信提交状态的详细描述。',
                                'description' => 'The description of the delivery request status.'."\n",
                                'type' => 'string',
                                'example' => 'The SMS Send Request was accepted',
                            ],
                            'Segments' => [
                                'title' => '短信计费条数。',
                                'description' => 'The number of messages that incurred fees.'."\n",
                                'type' => 'string',
                                'example' => '1',
                            ],
                            'To' => [
                                'title' => '接收短信号码。号码格式为：国际区号+号码。',
                                'description' => 'The mobile phone number to which the message was sent. The dialing code was added to the beginning of the mobile phone number. Example: 861503871\\*\\*\\*\\*.'."\n",
                                'type' => 'string',
                                'example' => '861503871****',
                            ],
                            'MessageId' => [
                                'title' => '短信消息ID。由阿里云国际短信平台生成。',
                                'description' => 'The ID of the message.'."\n",
                                'type' => 'string',
                                'example' => '1**************3',
                            ],
                            'RequestId' => [
                                'title' => '请求ID。',
                                'description' => 'The ID of the request.'."\n",
                                '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' => 'SendMessageWithTemplate',
            'description' => '### Usage notes'."\n"
                ."\n"
                .'You can call the SendMessageWithTemplate operation to send messages only to the Chinese mainland.'."\n",
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
            'extraInfo' => ' ',
        ],
        'SendMessageToGlobe' => [
            'summary' => 'Sends a message to regions outside the Chinese mainland.',
            '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' => 'The mobile phone number to which the message is sent. You must add the dialing code to the beginning of the mobile phone number. Example: 8521245567\\*\\*\\*\\*.'."\n"
                            ."\n"
                            .'For more information, see [Dialing codes](https://www.alibabacloud.com/help/en/sms/product-overview/dialing-codes?spm=a2c63.p38356.0.0.48b940a1PFYRMz).'."\n"
                            ."\n"
                            .'>  You cannot call the SendMessageToGlobe operation to send messages to the Chinese mainland.',
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '8521245567****',
                    ],
                ],
                [
                    'name' => 'From',
                    'in' => 'query',
                    'schema' => [
                        'title' => '发送方号码。支持SenderId的发送，只允许数字+字母，含有字母标识最长11位，纯数字标识支持15位。',
                        'description' => 'The mobile phone number of the sender. You can also specify a sender ID. The sender ID can contain both letters and digits. If it does, the ID must be between 1 to 11 characters in length. If the sender ID contains only digits, it must be 1 to 15 characters in length.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => 'Alicloud321',
                    ],
                ],
                [
                    'name' => 'Message',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信的内容。',
                        'description' => 'The content of the message.'."\n",
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => 'Hello',
                    ],
                ],
                [
                    'name' => 'Type',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信类型。取值：'."\n"
                            .'OTP：验证码短信。'."\n"
                            .'NOTIFY：通知短信。'."\n"
                            .'MKT：推广短信。',
                        'type' => 'string',
                        'required' => false,
                    ],
                ],
                [
                    'name' => 'TaskId',
                    'in' => 'query',
                    'schema' => [
                        'title' => '任务ID。长度不超过255个字符。可以从回执的TaskId字段获取。',
                        'description' => 'The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery receipt of the message.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'docRequired' => false,
                        'example' => '123****789',
                    ],
                ],
                [
                    'name' => 'ValidityPeriod',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信有效时长',
                        'description' => 'The validity period of the message. Unit: seconds.'."\n",
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '600',
                    ],
                ],
                [
                    'name' => 'ChannelId',
                    'in' => 'query',
                    'schema' => [
                        'description' => 'The ID of the channel.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => '3790',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => 'The response parameters.'."\n",
                        'type' => 'object',
                        'properties' => [
                            'ResponseCode' => [
                                'title' => '短信提交状态码。',
                                'description' => 'The status code of the delivery request.'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'NumberDetail' => [
                                'title' => '号码明细。',
                                'description' => 'The details about the mobile phone number of the recipient.'."\n",
                                'type' => 'object',
                                'properties' => [
                                    'Carrier' => [
                                        'title' => '号码所属的运营商网络。',
                                        'description' => 'The carrier that owns the mobile phone number.'."\n",
                                        'type' => 'string',
                                        'example' => 'CMI',
                                    ],
                                    'Region' => [
                                        'title' => '号码所属地区。',
                                        'description' => 'The region to which the mobile phone number belongs.'."\n",
                                        'type' => 'string',
                                        'example' => 'HongKong',
                                    ],
                                    'Country' => [
                                        'title' => '号码所属国家。',
                                        'description' => 'The country to which the mobile phone number belongs.'."\n",
                                        'type' => 'string',
                                        'example' => 'China',
                                    ],
                                ],
                            ],
                            'RequestId' => [
                                'title' => '请求ID。',
                                'description' => 'The ID of the request.'."\n",
                                'type' => 'string',
                                'required' => false,
                                'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990',
                            ],
                            'Segments' => [
                                'title' => '短信计费条数。',
                                'description' => 'The number of messages that incurred fees.'."\n",
                                'type' => 'string',
                                'example' => '1',
                            ],
                            'ResponseDescription' => [
                                'title' => '短信提交状态码描述。',
                                'description' => 'The description of the delivery request status.'."\n",
                                'type' => 'string',
                                'example' => 'The SMS Send Request was accepted',
                            ],
                            'From' => [
                                'title' => '发送方号码，返回传入的SenderId。',
                                'description' => 'The sender ID returned.'."\n",
                                'type' => 'string',
                                'example' => 'Alicloud321',
                            ],
                            'To' => [
                                'title' => '接收方号码。',
                                'description' => 'The mobile phone number to which the message was sent.'."\n",
                                'type' => 'string',
                                'example' => '1380000****',
                            ],
                            'MessageId' => [
                                'title' => '短信消息ID。由阿里云国际短信平台生成',
                                'description' => 'The ID of the message.'."\n",
                                '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' => 'SendMessageToGlobe',
            'description' => '### [](#)'."\n"
                ."\n"
                .'The SendMessageToGlobe API operation does not support message delivery to the Chinese mainland.'."\n"
                ."\n"
                .'### [](#qps-)QPS limit'."\n"
                ."\n"
                .'You can call this operation up to 2,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.'."\n",
        ],
        'QueryMessage' => [
            'summary' => 'Queries the delivery report of a message.',
            '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' => 'The ID of the message.'."\n",
                        'type' => 'string',
                        'required' => true,
                        'docRequired' => true,
                        'example' => '1008030xxx3003',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => 'The response parameters.'."\n",
                        'type' => 'object',
                        'properties' => [
                            'Status' => [
                                'title' => '短信的发送状态。'."\n"
                                    ."\n"
                                    .'1：成功（Delivered）'."\n"
                                    .'2：失败（Delivery Failed）'."\n"
                                    .'3：发送中（Delivering）',
                                'description' => 'The delivery status of the message.'."\n"
                                    ."\n"
                                    .'*   1: The message was sent.'."\n"
                                    .'*   2: The message failed to be sent.'."\n"
                                    .'*   3: The message is being sent.'."\n",
                                'type' => 'string',
                                'example' => '1',
                            ],
                            'ErrorDescription' => [
                                'title' => '短信发送状态码的描述。',
                                'description' => 'The description of the status code.'."\n",
                                'type' => 'string',
                                'example' => 'success',
                            ],
                            'ResponseCode' => [
                                'title' => '短信提交状态码。',
                                'description' => 'The status code of the delivery request.'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'ReceiveDate' => [
                                'title' => '发送短信收到运营商回执的时间。',
                                'description' => 'The time when the delivery receipt was received from the carrier.'."\n",
                                'type' => 'string',
                                'example' => 'Mon, 24 Dec 2018 16:58:22 +0800',
                            ],
                            'NumberDetail' => [
                                'title' => '号码明细。',
                                'description' => 'The details about the mobile phone number.'."\n",
                                'type' => 'object',
                                'properties' => [
                                    'Carrier' => [
                                        'title' => '号码所属的运营商网络。',
                                        'description' => 'The carrier that owns the mobile phone number.'."\n",
                                        'type' => 'string',
                                        'example' => 'CMI',
                                    ],
                                    'Region' => [
                                        'title' => '号码所属地区。',
                                        'description' => 'The region to which the mobile phone number belongs.'."\n",
                                        'type' => 'string',
                                        'example' => 'HongKong',
                                    ],
                                    'Country' => [
                                        'title' => '号码所属国家。',
                                        'description' => 'The country to which the mobile phone number belongs.'."\n",
                                        'type' => 'string',
                                        'example' => 'China',
                                    ],
                                ],
                            ],
                            'Message' => [
                                'title' => '短信内容。',
                                'description' => 'The content of the message.'."\n",
                                'type' => 'string',
                                'example' => 'Hello!',
                            ],
                            'ResponseDescription' => [
                                'title' => '短信提交状态的详细描述。',
                                'description' => 'The description of the delivery request status.'."\n",
                                'type' => 'string',
                                'example' => 'The SMS Send Request was accepted',
                            ],
                            'ErrorCode' => [
                                'title' => '短信发送状态码。',
                                'description' => 'The status code of the message.'."\n",
                                'type' => 'string',
                                'example' => 'DELIVERED',
                            ],
                            'SendDate' => [
                                'title' => '短信转发给运营商的时间。',
                                'description' => 'The time when the message was sent to the carrier.'."\n",
                                'type' => 'string',
                                'example' => 'Mon, 24 Dec 2018 16:58:22 +0800',
                            ],
                            'To' => [
                                'title' => '接收方号码。',
                                'description' => 'The mobile phone number to which the message was sent.'."\n",
                                'type' => 'string',
                                'example' => '6581xxx810',
                            ],
                            'MessageId' => [
                                'title' => '短信消息ID。',
                                'description' => 'The ID of the message.'."\n",
                                'type' => 'string',
                                'example' => '1008030xxx3003',
                            ],
                            'RequestId' => [
                                'title' => '请求ID。',
                                'description' => 'The ID of the request.'."\n",
                                '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' => 'QueryMessage',
            'description' => '### QPS limit'."\n"
                ."\n"
                .'You can call this operation up to 300 times per second. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.'."\n",
            'requestParamsDescription' => ' ',
            'responseParamsDescription' => ' ',
            'extraInfo' => ' ',
        ],
        'ConversionData' => [
            'summary' => 'Reports the status of an OTP message to Alibaba Cloud SMS.',
            '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' => 'Timestamp of the conversion rate observation should be a Unix timestamp, a millisecond-level long integer.'."\n"
                            ."\n"
                            .'>  If this field is not specified: the current timestamp is the default.',
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '1349055900000',
                    ],
                ],
                [
                    'name' => 'ConversionRate',
                    'in' => 'formData',
                    'schema' => [
                        'title' => '转化率监控回报值。该参数取值为double类型 ，区间是[0,1]。',
                        'description' => 'Conversion rate monitoring return value.'."\n"
                            ."\n"
                            .'>  The value of this parameter is of type double, and the value is between \\[0,1].'."\n",
                        'type' => 'string',
                        'required' => true,
                        'example' => '0.53',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'ResponseCode' => [
                                'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。',
                                'description' => 'Status code. Returning OK means the request was successful. For other error codes, please refer to the [Error codes](~~180674~~) list.'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'ResponseDescription' => [
                                'title' => '状态码描述。',
                                'description' => 'The description of the status code.'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'RequestId' => [
                                'title' => '请求ID。',
                                'description' => 'The ID of the request.'."\n",
                                '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' => 'ConversionData',
            'description' => 'Metrics:'."\n"
                ."\n"
                .'*   Requested OTP messages'."\n"
                .'*   Verified OTP messages'."\n"
                ."\n"
                .'An OTP conversion rate is calculated based on the following formula: OTP conversion rate = Number of verified OTP messages/Number of requested OTP messages.'."\n",
        ],
        'SmsConversion' => [
            'summary' => 'Delivers one-time password (OTP) message statuses to Alibaba Cloud, which calculates and monitors OTP conversion rates.',
            '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' => 'The ID of the OTP message.'."\n",
                        'type' => 'string',
                        'required' => false,
                        'example' => '1008030300****',
                    ],
                ],
                [
                    'name' => 'Delivered',
                    'in' => 'query',
                    'schema' => [
                        'title' => '如果您的用户确认接收到了您发送的消息，例如，回填了短信验证码，则设置为 true。否则，设置为 false。',
                        'description' => 'Specifies whether customers replied to the OTP message. Valid values: true and false.'."\n",
                        'type' => 'boolean',
                        'required' => true,
                        'example' => 'true',
                    ],
                ],
                [
                    'name' => 'ConversionTime',
                    'in' => 'query',
                    'schema' => [
                        'title' => '触达发送目标的时间戳。必须是Unix时间戳，毫秒级别长整型。'."\n"
                            ."\n"
                            .'如果不指定该字段：默认当前的时间戳。'."\n"
                            .'如果指定该字段：该时间戳必须大于发送时间并且小于当前时间戳。',
                        'description' => 'The time when the OTP message was delivered. The value is a UNIX timestamp. Unit: milliseconds.'."\n"
                            ."\n"
                            .'*   If you leave the parameter empty, the current timestamp is specified by default.'."\n"
                            .'*   If you specify the parameter, the timestamp must be greater than the message sending time and less than the current timestamp.'."\n",
                        'type' => 'integer',
                        'format' => 'int64',
                        'required' => false,
                        'example' => '1349055900000',
                    ],
                ],
                [
                    'name' => 'To',
                    'in' => 'query',
                    'schema' => [
                        'title' => '短信手机号',
                        'description' => 'The mobile phone number of the recipient. You must add the dialing code to the beginning of the mobile phone number.'."\n"
                            ."\n"
                            .'For more information, see [Dialing codes](~~158400~~).',
                        'type' => 'string',
                        'required' => false,
                        'example' => '8521245567****',
                    ],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'description' => '',
                        'type' => 'object',
                        'properties' => [
                            'ResponseCode' => [
                                'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。',
                                'description' => 'The status code. If OK is returned, the request is successful. For more information, see [Error codes](~~180674~~).'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'ResponseDescription' => [
                                'title' => '状态码描述。',
                                'description' => 'The description of the status code.'."\n",
                                'type' => 'string',
                                'example' => 'OK',
                            ],
                            'RequestId' => [
                                'title' => '请求ID。',
                                'description' => 'The ID of the request.'."\n",
                                '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' => 'SmsConversion',
            'description' => 'Metrics:'."\n"
                ."\n"
                .'*   Requested OTP messages'."\n"
                .'*   Verified OTP messages'."\n"
                ."\n"
                .'An OTP conversion rate is calculated based on the following formula: OTP conversion rate = Number of verified OTP messages/Number of requested OTP messages.'."\n"
                ."\n"
                .'> If you call the SmsConversion operation to query OTP conversion rates, your business may be affected. We recommend that you perform the following operations:'."\n"
                .'>*   Call the SmsConversion operation in an asynchronous manner by configuring queues or events.'."\n"
                .'>*   Manually degrade your services or use a circuit breaker to automatically degrade services.',
        ],
    ],
    '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',
        ],
    ],
];