path: root/data/en_us/dyvmsapi-intl/2021-10-15/api-docs.php

<?php return [
    'version' => '1.0',
    'info' => ['style' => 'RPC', 'product' => 'Dyvmsapi-intl', 'version' => '2021-10-15'],
    'directories' => [
        [
            'children' => ['VoiceSingleCall'],
            'type' => 'directory',
            'title' => 'Voice call',
        ],
        [
            'children' => ['VoiceGroupCall'],
            'type' => 'directory',
            'title' => 'Voice group call',
        ],
        [
            'children' => ['BackendCallGroup', 'BackendCallSignal', 'SignalCall', 'GroupCall'],
            'type' => 'directory',
            'title' => 'Others',
        ],
    ],
    'components' => [
        'schemas' => [],
    ],
    'apis' => [
        'BackendCallGroup' => [
            'summary' => 'Initiates a voice group call to multiple phone numbers. The content of the group call is that of approved templates. You can log on to the VMS console and choose Voice Call Template to view the template ID. This feature enqueues the phone numbers to be called. The time when the phone numbers are called is uncertain.',
            'methods' => ['get', 'post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'update',
                'abilityTreeCode' => '107319',
                'abilityTreeNodes' => ['FEATUREdyvms5W940Z'],
            ],
            'parameters' => [
                [
                    'name' => 'CalledNumber',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'description' => 'The called numbers. You can specify up to 50,000 phone numbers.'."\n",
                        'type' => 'array',
                        'items' => ['description' => 'You must add the country code to the beginning of the phone numbers. Example: 852\\*\\*\\*\\*0000.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****0000', 'title' => ''],
                        'required' => false,
                        'title' => '',
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'CallerIdNumber',
                    'in' => 'query',
                    'schema' => ['description' => 'The calling number.'."\n"
                        ."\n"
                        .'If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and choose Number Management to view the purchased phone numbers.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****1111', 'title' => ''],
                ],
                [
                    'name' => 'CountryId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ISO2 country code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HK', 'title' => ''],
                ],
                [
                    'name' => 'PlayTimes',
                    'in' => 'query',
                    'schema' => ['description' => 'The number of times the audio file is played. Valid values: 1 to 3.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
                ],
                [
                    'name' => 'SendType',
                    'in' => 'query',
                    'schema' => ['description' => 'The delivery type. Valid values: 1 and 2.'."\n"
                        ."\n"
                        .'1: The audio file is delivered immediately.'."\n"
                        ."\n"
                        .'2: The audio file is delivered at a scheduled time. If you specify SendType as 2, you must specify TimingStart.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
                ],
                [
                    'name' => 'Speed',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback speed. Valid values: -500 to 500.'."\n"
                        ."\n"
                        .'You must specify this parameter when the audio type is text-to-speech (TTS). You do not need to specify this parameter when you use recordings.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
                ],
                [
                    'name' => 'TaskName',
                    'in' => 'query',
                    'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '测试群呼', 'title' => ''],
                ],
                [
                    'name' => 'TimingStart',
                    'in' => 'query',
                    'schema' => ['description' => 'The time when the audio file is scheduled to be delivered.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-01T08:00:00+08:00', 'title' => ''],
                ],
                [
                    'name' => 'TtsCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The voice template ID of the audio file.'."\n"
                        ."\n"
                        .'You can log on to the VMS console and choose Voice Call Template > Audio File to view the template ID.'."\n"
                        ."\n"
                        .'You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the audio file as the call content. Alternatively, you can specify VoiceCode to use preset text as the call content.'."\n", 'type' => 'string', 'required' => false, 'example' => '100001', 'title' => ''],
                ],
                [
                    'name' => 'VoiceCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The TTS template ID.'."\n"
                        ."\n"
                        .'You can log on to the VMS console and choose Voice Call Template > TTS Template to view the template ID.'."\n"
                        ."\n"
                        .'You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the audio file as the call content. Alternatively, you can specify VoiceCode to use preset text as the call content.'."\n", 'type' => 'string', 'required' => false, 'example' => '200001', 'title' => ''],
                ],
                [
                    'name' => 'Volume',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback volume of the audio file. Valid values: 0 to 100. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
                ],
                [
                    'name' => 'OutId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message.'."\n"
                        ."\n"
                        .'The value must be of the STRING type and 1 to 15 bytes in length.'."\n", 'type' => 'string', 'example' => '22596****', 'title' => '', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E50F****-****-****-****-********966F', 'title' => ''],
                            'Code' => ['description' => 'The response code.'."\n"
                                ."\n"
                                .'The value OK indicates that the request was successful. Other values indicate that the request failed. For more information, see Error codes.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'TaskId' => ['description' => 'The task ID. You can use this ID to query the details of the task.'."\n", 'type' => 'string', 'example' => '550E****-****-****-****-********00A0', 'title' => ''],
                        ],
                        'description' => '',
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => ''],
                    ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
                    ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => ''],
                    ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => ''],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"E50F****-****-****-****-********966F\\",\\n  \\"Code\\": \\"OK\\",\\n  \\"Message\\": \\"OK\\",\\n  \\"TaskId\\": \\"550E****-****-****-****-********00A0\\"\\n}","type":"json"}]',
            'title' => 'BackendCallGroup',
            'changeSet' => [],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'ramActions' => [],
        ],
        'BackendCallSignal' => [
            'summary' => 'Sends a voice verification code and voice notification with variables to a phone number.',
            'methods' => ['get', 'post'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'write',
            'deprecated' => false,
            'systemTags' => [
                'operationType' => 'update',
                'abilityTreeCode' => '107320',
                'abilityTreeNodes' => ['FEATUREdyvms5W940Z'],
            ],
            'parameters' => [
                [
                    'name' => 'CalledNumber',
                    'in' => 'query',
                    'schema' => ['description' => 'The phone number that receives the voice notification.'."\n"
                        ."\n"
                        .'You must add the country code to the beginning of the phone number. Example: 85200\\*\\*\\*\\*00.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****0000', 'title' => ''],
                ],
                [
                    'name' => 'CallerIdNumber',
                    'in' => 'query',
                    'schema' => ['description' => 'The calling number.'."\n"
                        ."\n"
                        .'If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and choose Number Management to view the purchased phone numbers.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****0000', 'title' => ''],
                ],
                [
                    'name' => 'CountryId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ISO2 country code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HK', 'title' => ''],
                ],
                [
                    'name' => 'PlayTimes',
                    'in' => 'query',
                    'schema' => ['description' => 'The number of times the voice notification is played back in a call. Valid values: 1 to 3. Default value: 3.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
                ],
                [
                    'name' => 'Speed',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback speed. Valid values: -500 to 500.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
                ],
                [
                    'name' => 'TtsCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID of the approved voice verification code template.'."\n"
                        ."\n"
                        .'You can log on to the VMS console and choose Voice Call Template to view the template ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''],
                ],
                [
                    'name' => 'TtsParam',
                    'in' => 'query',
                    'schema' => ['description' => 'The variables in the template, in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"code":"1234"}', 'title' => ''],
                ],
                [
                    'name' => 'Volume',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
                ],
                [
                    'name' => 'OutId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message.'."\n"
                        ."\n"
                        .'The value must be of the STRING type and 1 to 15 bytes in length.'."\n", 'type' => 'string', 'example' => '22522****', 'title' => '', 'required' => false],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB****-****-****-****-********9D23', 'title' => ''],
                            'Code' => ['description' => 'The response code.'."\n"
                                ."\n"
                                .'The value OK indicates that the request was successful. Other values indicate that the request failed. For more information, see Error codes.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'CallId' => ['description' => 'The unique receipt ID for the call. You can use this ID to query the details of a single call.'."\n", 'type' => 'string', 'example' => '550E****-****-****-****-********0CA0', 'title' => ''],
                        ],
                        'description' => '',
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'errorCodes' => [
                400 => [
                    ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => ''],
                    ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''],
                    ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => ''],
                    ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => ''],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"RequestId\\": \\"D9CB****-****-****-****-********9D23\\",\\n  \\"Code\\": \\"OK\\",\\n  \\"Message\\": \\"OK\\",\\n  \\"CallId\\": \\"550E****-****-****-****-********0CA0\\"\\n}","type":"json"}]',
            'title' => 'BackendCallSignal',
            'changeSet' => [],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'ramActions' => [],
        ],
        'GroupCall' => [
            'summary' => 'Initiates multiple voice calls to specified numbers. Supports voice file templates or text-to-speech templates for the calls.',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'CalledNumber',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'title' => '',
                        'description' => 'The called numbers. A maximum of 50,000 numbers are supported.',
                        'type' => 'array',
                        'items' => ['title' => '', 'description' => 'The number format: country code + number. Example: 852****0000.', 'type' => 'string', 'required' => false, 'example' => '852****0000'],
                        'required' => false,
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'CallerIdNumber',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The calling number. If you do not specify this parameter, the system uses a random local number as the display number. If you use a dedicated number for outbound calls, you must specify a purchased number. Only one number is supported. Log on to the International Voice Service console and choose Number Management to view your purchased numbers.', 'type' => 'string', 'required' => false, 'example' => '852****1111'],
                ],
                [
                    'name' => 'CountryId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The ISO 3166-1 alpha-2 country or region code.', 'type' => 'string', 'required' => false, 'example' => 'HK'],
                ],
                [
                    'name' => 'PlayTimes',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The number of times the voice file is played. Valid values: 1 to 3.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
                ],
                [
                    'name' => 'SendType',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The send type. Valid values: 1 and 2. 1: starts the task immediately. 2: starts the task at a scheduled time. If you set this parameter to 2, TimingStart is required.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'],
                ],
                [
                    'name' => 'Speed',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The speech rate. Valid values: -500 to 500. This parameter is required when the audio type is TTS. This parameter is optional for recorded files.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '94'],
                ],
                [
                    'name' => 'TaskName',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => '群呼任务'],
                ],
                [
                    'name' => 'TimingStart',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => '2022-05-01T08:00:00+08:00.', 'type' => 'string', 'required' => false, 'example' => '定时发送的时间。'],
                ],
                [
                    'name' => 'TtsCode',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The template ID for text-to-speech. Log on to the International Voice Service console and choose Voice Template Management > Text-to-Speech Template to view the template ID. You must specify either this parameter or VoiceCode. TtsCode uses fixed template text as the call content, while VoiceCode uses a voice file as the call content.', 'type' => 'string', 'required' => false, 'example' => '1****01'],
                ],
                [
                    'name' => 'VoiceCode',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The template ID for the voice file. Log on to the International Voice Service console and choose Voice Template Management > Voice File to view the template ID. You must specify either this parameter or TtsCode. VoiceCode uses a voice file as the call content, while TtsCode uses fixed template text as the call content.', 'type' => 'string', 'required' => false, 'example' => '2*****01'],
                ],
                [
                    'name' => 'Volume',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The volume for voice file playback. Valid values: 0 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11'],
                ],
                [
                    'name' => 'OutId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string of 1 to 15 bytes in length.', 'type' => 'string', 'required' => false, 'example' => '22596****'."\n"],
                ],
                [
                    'name' => 'TtsParam',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The variable parameters in the template, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"code":"1234"}'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => '""', 'title' => ''],
                            'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E50F****-****-****-****-********966F'],
                            'Message' => ['title' => '', 'description' => 'The description of the returned information.', 'type' => 'string', 'example' => 'OK'],
                            'Model' => [
                                'description' => 'The request result data.',
                                'type' => 'object',
                                'properties' => [
                                    'TaskId' => ['title' => '', 'description' => 'The task ID. You can use this ID to query the task details.', 'type' => 'string', 'example' => '550E****-****-****-****-********00A0'],
                                ],
                                'example' => '',
                                'title' => '',
                            ],
                            'Code' => ['title' => '', 'description' => 'The request status code. OK indicates a successful request. For other error codes, see API error codes.', 'type' => 'string', 'example' => 'OK'],
                        ],
                        'description' => '',
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n  \\"RequestId\\": \\"E50F****-****-****-****-********966F\\",\\n  \\"Message\\": \\"OK\\",\\n  \\"Model\\": {\\n    \\"TaskId\\": \\"550E****-****-****-****-********00A0\\"\\n  },\\n  \\"Code\\": \\"OK\\"\\n}","type":"json"}]',
            'title' => 'Initiate a batch voice call to specified numbers',
            'changeSet' => [],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'ramActions' => [],
        ],
        'SignalCall' => [
            'summary' => 'Sends a voice verification code or a voice notification with parameter variables to a specified phone number. Voice file templates and text-to-speech templates are supported.',
            'methods' => ['post', 'get'],
            'schemes' => ['http', 'https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'CallerIdNumber',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The calling number. If you do not specify this parameter, the system uses a random local number as the display number. If you use a dedicated number for outbound calls, you must specify a purchased number. Only one number is supported. You can log on to the International Voice Service console and choose Number Management to view your purchased numbers.', 'type' => 'string', 'required' => false, 'example' => '852****0001'],
                ],
                [
                    'name' => 'CalledNumber',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The phone number that receives the voice notification. Format: country code + phone number. Example: 85200****00.', 'type' => 'string', 'required' => false, 'example' => '852****0000'],
                ],
                [
                    'name' => 'TtsCode',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The voice ID of the text-to-speech template. You can log on to the International Voice Service console and choose Voice Template Management > Text-to-Speech Template to view the template ID. You must specify either this parameter or VoiceCode. TtsCode indicates that fixed template text is used as the call content, and VoiceCode indicates that a voice file is used as the call content.', 'type' => 'string', 'required' => false, 'example' => '1001'],
                ],
                [
                    'name' => 'TtsParam',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The variable parameters in the template, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"code":"1234"}'],
                ],
                [
                    'name' => 'VoiceCode',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The template ID of the voice file. You can log on to the International Voice Service console and choose Voice Template Management > Voice File to view the template ID. You must specify either this parameter or TtsCode. VoiceCode indicates that a voice file is used as the call content, and TtsCode indicates that fixed template text is used as the call content.', 'type' => 'string', 'required' => false, 'example' => '1002'],
                ],
                [
                    'name' => 'PlayTimes',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The number of times the voice notification content is played in a single call. Valid values: 1 to 3. Default value: 3.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
                ],
                [
                    'name' => 'Volume',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
                ],
                [
                    'name' => 'Speed',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The speech rate control. Valid values: -500 to 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'],
                ],
                [
                    'name' => 'CountryId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The ISO2 two-letter country or region code.', 'type' => 'string', 'required' => false, 'example' => 'HK'],
                ],
                [
                    'name' => 'TaskName',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'required' => false, 'example' => '单呼任务名'],
                ],
                [
                    'name' => 'SendType',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The send type. Valid values: 1 and 2. 1: starts the send task immediately without waiting. 2: starts the send task at a scheduled time. If you set this parameter to 2, TimingStart is required.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
                ],
                [
                    'name' => 'TimingStart',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The scheduled send time.', 'type' => 'string', 'required' => false, 'example' => '2022-05-01T08:00:00+08:00'],
                ],
                [
                    'name' => 'OutId',
                    'in' => 'query',
                    'schema' => ['title' => '', 'description' => 'The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string of 1 to 15 bytes in length.', 'type' => 'string', 'required' => false, 'example' => '22522****'],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '""', 'title' => ''],
                            'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB****-****-****-****-********9D23'."\n"],
                            'Message' => ['title' => '', 'description' => 'The description of the returned information.', 'type' => 'string', 'example' => 'OK'."\n"],
                            'Model' => [
                                'description' => 'The data of the request result.',
                                'type' => 'object',
                                'properties' => [
                                    'CallId' => ['title' => '', 'description' => 'The task ID. You can use this ID to query the task details.', 'type' => 'string', 'example' => '550E****-****-****-****-********0CA0'."\n"],
                                ],
                                'example' => '',
                                'title' => '',
                            ],
                            'Code' => ['title' => '', 'description' => 'The request status code. OK indicates a successful request. For other error codes, see API error codes.', 'type' => 'string', 'example' => 'OK'],
                            'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true'],
                        ],
                        'description' => '',
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n  \\"RequestId\\": \\"D9CB****-****-****-****-********9D23\\\\n\\",\\n  \\"Message\\": \\"OK\\\\n\\",\\n  \\"Model\\": {\\n    \\"CallId\\": \\"550E****-****-****-****-********0CA0\\\\n\\"\\n  },\\n  \\"Code\\": \\"OK\\",\\n  \\"Success\\": true\\n}","type":"json"}]',
            'title' => 'Initiate a voice call to a specified number',
            'changeSet' => [],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'ramActions' => [],
        ],
        'VoiceGroupCall' => [
            'summary' => 'Sends a voice notification to multiple phone numbers. A voice file or text-to-speech (TTS) template is supported.',
            'methods' => ['post', 'get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'CallerIdNumber',
                    'in' => 'query',
                    'schema' => ['description' => 'The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and go to the number management page to view the purchased phone numbers.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****1111', 'title' => ''],
                ],
                [
                    'name' => 'CalledNumber',
                    'in' => 'query',
                    'style' => 'json',
                    'schema' => [
                        'description' => 'The called numbers. You can specify up to 50,000 numbers.'."\n",
                        'type' => 'array',
                        'items' => ['description' => 'The number. You must add the country/region dialing code to the beginning of the phone number. Example: 852\\*\\*\\*\\*0000.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****0000', 'title' => ''],
                        'required' => false,
                        'title' => '',
                        'example' => '',
                    ],
                ],
                [
                    'name' => 'TtsCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID of the TTS template. You can log on to the VMS console and go to the TTS templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", 'type' => 'string', 'required' => false, 'example' => '1****01', 'title' => ''],
                ],
                [
                    'name' => 'TtsParam',
                    'in' => 'query',
                    'schema' => ['description' => 'The variables in the template, in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"code":"1234"}', 'title' => ''],
                ],
                [
                    'name' => 'VoiceCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID of the voice file template. You can log on to the VMS console and go to the voice file templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", 'type' => 'string', 'required' => false, 'example' => '2*****01', 'title' => ''],
                ],
                [
                    'name' => 'PlayTimes',
                    'in' => 'query',
                    'schema' => ['description' => 'The number of times the voice notification is played in the call. Valid values: 1 to 3.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
                ],
                [
                    'name' => 'Volume',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback volume of the voice file. Valid values: 0 to 100. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
                ],
                [
                    'name' => 'Speed',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback speed. Valid values: -500 to 500. This parameter is required when a TTS template is used. You do not need to specify this parameter when a recorded voice file is used.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
                ],
                [
                    'name' => 'TaskName',
                    'in' => 'query',
                    'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '群呼任务', 'title' => ''],
                ],
                [
                    'name' => 'SendType',
                    'in' => 'query',
                    'schema' => ['description' => 'The delivery type. Valid values: 1 and 2. 1: immediately delivers the task. 2: delivers the task at a scheduled time. If you set this parameter to 2, you must specify TimingStart.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
                ],
                [
                    'name' => 'TimingStart',
                    'in' => 'query',
                    'schema' => ['description' => 'The time when the task is scheduled to be delivered.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-01T08:00:00+08:00', 'title' => ''],
                ],
                [
                    'name' => 'OutId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be a string that is 1 to 15 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '22596****', 'title' => ''],
                ],
                [
                    'name' => 'CountryId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ISO2 country/region code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HK', 'title' => ''],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''],
                            'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E50F****-****-****-****-********966F', 'title' => ''],
                            'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'Model' => ['description' => 'The returned data.'."\n", 'type' => 'object', 'title' => '', 'example' => ''],
                            'Code' => ['description' => 'The error code. A value of OK indicates that the request was successful. For information about other error codes, see Error codes.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
                        ],
                        'description' => '',
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n  \\"RequestId\\": \\"E50F****-****-****-****-********966F\\",\\n  \\"Message\\": \\"OK\\",\\n  \\"Model\\": {\\n    \\"test\\": \\"test\\",\\n    \\"test2\\": 1\\n  },\\n  \\"Code\\": \\"OK\\",\\n  \\"Success\\": true\\n}","type":"json"}]',
            'title' => 'VoiceGroupCall',
            'changeSet' => [
                ['createdAt' => '2025-07-31T08:14:59.000Z', 'description' => 'OpenAPI offline'],
            ],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'ramActions' => [],
        ],
        'VoiceSingleCall' => [
            'summary' => 'Sends a voice verification code or voice notification with variables to a phone number. A voice file or text-to-speech (TTS) template is supported.',
            'methods' => ['post', 'get'],
            'schemes' => ['https'],
            'security' => [
                [
                    'AK' => [],
                ],
            ],
            'operationType' => 'read',
            'deprecated' => false,
            'parameters' => [
                [
                    'name' => 'CallerIdNumber',
                    'in' => 'query',
                    'schema' => ['description' => 'The calling number. If you do not specify this parameter, the system uses a local random number as the display number. If you use a dedicated number for outbound calls, you must specify the purchased number. You can specify only one number. You can log on to the VMS console and go to the number management page to view the purchased phone numbers.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****0001', 'title' => ''],
                ],
                [
                    'name' => 'CalledNumber',
                    'in' => 'query',
                    'schema' => ['description' => 'The phone number that receives the voice notification. You must add the country/region dialing code to the beginning of the phone number. Example: 85200\\*\\*\\*\\*00.'."\n", 'type' => 'string', 'required' => false, 'example' => '852****0000', 'title' => ''],
                ],
                [
                    'name' => 'TtsCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID of the TTS template. You can log on to the VMS console and go to the TTS templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''],
                ],
                [
                    'name' => 'TtsParam',
                    'in' => 'query',
                    'schema' => ['description' => 'The variables in the template, in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"code":"1234"}', 'title' => ''],
                ],
                [
                    'name' => 'VoiceCode',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID of the voice file template. You can log on to the VMS console and go to the voice file templates page to view the template ID. You must specify either TtsCode or VoiceCode. You can specify TtsCode to use the voice file as the call content, or you can specify VoiceCode to use preset text as the call content.'."\n", 'type' => 'string', 'required' => false, 'example' => '1002', 'title' => ''],
                ],
                [
                    'name' => 'PlayTimes',
                    'in' => 'query',
                    'schema' => ['description' => 'The number of times the voice notification is played in the call. Valid values: 1 to 3. Default value: 3.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''],
                ],
                [
                    'name' => 'Volume',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''],
                ],
                [
                    'name' => 'Speed',
                    'in' => 'query',
                    'schema' => ['description' => 'The playback speed. Valid values: -500 to 500.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''],
                ],
                [
                    'name' => 'TaskName',
                    'in' => 'query',
                    'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '单呼任务名', 'title' => ''],
                ],
                [
                    'name' => 'SendType',
                    'in' => 'query',
                    'schema' => ['description' => 'The delivery type. Valid values: 1 and 2. 1: immediately delivers the task. 2: delivers the task at a scheduled time. If you set this parameter to 2, you must specify TimingStart.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''],
                ],
                [
                    'name' => 'TimingStart',
                    'in' => 'query',
                    'schema' => ['description' => 'The time when the task is scheduled to be delivered.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-05-01T08:00:00+08:00', 'title' => ''],
                ],
                [
                    'name' => 'OutId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in a receipt message. The value must be a string that is 1 to 15 bytes in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '22522****', 'title' => ''],
                ],
                [
                    'name' => 'CountryId',
                    'in' => 'query',
                    'schema' => ['description' => 'The ISO2 country/region code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HK', 'title' => ''],
                ],
            ],
            'responses' => [
                200 => [
                    'schema' => [
                        'type' => 'object',
                        'properties' => [
                            'AccessDeniedDetail' => ['description' => 'The details about the access denial.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''],
                            'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''],
                            'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D9CB****-****-****-****-********9D23'."\n", 'title' => ''],
                            'Model' => ['description' => 'The returned data.'."\n", 'type' => 'object', 'title' => '', 'example' => ''],
                            'Code' => ['description' => 'The error code. A value of OK indicates that the request was successful. For information about other error codes, see Error codes.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''],
                            'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''],
                        ],
                        'description' => '',
                        'title' => '',
                        'example' => '',
                    ],
                ],
            ],
            'responseDemo' => '[{"errorExample":"","example":"{\\n  \\"AccessDeniedDetail\\": \\"\\\\\\"\\\\\\"\\",\\n  \\"Message\\": \\"OK\\",\\n  \\"RequestId\\": \\"D9CB****-****-****-****-********9D23\\\\n\\",\\n  \\"Model\\": {\\n    \\"test\\": \\"test\\",\\n    \\"test2\\": 1\\n  },\\n  \\"Code\\": \\"SUCCESS\\",\\n  \\"Success\\": true\\n}","type":"json"}]',
            'title' => 'VoiceSingleCall',
            'changeSet' => [
                ['createdAt' => '2025-07-31T08:14:59.000Z', 'description' => 'OpenAPI offline'],
            ],
            'flowControl' => [
                'flowControlList' => [],
            ],
            'ramActions' => [],
        ],
    ],
    'endpoints' => [
        ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dyvmsapi-intl.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dyvmsapi-intl.ap-southeast-1.aliyuncs.com', 'vpc' => 'dyvmsapi-intl-vpc.ap-southeast-1.aliyuncs.com'],
    ],
    'errorCodes' => [
        ['code' => 'ACCOUNT_INFO_UNCOMPLETED', 'message' => 'Remote invoke error msg:Your account info is incomplete.', 'http_code' => 400, 'description' => 'Remote call error message: Your account information is incomplete, please go to https://myaccount.alibabacloud.com/user_info.htm'],
        ['code' => 'DidNumberInvalid', 'message' => 'Invalid calling number.', 'http_code' => 400, 'description' => 'Invalid calling number'],
        ['code' => 'isv.PRODUCT_UN_SUBSCRIPT', 'message' => '未开通云通信产品的阿里云客户', 'http_code' => 400, 'description' => 'Alibaba Cloud customers who have not activated cloud communication products'],
        ['code' => 'PlayTimesInvalid', 'message' => 'The value range of replay times is incorrect, [1,3].', 'http_code' => 400, 'description' => 'The value range of replay times is incorrect,[1,3]'],
        ['code' => 'SpeedInvalid', 'message' => 'The speech speed value range is wrong, [-500,500].', 'http_code' => 400, 'description' => 'The speech speed value range is wrong,[-500,500]'],
        ['code' => 'SUPER_RESELLER_NOT_OPEN', 'message' => 'The distribution account has not been opened yet. Please contact the primary account to open the service and try again.', 'http_code' => 400, 'description' => 'The distribution account has not been opened yet. Please contact the primary account to open the service and try again.'],
        ['code' => 'TemplateInvalid', 'message' => 'Invalid template ID.', 'http_code' => 400, 'description' => 'Invalid template ID'],
    ],
    'changeSet' => [
        [
            'apis' => [
                ['description' => 'OpenAPI offline', 'api' => 'VoiceSingleCall'],
                ['description' => 'OpenAPI offline', 'api' => 'VoiceGroupCall'],
            ],
            'createdAt' => '2025-07-31T08:14:59.000Z',
            'description' => '',
        ],
    ],
    'flowControl' => [
        'flowControlList' => [
            ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
        ],
    ],
    'ram' => [
        'productCode' => 'VoiceMessagingService',
        'productName' => 'Voice Service',
        'ramCodes' => ['dyvms'],
        'ramLevel' => 'SERVICE',
        'ramConditions' => [],
        'ramActions' => [],
        'resourceTypes' => [],
    ],
];