resource_channels.h File Reference

Generated file - declares stubs to be implemented in res/ari/resource_channels.c. More...

#include "asterisk/ari.h"

Include dependency graph for resource_channels.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ast_ari_channels_answer_args
struct	ast_ari_channels_continue_in_dialplan_args
struct	ast_ari_channels_create_args
struct	ast_ari_channels_dial_args
struct	ast_ari_channels_external_media_args
struct	ast_ari_channels_get_args
struct	ast_ari_channels_get_channel_var_args
struct	ast_ari_channels_hangup_args
struct	ast_ari_channels_hold_args
struct	ast_ari_channels_list_args
struct	ast_ari_channels_move_args
struct	ast_ari_channels_mute_args
struct	ast_ari_channels_originate_args
struct	ast_ari_channels_originate_with_id_args
struct	ast_ari_channels_play_args
struct	ast_ari_channels_play_with_id_args
struct	ast_ari_channels_record_args
struct	ast_ari_channels_redirect_args
struct	ast_ari_channels_ring_args
struct	ast_ari_channels_ring_stop_args
struct	ast_ari_channels_rtpstatistics_args
struct	ast_ari_channels_send_dtmf_args
struct	ast_ari_channels_set_channel_var_args
struct	ast_ari_channels_snoop_channel_args
struct	ast_ari_channels_snoop_channel_with_id_args
struct	ast_ari_channels_start_moh_args
struct	ast_ari_channels_start_silence_args
struct	ast_ari_channels_stop_moh_args
struct	ast_ari_channels_stop_silence_args
struct	ast_ari_channels_unhold_args
struct	ast_ari_channels_unmute_args

Functions
void	ast_ari_channels_answer (struct ast_variable *headers, struct ast_ari_channels_answer_args *args, struct ast_ari_response *response)
	Answer a channel. More...
void	ast_ari_channels_continue_in_dialplan (struct ast_variable *headers, struct ast_ari_channels_continue_in_dialplan_args *args, struct ast_ari_response *response)
	Exit application; continue execution in the dialplan. More...
int	ast_ari_channels_continue_in_dialplan_parse_body (struct ast_json *body, struct ast_ari_channels_continue_in_dialplan_args *args)
	Body parsing function for /channels/{channelId}/continue. More...
void	ast_ari_channels_create (struct ast_variable *headers, struct ast_ari_channels_create_args *args, struct ast_ari_response *response)
	Create channel. More...
int	ast_ari_channels_create_parse_body (struct ast_json *body, struct ast_ari_channels_create_args *args)
	Body parsing function for /channels/create. More...
void	ast_ari_channels_dial (struct ast_variable *headers, struct ast_ari_channels_dial_args *args, struct ast_ari_response *response)
	Dial a created channel. More...
int	ast_ari_channels_dial_parse_body (struct ast_json *body, struct ast_ari_channels_dial_args *args)
	Body parsing function for /channels/{channelId}/dial. More...
void	ast_ari_channels_external_media (struct ast_variable *headers, struct ast_ari_channels_external_media_args *args, struct ast_ari_response *response)
	Start an External Media session. More...
int	ast_ari_channels_external_media_parse_body (struct ast_json *body, struct ast_ari_channels_external_media_args *args)
	Body parsing function for /channels/externalMedia. More...
void	ast_ari_channels_get (struct ast_variable *headers, struct ast_ari_channels_get_args *args, struct ast_ari_response *response)
	Channel details. More...
void	ast_ari_channels_get_channel_var (struct ast_variable *headers, struct ast_ari_channels_get_channel_var_args *args, struct ast_ari_response *response)
	Get the value of a channel variable or function. More...
int	ast_ari_channels_get_channel_var_parse_body (struct ast_json *body, struct ast_ari_channels_get_channel_var_args *args)
	Body parsing function for /channels/{channelId}/variable. More...
void	ast_ari_channels_hangup (struct ast_variable *headers, struct ast_ari_channels_hangup_args *args, struct ast_ari_response *response)
	Delete (i.e. hangup) a channel. More...
int	ast_ari_channels_hangup_parse_body (struct ast_json *body, struct ast_ari_channels_hangup_args *args)
	Body parsing function for /channels/{channelId}. More...
void	ast_ari_channels_hold (struct ast_variable *headers, struct ast_ari_channels_hold_args *args, struct ast_ari_response *response)
	Hold a channel. More...
void	ast_ari_channels_list (struct ast_variable *headers, struct ast_ari_channels_list_args *args, struct ast_ari_response *response)
	List all active channels in Asterisk. More...
void	ast_ari_channels_move (struct ast_variable *headers, struct ast_ari_channels_move_args *args, struct ast_ari_response *response)
	Move the channel from one Stasis application to another. More...
int	ast_ari_channels_move_parse_body (struct ast_json *body, struct ast_ari_channels_move_args *args)
	Body parsing function for /channels/{channelId}/move. More...
void	ast_ari_channels_mute (struct ast_variable *headers, struct ast_ari_channels_mute_args *args, struct ast_ari_response *response)
	Mute a channel. More...
int	ast_ari_channels_mute_parse_body (struct ast_json *body, struct ast_ari_channels_mute_args *args)
	Body parsing function for /channels/{channelId}/mute. More...
void	ast_ari_channels_originate (struct ast_variable *headers, struct ast_ari_channels_originate_args *args, struct ast_ari_response *response)
	Create a new channel (originate). More...
int	ast_ari_channels_originate_parse_body (struct ast_json *body, struct ast_ari_channels_originate_args *args)
	Body parsing function for /channels. More...
void	ast_ari_channels_originate_with_id (struct ast_variable *headers, struct ast_ari_channels_originate_with_id_args *args, struct ast_ari_response *response)
	Create a new channel (originate with id). More...
int	ast_ari_channels_originate_with_id_parse_body (struct ast_json *body, struct ast_ari_channels_originate_with_id_args *args)
	Body parsing function for /channels/{channelId}. More...
void	ast_ari_channels_play (struct ast_variable *headers, struct ast_ari_channels_play_args *args, struct ast_ari_response *response)
	Start playback of media. More...
int	ast_ari_channels_play_parse_body (struct ast_json *body, struct ast_ari_channels_play_args *args)
	Body parsing function for /channels/{channelId}/play. More...
void	ast_ari_channels_play_with_id (struct ast_variable *headers, struct ast_ari_channels_play_with_id_args *args, struct ast_ari_response *response)
	Start playback of media and specify the playbackId. More...
int	ast_ari_channels_play_with_id_parse_body (struct ast_json *body, struct ast_ari_channels_play_with_id_args *args)
	Body parsing function for /channels/{channelId}/play/{playbackId}. More...
void	ast_ari_channels_record (struct ast_variable *headers, struct ast_ari_channels_record_args *args, struct ast_ari_response *response)
	Start a recording. More...
int	ast_ari_channels_record_parse_body (struct ast_json *body, struct ast_ari_channels_record_args *args)
	Body parsing function for /channels/{channelId}/record. More...
void	ast_ari_channels_redirect (struct ast_variable *headers, struct ast_ari_channels_redirect_args *args, struct ast_ari_response *response)
	Redirect the channel to a different location. More...
int	ast_ari_channels_redirect_parse_body (struct ast_json *body, struct ast_ari_channels_redirect_args *args)
	Body parsing function for /channels/{channelId}/redirect. More...
void	ast_ari_channels_ring (struct ast_variable *headers, struct ast_ari_channels_ring_args *args, struct ast_ari_response *response)
	Indicate ringing to a channel. More...
void	ast_ari_channels_ring_stop (struct ast_variable *headers, struct ast_ari_channels_ring_stop_args *args, struct ast_ari_response *response)
	Stop ringing indication on a channel if locally generated. More...
void	ast_ari_channels_rtpstatistics (struct ast_variable *headers, struct ast_ari_channels_rtpstatistics_args *args, struct ast_ari_response *response)
	RTP stats on a channel. More...
void	ast_ari_channels_send_dtmf (struct ast_variable *headers, struct ast_ari_channels_send_dtmf_args *args, struct ast_ari_response *response)
	Send provided DTMF to a given channel. More...
int	ast_ari_channels_send_dtmf_parse_body (struct ast_json *body, struct ast_ari_channels_send_dtmf_args *args)
	Body parsing function for /channels/{channelId}/dtmf. More...
void	ast_ari_channels_set_channel_var (struct ast_variable *headers, struct ast_ari_channels_set_channel_var_args *args, struct ast_ari_response *response)
	Set the value of a channel variable or function. More...
int	ast_ari_channels_set_channel_var_parse_body (struct ast_json *body, struct ast_ari_channels_set_channel_var_args *args)
	Body parsing function for /channels/{channelId}/variable. More...
void	ast_ari_channels_snoop_channel (struct ast_variable *headers, struct ast_ari_channels_snoop_channel_args *args, struct ast_ari_response *response)
	Start snooping. More...
int	ast_ari_channels_snoop_channel_parse_body (struct ast_json *body, struct ast_ari_channels_snoop_channel_args *args)
	Body parsing function for /channels/{channelId}/snoop. More...
void	ast_ari_channels_snoop_channel_with_id (struct ast_variable *headers, struct ast_ari_channels_snoop_channel_with_id_args *args, struct ast_ari_response *response)
	Start snooping. More...
int	ast_ari_channels_snoop_channel_with_id_parse_body (struct ast_json *body, struct ast_ari_channels_snoop_channel_with_id_args *args)
	Body parsing function for /channels/{channelId}/snoop/{snoopId}. More...
void	ast_ari_channels_start_moh (struct ast_variable *headers, struct ast_ari_channels_start_moh_args *args, struct ast_ari_response *response)
	Play music on hold to a channel. More...
int	ast_ari_channels_start_moh_parse_body (struct ast_json *body, struct ast_ari_channels_start_moh_args *args)
	Body parsing function for /channels/{channelId}/moh. More...
