Play a music

The play a music API is used to connect the call and play the audio file to the caller, by greeting the caller with specific pre-recorded music or playing the music while the caller is on hold. Using app id and app secret you can able to make a play a music API request.

Base URL

Send your POST method request with valid parameters, to the following base URL.

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*appidnumberYour app id
*secretstringYour app secret
*fromnumberYour caller id for this call
*tonumberThe number the call was made to
extra_paramsstringYour custom parameters
*pcmoarray objectThe PCMO should return the play music array object
The * marked property is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

"appid": 2222226,
"secret": "xxxx-xxxx-xxxx-xxxx",
"from": 19170000000,
"to": 19170000001,
"extra_params": { "key": "value" },
"pcmo": [
"action": "play",
"file_name": "welcome_11112.wav"

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

"data": {
"status": "progress",
"request_id": "FrTckxcdYpJQFwSwki7ee2qY90MOYhgRyFzqgSlK5uT"
"status": "progress",
"request_id": "FrTckxcdYpJQFwSwki7ee2qY90MOYhgRyFzqgSlK5uT",
"code": 200


These are the list of properties and its description

statusstringThe Status of the call
request_idstringThe Unique ID for this call

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus codeDescription
200OKWe received the request
420ErrorInvalid app id or secret, failed to authenticate token
404ErrorInvalid music filename
422ErrorMissing required property
502ErrorThe property required is missing