Skip to content

CallsApi.md

Latest commit

 

History

History
265 lines (181 loc) · 8.55 KB

CallsApi.md

File metadata and controls

265 lines (181 loc) · 8.55 KB

dialmycalls_client.CallsApi

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

Method HTTP request Description
cancel_call_by_id DELETE /service/call/{CallId} Cancel Call
create_call POST /service/call Create Call
get_call_by_id GET /service/call/{CallId} Get Call
get_call_recipients_by_call_id GET /service/call/{CallId}/recipients Get Call Recipients
get_calls GET /service/calls List Calls

cancel_call_by_id

object cancel_call_by_id(call_id)

Cancel Call

Cancel an outgoing call.

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/service/call/$CALL_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.CallsApi()
call_id = 'call_id_example' # str | CallId

try: 
    # Cancel Call
    api_response = api_instance.cancel_call_by_id(call_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->cancel_call_by_id: %s\n" % e

Parameters

Name Type Description Notes
call_id str CallId

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_call

object create_call(create_call_parameters)

Create Call

Create an outgoing call broadcast.

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

curl -i -H "Content-Type: application/json" -X POST -d "{\"name\": \"Test\", \"callerid_id\": \"8bc6748e-d8a0-11e4-8b2d-00163e603cea\", \"recording_id\": \"079ff28a-1b75-11e5-88eb-00163e603cea\", \"send_immediately\": true, \"use_amd\": true, \"contacts\": [{\"phone\":\"1116551235\"},{\"phone\":\"1116551234\"}]}" https://$API_KEY@api.dialmycalls.com/2.0/service/call

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.CallsApi()
create_call_parameters = dialmycalls_client.CreateCallParameters() # CreateCallParameters | Request body

try: 
    # Create Call
    api_response = api_instance.create_call(create_call_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->create_call: %s\n" % e

Parameters

Name Type Description Notes
create_call_parameters CreateCallParameters 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]

get_call_by_id

object get_call_by_id(call_id)

Get Call

Retrieve a call.

Returns a call service 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/service/call/$CALL_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.CallsApi()
call_id = 'call_id_example' # str | CallId

try: 
    # Get Call
    api_response = api_instance.get_call_by_id(call_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->get_call_by_id: %s\n" % e

Parameters

Name Type Description Notes
call_id str CallId

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_call_recipients_by_call_id

object get_call_recipients_by_call_id(call_id, range=range)

Get Call Recipients

Retrieve a list of a call's recipients.

Returns a list of call recipient objects 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/service/call/$CALL_ID/recipients

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.CallsApi()
call_id = 'call_id_example' # str | CallId
range = 'range_example' # str | Range (ie \"records=201-300\") of recipients requested (optional)

try: 
    # Get Call Recipients
    api_response = api_instance.get_call_recipients_by_call_id(call_id, range=range)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallsApi->get_call_recipients_by_call_id: %s\n" % e

Parameters

Name Type Description Notes
call_id str CallId
range str Range (ie "records=201-300") of recipients 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]

get_calls

object get_calls(range=range)

List Calls

Retrieve a list of calls.

Returns a list of call service objects.

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

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.CallsApi()
range = 'range_example' # str | Range (ie \"records=201-300\") of calls requested (optional)

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

Parameters

Name Type Description Notes
range str Range (ie "records=201-300") of calls 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]