void	ast_ari_channels_start_silence (struct ast_variable *headers, struct ast_ari_channels_start_silence_args *args, struct ast_ari_response *response)
	Play silence to a channel. More...
void	ast_ari_channels_stop_moh (struct ast_variable *headers, struct ast_ari_channels_stop_moh_args *args, struct ast_ari_response *response)
	Stop playing music on hold to a channel. More...
void	ast_ari_channels_stop_silence (struct ast_variable *headers, struct ast_ari_channels_stop_silence_args *args, struct ast_ari_response *response)
	Stop playing silence to a channel. More...
void	ast_ari_channels_unhold (struct ast_variable *headers, struct ast_ari_channels_unhold_args *args, struct ast_ari_response *response)
	Remove a channel from hold. More...
void	ast_ari_channels_unmute (struct ast_variable *headers, struct ast_ari_channels_unmute_args *args, struct ast_ari_response *response)
	Unmute a channel. More...
int	ast_ari_channels_unmute_parse_body (struct ast_json *body, struct ast_ari_channels_unmute_args *args)
	Body parsing function for /channels/{channelId}/mute. More...

Detailed Description

Generated file - declares stubs to be implemented in res/ari/resource_channels.c.

Channel resources

Author

David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file resource_channels.h.

Function Documentation

ast_ari_channels_answer()

void ast_ari_channels_answer	(	struct ast_variable *	headers,
		struct ast_ari_channels_answer_args *	args,
		struct ast_ari_response *	response
	)

Answer a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 338 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), ast_ari_channels_answer_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_answer().

Referenced by ast_ari_channels_answer_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   if (stasis_app_control_answer(control) != 0) {
      ast_ari_response_error(
         response, 500, "Internal Server Error",
         "Failed to answer channel");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_channels_continue_in_dialplan()

void ast_ari_channels_continue_in_dialplan	(	struct ast_variable *	headers,
		struct ast_ari_channels_continue_in_dialplan_args *	args,
		struct ast_ari_response *	response
	)

Exit application; continue execution in the dialplan.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 180 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, ast_debug, ast_findlabel_extension(), ast_log, AST_LOG_ERROR, ast_strlen_zero, ast_ari_channels_continue_in_dialplan_args::channel_id, channel_state_invalid(), context, ast_ari_channels_continue_in_dialplan_args::context, exten, ast_ari_channels_continue_in_dialplan_args::extension, find_control(), ast_ari_channels_continue_in_dialplan_args::label, NULL, ast_ari_channels_continue_in_dialplan_args::priority, RAII_VAR, S_OR, stasis_app_control_continue(), and stasis_app_control_get_snapshot().

Referenced by ast_ari_channels_continue_in_dialplan_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   RAII_VAR(struct ast_channel_snapshot *, snapshot, NULL, ao2_cleanup);
   int ipri;
   const char *context;
   const char *exten;

   ast_assert(response != NULL);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   snapshot = stasis_app_control_get_snapshot(control);
   if (!snapshot) {
      ast_ari_response_error(response, 404, "Not Found", "Channel not found");
      return;
   }

   if (ast_strlen_zero(args->context)) {
      context = snapshot->dialplan->context;
      exten = S_OR(args->extension, snapshot->dialplan->exten);
   } else {
      context = args->context;
      exten = S_OR(args->extension, "s");
   }

   if (!ast_strlen_zero(args->label)) {
      /* A label was provided in the request, use that */

      if (sscanf(args->label, "%30d", &ipri) != 1) {
         ipri = ast_findlabel_extension(NULL, context, exten, args->label, NULL);
         if (ipri == -1) {
            ast_log(AST_LOG_ERROR, "Requested label: %s can not be found in context: %s\n", args->label, context);
            ast_ari_response_error(response, 404, "Not Found", "Requested label can not be found");
            return;
         }
      } else {
         ast_debug(3, "Numeric value provided for label, jumping to that priority\n");
      }

      if (ipri == 0) {
         ast_log(AST_LOG_ERROR, "Invalid priority label '%s' specified for extension %s in context: %s\n",
               args->label, exten, context);
         ast_ari_response_error(response, 400, "Bad Request", "Requested priority is illegal");
         return;
      }

   } else if (args->priority) {
      /* No label provided, use provided priority */
      ipri = args->priority;
   } else if (ast_strlen_zero(args->context) && ast_strlen_zero(args->extension)) {
      /* Special case. No exten, context, or priority provided, then move on to the next priority */
      ipri = snapshot->dialplan->priority + 1;
   } else {
      ipri = 1;
   }


   if (stasis_app_control_continue(control, context, exten, ipri)) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_channels_continue_in_dialplan_parse_body()

int ast_ari_channels_continue_in_dialplan_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_continue_in_dialplan_args *	args
	)

Body parsing function for /channels/{channelId}/continue.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 681 of file res_ari_channels.c.

References ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_ari_channels_continue_in_dialplan_args::context, ast_ari_channels_continue_in_dialplan_args::extension, ast_ari_channels_continue_in_dialplan_args::label, and ast_ari_channels_continue_in_dialplan_args::priority.

Referenced by ast_ari_channels_continue_in_dialplan_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "context");
   if (field) {
      args->context = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "extension");
   if (field) {
      args->extension = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "priority");
   if (field) {
      args->priority = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "label");
   if (field) {
      args->label = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_create()

void ast_ari_channels_create	(	struct ast_variable *	headers,
		struct ast_ari_channels_create_args *	args,
		struct ast_ari_response *	response
	)

Create channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1778 of file resource_channels.c.

References ao2_bump, ao2_cleanup, ao2_ref, ast_ari_channels_create_args::app, ast_ari_channels_create_args::app_args, ari_channel_thread(), ast_ari_channels_create_parse_body(), ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_calloc, ast_channel_cleanup, ast_channel_errno(), AST_CHANNEL_ERROR_ID_EXISTS, ast_channel_get_by_name(), ast_channel_nativeformats(), ast_channel_snapshot_get_latest(), ast_channel_snapshot_to_json(), ast_channel_uniqueid(), ast_format_cache_get, ast_format_cap_alloc, ast_format_cap_append, ast_format_cap_append_by_type(), AST_FORMAT_CAP_FLAG_DEFAULT, ast_json_object_get(), AST_MEDIA_TYPE_AUDIO, ast_pthread_create_detached, ast_request(), ast_set_variables(), ast_str_append(), ast_str_create, ast_strdupa, ast_strip(), ast_strlen_zero, ari_channel_thread_data::chan, chan_data_destroy(), ast_ari_channels_create_args::channel_id, ast_ari_channels_create_args::endpoint, ast_ari_channels_create_args::formats, json_to_ast_variables(), NULL, ast_ari_channels_create_args::originator, ast_ari_channels_create_args::other_channel_id, save_dialstring(), stasis_app_subscribe_channel(), ari_channel_thread_data::stasis_stuff, strsep(), thread, ast_assigned_ids::uniqueid, ast_assigned_ids::uniqueid2, and ast_ari_channels_create_args::variables.

Referenced by ast_ari_channels_create_cb().

{
   struct ast_variable *variables = NULL;
   struct ast_assigned_ids assignedids;
   struct ari_channel_thread_data *chan_data;
   struct ast_channel_snapshot *snapshot;
   pthread_t thread;
   char *dialtech;
   char *dialdevice = NULL;
   char *stuff;
   int cause;
   struct ast_format_cap *request_cap;
   struct ast_channel *originator;

   /* Parse any query parameters out of the body parameter */
   if (args->variables) {
      struct ast_json *json_variables;

      ast_ari_channels_create_parse_body(args->variables, args);
      json_variables = ast_json_object_get(args->variables, "variables");
      if (json_variables
         && json_to_ast_variables(response, json_variables, &variables)) {
         return;
      }
   }

   assignedids.uniqueid = args->channel_id;
   assignedids.uniqueid2 = args->other_channel_id;

   if (!ast_strlen_zero(args->originator) && !ast_strlen_zero(args->formats)) {
      ast_ari_response_error(response, 400, "Bad Request",
         "Originator and formats can't both be specified");
      return;
   }

   if (ast_strlen_zero(args->endpoint)) {
      ast_ari_response_error(response, 400, "Bad Request",
         "Endpoint must be specified");
      return;
   }

   chan_data = ast_calloc(1, sizeof(*chan_data));
   if (!chan_data) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   chan_data->stasis_stuff = ast_str_create(32);
   if (!chan_data->stasis_stuff) {
      ast_ari_response_alloc_failed(response);
      chan_data_destroy(chan_data);
      return;
   }

   ast_str_append(&chan_data->stasis_stuff, 0, "%s", args->app);
   if (!ast_strlen_zero(args->app_args)) {
      ast_str_append(&chan_data->stasis_stuff, 0, ",%s", args->app_args);
   }

   dialtech = ast_strdupa(args->endpoint);
   if ((stuff = strchr(dialtech, '/'))) {
      *stuff++ = '\0';
      dialdevice = stuff;
   }

   if (ast_strlen_zero(dialtech) || ast_strlen_zero(dialdevice)) {
      ast_ari_response_error(response, 400, "Bad Request",
         "Invalid endpoint specified");
      chan_data_destroy(chan_data);
      return;
   }

   originator = ast_channel_get_by_name(args->originator);
   if (originator) {
      request_cap = ao2_bump(ast_channel_nativeformats(originator));
      if (!ast_strlen_zero(args->app)) {
         stasis_app_subscribe_channel(args->app, originator);
      }
   } else if (!ast_strlen_zero(args->formats)) {
      char *format_name;
      char *formats_copy = ast_strdupa(args->formats);

      if (!(request_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
         ast_ari_response_alloc_failed(response);
         chan_data_destroy(chan_data);
         return;
      }

      while ((format_name = ast_strip(strsep(&formats_copy, ",")))) {
         struct ast_format *fmt = ast_format_cache_get(format_name);

         if (!fmt || ast_format_cap_append(request_cap, fmt, 0)) {
            if (!fmt) {
               ast_ari_response_error(
                  response, 400, "Bad Request",
                  "Provided format (%s) was not found", format_name);
            } else {
               ast_ari_response_alloc_failed(response);
            }
            ao2_ref(request_cap, -1);
            ao2_cleanup(fmt);
            chan_data_destroy(chan_data);
            return;
         }
         ao2_ref(fmt, -1);
      }
   } else {
      if (!(request_cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT))) {
         ast_ari_response_alloc_failed(response);
         chan_data_destroy(chan_data);
         return;
      }

      ast_format_cap_append_by_type(request_cap, AST_MEDIA_TYPE_AUDIO);
   }

   chan_data->chan = ast_request(dialtech, request_cap, &assignedids, originator, dialdevice, &cause);
   ao2_cleanup(request_cap);

   if (!chan_data->chan) {
      if (ast_channel_errno() == AST_CHANNEL_ERROR_ID_EXISTS) {
         ast_ari_response_error(response, 409, "Conflict",
            "Channel with given unique ID already exists");
      } else {
         ast_ari_response_alloc_failed(response);
      }
      ast_channel_cleanup(originator);
      chan_data_destroy(chan_data);
      return;
   }

   if (!ast_strlen_zero(args->app)) {
      stasis_app_subscribe_channel(args->app, chan_data->chan);
   }

   if (variables) {
      ast_set_variables(chan_data->chan, variables);
   }

   ast_channel_cleanup(originator);

   if (save_dialstring(chan_data->chan, stuff)) {
      ast_ari_response_alloc_failed(response);
      chan_data_destroy(chan_data);
      return;
   }

   snapshot = ast_channel_snapshot_get_latest(ast_channel_uniqueid(chan_data->chan));

   if (ast_pthread_create_detached(&thread, NULL, ari_channel_thread, chan_data)) {
      ast_ari_response_alloc_failed(response);
      chan_data_destroy(chan_data);
   } else {
      ast_ari_response_ok(response, ast_channel_snapshot_to_json(snapshot, NULL));
   }

   ao2_ref(snapshot, -1);
}

ast_ari_channels_create_parse_body()

int ast_ari_channels_create_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_create_args *	args
	)

