Skip to content

CallerIdsApi.md

Latest commit

 

History

History
369 lines (253 loc) · 12.9 KB

CallerIdsApi.md

File metadata and controls

369 lines (253 loc) · 12.9 KB

dialmycalls_client.CallerIdsApi

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

Method HTTP request Description
create_caller_id POST /callerid Add Caller ID
create_unverified_caller_id POST /verify/callerid Add Caller ID (Unverified)
delete_caller_id_by_id DELETE /callerid/{CalleridId} Delete Caller ID
get_caller_id_by_id GET /callerid/{CalleridId} Get Caller ID
get_caller_ids GET /callerids List Caller IDs
update_caller_id_by_id PUT /callerid/{CalleridId} Update Caller ID
verify_caller_id_by_id PUT /verify/callerid/{CalleridId} Verify Caller ID

create_caller_id

object create_caller_id(create_caller_id_parameters)

Add Caller ID

Add a caller ID.

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

curl -i -H "Content-Type: application/json" -X POST -d "{\"phone\": \"5555555555\", \"name\": \"New Number\"}" https://$API_KEY@api.dialmycalls.com/2.0/callerid

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.CallerIdsApi()
create_caller_id_parameters = dialmycalls_client.CreateCallerIdParameters() # CreateCallerIdParameters | Request body

try: 
    # Add Caller ID
    api_response = api_instance.create_caller_id(create_caller_id_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->create_caller_id: %s\n" % e

Parameters

Name Type Description Notes
create_caller_id_parameters CreateCallerIdParameters 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_unverified_caller_id

object create_unverified_caller_id(create_unverified_caller_id_parameters)

Add Caller ID (Unverified)

Initiate adding a new caller ID when you need to go through the verification process. You will receive a phone call at the phone number provided and will need to make a subsequent API call with the PIN code that you are provided.

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

curl -i -H "Content-Type: application/json" -X POST -d "{\"phone\": \"5555555555\", \"name\": \"New Number\"}" https://$API_KEY@api.dialmycalls.com/2.0/verify/callerid

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.CallerIdsApi()
create_unverified_caller_id_parameters = dialmycalls_client.CreateUnverifiedCallerIdParameters() # CreateUnverifiedCallerIdParameters | Request body

try: 
    # Add Caller ID (Unverified)
    api_response = api_instance.create_unverified_caller_id(create_unverified_caller_id_parameters)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->create_unverified_caller_id: %s\n" % e

Parameters

Name Type Description Notes
create_unverified_caller_id_parameters CreateUnverifiedCallerIdParameters 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_caller_id_by_id

object delete_caller_id_by_id(callerid_id)

Delete Caller ID

Delete a caller ID.

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/callerid/$CALLERID_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.CallerIdsApi()
callerid_id = 'callerid_id_example' # str | CalleridId

try: 
    # Delete Caller ID
    api_response = api_instance.delete_caller_id_by_id(callerid_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->delete_caller_id_by_id: %s\n" % e

Parameters

Name Type Description Notes
callerid_id str CalleridId

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_caller_id_by_id

object get_caller_id_by_id(callerid_id)

Get Caller ID

Retrieve a caller ID.

Returns a caller ID 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/callerid/$CALLERID_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.CallerIdsApi()
callerid_id = 'callerid_id_example' # str | CalleridId

try: 
    # Get Caller ID
    api_response = api_instance.get_caller_id_by_id(callerid_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->get_caller_id_by_id: %s\n" % e

Parameters

Name Type Description Notes
callerid_id str CalleridId

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_caller_ids

object get_caller_ids(range=range)

List Caller IDs

Retrieve a list of caller IDs.

Returns a list of caller ID objects.

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

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

try: 
    # List Caller IDs
    api_response = api_instance.get_caller_ids(range=range)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->get_caller_ids: %s\n" % e

Parameters

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

object update_caller_id_by_id(update_caller_id_by_id_parameters, callerid_id)

Update Caller ID

Update an existing caller ID.

Returns a caller ID 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\": \"New Number Updated\"}" https://$API_KEY@api.dialmycalls.com/2.0/callerid/$CALLERID_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.CallerIdsApi()
update_caller_id_by_id_parameters = dialmycalls_client.UpdateCallerIdByIdParameters() # UpdateCallerIdByIdParameters | Request body
callerid_id = 'callerid_id_example' # str | CalleridId

try: 
    # Update Caller ID
    api_response = api_instance.update_caller_id_by_id(update_caller_id_by_id_parameters, callerid_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->update_caller_id_by_id: %s\n" % e

Parameters

Name Type Description Notes
update_caller_id_by_id_parameters UpdateCallerIdByIdParameters Request body
callerid_id str CalleridId

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]

verify_caller_id_by_id

object verify_caller_id_by_id(verify_caller_id_by_id_parameters, callerid_id)

Verify Caller ID

Verify a new caller ID.

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

curl -i -H "Content-Type: application/json" -X POST -d "{\"phone\": \"5555555555\", \"name\": \"New Number\"}" https://$API_KEY@api.dialmycalls.com/2.0/verify/callerid/$CALLERID_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.CallerIdsApi()
verify_caller_id_by_id_parameters = dialmycalls_client.VerifyCallerIdByIdParameters() # VerifyCallerIdByIdParameters | Request body
callerid_id = 'callerid_id_example' # str | CalleridId

try: 
    # Verify Caller ID
    api_response = api_instance.verify_caller_id_by_id(verify_caller_id_by_id_parameters, callerid_id)
    pprint(api_response)
except ApiException as e:
    print "Exception when calling CallerIdsApi->verify_caller_id_by_id: %s\n" % e

Parameters

Name Type Description Notes
verify_caller_id_by_id_parameters VerifyCallerIdByIdParameters Request body
callerid_id str CalleridId

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]