Asterisk - The Open Source Telephony Project GIT-master-7921072
Data Fields
ast_ari_endpoints_refer_args Struct Reference

#include <resource_endpoints.h>

Collaboration diagram for ast_ari_endpoints_refer_args:
Collaboration graph
[legend]

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

◆ from

const char* from

The endpoint resource or technology specific identity to refer from.

Definition at line 87 of file resource_endpoints.h.

◆ refer_to

const char* refer_to

The endpoint resource or technology specific URI to refer to.

Definition at line 89 of file resource_endpoints.h.

◆ to

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.

◆ to_self

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.

◆ variables

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.


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