Body parsing function for /channels/create.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 264 of file res_ari_channels.c.

References ast_ari_channels_create_args::app, ast_ari_channels_create_args::app_args, ast_json_object_get(), ast_json_string_get(), ast_ari_channels_create_args::channel_id, ast_ari_channels_create_args::endpoint, ast_ari_channels_create_args::formats, ast_ari_channels_create_args::originator, and ast_ari_channels_create_args::other_channel_id.

Referenced by ast_ari_channels_create().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "endpoint");
   if (field) {
      args->endpoint = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "appArgs");
   if (field) {
      args->app_args = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "channelId");
   if (field) {
      args->channel_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "otherChannelId");
   if (field) {
      args->other_channel_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "originator");
   if (field) {
      args->originator = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "formats");
   if (field) {
      args->formats = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_dial()

void ast_ari_channels_dial	(	struct ast_variable *	headers,
		struct ast_ari_channels_dial_args *	args,
		struct ast_ari_response *	response
	)

Dial a created channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1939 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_no_content(), ast_channel_adsicpe_set(), ast_channel_caller(), ast_channel_cleanup, ast_channel_connected(), ast_channel_datastore_inherit(), ast_channel_dialed(), ast_channel_get_by_name(), ast_channel_inherit_variables(), ast_channel_language(), ast_channel_lock, ast_channel_lock_both, ast_channel_musicclass(), ast_channel_redirecting(), ast_channel_req_accountcodes(), AST_CHANNEL_REQUESTOR_BRIDGE_PEER, ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_transfercapability(), ast_channel_transfercapability_set(), ast_channel_unlock, ast_connected_line_copy_from_caller(), ast_max_forwards_decrement(), ast_party_redirecting_copy(), AST_STATE_DOWN, AST_STATE_RESERVED, ast_strdupa, ast_strlen_zero, ast_ari_channels_dial_args::caller, ast_ari_channels_dial_args::channel_id, find_control(), NULL, RAII_VAR, restore_dialstring(), stasis_app_control_dial(), ast_ari_channels_dial_args::timeout, and ast_party_dialed::transit_network_select.

Referenced by ast_ari_channels_dial_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   RAII_VAR(struct ast_channel *, caller, NULL, ast_channel_cleanup);
   RAII_VAR(struct ast_channel *, callee, NULL, ast_channel_cleanup);
   char *dialstring;

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   caller = ast_channel_get_by_name(args->caller);

   callee = ast_channel_get_by_name(args->channel_id);
   if (!callee) {
      ast_ari_response_error(response, 404, "Not Found",
         "Callee not found");
      return;
   }

   if (ast_channel_state(callee) != AST_STATE_DOWN
      && ast_channel_state(callee) != AST_STATE_RESERVED) {
      ast_ari_response_error(response, 409, "Conflict",
         "Channel is not in the 'Down' state");
      return;
   }

   /* XXX This is straight up copied from main/dial.c. It's probably good
    * to separate this to some common method.
    */
   if (caller) {
      ast_channel_lock_both(caller, callee);
   } else {
      ast_channel_lock(callee);
   }

   dialstring = restore_dialstring(callee);
   if (!dialstring) {
      ast_channel_unlock(callee);
      if (caller) {
         ast_channel_unlock(caller);
      }
      ast_ari_response_error(response, 409, "Conflict",
         "Dialing a channel not created by ARI");
      return;
   }
   /* Make a copy of the dialstring just in case some jerk tries to hang up the
    * channel before we can actually dial
    */
   dialstring = ast_strdupa(dialstring);

   ast_channel_stage_snapshot(callee);
   if (caller) {
      ast_channel_inherit_variables(caller, callee);
      ast_channel_datastore_inherit(caller, callee);
      ast_max_forwards_decrement(callee);

      /* Copy over callerid information */
      ast_party_redirecting_copy(ast_channel_redirecting(callee), ast_channel_redirecting(caller));

      ast_channel_dialed(callee)->transit_network_select = ast_channel_dialed(caller)->transit_network_select;

      ast_connected_line_copy_from_caller(ast_channel_connected(callee), ast_channel_caller(caller));

      ast_channel_language_set(callee, ast_channel_language(caller));
      ast_channel_req_accountcodes(callee, caller, AST_CHANNEL_REQUESTOR_BRIDGE_PEER);
      if (ast_strlen_zero(ast_channel_musicclass(callee)))
         ast_channel_musicclass_set(callee, ast_channel_musicclass(caller));

      ast_channel_adsicpe_set(callee, ast_channel_adsicpe(caller));
      ast_channel_transfercapability_set(callee, ast_channel_transfercapability(caller));
      ast_channel_unlock(caller);
   }

   ast_channel_stage_snapshot_done(callee);
   ast_channel_unlock(callee);

   if (stasis_app_control_dial(control, dialstring, args->timeout)) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_channels_dial_parse_body()

int ast_ari_channels_dial_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_dial_args *	args
	)

Body parsing function for /channels/{channelId}/dial.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2667 of file res_ari_channels.c.

References ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_ari_channels_dial_args::caller, and ast_ari_channels_dial_args::timeout.

Referenced by ast_ari_channels_dial_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "caller");
   if (field) {
      args->caller = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "timeout");
   if (field) {
      args->timeout = ast_json_integer_get(field);
   }
   return 0;
}

ast_ari_channels_external_media()

void ast_ari_channels_external_media	(	struct ast_variable *	headers,
		struct ast_ari_channels_external_media_args *	args,
		struct ast_ari_response *	response
	)

Start an External Media session.

Create a channel to an External Media source/sink.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 2176 of file resource_channels.c.

References ast_ari_channels_external_media_args::app, ast_ari_channels_external_media_parse_body(), ast_ari_response_error(), ast_assert, ast_json_object_get(), ast_sockaddr_split_hostport(), ast_strdupa, ast_strlen_zero, ast_ari_channels_external_media_args::connection_type, ast_ari_channels_external_media_args::direction, ast_ari_channels_external_media_args::encapsulation, ast_ari_channels_external_media_args::external_host, external_media_audiosocket_tcp(), external_media_rtp_udp(), ast_ari_channels_external_media_args::format, host, json_to_ast_variables(), NULL, PARSE_PORT_REQUIRE, ast_ari_channels_external_media_args::transport, and ast_ari_channels_external_media_args::variables.

Referenced by ast_ari_channels_external_media_cb().

{
   struct ast_variable *variables = NULL;
   char *external_host;
   char *host = NULL;
   char *port = NULL;

   ast_assert(response != NULL);

   if (ast_strlen_zero(args->app)) {
      ast_ari_response_error(response, 400, "Bad Request", "app cannot be empty");
      return;
   }

   if (ast_strlen_zero(args->external_host)) {
      ast_ari_response_error(response, 400, "Bad Request", "external_host cannot be empty");
      return;
   }

   external_host = ast_strdupa(args->external_host);
   if (!ast_sockaddr_split_hostport(external_host, &host, &port, PARSE_PORT_REQUIRE)) {
      ast_ari_response_error(response, 400, "Bad Request", "external_host must be <host>:<port>");
      return;
   }

   if (ast_strlen_zero(args->format)) {
      ast_ari_response_error(response, 400, "Bad Request", "format cannot be empty");
      return;
   }

   if (ast_strlen_zero(args->encapsulation)) {
      args->encapsulation = "rtp";
   }
   if (ast_strlen_zero(args->transport)) {
      args->transport = "udp";
   }
   if (ast_strlen_zero(args->connection_type)) {
      args->connection_type = "client";
   }
   if (ast_strlen_zero(args->direction)) {
      args->direction = "both";
   }

   if (args->variables) {
      struct ast_json *json_variables;

      ast_ari_channels_external_media_parse_body(args->variables, args);
      json_variables = ast_json_object_get(args->variables, "variables");
      if (json_variables
         && json_to_ast_variables(response, json_variables, &variables)) {
         return;
      }
   }

   if (strcasecmp(args->encapsulation, "rtp") == 0 && strcasecmp(args->transport, "udp") == 0) {
      external_media_rtp_udp(args, variables, response);
   } else if (strcasecmp(args->encapsulation, "audiosocket") == 0 && strcasecmp(args->transport, "tcp") == 0) {
      external_media_audiosocket_tcp(args, variables, response);
   } else {
      ast_ari_response_error(
         response, 501, "Not Implemented",
         "The encapsulation and/or transport is not supported");
   }
}

