Sinch Node.js SDK - v0.0.4
    Preparing search index...

    Class FaxesApi

    Hierarchy

    • FaxDomainApi
      • FaxesApi
    Index

    Methods

    • Delete fax content Delete the fax content for a fax using the ID number of the fax. Please note that this only deletes the content of the fax from storage.

      Parameters

      Returns Promise<void>

    • List faxes List faxes sent (OUTBOUND) or received (INBOUND), set parameters to filter the list. Example: Return calls made between 1st of January 2021 and 10th of January 2021. ``` created>=2021-01-01&startTime<=2021-01-10 ```

      Parameters

      Returns ApiListPromise<Fax>

    • Send a fax Create and send a fax. Fax content may be supplied via one or more files or URLs of supported filetypes. This endpoint supports the following content types for the fax payload:

      • Multipart/form-data
      • Application/json We will however always return a fax object in the response in application json. If you supply a callbackUrl the callback will be sent as multipart/form-data with the content of the fax as an attachment to the body, unless you specify callbackContentType as application/json.

      Files may be included in the POST request as multipart/form-data parts.

      Any URL on the Internet (including ones with basic authentication), and we'll pull it down and make it a fax. This might be useful to you if you're using a web framework for templates and creating fax files. Please note: If you are passing fax a secure URL (starting with 'https://'), make sure that your SSL certificate (including your intermediate cert, if you have one) is installed properly, valid, and up-to-date.

      Parameters

      Returns Promise<Fax>

    • Update the default basePath for the API

      Parameters

      • basePath: string

        The new base path to use for the APIs.

      Returns void