Debug Voice Messaging Service with OpenAPI-Voice Service(VS)-阿里云帮助中心

You can programmatically integrate Voice Messaging Service into your business systems. This allows you to automate voice calls based on your business needs, simplifying operations and reducing management costs. This topic describes the OpenAPI operations and integration methods supported by Voice Messaging Service.

OpenAPI

Alibaba Cloud provides OpenAPI Explorer to help you learn and use the OpenAPI of cloud services efficiently. OpenAPI Explorer provides features such as intelligent OpenAPI search, documentation, online debugging, SDK downloads, code sample generation, call error diagnostics, and call statistics. You can use OpenAPI Explorer to call the OpenAPI of Alibaba Cloud services and view requests and responses. OpenAPI Explorer also automatically generates SDK code samples to help you get started with Alibaba Cloud services. For more information, see What is OpenAPI.

API version

Voice Messaging Service provides various OpenAPI operations, such as sending voice notifications or voice verification codes, querying call details, and binding virtual numbers.

Note

Alibaba Cloud OpenAPI uses version numbers to manage the API lists for major versions of cloud services.

For example, Voice Messaging Service supports the API list for version 2017-05-25. The string 2017-05-25 represents the API version and is not a timestamp. The API data for this version is always current and is not frozen as of 2017-05-25.

API version	Description
2017-05-25	Recommended

Online debugging

Voice Messaging Service supports API debugging in OpenAPI Explorer. Before you make a call, understand the service's version, endpoints, API style, and calling methods. Log on to the Alibaba Cloud OpenAPI Explorer, and find the SingleCallByVoice operation of Voice Messaging Service. This operation sends a voice notification file to a specified number. Set the endpoint to China (Hangzhou) and configure the request parameters: CalledShowNumber (the number displayed to the callee), CalledNumber (the number that receives the voice notification, required), VoiceCode (the voice ID of the voice notification file, required), PlayTimes (the number of playback times), Volume (the playback volume), Speed (the speech rate), and OutId (an ID reserved for the caller). Then, click Initiate Call.

Debugging entry point

The API debugging entry point is: https://next.api.aliyun.com/api/Dyvmsapi/2017-05-25/

Endpoints

Select the endpoint that corresponds to the region where your resources reside to minimize latency.

The global endpoint domain name is dyvmsapi.aliyuncs.com. For more information, see Endpoints.

Supported identities

When you log on to OpenAPI Explorer with your Alibaba Cloud account, OpenAPI Explorer uses your account to debug OpenAPI operations by default. An Alibaba Cloud account has full access permissions for all APIs, which poses a high security risk. We strongly recommend creating and using a RAM user for API access or daily O&M. Grant the RAM user permissions as needed before you call the operations. For more information, see Use RAM for access control.

User identity	Support status
Alibaba Cloud account	Supported
RAM user (recommended)	Supported
RAM role (recommended)	Supported

Integration methods

Voice Messaging Service provides multiple integration methods, such as SDKs.

Alibaba Cloud SDK

Alibaba Cloud provides SDKs for various programming languages, such as Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. The SDKs encapsulate the signing mechanism, timeout mechanism, and retry mechanism, and return structured response objects based on the documented response schema, simplifying development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.
For information about the languages and dependency installation methods supported by the Voice Messaging Service SDK, see SDK Reference.

Alibaba Cloud CLI

Alibaba Cloud CLI is a command-line tool that lets you interact with Alibaba Cloud services and manage your cloud resources from a terminal with the aliyun command. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI.
Using Alibaba Cloud CLI to call Voice Messaging Service is not supported.

ROS

Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies the management of cloud computing resources. Developers and administrators can write a template to define the required Alibaba Cloud resources, such as ECS instances and RDS database instances, and the dependencies between them. The ROS orchestration engine automatically creates and configures all resources based on the template, enabling automated deployment and O&M. For more information, see What is Resource Orchestration Service.
Using ROS to call Voice Messaging Service is not supported.

Custom API calls

If none of the preceding methods meet your business requirements, you can encapsulate API requests yourself. However, this method is not recommended. For more information, see V3 version request body & signature mechanism.

Usage notes

If a call to a Voice Messaging Service API returns an error, use the error code to verify your request parameters and their values. For more information, see API error codes.
You can also record the returned RequestID or the SDK error message to run self-service diagnostics on the Alibaba Cloud OpenAPI Diagnostic Platform.