ast_ari_channels_external_media_parse_body()

int ast_ari_channels_external_media_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_external_media_args *	args
	)

Body parsing function for /channels/externalMedia.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2814 of file res_ari_channels.c.

References ast_ari_channels_external_media_args::app, ast_json_object_get(), ast_json_string_get(), ast_ari_channels_external_media_args::channel_id, ast_ari_channels_external_media_args::connection_type, ast_ari_channels_external_media_args::data, ast_ari_channels_external_media_args::direction, ast_ari_channels_external_media_args::encapsulation, ast_ari_channels_external_media_args::external_host, ast_ari_channels_external_media_args::format, and ast_ari_channels_external_media_args::transport.

Referenced by ast_ari_channels_external_media().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "channelId");
   if (field) {
      args->channel_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "external_host");
   if (field) {
      args->external_host = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "encapsulation");
   if (field) {
      args->encapsulation = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "transport");
   if (field) {
      args->transport = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "connection_type");
   if (field) {
      args->connection_type = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "format");
   if (field) {
      args->format = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "direction");
   if (field) {
      args->direction = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "data");
   if (field) {
      args->data = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_get()

void ast_ari_channels_get	(	struct ast_variable *	headers,
		struct ast_ari_channels_get_args *	args,
		struct ast_ari_response *	response
	)

Channel details.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 888 of file resource_channels.c.

References ao2_ref, ast_ari_response_error(), ast_ari_response_ok(), ast_channel_snapshot_get_latest(), ast_channel_snapshot_to_json(), ast_ari_channels_get_args::channel_id, and NULL.

Referenced by ast_ari_channels_get_cb().

{
   struct ast_channel_snapshot *snapshot;

   snapshot = ast_channel_snapshot_get_latest(args->channel_id);
   if (!snapshot) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Channel not found");
      return;
   }

   ast_ari_response_ok(response,
            ast_channel_snapshot_to_json(snapshot, NULL));
   ao2_ref(snapshot, -1);
}

ast_ari_channels_get_channel_var()

void ast_ari_channels_get_channel_var	(	struct ast_variable *	headers,
		struct ast_ari_channels_get_channel_var_args *	args,
		struct ast_ari_response *	response
	)

Get the value of a channel variable or function.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1472 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_alloc_failed(), ast_ari_response_error(), ast_ari_response_ok(), ast_assert, ast_channel_cleanup, ast_channel_get_by_name(), ast_free, ast_func_read2(), ast_json_pack(), ast_json_ref(), ast_json_unref(), ast_str_buffer(), ast_str_create, ast_str_retrieve_variable(), ast_strlen_zero, ast_ari_channels_get_channel_var_args::channel_id, NULL, RAII_VAR, S_OR, value, and ast_ari_channels_get_channel_var_args::variable.

Referenced by ast_ari_channels_get_channel_var_cb().

{
   RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   RAII_VAR(struct ast_str *, value, ast_str_create(32), ast_free);
   RAII_VAR(struct ast_channel *, channel, NULL, ast_channel_cleanup);

   ast_assert(response != NULL);

   if (!value) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   if (ast_strlen_zero(args->variable)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Variable name is required");
      return;
   }

   if (ast_strlen_zero(args->channel_id)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Channel ID is required");
      return;
   }

   channel = ast_channel_get_by_name(args->channel_id);
   if (!channel) {
      ast_ari_response_error(
         response, 404, "Channel Not Found",
         "Provided channel was not found");
      return;
   }

   /* You may be tempted to lock the channel you're about to read from. You
    * would be wrong. Some dialplan functions put the channel into
    * autoservice, which deadlocks if the channel is already locked.
    * ast_str_retrieve_variable() does its own locking, and the dialplan
    * functions need to as well. We should be fine without the lock.
    */

   if (args->variable[strlen(args->variable) - 1] == ')') {
      if (ast_func_read2(channel, args->variable, &value, 0)) {
         ast_ari_response_error(
            response, 500, "Error With Function",
            "Unable to read provided function");
         return;
      }
   } else {
      if (!ast_str_retrieve_variable(&value, 0, channel, NULL, args->variable)) {
         ast_ari_response_error(
            response, 404, "Variable Not Found",
            "Provided variable was not found");
         return;
      }
   }

   if (!(json = ast_json_pack("{s: s}", "value", S_OR(ast_str_buffer(value), "")))) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   ast_ari_response_ok(response, ast_json_ref(json));
}

ast_ari_channels_get_channel_var_parse_body()

int ast_ari_channels_get_channel_var_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_get_channel_var_args *	args
	)

Body parsing function for /channels/{channelId}/variable.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2278 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_channels_get_channel_var_args::variable.

Referenced by ast_ari_channels_get_channel_var_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "variable");
   if (field) {
      args->variable = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_hangup()

void ast_ari_channels_hangup	(	struct ast_variable *	headers,
		struct ast_ari_channels_hangup_args *	args,
		struct ast_ari_response *	response
	)

Delete (i.e. hangup) a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 907 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), AST_CAUSE_NORMAL, ast_channel_get_by_name(), ast_channel_hangupcause_set(), ast_softhangup(), AST_SOFTHANGUP_EXPLICIT, ast_strlen_zero, ast_ari_channels_hangup_args::channel_id, convert_reason_to_hangup_code(), NULL, RAII_VAR, ast_ari_channels_hangup_args::reason, and ast_ari_channels_hangup_args::reason_code.

Referenced by ast_ari_channels_hangup_cb().

{
   RAII_VAR(struct ast_channel *, chan, NULL, ao2_cleanup);
   int cause;

   chan = ast_channel_get_by_name(args->channel_id);
   if (chan == NULL) {
      ast_ari_response_error(
         response, 404, "Not Found",
         "Channel not found");
      return;
   }

   if (!ast_strlen_zero(args->reason) && !ast_strlen_zero(args->reason_code)) {
      ast_ari_response_error(response, 400, "Bad Request",
         "The reason and reason_code can't both be specified");
      return;
   }

   if (!ast_strlen_zero(args->reason_code)) {
      /* reason_code allows any hangup code */
      if (sscanf(args->reason_code, "%30d", &cause) != 1) {
         ast_ari_response_error(
            response, 400, "Invalid Reason Code",
            "Invalid reason for hangup reason code provided");
         return;
      }
   } else if (!ast_strlen_zero(args->reason)) {
      /* reason allows only listed hangup reason */
      cause = convert_reason_to_hangup_code(args->reason);
      if (cause == -1) {
         ast_ari_response_error(
            response, 400, "Invalid Reason",
            "Invalid reason for hangup reason provided");
         return;
      }
   } else {
      /* not specified. set default hangup */
      cause = AST_CAUSE_NORMAL;
   }

   ast_channel_hangupcause_set(chan, cause);
   ast_softhangup(chan, AST_SOFTHANGUP_EXPLICIT);

   ast_ari_response_no_content(response);
}

ast_ari_channels_hangup_parse_body()

int ast_ari_channels_hangup_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_hangup_args *	args
	)

Body parsing function for /channels/{channelId}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 592 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), ast_ari_channels_hangup_args::reason, and ast_ari_channels_hangup_args::reason_code.

Referenced by ast_ari_channels_hangup_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "reason_code");
   if (field) {
      args->reason_code = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "reason");
   if (field) {
      args->reason = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_hold()

void ast_ari_channels_hold	(	struct ast_variable *	headers,
		struct ast_ari_channels_hold_args *	args,
		struct ast_ari_response *	response
	)

Hold a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 514 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_hold_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_hold().

Referenced by ast_ari_channels_hold_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_hold(control);

   ast_ari_response_no_content(response);
}

ast_ari_channels_list()

void ast_ari_channels_list	(	struct ast_variable *	headers,
		struct ast_ari_channels_list_args *	args,
		struct ast_ari_response *	response
	)

List all active channels in Asterisk.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 956 of file resource_channels.c.

References ao2_cleanup, ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_ari_response_alloc_failed(), ast_ari_response_ok(), ast_channel_cache_all(), ast_channel_snapshot_to_json(), ast_json_array_append(), ast_json_array_create(), ast_json_ref(), ast_json_unref(), stasis_message_sanitizer::channel_snapshot, NULL, RAII_VAR, and stasis_app_get_sanitizer().

Referenced by ast_ari_channels_list_cb().

{
   RAII_VAR(struct ao2_container *, snapshots, NULL, ao2_cleanup);
   RAII_VAR(struct ast_json *, json, NULL, ast_json_unref);
   struct ao2_iterator i;
   void *obj;
   struct stasis_message_sanitizer *sanitize = stasis_app_get_sanitizer();

   snapshots = ast_channel_cache_all();

   json = ast_json_array_create();
   if (!json) {
      ast_ari_response_alloc_failed(response);
      return;
   }

   i = ao2_iterator_init(snapshots, 0);
   while ((obj = ao2_iterator_next(&i))) {
      struct ast_channel_snapshot *snapshot = obj;
      int r;

      if (sanitize && sanitize->channel_snapshot
         && sanitize->channel_snapshot(snapshot)) {
         ao2_ref(snapshot, -1);
         continue;
      }

      r = ast_json_array_append(
         json, ast_channel_snapshot_to_json(snapshot, NULL));
      if (r != 0) {
         ast_ari_response_alloc_failed(response);
         ao2_iterator_destroy(&i);
         ao2_ref(snapshot, -1);
         return;
      }
      ao2_ref(snapshot, -1);
   }
   ao2_iterator_destroy(&i);

   ast_ari_response_ok(response, ast_json_ref(json));
}

