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

#include <resource_channels.h>

Collaboration diagram for ast_ari_channels_originate_with_id_args:
Collaboration graph
[legend]

Data Fields

const char * app
 
const char * app_args
 
const char * caller_id
 
const char * channel_id
 
const char * context
 
const char * endpoint
 
const char * extension
 
const char * formats
 
const char * label
 
const char * originator
 
const char * other_channel_id
 
long priority
 
int timeout
 
struct ast_jsonvariables
 

Detailed Description

Argument struct for ast_ari_channels_originate_with_id()

Definition at line 157 of file resource_channels.h.

Field Documentation

◆ app

const char* app

The application that is subscribed to the originated channel. When the channel is answered, it will be passed to this Stasis application. Mutually exclusive with 'context', 'extension', 'priority', and 'label'.

Definition at line 171 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_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 173 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ caller_id

const char* caller_id

CallerID to use when dialing the endpoint or extension.

Definition at line 175 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ channel_id

const char* channel_id

The unique id to assign the channel on creation.

Definition at line 159 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), and ast_ari_channels_originate_with_id_cb().

◆ context

const char* context

The context to dial after the endpoint answers. If omitted, uses 'default'. Mutually exclusive with 'app'.

Definition at line 165 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ endpoint

const char* endpoint

◆ extension

const char* extension

The extension to dial after the endpoint answers. Mutually exclusive with 'app'.

Definition at line 163 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_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 185 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ label

const char* label

The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'.

Definition at line 169 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ originator

const char* originator

The unique id of the channel which is originating this one.

Definition at line 183 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_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 181 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ priority

long priority

The priority to dial after the endpoint answers. If omitted, uses 1. Mutually exclusive with 'app'.

Definition at line 167 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_parse_body().

◆ timeout

int timeout

Timeout (in seconds) before giving up dialing, or -1 for no timeout.

Definition at line 177 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), ast_ari_channels_originate_with_id_cb(), and ast_ari_channels_originate_with_id_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 179 of file resource_channels.h.

Referenced by ast_ari_channels_originate_with_id(), and ast_ari_channels_originate_with_id_cb().


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