github.com/CyCoreSystems/ari@v4.8.4+incompatible/ari.proto (about)

     1  syntax = "proto3";
     2  
     3  package asterisk.ari;
     4  
     5  option go_package = "ari";
     6  
     7  import "github.com/gogo/protobuf/gogoproto/gogo.proto";
     8  import "google/protobuf/timestamp.proto";
     9  
    10  // Key identifies a unique resource in the system
    11  message Key {
    12     // NOTE: we build our own stringer
    13     option (gogoproto.goproto_stringer) = false;
    14     
    15  	// Kind indicates the type of resource the Key points to.  e.g., "channel",
    16  	// "bridge", etc.
    17  	string kind = 1;
    18  
    19  	// ID indicates the unique identifier of the resource
    20     string id = 2 [(gogoproto.customname) = "ID"];
    21  
    22  	// Node indicates the unique identifier of the Asterisk node on which the
    23  	// resource exists or will be created
    24     string node = 3;
    25  
    26  	// Dialog indicates a named scope of the resource, for receiving events
    27     string dialog = 4;
    28  
    29  	// App indiciates the ARI application that this key is bound to.
    30     string app = 5;
    31  }
    32  
    33  // CallerID describes the name and number which identifies the caller to other endpoints
    34  message CallerID {
    35     // NOTE: we build our own stringer
    36     option (gogoproto.goproto_stringer) = false;
    37  
    38     // Name is the name of the party
    39     string name = 1;
    40  
    41     // Number is the number of the party
    42     string number = 2;
    43  }
    44  
    45  // ChannelData describes the data for a specific channel
    46  message ChannelData {
    47     // Key is the key of the channel
    48     Key key = 1;
    49  
    50     // Id is the unique ID for this channel (AMI-style)
    51     string id = 2 [(gogoproto.customname) = "ID"];
    52  
    53     // Name is the name of this channel (tect/name-id)
    54     string name = 3;
    55  
    56     // State is the current state of the channel
    57     string state = 4;
    58  
    59     // Accountcode is the account code assigned to the channel
    60     string accountcode = 5;
    61  
    62     // Caller is the callerID of the calling endpoint
    63     CallerID caller = 6;
    64  
    65     // Connected is the callerID of the connected line, if applicable
    66     CallerID connected = 7;
    67  
    68     // Creationtime is the time at which the channel was created
    69     google.protobuf.Timestamp creationtime = 8;
    70  
    71     // Dialplan is the current location of the channel in the dialplan
    72     DialplanCEP dialplan = 9;
    73  
    74     // Language is the default spoken language for this channel
    75     string language = 10;
    76  
    77     // ChannelVars is the list of channel variables set on this channel
    78     map<string, string> channelvars = 11 [(gogoproto.customname) = "ChannelVars"];
    79  
    80  }
    81  
    82  // Dialplan describes a location in the Asterisk dialplan
    83  message DialplanCEP {
    84  
    85     // Context describes the section in the dialplan
    86     string context = 1;
    87  
    88     // Exten describes the label in the section of the dialplan
    89     string exten = 2;
    90  
    91     // Priority indicates the index at the label in the section of the dialplan
    92     int64 priority = 3;
    93  }