Asterisk - The Open Source Telephony Project  18.5.0
Data Fields
ast_ari_channels_create_args Struct Reference

#include <resource_channels.h>

Collaboration diagram for ast_ari_channels_create_args:
Collaboration graph
[legend]

Data Fields

const char * app
 
const char * app_args
 
const char * channel_id
 
const char * endpoint
 
const char * formats
 
const char * originator
 
const char * other_channel_id
 
struct ast_jsonvariables
 

Detailed Description

Argument struct for ast_ari_channels_create()

Definition at line 106 of file resource_channels.h.

Field Documentation

◆ app

const char* app

Stasis Application to place channel into

Definition at line 110 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ app_args

const char* app_args

The application arguments to pass to the Stasis application provided by 'app'. Mutually exclusive with 'context', 'extension', 'priority', and 'label'.

Definition at line 112 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ channel_id

const char* channel_id

The unique id to assign the channel on creation.

Definition at line 114 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ endpoint

const char* endpoint

Endpoint for channel communication

Definition at line 108 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ formats

const char* formats

The format name capability list to use if originator is not specified. Ex. "ulaw,slin16". Format names can be found with "core show codecs".

Definition at line 120 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ originator

const char* originator

Unique ID of the calling channel

Definition at line 118 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ other_channel_id

const char* other_channel_id

The unique id to assign the second channel when using local channels.

Definition at line 116 of file resource_channels.h.

Referenced by ast_ari_channels_create(), ast_ari_channels_create_cb(), and ast_ari_channels_create_parse_body().

◆ variables

struct ast_json* variables

The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } }

Definition at line 122 of file resource_channels.h.

Referenced by ast_ari_channels_create(), and ast_ari_channels_create_cb().


The documentation for this struct was generated from the following file: