Asterisk - The Open Source Telephony Project GIT-master-d856a3e
Data Fields
ast_ari_channels_originate_args Struct Reference

#include <resource_channels.h>

Collaboration diagram for ast_ari_channels_originate_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()

Definition at line 54 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 66 of file resource_channels.h.

◆ 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 68 of file resource_channels.h.

◆ caller_id

const char* caller_id

CallerID to use when dialing the endpoint or extension.

Definition at line 70 of file resource_channels.h.

◆ channel_id

const char* channel_id

The unique id to assign the channel on creation.

Definition at line 76 of file resource_channels.h.

◆ context

const char* context

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

Definition at line 60 of file resource_channels.h.

◆ endpoint

const char* endpoint

Endpoint to call.

Definition at line 56 of file resource_channels.h.

◆ extension

const char* extension

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

Definition at line 58 of file resource_channels.h.

Referenced by Registration::write().

◆ 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 82 of file resource_channels.h.

◆ label

const char* label

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

Definition at line 64 of file resource_channels.h.

◆ originator

const char* originator

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

Definition at line 80 of file resource_channels.h.

◆ other_channel_id

const char* other_channel_id

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

Definition at line 78 of file resource_channels.h.

◆ priority

long priority

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

Definition at line 62 of file resource_channels.h.

◆ timeout

int timeout

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

Definition at line 72 of file resource_channels.h.

◆ 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 74 of file resource_channels.h.


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