ast_ari_channels_move()

void ast_ari_channels_move	(	struct ast_variable *	headers,
		struct ast_ari_channels_move_args *	args,
		struct ast_ari_response *	response
	)

Move the channel from one Stasis application to another.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 256 of file resource_channels.c.

References ao2_cleanup, ast_ari_channels_move_args::app, ast_ari_channels_move_args::app_args, ast_ari_response_error(), ast_ari_response_no_content(), ast_ari_channels_move_args::channel_id, find_control(), NULL, RAII_VAR, and stasis_app_control_move().

Referenced by ast_ari_channels_move_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (!control) {
      return;
   }

   if (stasis_app_control_move(control, args->app, args->app_args)) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Failed to switch Stasis applications");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_channels_move_parse_body()

int ast_ari_channels_move_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_move_args *	args
	)

Body parsing function for /channels/{channelId}/move.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 785 of file res_ari_channels.c.

References ast_ari_channels_move_args::app, ast_ari_channels_move_args::app_args, ast_json_object_get(), and ast_json_string_get().

Referenced by ast_ari_channels_move_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "appArgs");
   if (field) {
      args->app_args = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_mute()

void ast_ari_channels_mute	(	struct ast_variable *	headers,
		struct ast_ari_channels_mute_args *	args,
		struct ast_ari_response *	response
	)

Mute a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 403 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), AST_FRAME_VOICE, AST_MUTE_DIRECTION_READ, AST_MUTE_DIRECTION_WRITE, ast_strlen_zero, ast_ari_channels_mute_args::channel_id, channel_state_invalid(), ast_ari_channels_mute_args::direction, find_control(), NULL, RAII_VAR, and stasis_app_control_mute().

Referenced by ast_ari_channels_mute_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   unsigned int direction = 0;
   enum ast_frame_type frametype = AST_FRAME_VOICE;

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   if (ast_strlen_zero(args->direction)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Direction is required");
      return;
   }

   if (!strcmp(args->direction, "in")) {
      direction = AST_MUTE_DIRECTION_READ;
   } else if (!strcmp(args->direction, "out")) {
      direction = AST_MUTE_DIRECTION_WRITE;
   } else if (!strcmp(args->direction, "both")) {
      direction = AST_MUTE_DIRECTION_READ | AST_MUTE_DIRECTION_WRITE;
   } else {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Invalid direction specified");
      return;
   }

   stasis_app_control_mute(control, direction, frametype);

   ast_ari_response_no_content(response);
}

ast_ari_channels_mute_parse_body()

int ast_ari_channels_mute_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_mute_args *	args
	)

Body parsing function for /channels/{channelId}/mute.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1251 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_channels_mute_args::direction.

Referenced by ast_ari_channels_mute_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "direction");
   if (field) {
      args->direction = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_originate()

void ast_ari_channels_originate	(	struct ast_variable *	headers,
		struct ast_ari_channels_originate_args *	args,
		struct ast_ari_response *	response
	)

Create a new channel (originate).

The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1433 of file resource_channels.c.

References ast_ari_channels_originate_args::app, ast_ari_channels_originate_args::app_args, ari_channels_handle_originate_with_id(), ast_ari_channels_originate_parse_body(), ast_channel_cleanup, ast_json_object_get(), ast_variables_destroy(), ast_ari_channels_originate_args::caller_id, ast_ari_channels_originate_args::channel_id, ast_ari_channels_originate_args::context, ast_ari_channels_originate_args::endpoint, ast_ari_channels_originate_args::extension, ast_ari_channels_originate_args::formats, json_to_ast_variables(), ast_ari_channels_originate_args::label, NULL, ast_ari_channels_originate_args::originator, ast_ari_channels_originate_args::other_channel_id, ast_ari_channels_originate_args::priority, ast_ari_channels_originate_args::timeout, and ast_ari_channels_originate_args::variables.

Referenced by ast_ari_channels_originate_cb().

{
   struct ast_variable *variables = NULL;
   struct ast_channel *chan;

   /* Parse any query parameters out of the body parameter */
   if (args->variables) {
      struct ast_json *json_variables;

      ast_ari_channels_originate_parse_body(args->variables, args);
      json_variables = ast_json_object_get(args->variables, "variables");
      if (json_variables
         && json_to_ast_variables(response, json_variables, &variables)) {
         return;
      }
   }

   chan = ari_channels_handle_originate_with_id(
      args->endpoint,
      args->extension,
      args->context,
      args->priority,
      args->label,
      args->app,
      args->app_args,
      args->caller_id,
      args->timeout,
      variables,
      args->channel_id,
      args->other_channel_id,
      args->originator,
      args->formats,
      response);
   ast_channel_cleanup(chan);
   ast_variables_destroy(variables);
}

ast_ari_channels_originate_parse_body()

int ast_ari_channels_originate_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_originate_args *	args
	)

Body parsing function for /channels.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 107 of file res_ari_channels.c.

References ast_ari_channels_originate_args::app, ast_ari_channels_originate_args::app_args, ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_ari_channels_originate_args::caller_id, ast_ari_channels_originate_args::channel_id, ast_ari_channels_originate_args::context, ast_ari_channels_originate_args::endpoint, ast_ari_channels_originate_args::extension, ast_ari_channels_originate_args::formats, ast_ari_channels_originate_args::label, ast_ari_channels_originate_args::originator, ast_ari_channels_originate_args::other_channel_id, ast_ari_channels_originate_args::priority, and ast_ari_channels_originate_args::timeout.

Referenced by ast_ari_channels_originate().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "endpoint");
   if (field) {
      args->endpoint = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "extension");
   if (field) {
      args->extension = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "context");
   if (field) {
      args->context = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "priority");
   if (field) {
      args->priority = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "label");
   if (field) {
      args->label = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "appArgs");
   if (field) {
      args->app_args = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "callerId");
   if (field) {
      args->caller_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "timeout");
   if (field) {
      args->timeout = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "channelId");
   if (field) {
      args->channel_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "otherChannelId");
   if (field) {
      args->other_channel_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "originator");
   if (field) {
      args->originator = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "formats");
   if (field) {
      args->formats = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_originate_with_id()

void ast_ari_channels_originate_with_id	(	struct ast_variable *	headers,
		struct ast_ari_channels_originate_with_id_args *	args,
		struct ast_ari_response *	response
	)

Create a new channel (originate with id).

The new channel is created immediately and a snapshot of it returned. If a Stasis application is provided it will be automatically subscribed to the originated channel for further events and updates.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1394 of file resource_channels.c.

References ast_ari_channels_originate_with_id_args::app, ast_ari_channels_originate_with_id_args::app_args, ari_channels_handle_originate_with_id(), ast_ari_channels_originate_with_id_parse_body(), ast_channel_cleanup, ast_json_object_get(), ast_variables_destroy(), ast_ari_channels_originate_with_id_args::caller_id, ast_ari_channels_originate_with_id_args::channel_id, ast_ari_channels_originate_with_id_args::context, ast_ari_channels_originate_with_id_args::endpoint, ast_ari_channels_originate_with_id_args::extension, ast_ari_channels_originate_with_id_args::formats, json_to_ast_variables(), ast_ari_channels_originate_with_id_args::label, NULL, ast_ari_channels_originate_with_id_args::originator, ast_ari_channels_originate_with_id_args::other_channel_id, ast_ari_channels_originate_with_id_args::priority, ast_ari_channels_originate_with_id_args::timeout, and ast_ari_channels_originate_with_id_args::variables.

Referenced by ast_ari_channels_originate_with_id_cb().

{
   struct ast_variable *variables = NULL;
   struct ast_channel *chan;

   /* Parse any query parameters out of the body parameter */
   if (args->variables) {
      struct ast_json *json_variables;

      ast_ari_channels_originate_with_id_parse_body(args->variables, args);
      json_variables = ast_json_object_get(args->variables, "variables");
      if (json_variables
         && json_to_ast_variables(response, json_variables, &variables)) {
         return;
      }
   }

   chan = ari_channels_handle_originate_with_id(
      args->endpoint,
      args->extension,
      args->context,
      args->priority,
      args->label,
      args->app,
      args->app_args,
      args->caller_id,
      args->timeout,
      variables,
      args->channel_id,
      args->other_channel_id,
      args->originator,
      args->formats,
      response);
   ast_channel_cleanup(chan);
   ast_variables_destroy(variables);
}

ast_ari_channels_originate_with_id_parse_body()

int ast_ari_channels_originate_with_id_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_originate_with_id_args *	args
	)

Body parsing function for /channels/{channelId}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 436 of file res_ari_channels.c.

References ast_ari_channels_originate_with_id_args::app, ast_ari_channels_originate_with_id_args::app_args, ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_ari_channels_originate_with_id_args::caller_id, ast_ari_channels_originate_with_id_args::context, ast_ari_channels_originate_with_id_args::endpoint, ast_ari_channels_originate_with_id_args::extension, ast_ari_channels_originate_with_id_args::formats, ast_ari_channels_originate_with_id_args::label, ast_ari_channels_originate_with_id_args::originator, ast_ari_channels_originate_with_id_args::other_channel_id, ast_ari_channels_originate_with_id_args::priority, and ast_ari_channels_originate_with_id_args::timeout.

