<Receive>

The <Receive> verb tells SignalWire to receive an incoming fax, which results in the creation of a new Fax instance resource.

Faxes remain stored indefinitely. To delete a fax, use the appropriate API call from the Compatibility API.

Verb Attributes

Attribute
action optional	The URL to request when a fax has failed or has been received.
method optional	The method attribute specifies whether the request to action is a GET or a POST. Valid values are GET or POST. Default value is POST.
mediaType optional	The type of media used to store fax media. Valid values are application/pdf or image/tiff. Default is application/pdf.
pageSize optional	The size to interpret incoming pages as. Valid values are letter, legal, or a4. Default is letter.

Action Callback

If the verb attribute action is specified, the action callback will include the Standard Fax Request Parameters plus the following optional parameters:

Parameter
RemoteStationId optional	The transmitting subscriber identification (TSID) reported by the fax machine that sent in the fax.
FaxStatus optional	The status of the fax.
NumPages optional	The number of pages received from a successful fax.
MediaUrl optional	The media URL to request to retrieve incoming media.
ErrorCode optional	The error code provides more information on a failed fax.
ErrorMessage optional	The message explaining the reason for fax failure.

Examples

Receive a Fax

XML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive action="/fax/received"/>
</Response>

JavaScript

const { RestClient } = require("@signalwire/compatibility-api");
const response = new RestClient.LaML.FaxResponse();

response.receive({ action: "/fax/received" });
console.log(response.toString());

PHP

<?php
  use SignalWire\LaML;
  $response = new LaML;

  $response->receive(array( 'action' => '/fax/received' ));
  echo $response;
?>

C#

using Twilio.TwiML;
using Twilio.TwiML.Fax;
using System;


class Example
{
    static void Main()
    {
        var response = new FaxResponse();
        response.Receive(action: "/fax/received"));

        Console.WriteLine(response.ToString());;
    }
}

Python

from signalwire.fax_response import FaxResponse, Receive

response = FaxResponse()
response.receive(action="/fax/received")

print(response)

Ruby

require 'signalwire/sdk'

response = Signalwire::Sdk::FaxResponse.new do |response|
  response.receive(action: "/fax/received")
end

puts response.to_s

SignalWire will receive the incoming fax and provide a URL endpoint.

Store Fax Image

XML

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Receive mediaType="image/tiff"></Receive>
</Response>

JavaScript

const { RestClient } = require("@signalwire/compatibility-api");
const response = new RestClient.LaML.FaxResponse();

response.receive({ mediaType: "image/tiff" });
console.log(response.toString());

PHP

<?php
  use SignalWire\LaML;
  $response = new LaML;

  $response->receive(array( 'mediaType' => 'image/tiff' ));
  echo $response;
?>

C#

using Twilio.TwiML;
using Twilio.TwiML.Fax;
using System;


class Example
{
    static void Main()
    {
        var response = new FaxResponse();
        response.Receive(mediaType: "image/tiff"));

        Console.WriteLine(response.ToString());;
    }
}

Python

from signalwire.fax_response import FaxResponse, Receive

response = FaxResponse()
response.receive(media_type="image/tiff")

print(response)

Ruby

require 'signalwire/sdk'

response = Signalwire::Sdk::FaxResponse.new do |response|
  response.receive(media_type: "image/tiff")
end

puts response.to_s

This example shows that the media from the incoming fax will be stored on SignalWire's server in TIFF format.