REST Resource: projects.faxes

Resource: Fax

The Fax resource.

JSON representation

{
  "name": string,
  "call": string,
  "to": string,
  "from": string,
  "pageCount": number (int32),
  "readyUri": string,
  "uri": string,
  "startTime": string (Timestamp),
  "createTime": string (Timestamp)
}

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.
pageCount	number (int32 format) Output only. The number of pages.
readyUri	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.
startTime	string (Timestamp format) Output only. The start time of the fax. This is when fax on the call started. Only set when state is SUCCEEDED.
createTime	string (Timestamp format) Output only. The creation time of the fax. This is the time that the fax resource was created.

Methods

Methods
get	GET /v1beta1/{name} Retrieves a Fax identified by the supplied resource name. The caller must have voice.faxes.get permission on the project.
list	GET /v1beta1/{parent}/faxes 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.
delete	DELETE /v1beta1/{name} Deletes a fax. The caller must have voice.faxes.delete permission on the project.