Referenced by ast_ari_channels_originate_with_id().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "endpoint");
   if (field) {
      args->endpoint = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "extension");
   if (field) {
      args->extension = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "context");
   if (field) {
      args->context = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "priority");
   if (field) {
      args->priority = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "label");
   if (field) {
      args->label = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "appArgs");
   if (field) {
      args->app_args = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "callerId");
   if (field) {
      args->caller_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "timeout");
   if (field) {
      args->timeout = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "otherChannelId");
   if (field) {
      args->other_channel_id = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "originator");
   if (field) {
      args->originator = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "formats");
   if (field) {
      args->formats = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_play()

void ast_ari_channels_play	(	struct ast_variable *	headers,
		struct ast_ari_channels_play_args *	args,
		struct ast_ari_response *	response
	)

Start playback of media.

The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 718 of file resource_channels.c.

References ari_channels_handle_play(), ast_ari_channels_play_args::channel_id, ast_ari_channels_play_args::lang, ast_ari_channels_play_args::media, ast_ari_channels_play_args::media_count, ast_ari_channels_play_args::offsetms, ast_ari_channels_play_args::playback_id, and ast_ari_channels_play_args::skipms.

Referenced by ast_ari_channels_play_cb().

{
   ari_channels_handle_play(
      args->channel_id,
      args->media,
      args->media_count,
      args->lang,
      args->offsetms,
      args->skipms,
      args->playback_id,
      response);
}

ast_ari_channels_play_parse_body()

int ast_ari_channels_play_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_play_args *	args
	)

Body parsing function for /channels/{channelId}/play.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1800 of file res_ari_channels.c.

References ast_free, AST_JSON_ARRAY, ast_json_array_get(), ast_json_array_size(), ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_json_typeof(), ast_malloc, ast_ari_channels_play_args::lang, ast_ari_channels_play_args::media, ast_ari_channels_play_args::media_count, ast_ari_channels_play_args::offsetms, ast_ari_channels_play_args::playback_id, and ast_ari_channels_play_args::skipms.

Referenced by ast_ari_channels_play_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "media");
   if (field) {
      /* If they were silly enough to both pass in a query param and a
       * JSON body, free up the query value.
       */
      ast_free(args->media);
      if (ast_json_typeof(field) == AST_JSON_ARRAY) {
         /* Multiple param passed as array */
         size_t i;
         args->media_count = ast_json_array_size(field);
         args->media = ast_malloc(sizeof(*args->media) * args->media_count);

         if (!args->media) {
            return -1;
         }

         for (i = 0; i < args->media_count; ++i) {
            args->media[i] = ast_json_string_get(ast_json_array_get(field, i));
         }
      } else {
         /* Multiple param passed as single value */
         args->media_count = 1;
         args->media = ast_malloc(sizeof(*args->media) * args->media_count);
         if (!args->media) {
            return -1;
         }
         args->media[0] = ast_json_string_get(field);
      }
   }
   field = ast_json_object_get(body, "lang");
   if (field) {
      args->lang = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "offsetms");
   if (field) {
      args->offsetms = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "skipms");
   if (field) {
      args->skipms = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "playbackId");
   if (field) {
      args->playback_id = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_play_with_id()

void ast_ari_channels_play_with_id	(	struct ast_variable *	headers,
		struct ast_ari_channels_play_with_id_args *	args,
		struct ast_ari_response *	response
	)

Start playback of media and specify the playbackId.

The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 733 of file resource_channels.c.

References ari_channels_handle_play(), ast_ari_channels_play_with_id_args::channel_id, ast_ari_channels_play_with_id_args::lang, ast_ari_channels_play_with_id_args::media, ast_ari_channels_play_with_id_args::media_count, ast_ari_channels_play_with_id_args::offsetms, ast_ari_channels_play_with_id_args::playback_id, and ast_ari_channels_play_with_id_args::skipms.

Referenced by ast_ari_channels_play_with_id_cb().

{
   ari_channels_handle_play(
      args->channel_id,
      args->media,
      args->media_count,
      args->lang,
      args->offsetms,
      args->skipms,
      args->playback_id,
      response);
}

ast_ari_channels_play_with_id_parse_body()

int ast_ari_channels_play_with_id_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_play_with_id_args *	args
	)

Body parsing function for /channels/{channelId}/play/{playbackId}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1978 of file res_ari_channels.c.

References ast_free, AST_JSON_ARRAY, ast_json_array_get(), ast_json_array_size(), ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_json_typeof(), ast_malloc, ast_ari_channels_play_with_id_args::lang, ast_ari_channels_play_with_id_args::media, ast_ari_channels_play_with_id_args::media_count, ast_ari_channels_play_with_id_args::offsetms, and ast_ari_channels_play_with_id_args::skipms.

Referenced by ast_ari_channels_play_with_id_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "media");
   if (field) {
      /* If they were silly enough to both pass in a query param and a
       * JSON body, free up the query value.
       */
      ast_free(args->media);
      if (ast_json_typeof(field) == AST_JSON_ARRAY) {
         /* Multiple param passed as array */
         size_t i;
         args->media_count = ast_json_array_size(field);
         args->media = ast_malloc(sizeof(*args->media) * args->media_count);

         if (!args->media) {
            return -1;
         }

         for (i = 0; i < args->media_count; ++i) {
            args->media[i] = ast_json_string_get(ast_json_array_get(field, i));
         }
      } else {
         /* Multiple param passed as single value */
         args->media_count = 1;
         args->media = ast_malloc(sizeof(*args->media) * args->media_count);
         if (!args->media) {
            return -1;
         }
         args->media[0] = ast_json_string_get(field);
      }
   }
   field = ast_json_object_get(body, "lang");
   if (field) {
      args->lang = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "offsetms");
   if (field) {
      args->offsetms = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "skipms");
   if (field) {
      args->skipms = ast_json_integer_get(field);
   }
   return 0;
}

ast_ari_channels_record()

void ast_ari_channels_record	(	struct ast_variable *	headers,
		struct ast_ari_channels_record_args *	args,
		struct ast_ari_response *	response
	)

Start a recording.

Record audio from a channel. Note that this will not capture audio sent to the channel. The bridge itself has a record feature if that's what you want.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 748 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_created(), ast_ari_response_error(), ast_asprintf, ast_assert, ast_free, ast_get_format_for_file_ext(), ast_log, ast_malloc, AST_RECORD_IF_EXISTS_ERROR, ast_string_field_build, ast_uri_encode(), ast_uri_http, ast_ari_channels_record_args::beep, ast_ari_channels_record_args::channel_id, errno, find_control(), ast_ari_channels_record_args::format, ast_ari_channels_record_args::if_exists, LOG_WARNING, ast_ari_channels_record_args::max_duration_seconds, ast_ari_channels_record_args::max_silence_seconds, ast_ari_channels_record_args::name, NULL, options, RAII_VAR, stasis_app_control_record(), stasis_app_recording_if_exists_parse(), stasis_app_recording_options_create(), STASIS_APP_RECORDING_TERMINATE_INVALID, stasis_app_recording_termination_parse(), stasis_app_recording_to_json(), and ast_ari_channels_record_args::terminate_on.

Referenced by ast_ari_channels_record_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   RAII_VAR(struct stasis_app_recording *, recording, NULL, ao2_cleanup);
   RAII_VAR(char *, recording_url, NULL, ast_free);
   struct ast_json *json;
   RAII_VAR(struct stasis_app_recording_options *, options, NULL,
      ao2_cleanup);
   RAII_VAR(char *, uri_encoded_name, NULL, ast_free);
   size_t uri_name_maxlen;

   ast_assert(response != NULL);

   if (args->max_duration_seconds < 0) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "max_duration_seconds cannot be negative");
      return;
   }

   if (args->max_silence_seconds < 0) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "max_silence_seconds cannot be negative");
      return;
   }

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   options = stasis_app_recording_options_create(args->name, args->format);
   if (options == NULL) {
      ast_ari_response_error(
         response, 500, "Internal Server Error",
         "Out of memory");
   }
   ast_string_field_build(options, target, "channel:%s", args->channel_id);
   options->max_silence_seconds = args->max_silence_seconds;
   options->max_duration_seconds = args->max_duration_seconds;
   options->terminate_on =
      stasis_app_recording_termination_parse(args->terminate_on);
   options->if_exists =
      stasis_app_recording_if_exists_parse(args->if_exists);
   options->beep = args->beep;

   if (options->terminate_on == STASIS_APP_RECORDING_TERMINATE_INVALID) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "terminateOn invalid");
      return;
   }

   if (options->if_exists == AST_RECORD_IF_EXISTS_ERROR) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "ifExists invalid");
      return;
   }

   if (!ast_get_format_for_file_ext(options->format)) {
      ast_ari_response_error(
         response, 422, "Unprocessable Entity",
         "specified format is unknown on this system");
      return;
   }

   recording = stasis_app_control_record(control, options);
   if (recording == NULL) {
      switch(errno) {
      case EINVAL:
         /* While the arguments are invalid, we should have
          * caught them prior to calling record.
          */
         ast_ari_response_error(
            response, 500, "Internal Server Error",
            "Error parsing request");
         break;
      case EEXIST:
         ast_ari_response_error(response, 409, "Conflict",
            "Recording '%s' already exists and can not be overwritten",
            args->name);
         break;
      case ENOMEM:
         ast_ari_response_error(
            response, 500, "Internal Server Error",
            "Out of memory");
         break;
      case EPERM:
         ast_ari_response_error(
            response, 400, "Bad Request",
            "Recording name invalid");
         break;
      default:
         ast_log(LOG_WARNING,
            "Unrecognized recording error: %s\n",
            strerror(errno));
         ast_ari_response_error(
            response, 500, "Internal Server Error",
            "Internal Server Error");
         break;
      }
      return;
   }

   uri_name_maxlen = strlen(args->name) * 3;
   uri_encoded_name = ast_malloc(uri_name_maxlen);
   if (!uri_encoded_name) {
      ast_ari_response_error(
         response, 500, "Internal Server Error",
         "Out of memory");
      return;
   }
   ast_uri_encode(args->name, uri_encoded_name, uri_name_maxlen,
      ast_uri_http);

   if (ast_asprintf(&recording_url, "/recordings/live/%s",
         uri_encoded_name) == -1) {
      recording_url = NULL;
      ast_ari_response_error(
         response, 500, "Internal Server Error",
         "Out of memory");
      return;
   }

   json = stasis_app_recording_to_json(recording);
   if (!json) {
      ast_ari_response_error(
         response, 500, "Internal Server Error",
         "Out of memory");
      return;
   }

   ast_ari_response_created(response, recording_url, json);
}

