Service enfonica.voice.v1beta1.Faxes¶

Methods¶

DeleteFax
rpc DeleteFax(DeleteFaxRequest) returns (google.protobuf.Empty) Deletes a fax. The caller must have `voice.faxes.delete` permission on the project.

GetFax
rpc GetFax(GetFaxRequest) returns (Fax) Retrieves a Fax identified by the supplied resource name. The caller must have `voice.faxes.get` permission on the project.

ListFaxes
rpc ListFaxes(ListFaxesRequest) returns (ListFaxesResponse) Lists the Faxes of the specified project. List returns Faxes sorted by create_time descending. The caller must have `voice.faxes.list` permission on the project.

The Fax resource.

Fields
name	string Resource name of the fax. It must match the pattern `projects//faxes/`.
call	string Output only. The call that the fax was received on.
to	string Required. The recipient of the call. For PSTN calls, this is the phone number in +E164 format. For calls to a SIP domain, this is the URI in the To header, in the format `sip:user-or-number@domain`.
from	string Output only. The originator of the call. For PSTN calls, this is the CLI (Caller ID) in +E164 format. When placing outgoing API calls, this is required. For calls to a SIP domain, this is the URI in the From header, in the format `sip:user-or-number@domain`. This field will not be set if the CLI originated from the PSTN and the call came from a private number.
page_count	int32 Output only. The number of pages.
ready_uri	string Output only. The URI to send the fax ready webhook to. Must be an absolute URI.
uri	string Output only. An ephemeral URI that can be used to download the fax. The URI is valid for 60 minutes. Note that this field is only included in the FULL view.
start_time	google.protobuf.Timestamp Output only. The start time of the fax. This is when fax on the call started. Only set when state is SUCCEEDED.
create_time	google.protobuf.Timestamp Output only. The creation time of the fax. This is the time that the fax resource was created.

The GetFax request fax.

Fields
name	string Required. The resource name of the Fax to retrieve. Must be of the form `projects//calls//fax`.
view	FaxView Configuration of partial responses. Defaults to FULL.

Configuration of partial responses for the Fax resource.

Enums
FAX_VIEW_UNSPECIFIED	The default / unset value. The API will default to BASIC for ListFaxes and FULL for GetFax.
BASIC	Includes all fields except `uri`. This is the default for ListFaxes.
FULL	Includes all fields. This is the default for GetFax.

The ListFaxes request fax.

Fields
parent	string Required. The resource name of the parent of which to list faxes. Must be of the form `projects/*`.
page_size	int32 The maximum number of Faxes to return in the response. Default value of 10 and maximum value of 100.
page_token	string A pagination token returned from a previous fax to `ListFaxes` that indicates where this listing should continue from.
view	FaxView Configuration of partial responses. Defaults to BASIC.

The ListFaxes response fax.

Fields
faxes[]	Fax A possibly paginated list of Faxes that are direct descendants of the specified parent resource.
next_page_token	string A pagination token returned from a previous fax to `ListFaxes` that indicates from where listing should continue.

The DeleteFax request message.

Fields
name	string Required. The resource name of the Fax to be deleted. Must be of the form `projects//calls//fax`.