Play a Sound Element

Plays an audio element to a mobile phone. The audio file resource is resolved to a playable URL and pushed to the target mobile phone.

Request URL

POST {base_url}/uc-cconfig/api/v1/sounds/elements/play

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
resourceId No String The ID of the audio file resource, which is returned by the upload or record interfaces.
extension No String The extension number of the target mobile phone.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object The result of the operation.