ast_ari_channels_record_parse_body()

int ast_ari_channels_record_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_record_args *	args
	)

Body parsing function for /channels/{channelId}/record.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2152 of file res_ari_channels.c.

References ast_json_integer_get(), ast_json_is_true(), ast_json_object_get(), ast_json_string_get(), ast_ari_channels_record_args::beep, ast_ari_channels_record_args::format, ast_ari_channels_record_args::if_exists, ast_ari_channels_record_args::max_duration_seconds, ast_ari_channels_record_args::max_silence_seconds, ast_ari_channels_record_args::name, and ast_ari_channels_record_args::terminate_on.

Referenced by ast_ari_channels_record_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "name");
   if (field) {
      args->name = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "format");
   if (field) {
      args->format = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "maxDurationSeconds");
   if (field) {
      args->max_duration_seconds = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "maxSilenceSeconds");
   if (field) {
      args->max_silence_seconds = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "ifExists");
   if (field) {
      args->if_exists = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "beep");
   if (field) {
      args->beep = ast_json_is_true(field);
   }
   field = ast_json_object_get(body, "terminateOn");
   if (field) {
      args->terminate_on = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_redirect()

void ast_ari_channels_redirect	(	struct ast_variable *	headers,
		struct ast_ari_channels_redirect_args *	args,
		struct ast_ari_response *	response
	)

Redirect the channel to a different location.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 276 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), ast_channel_snapshot_get_latest(), ast_strdupa, ast_strlen_zero, ast_ari_channels_redirect_args::channel_id, channel_state_invalid(), ast_ari_channels_redirect_args::endpoint, find_control(), NULL, RAII_VAR, and stasis_app_control_redirect().

Referenced by ast_ari_channels_redirect_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   RAII_VAR(struct ast_channel_snapshot *, chan_snapshot, NULL, ao2_cleanup);
   char *tech;
   char *resource;
   int tech_len;

   control = find_control(response, args->channel_id);
   if (!control) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   if (ast_strlen_zero(args->endpoint)) {
      ast_ari_response_error(response, 400, "Not Found",
         "Required parameter 'endpoint' not provided.");
      return;
   }

   tech = ast_strdupa(args->endpoint);
   if (!(resource = strchr(tech, '/')) || !(tech_len = resource - tech)) {
      ast_ari_response_error(response, 422, "Unprocessable Entity",
         "Endpoint parameter '%s' does not contain tech/resource", args->endpoint);
      return;
   }

   *resource++ = '\0';
   if (ast_strlen_zero(resource)) {
      ast_ari_response_error(response, 422, "Unprocessable Entity",
         "No resource provided in endpoint parameter '%s'", args->endpoint);
      return;
   }

   chan_snapshot = ast_channel_snapshot_get_latest(args->channel_id);
   if (!chan_snapshot) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Unable to find channel snapshot for '%s'", args->channel_id);
      return;
   }

   if (strncasecmp(chan_snapshot->base->type, tech, tech_len)) {
      ast_ari_response_error(response, 422, "Unprocessable Entity",
         "Endpoint technology '%s' does not match channel technology '%s'",
         tech, chan_snapshot->base->type);
      return;
   }

   if (stasis_app_control_redirect(control, resource)) {
      ast_ari_response_error(response, 500, "Internal Server Error",
         "Failed to redirect channel");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_channels_redirect_parse_body()

int ast_ari_channels_redirect_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_redirect_args *	args
	)

Body parsing function for /channels/{channelId}/redirect.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 874 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_channels_redirect_args::endpoint.

Referenced by ast_ari_channels_redirect_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "endpoint");
   if (field) {
      args->endpoint = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_ring()

void ast_ari_channels_ring	(	struct ast_variable *	headers,
		struct ast_ari_channels_ring_args *	args,
		struct ast_ari_response *	response
	)

Indicate ringing to a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 363 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_ring_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_ring().

Referenced by ast_ari_channels_ring_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_ring(control);

   ast_ari_response_no_content(response);
}

ast_ari_channels_ring_stop()

void ast_ari_channels_ring_stop	(	struct ast_variable *	headers,
		struct ast_ari_channels_ring_stop_args *	args,
		struct ast_ari_response *	response
	)

Stop ringing indication on a channel if locally generated.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 383 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_ring_stop_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_ring_stop().

Referenced by ast_ari_channels_ring_stop_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_ring_stop(control);

   ast_ari_response_no_content(response);
}

ast_ari_channels_rtpstatistics()

void ast_ari_channels_rtpstatistics	(	struct ast_variable *	headers,
		struct ast_ari_channels_rtpstatistics_args *	args,
		struct ast_ari_response *	response
	)

RTP stats on a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 2028 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_ok(), ast_channel_cleanup, ast_channel_get_by_name(), ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_rtp_instance_get_glue(), ast_rtp_instance_get_stats_all_json(), ast_ari_channels_rtpstatistics_args::channel_id, ast_rtp_glue::get_rtp_info, NULL, RAII_VAR, and ast_channel_tech::type.

Referenced by ast_ari_channels_rtpstatistics_cb().

{
   RAII_VAR(struct ast_channel *, chan, NULL, ast_channel_cleanup);
   RAII_VAR(struct ast_rtp_instance *, rtp, NULL, ao2_cleanup);
   struct ast_json *j_res;
   const struct ast_channel_tech *tech;
   struct ast_rtp_glue *glue;

   chan = ast_channel_get_by_name(args->channel_id);
   if (!chan) {
      ast_ari_response_error(response, 404, "Not Found",
         "Channel not found");
      return;
   }

   ast_channel_lock(chan);
   tech = ast_channel_tech(chan);
   if (!tech) {
      ast_channel_unlock(chan);
      ast_ari_response_error(response, 404, "Not Found",
         "Channel's tech not found");
      return;
   }

   glue = ast_rtp_instance_get_glue(tech->type);
   if (!glue) {
      ast_channel_unlock(chan);
      ast_ari_response_error(response, 403, "Forbidden",
         "Unsupported channel type");
      return;
   }

   glue->get_rtp_info(chan, &rtp);
   if (!rtp) {
      ast_channel_unlock(chan);
      ast_ari_response_error(response, 404, "Not Found",
         "RTP info not found");
      return;
   }

   j_res = ast_rtp_instance_get_stats_all_json(rtp);
   if (!j_res) {
      ast_channel_unlock(chan);
      ast_ari_response_error(response, 404, "Not Found",
         "Statistics not found");
      return;
   }

   ast_channel_unlock(chan);
   ast_ari_response_ok(response, j_res);

   return;
}

ast_ari_channels_send_dtmf()

void ast_ari_channels_send_dtmf	(	struct ast_variable *	headers,
		struct ast_ari_channels_send_dtmf_args *	args,
		struct ast_ari_response *	response
	)

Send provided DTMF to a given channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 487 of file resource_channels.c.

References ast_ari_channels_send_dtmf_args::after, ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), ast_strlen_zero, ast_ari_channels_send_dtmf_args::before, ast_ari_channels_send_dtmf_args::between, ast_ari_channels_send_dtmf_args::channel_id, channel_state_invalid(), ast_ari_channels_send_dtmf_args::dtmf, ast_ari_channels_send_dtmf_args::duration, find_control(), NULL, RAII_VAR, and stasis_app_control_dtmf().

Referenced by ast_ari_channels_send_dtmf_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   if (ast_strlen_zero(args->dtmf)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "DTMF is required");
      return;
   }

   stasis_app_control_dtmf(control, args->dtmf, args->before, args->between, args->duration, args->after);

   ast_ari_response_no_content(response);
}

ast_ari_channels_send_dtmf_parse_body()

int ast_ari_channels_send_dtmf_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_send_dtmf_args *	args
	)

Body parsing function for /channels/{channelId}/dtmf.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1139 of file res_ari_channels.c.

References ast_ari_channels_send_dtmf_args::after, ast_json_integer_get(), ast_json_object_get(), ast_json_string_get(), ast_ari_channels_send_dtmf_args::before, ast_ari_channels_send_dtmf_args::between, ast_ari_channels_send_dtmf_args::dtmf, and ast_ari_channels_send_dtmf_args::duration.

Referenced by ast_ari_channels_send_dtmf_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "dtmf");
   if (field) {
      args->dtmf = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "before");
   if (field) {
      args->before = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "between");
   if (field) {
      args->between = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "duration");
   if (field) {
      args->duration = ast_json_integer_get(field);
   }
   field = ast_json_object_get(body, "after");
   if (field) {
      args->after = ast_json_integer_get(field);
   }
   return 0;
}

ast_ari_channels_set_channel_var()

void ast_ari_channels_set_channel_var	(	struct ast_variable *	headers,
		struct ast_ari_channels_set_channel_var_args *	args,
		struct ast_ari_response *	response
	)

Set the value of a channel variable or function.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1541 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), ast_assert, ast_strlen_zero, ast_ari_channels_set_channel_var_args::channel_id, find_control(), NULL, RAII_VAR, stasis_app_control_set_channel_var(), ast_ari_channels_set_channel_var_args::value, and ast_ari_channels_set_channel_var_args::variable.

Referenced by ast_ari_channels_set_channel_var_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   ast_assert(response != NULL);

   if (ast_strlen_zero(args->variable)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Variable name is required");
      return;
   }

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* response filled in by find_control */
      return;
   }

   if (stasis_app_control_set_channel_var(control, args->variable, args->value)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Failed to execute function");
      return;
   }

   ast_ari_response_no_content(response);
}

