package fonoster.routr.connect.agents.v2beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Agents
agents.proto:29The Agents service definition
rpc Create (, )
agents.proto:31Creates a new Agent
message
agents.proto:80The request message for the Agents.Create method
string name = 1
The name of the Agent
string username = 2
The username of the Agent
Privacy privacy = 3
The password of the Agent
bool enabled = 4
The enabled status of the Agent
string domain_ref = 5
Reference to the Domain of the Agent
string credentials_ref = 6
Reference to the Credentials of the Agent
int32 max_contacts = 8
The maximum number of contacts that can be created for this Agent
int32 expires = 9
Value to override the expires requested by the Agent
optional extended = 7
The extended attributes of the Agent
rpc Update (, )
agents.proto:33Updates an existing Agent
message
agents.proto:102The request message for the Agents.Update method
string ref = 1
The unique identifier of the Agent
string name = 2
The name of the Agent
Privacy privacy = 3
The privacy settings of the Agent
bool enabled = 4
The enabled status of the Agent
string domain_ref = 5
Reference to the Domain of the Agent
string credentials_ref = 6
Reference to the Credentials of the Agent
int32 max_contacts = 8
The maximum number of contacts that can be created for this Agent
int32 expires = 9
Value to override the expires requested by the Agent
optional extended = 7
The extended attributes of the Agent
rpc Get (, )
agents.proto:35Gets an existing Agent
message
agents.proto:124The request message for the Agents.Get method
string ref = 1
The unique identifier of the Agent
rpc Delete (, )
agents.proto:37Deletes an existing Agent
message
agents.proto:130The request message for the Agents.Delete method
string ref = 1
The unique identifier of the Agent
rpc List (, )
agents.proto:39Lists all Agents
message
agents.proto:150The request message for the Agents.List method
int32 page_size = 1
The maximum number of items in the list
string page_token = 2
The next_page_token value returned from the previous request, if any
message
agents.proto:159The response message for the Agents.List method
repeated items = 1
List of Agents
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list
rpc FindBy (, )
agents.proto:41Find Agents by field name and value
message
agents.proto:136The request message for the Agents.FindBy method
string field_name = 1
The field name to search
string field_value = 2
The value to search
message
agents.proto:144The response message for the Agents.FindBy method
repeated items = 1
The list of Agents
message
agents.proto:50The message for the Agent resource
Used as response type in: Agents.Create, Agents.Get, Agents.Update
Used as field type in: ,
string api_version = 1
The API version of the Agent
string ref = 2
The unique identifier of the Agent
string name = 3
The name of the Agent
string username = 4
The username of the Agent
Privacy privacy = 5
The password of the Agent
bool enabled = 6
The enabled status of the Agent
int32 created_at = 7
The created_at timestamp of the Agent
int32 updated_at = 8
The updated_at timestamp of the Agent
int32 max_contacts = 12
The maximum number of contacts that can be created for this Agent
int32 expires = 13
Value to override the expires requested by the Agent
optional domain = 9
The domain of the Agent
optional credentials = 10
The credentials of the Agent
optional extended = 11
The extended attributes of the Agent
Used in: , ,
PRIVATE = 0
NONE = 1