All Products
Search

This Product

    Voice Service:BackendCallSignal

    Document Center

    Voice Service:BackendCallSignal

    Last Updated:Mar 26, 2024

    Sends a voice verification code and voice notification with variables to a phone number.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    CalledNumberstringNo

    The phone number that receives the voice notification.

    You must add the country code to the beginning of the phone number. Example: 85200****00.

    		852****0000
    CallerIdNumberstringNo

    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 choose Number Management to view the purchased phone numbers.

    		852****0000
    CountryIdstringNo

    The ISO2 country code.

    		HK
    PlayTimeslongNo

    The number of times the voice notification is played back in a call. Valid values: 1 to 3. Default value: 3.

    		2
    SpeedlongNo

    The playback speed. Valid values: -500 to 500.

    		0
    TtsCodestringNo

    The ID of the approved voice verification code template.

    You can log on to the VMS console and choose Voice Call Template to view the template ID.

    		1001
    TtsParamstringNo

    The variables in the template, in the JSON format.

    		{"code":"1234"}
    VolumelongNo

    The playback volume of the voice notification. Valid values: 0 to 100. Default value: 100.

    		100
    OutIdstringNo

    The ID reserved for the caller. This ID is returned to the caller in a receipt message.

    The value must be of the STRING type and 1 to 15 bytes in length.

    		22522****

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
    Codestring

    The response code.

    The value OK indicates that the request was successful. Other values indicate that the request failed. For more information, see Error codes.

    		OK
    Messagestring

    The returned message.

    		OK
    CallIdstring

    The unique receipt ID for the call. You can use this ID to query the details of a single call.

    		550e8400-e29b-41d4-a716-446655440000

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Code": "OK",
  "Message": "OK",
  "CallId": "550e8400-e29b-41d4-a716-446655440000"
}

    Error codes

    HTTP status codeError codeError message
    400Product.UnsubscriptYou have not subscribed to the specified product.
    400Ram.PermissionDenyYou are not authorized to perform the operation.
    400System.LimitControlThe system is under flow control.
    400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-10-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-05-29The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-03-14The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: OutId