Skip to content

RecordingsApi.md

Latest commit

 

History

History
367 lines (251 loc) · 12.9 KB

RecordingsApi.md

File metadata and controls

367 lines (251 loc) · 12.9 KB

dialmycalls_client.RecordingsApi

All URIs are relative to https://api.dialmycalls.com/2.0

Method HTTP request Description
create_recording POST /recording/tts Create Recording (Text-to-Speech)
create_recording_by_phone POST /recording/phone Create Recording (Phone)
create_recording_by_url POST /recording/url Create Recording (URL)
delete_recording_by_id DELETE /recording/{RecordingId} Delete Recording
get_recording_by_id GET /recording/{RecordingId} Get Recording
get_recordings GET /recordings List Recordings
update_recording_by_id PUT /recording/{RecordingId} Update Recording

create_recording

object create_recording(create_recording_parameters)

Create Recording (Text-to-Speech)

Create a new recording using text-to-speech.

Returns a recording object on success, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X POST -d "{\"name\": \"Test Recording\", \"gender\": \"M\", \"language\": \"en\", \"text\": \"This is just a test.\"}" https://$API_KEY@api.dialmycalls.com/2.0/recording/tts

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
create_recording_parameters = dialmycalls_client.CreateRecordingParameters() # CreateRecordingParameters | Request body

try: 
    # Create Recording (Text-to-Speech)
    api_response = api_instance.create_recording(create_recording_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->create_recording: %s\n" % e

Parameters

Name Type Description Notes
create_recording_parameters CreateRecordingParameters Request body

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_recording_by_phone

object create_recording_by_phone(create_recording_by_phone_parameters)

Create Recording (Phone)

Create a new recording by phone.

Returns a recording object on success, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X POST -d "{\"name\": \"Test Recording\", \"phone\": \"5551234567\", \"callerid_id\": \"$CALLERID_ID\"}" https://$API_KEY@api.dialmycalls.com/2.0/recording/phone

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
create_recording_by_phone_parameters = dialmycalls_client.CreateRecordingByPhoneParameters() # CreateRecordingByPhoneParameters | Request body

try: 
    # Create Recording (Phone)
    api_response = api_instance.create_recording_by_phone(create_recording_by_phone_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->create_recording_by_phone: %s\n" % e

Parameters

Name Type Description Notes
create_recording_by_phone_parameters CreateRecordingByPhoneParameters Request body

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_recording_by_url

object create_recording_by_url(create_recording_by_url_parameters)

Create Recording (URL)

Create a new recording from a URL.

Returns a recording object on success, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X POST -d "{\"name\": \"Test Recording\", \"url\": \"https://ia700200.us.archive.org/1/items/testmp3testfile/mpthreetest.mp3\"}" https://$API_KEY@api.dialmycalls.com/2.0/recording/url

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
create_recording_by_url_parameters = dialmycalls_client.CreateRecordingByUrlParameters() # CreateRecordingByUrlParameters | Request body

try: 
    # Create Recording (URL)
    api_response = api_instance.create_recording_by_url(create_recording_by_url_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->create_recording_by_url: %s\n" % e

Parameters

Name Type Description Notes
create_recording_by_url_parameters CreateRecordingByUrlParameters Request body

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_recording_by_id

object delete_recording_by_id(recording_id)

Delete Recording

Delete a recording.

Returns the following if a valid identifier was provided, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X DELETE https://$API_KEY@api.dialmycalls.com/2.0/recording/$RECORDING_ID

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
recording_id = 'recording_id_example' # str | RecordingId

try: 
    # Delete Recording
    api_response = api_instance.delete_recording_by_id(recording_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->delete_recording_by_id: %s\n" % e

Parameters

Name Type Description Notes
recording_id str RecordingId

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_recording_by_id

object get_recording_by_id(recording_id)

Get Recording

Retrieve a recording.

Returns a recording object if a valid identifier was provided, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X GET https://$API_KEY@api.dialmycalls.com/2.0/recording/$RECORDING_ID

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
recording_id = 'recording_id_example' # str | RecordingId

try: 
    # Get Recording
    api_response = api_instance.get_recording_by_id(recording_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->get_recording_by_id: %s\n" % e

Parameters

Name Type Description Notes
recording_id str RecordingId

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_recordings

object get_recordings(range=range)

List Recordings

Retrieve a list of recordings.

Returns a list of recording objects.

curl -i -H "Content-Type: application/json" -X GET https://$API_KEY@api.dialmycalls.com/2.0/recordings

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
range = 'range_example' # str | Range (ie \"records=201-300\") of recordings requested (optional)

try: 
    # List Recordings
    api_response = api_instance.get_recordings(range=range)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->get_recordings: %s\n" % e

Parameters

Name Type Description Notes
range str Range (ie "records=201-300") of recordings requested [optional]

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_recording_by_id

object update_recording_by_id(update_recording_by_id_parameters, recording_id)

Update Recording

Update an existing recording.

Returns a recording object if a valid identifier was provided and input validation passed, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X PUT -d "{\"name\": \"Test Recording Updated\"}" https://$API_KEY@api.dialmycalls.com/2.0/recording/$RECORDING_ID

Example

import time
import dialmycalls_client
from dialmycalls_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
dialmycalls_client.configuration.api_key['X-Auth-ApiKey'] = 'YOUR_API_KEY'

# create an instance of the API class
api_instance = dialmycalls_client.RecordingsApi()
update_recording_by_id_parameters = dialmycalls_client.UpdateRecordingByIdParameters() # UpdateRecordingByIdParameters | Request body
recording_id = 'recording_id_example' # str | RecordingId

try: 
    # Update Recording
    api_response = api_instance.update_recording_by_id(update_recording_by_id_parameters, recording_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling RecordingsApi->update_recording_by_id: %s\n" % e

Parameters

Name Type Description Notes
update_recording_by_id_parameters UpdateRecordingByIdParameters Request body
recording_id str RecordingId

Return type

object

Authorization

api_key

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

[Back to top] [Back to API list] [Back to Model list] [Back to README]