OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsendpointsFormat View Source

API calls for all endpoints tagged ApiDocsendpointsFormat.

Link to this section Summary

Details for an endpoint

List all endpoints

List available endoints for a given endpoint technology

Send a message to some technology URI or endpoint

Send a message to some endpoint in a technology

get(connection, tech, resource, opts \\ [])

get(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Details for an endpoint.

{:ok, %{}} on success {:error, info} on failure

list(connection, opts \\ [])

list(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

List all endpoints.

{:ok, %{}} on success {:error, info} on failure

list_by_tech(connection, tech, opts \\ [])

list_by_tech(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

List available endoints for a given endpoint technology.

{:ok, %{}} on success {:error, info} on failure

send_message(connection, to, from, opts \\ [])

send_message(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Send a message to some technology URI or endpoint.

connection (Swagger.Client.Connection): Connection to server
to (String.t): The endpoint resource or technology specific URI to send the message to. Valid resources are sip, pjsip, and xmpp.
from (String.t): The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
opts (KeywordList): [optional] Optional parameters
- :body (String.t): The body of the message
- :variables (Containers):

{:ok, %{}} on success {:error, info} on failure

send_message_to_endpoint(connection, tech, resource, from, opts \\ [])

send_message_to_endpoint(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Send a message to some endpoint in a technology.

connection (Swagger.Client.Connection): Connection to server
tech (String.t): Technology of the endpoint
resource (String.t): ID of the endpoint
from (String.t): The endpoint resource or technology specific identity to send this message from. Valid resources are sip, pjsip, and xmpp.
opts (KeywordList): [optional] Optional parameters
- :body (String.t): The body of the message
- :variables (Containers):

{:ok, %{}} on success {:error, info} on failure