Asterisk - The Open Source Telephony Project  21.4.1
Data Fields
ast_ari_endpoints_refer_to_endpoint_args Struct Reference

#include <resource_endpoints.h>

Data Fields

const char * from
 
const char * refer_to
 
const char * resource
 
const char * tech
 
int to_self
 
struct ast_jsonvariables
 

Detailed Description

Argument struct for ast_ari_endpoints_refer_to_endpoint()

Definition at line 174 of file resource_endpoints.h.

Field Documentation

const char* from

The endpoint resource or technology specific identity to refer from.

Definition at line 180 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer_to_endpoint(), ast_ari_endpoints_refer_to_endpoint_cb(), and ast_ari_endpoints_refer_to_endpoint_parse_body().

const char* refer_to

The endpoint resource or technology specific URI to refer to.

Definition at line 182 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer_to_endpoint(), ast_ari_endpoints_refer_to_endpoint_cb(), and ast_ari_endpoints_refer_to_endpoint_parse_body().

const char* resource

ID of the endpoint

Definition at line 178 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer_to_endpoint(), and ast_ari_endpoints_refer_to_endpoint_cb().

const char* tech

Technology of the endpoint

Definition at line 176 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer_to_endpoint(), and ast_ari_endpoints_refer_to_endpoint_cb().

int to_self

If true and "refer_to" refers to an Asterisk endpoint, the "refer_to" value is set to point to this Asterisk endpoint - so the referee is referred to Asterisk. Otherwise, use the contact URI associated with the endpoint.

Definition at line 184 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer_to_endpoint(), ast_ari_endpoints_refer_to_endpoint_cb(), and ast_ari_endpoints_refer_to_endpoint_parse_body().

struct ast_json* variables

The "variables" key in the body object holds technology specific key/value pairs to append to the message. These can be interpreted and used by the various resource types; for example, the pjsip resource type will add the key/value pairs as SIP headers,

Definition at line 186 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer_to_endpoint(), and ast_ari_endpoints_refer_to_endpoint_cb().


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