DocsICP FilingConsole
Documentation

SingleCallByVideo

Updated at:
Copy as MD
Product
My Favorites

Calls a single phone number and plays a voice or video file.

Operation description

  • The 5G video call feature is available by invitation only. Contact your account manager to enable this feature.

  • After you initiate a call, you can also call the PlayVideoFile, PauseVideoFile, and ResumeVideoFile operations to play, pause, and resume the video during the call.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dyvms:SingleCallByVideo

none

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
CalledShowNumber

string

No

The outbound number for the video notification. This is the number displayed to the callee.

  • If you use a number in common pattern, do not specify this parameter. For more information, see Common pattern.

  • If you use a number in exclusive pattern, specify your real number or virtual number. Log on to the Voice Service console. On the Real Number Management page, view your purchased real numbers. On the Virtual Number Management page, view the virtual numbers that you created and attached to real numbers.

0571****5678
CalledNumber

string

Yes

The phone number that receives the video notification.

The number must be in one of the following formats:

  • A mobile phone number. Example: 159****0000.

  • A landline number. Example: 0571****5678.

  • Country code+Number. Example: 85200****00.

1590****000
VoiceCode

string

Yes

The voice ID of the voice notification file.

Log on to the Voice Service console to obtain the voice ID from one of the following pages. The voice notification file must be approved.

  • On the Voice Messaging > Voice Notifications > Voice Notification Files page, obtain the Voice ID.

  • On the Voice File Management > Voice Notification Files page, obtain the Voice ID.

17d37e58-2a09-419f-9b3d-e7e4b4****dd.wav
PlayTimes

integer

No

The number of times the notification file is played. Valid values: 1 to 3.

3
Volume

integer

No

The playback volume of the notification file. Valid values: 0 to 100. The default value is 100.

100
Speed

integer

No

The playback speed of the voice file. Valid values: -500 to 500.

100
OutId

string

No

A custom ID that you can specify when you initiate a request. This ID is returned to you in a receipt message.

A string of 1 to 15 characters.

abcdefgh
VideoCode

string

Yes

The ID of the video notification file.

You can view the IDs of approved video notification files on the Video Notification Files page.

1120213841979436_20240621103****39_.mp4

Response elements

Element

Type

Description

Example

object

Code

string

The request status code.

  • A value of OK indicates that the request was successful.

  • For more information about other error codes, see API error codes.

OK
Message

string

The description of the status code.

OK
RequestId

string

The request ID.

a78278ff-26bb-48ec-805c-26a0f4c102***
CallId

string

The unique ID of the voice or video notification.

You can use this parameter to call operations such as PlayVideoFile to play a video. You can configure receipt messages to obtain call records, intermediate call status messages, and recording records.

116012354148^10281378****

Examples

Success response

JSON format

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "a78278ff-26bb-48ec-805c-26a0f4c102***",
  "CallId": "116012354148^10281378****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.