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

#include <resource_endpoints.h>

Data Fields

const char * from
 
const char * refer_to
 
const char * to
 
int to_self
 
struct ast_jsonvariables
 

Detailed Description

Argument struct for ast_ari_endpoints_refer()

Definition at line 83 of file resource_endpoints.h.

Field Documentation

const char* from

The endpoint resource or technology specific identity to refer from.

Definition at line 87 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer(), ast_ari_endpoints_refer_cb(), and ast_ari_endpoints_refer_parse_body().

const char* refer_to

The endpoint resource or technology specific URI to refer to.

Definition at line 89 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer(), ast_ari_endpoints_refer_cb(), and ast_ari_endpoints_refer_parse_body().

const char* to

The endpoint resource or technology specific URI that should be referred to somewhere. Valid resource is pjsip.

Definition at line 85 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer(), ast_ari_endpoints_refer_cb(), and ast_ari_endpoints_refer_parse_body().

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 91 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer(), ast_ari_endpoints_refer_cb(), and ast_ari_endpoints_refer_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. The "display_name" key is used by the PJSIP technology. Its value will be prepended as a display name to the Refer-To URI.

Definition at line 93 of file resource_endpoints.h.

Referenced by ast_ari_endpoints_refer(), and ast_ari_endpoints_refer_cb().


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