REST Resource: projects.sipDomains.aliases

Resource: Alias

The Alias resource.

JSON representation

{
  "name": string,
  "aliasId": string,
  "displayName": string,
  "loadBalancerConfig": {
    object (LoadBalancerConfig)
  },
  "address": string,
  "createTime": string (Timestamp)
}

Fields
name	string Resource name of the alias. It must match the pattern projects/{project_id}/sipDomains/{sip_domain_id}/aliases/{alias_id}
aliasId	string Output only. A convenience field for the alias_id component of the resource name. This forms the address of the alias, of the form: {alias}@{fqdn}.
displayName	string The display name of the alias for use in the UI. Max length 100 characters.
loadBalancerConfig	object (LoadBalancerConfig) Config the alias as a load balancer.
address	string Output only. The address represented by this alias. It will be of the form {alias}@{fqdn}.
createTime	string (Timestamp format) Output only. The creation time of the alias.

LoadBalancerConfig

The configuration of an origination load balancer.

JSON representation

{
  "endpoints": [
    {
      object (LoadBalancerEndpoint)
    }
  ],
  "failoverCallHandlerUris": [
    string
  ]
}

Fields
endpoints[]	object (LoadBalancerEndpoint) The endpoints that are included in the load balancer. May contain a maximum of 10 endpoints.
failoverCallHandlerUris[]	string The failover URIs to execute in case all endpoints do not work. This is useful for configuring disaster recovery for your incoming calls, and can direct to any supported endpoint type, including: programmable voice, Flow, SIP and tel URIs.

LoadBalancerEndpoint

An endpoint that is part of a load balancer.

JSON representation

{
  "uri": string,
  "priority": number (int32),
  "weight": number (int32),
  "enabled": boolean
}

Fields
uri	string The SIP URI of the endpoint.
priority	number (int32 format) The priority of the endpoint. Value must be in the range [0,65535]. Lower priority endpoints will be attempted first.
weight	number (int32 format) The weighting to apply to this endpoint when selecting endpoints. Endpoints of the same priority will be selected by weighted randomization using this value. Value must be in the range [1,65535]. Default value is 10.
enabled	boolean Whether this endpoint is enabled. If disabled, it won't be selected.

Methods

Methods
create	POST /v1beta1/{parent}/aliases Creates a alias. The caller must have voice.aliases.create permission on the project.
get	GET /v1beta1/{name} Retrieves a alias identified by the supplied resource name. The caller must have voice.aliases.get permission on the project.
list	GET /v1beta1/{parent}/aliases Lists all Aliases. List returns alias sorted by create_time descending. The caller must have voice.aliases.list permission on the project.
update	PATCH /v1beta1/{alias.name} Updates a alias. The caller must have voice.aliases.update permission on the project.
delete	DELETE /v1beta1/{name} Deletes the specified alias. The caller must have voice.aliases.delete permission on the project.