ast_ari_channels_set_channel_var_parse_body()

int ast_ari_channels_set_channel_var_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_set_channel_var_args *	args
	)

Body parsing function for /channels/{channelId}/variable.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2361 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), ast_ari_channels_set_channel_var_args::value, and ast_ari_channels_set_channel_var_args::variable.

Referenced by ast_ari_channels_set_channel_var_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "variable");
   if (field) {
      args->variable = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "value");
   if (field) {
      args->value = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_snoop_channel()

void ast_ari_channels_snoop_channel	(	struct ast_variable *	headers,
		struct ast_ari_channels_snoop_channel_args *	args,
		struct ast_ari_response *	response
	)

Start snooping.

Snoop (spy/whisper) on a specific channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1651 of file resource_channels.c.

References ast_ari_channels_snoop_channel_args::app, ast_ari_channels_snoop_channel_args::app_args, ari_channels_handle_snoop_channel(), ast_ari_channels_snoop_channel_args::channel_id, ast_ari_channels_snoop_channel_args::snoop_id, ast_ari_channels_snoop_channel_args::spy, and ast_ari_channels_snoop_channel_args::whisper.

Referenced by ast_ari_channels_snoop_channel_cb().

{
   ari_channels_handle_snoop_channel(
      args->channel_id,
      args->spy,
      args->whisper,
      args->app,
      args->app_args,
      args->snoop_id,
      response);
}

ast_ari_channels_snoop_channel_parse_body()

int ast_ari_channels_snoop_channel_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_snoop_channel_args *	args
	)

Body parsing function for /channels/{channelId}/snoop.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2451 of file res_ari_channels.c.

References ast_ari_channels_snoop_channel_args::app, ast_ari_channels_snoop_channel_args::app_args, ast_json_object_get(), ast_json_string_get(), ast_ari_channels_snoop_channel_args::snoop_id, ast_ari_channels_snoop_channel_args::spy, and ast_ari_channels_snoop_channel_args::whisper.

Referenced by ast_ari_channels_snoop_channel_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "spy");
   if (field) {
      args->spy = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "whisper");
   if (field) {
      args->whisper = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "appArgs");
   if (field) {
      args->app_args = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "snoopId");
   if (field) {
      args->snoop_id = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_snoop_channel_with_id()

void ast_ari_channels_snoop_channel_with_id	(	struct ast_variable *	headers,
		struct ast_ari_channels_snoop_channel_with_id_args *	args,
		struct ast_ari_response *	response
	)

Start snooping.

Snoop (spy/whisper) on a specific channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 1665 of file resource_channels.c.

References ast_ari_channels_snoop_channel_with_id_args::app, ast_ari_channels_snoop_channel_with_id_args::app_args, ari_channels_handle_snoop_channel(), ast_ari_channels_snoop_channel_with_id_args::channel_id, ast_ari_channels_snoop_channel_with_id_args::snoop_id, ast_ari_channels_snoop_channel_with_id_args::spy, and ast_ari_channels_snoop_channel_with_id_args::whisper.

Referenced by ast_ari_channels_snoop_channel_with_id_cb().

{
   ari_channels_handle_snoop_channel(
      args->channel_id,
      args->spy,
      args->whisper,
      args->app,
      args->app_args,
      args->snoop_id,
      response);
}

ast_ari_channels_snoop_channel_with_id_parse_body()

int ast_ari_channels_snoop_channel_with_id_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_snoop_channel_with_id_args *	args
	)

Body parsing function for /channels/{channelId}/snoop/{snoopId}.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 2561 of file res_ari_channels.c.

References ast_ari_channels_snoop_channel_with_id_args::app, ast_ari_channels_snoop_channel_with_id_args::app_args, ast_json_object_get(), ast_json_string_get(), ast_ari_channels_snoop_channel_with_id_args::spy, and ast_ari_channels_snoop_channel_with_id_args::whisper.

Referenced by ast_ari_channels_snoop_channel_with_id_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "spy");
   if (field) {
      args->spy = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "whisper");
   if (field) {
      args->whisper = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "app");
   if (field) {
      args->app = ast_json_string_get(field);
   }
   field = ast_json_object_get(body, "appArgs");
   if (field) {
      args->app_args = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_start_moh()

void ast_ari_channels_start_moh	(	struct ast_variable *	headers,
		struct ast_ari_channels_start_moh_args *	args,
		struct ast_ari_response *	response
	)

Play music on hold to a channel.

Using media operations such as /play on a channel playing MOH in this manner will suspend MOH without resuming automatically. If continuing music on hold is desired, the stasis application must reinitiate music on hold.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 556 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_start_moh_args::channel_id, channel_state_invalid(), find_control(), ast_ari_channels_start_moh_args::moh_class, NULL, RAII_VAR, and stasis_app_control_moh_start().

Referenced by ast_ari_channels_start_moh_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_moh_start(control, args->moh_class);
   ast_ari_response_no_content(response);
}

ast_ari_channels_start_moh_parse_body()

int ast_ari_channels_start_moh_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_start_moh_args *	args
	)

Body parsing function for /channels/{channelId}/moh.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1537 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_channels_start_moh_args::moh_class.

Referenced by ast_ari_channels_start_moh_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "mohClass");
   if (field) {
      args->moh_class = ast_json_string_get(field);
   }
   return 0;
}

ast_ari_channels_start_silence()

void ast_ari_channels_start_silence	(	struct ast_variable *	headers,
		struct ast_ari_channels_start_silence_args *	args,
		struct ast_ari_response *	response
	)

Play silence to a channel.

Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 596 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_start_silence_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_silence_start().

Referenced by ast_ari_channels_start_silence_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_silence_start(control);
   ast_ari_response_no_content(response);
}

ast_ari_channels_stop_moh()

void ast_ari_channels_stop_moh	(	struct ast_variable *	headers,
		struct ast_ari_channels_stop_moh_args *	args,
		struct ast_ari_response *	response
	)

Stop playing music on hold to a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 576 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_stop_moh_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_moh_stop().

Referenced by ast_ari_channels_stop_moh_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_moh_stop(control);
   ast_ari_response_no_content(response);
}

ast_ari_channels_stop_silence()

void ast_ari_channels_stop_silence	(	struct ast_variable *	headers,
		struct ast_ari_channels_stop_silence_args *	args,
		struct ast_ari_response *	response
	)

Stop playing silence to a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 616 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_stop_silence_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_silence_stop().

Referenced by ast_ari_channels_stop_silence_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_silence_stop(control);
   ast_ari_response_no_content(response);
}

ast_ari_channels_unhold()

void ast_ari_channels_unhold	(	struct ast_variable *	headers,
		struct ast_ari_channels_unhold_args *	args,
		struct ast_ari_response *	response
	)

Remove a channel from hold.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 535 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_no_content(), ast_ari_channels_unhold_args::channel_id, channel_state_invalid(), find_control(), NULL, RAII_VAR, and stasis_app_control_unhold().

Referenced by ast_ari_channels_unhold_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      /* Response filled in by find_control */
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   stasis_app_control_unhold(control);

   ast_ari_response_no_content(response);
}

ast_ari_channels_unmute()

void ast_ari_channels_unmute	(	struct ast_variable *	headers,
		struct ast_ari_channels_unmute_args *	args,
		struct ast_ari_response *	response
	)

Unmute a channel.

Parameters

	headers	HTTP headers
	args	Swagger parameters
[out]	response	HTTP response

Definition at line 445 of file resource_channels.c.

References ao2_cleanup, ast_ari_response_error(), ast_ari_response_no_content(), AST_FRAME_VOICE, AST_MUTE_DIRECTION_READ, AST_MUTE_DIRECTION_WRITE, ast_strlen_zero, ast_ari_channels_unmute_args::channel_id, channel_state_invalid(), ast_ari_channels_unmute_args::direction, find_control(), NULL, RAII_VAR, and stasis_app_control_unmute().

Referenced by ast_ari_channels_unmute_cb().

{
   RAII_VAR(struct stasis_app_control *, control, NULL, ao2_cleanup);
   unsigned int direction = 0;
   enum ast_frame_type frametype = AST_FRAME_VOICE;

   control = find_control(response, args->channel_id);
   if (control == NULL) {
      return;
   }

   if (channel_state_invalid(control, response)) {
      return;
   }

   if (ast_strlen_zero(args->direction)) {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Direction is required");
      return;
   }

   if (!strcmp(args->direction, "in")) {
      direction = AST_MUTE_DIRECTION_READ;
   } else if (!strcmp(args->direction, "out")) {
      direction = AST_MUTE_DIRECTION_WRITE;
   } else if (!strcmp(args->direction, "both")) {
      direction = AST_MUTE_DIRECTION_READ | AST_MUTE_DIRECTION_WRITE;
   } else {
      ast_ari_response_error(
         response, 400, "Bad Request",
         "Invalid direction specified");
      return;
   }

   stasis_app_control_unmute(control, direction, frametype);

   ast_ari_response_no_content(response);
}

ast_ari_channels_unmute_parse_body()

int ast_ari_channels_unmute_parse_body	(	struct ast_json *	body,
		struct ast_ari_channels_unmute_args *	args
	)

Body parsing function for /channels/{channelId}/mute.

Parameters

	body	The JSON body from which to parse parameters.
[out]	args	The args structure to parse into.

Return values

zero	on success
non-zero	on failure

Definition at line 1334 of file res_ari_channels.c.

References ast_json_object_get(), ast_json_string_get(), and ast_ari_channels_unmute_args::direction.

Referenced by ast_ari_channels_unmute_cb().

{
   struct ast_json *field;
   /* Parse query parameters out of it */
   field = ast_json_object_get(body, "direction");
   if (field) {
      args->direction = ast_json_string_get(field);
   }
   return 0;
}