Skip to content

Latest commit

 

History

History
278 lines (200 loc) · 9.38 KB

EndpointsApi.md

File metadata and controls

278 lines (200 loc) · 9.38 KB
Raw

swagger_client.EndpointsApi

All URIs are relative to http://localhost:8088/ari

Method HTTP request Description
endpoints_get GET /endpoints List all endpoints.
endpoints_send_message_put PUT /endpoints/sendMessage Send a message to some technology URI or endpoint.
endpoints_tech_get GET /endpoints/{tech} List available endoints for a given endpoint technology.
endpoints_tech_resource_get GET /endpoints/{tech}/{resource} Details for an endpoint.
endpoints_tech_resource_send_message_put PUT /endpoints/{tech}/{resource}/sendMessage Send a message to some endpoint in a technology.

endpoints_get

list[Endpoint] endpoints_get()

List all endpoints.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EndpointsApi(swagger_client.ApiClient(configuration))

try:
    # List all endpoints.
    api_response = api_instance.endpoints_get()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[Endpoint]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

endpoints_send_message_put

endpoints_send_message_put(to, _from, body=body, variables=variables)

Send a message to some technology URI or endpoint.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EndpointsApi(swagger_client.ApiClient(configuration))
to = 'to_example' # str | The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
_from = '_from_example' # str | The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
body = 'body_example' # str | The body of the message (optional)
variables = [swagger_client.ConfigTuple()] # list[ConfigTuple] |  (optional)

try:
    # Send a message to some technology URI or endpoint.
    api_instance.endpoints_send_message_put(to, _from, body=body, variables=variables)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_send_message_put: %s\n" % e)

Parameters

Name Type Description Notes
to str The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
_from str The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
body str The body of the message [optional]
variables list[ConfigTuple] [optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

endpoints_tech_get

list[Endpoint] endpoints_tech_get(tech)

List available endoints for a given endpoint technology.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EndpointsApi(swagger_client.ApiClient(configuration))
tech = 'tech_example' # str | Technology of the endpoints (sip,iax2,...)

try:
    # List available endoints for a given endpoint technology.
    api_response = api_instance.endpoints_tech_get(tech)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_tech_get: %s\n" % e)

Parameters

Name Type Description Notes
tech str Technology of the endpoints (sip,iax2,...)

Return type

list[Endpoint]

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

endpoints_tech_resource_get

Endpoint endpoints_tech_resource_get(tech, resource)

Details for an endpoint.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EndpointsApi(swagger_client.ApiClient(configuration))
tech = 'tech_example' # str | Technology of the endpoint
resource = 'resource_example' # str | ID of the endpoint

try:
    # Details for an endpoint.
    api_response = api_instance.endpoints_tech_resource_get(tech, resource)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_tech_resource_get: %s\n" % e)

Parameters

Name Type Description Notes
tech str Technology of the endpoint
resource str ID of the endpoint

Return type

Endpoint

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

endpoints_tech_resource_send_message_put

endpoints_tech_resource_send_message_put(tech, resource, _from, body=body, variables=variables)

Send a message to some endpoint in a technology.

Example

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure HTTP basic authorization: basicAuth
configuration = swagger_client.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'

# create an instance of the API class
api_instance = swagger_client.EndpointsApi(swagger_client.ApiClient(configuration))
tech = 'tech_example' # str | Technology of the endpoint
resource = 'resource_example' # str | ID of the endpoint
_from = '_from_example' # str | The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
body = 'body_example' # str | The body of the message (optional)
variables = [swagger_client.ConfigTuple()] # list[ConfigTuple] |  (optional)

try:
    # Send a message to some endpoint in a technology.
    api_instance.endpoints_tech_resource_send_message_put(tech, resource, _from, body=body, variables=variables)
except ApiException as e:
    print("Exception when calling EndpointsApi->endpoints_tech_resource_send_message_put: %s\n" % e)

Parameters

Name Type Description Notes
tech str Technology of the endpoint
resource str ID of the endpoint
_from str The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
body str The body of the message [optional]
variables list[ConfigTuple] [optional]

Return type

void (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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