Send and Track Faxes with Faximo in Jinba Flow

Faximo provides comprehensive FAX services through both standard Faximo and FaximoSilver platforms. Send documents via FAX and track your FAX history with detailed delivery reports and status tracking.

FAXIMO_SEND_FAX

Send FAX messages to single or multiple recipients
Support for document attachments
Delivery confirmation and tracking
Customizable FAX settings and options

FAXIMO_SEARCH_HISTORY

Search through FAX send history
Track delivery status and timing
Access historical FAX records
Filtering and search capabilities

Connect with Faximo credentials

Faximo requires login credentials for your Faximo or FaximoSilver account. Required credentials:

Login ID
Password

Note: Treat credentials as sensitive information and never commit them to public repositories.

Send a fax document

- id: prepare_fax_document
  name: prepare_fax_document
  tool: INPUT_FILE
  input:
    - name: description
      value: "Upload document to send via FAX"

- id: send_important_fax
  name: send_important_fax
  tool: FAXIMO_SEND_FAX
  needs: [prepare_fax_document]
  config:
    - name: login_id
      value: "{{secrets.FAXIMO_LOGIN_ID}}"
    - name: password
      value: "{{secrets.FAXIMO_PASSWORD}}"
  input:
    - name: service_type
      value: "faximoSilver"  # or "faximo" (default: faximoSilver)
    - name: sendto
      value: "0312345678,0398765432"  # comma-separated FAX numbers
    - name: subject
      value: "Important Business Document"
    - name: body
      value: |
        Dear Recipient,
        
        Please find attached important business documents for your review.
        
        This FAX was sent automatically via Jinba Flow.
        
        Best regards,
        Your Company Name
    - name: attachment_urls
      value: "{{steps.prepare_fax_document.result}}"
    - name: attachment_names
      value: "document.pdf"
    - name: retrynum
      value: 1
    - name: resaddress
      value: "admin@yourcompany.com"

- id: log_fax_result
  name: log_fax_result
  tool: OUTPUT_TEXT
  needs: [send_important_fax]
  input:
    - name: value
      value: |
        FAX request accepted.
        Result Code: {{steps.send_important_fax.result.result}}
        Process Key: {{steps.send_important_fax.result.processkey}}
        Acceptance Time: {{steps.send_important_fax.result.accepttime}}
        Detail Number: {{steps.send_important_fax.result.idxcnt}}

Send a bulk fax campaign

- id: prepare_recipient_list
  name: prepare_recipient_list
  tool: PYTHON_SANDBOX_RUN
  input:
    - name: data_type
      value: OBJECT
    - name: code
      value: |
        import json

        # Prepare FAX recipient list
        recipients = [
            {"name": "Company A", "fax": "0311112222"},
            {"name": "Company B", "fax": "0333334444"},
            {"name": "Company C", "fax": "0355556666"}
        ]
        
        # Create comma-separated FAX numbers
        fax_numbers = ",".join([r["fax"] for r in recipients])
        
        # Create recipient summary
        print(json.dumps({
            "fax_numbers": fax_numbers,
            "total_recipients": len(recipients),
            "recipients": recipients
        }))

- id: upload_campaign_document
  name: upload_campaign_document
  tool: INPUT_FILE
  input:
    - name: description
      value: "Upload marketing document for FAX campaign"

- id: send_bulk_fax
  name: send_bulk_fax
  tool: FAXIMO_SEND_FAX
  needs: [prepare_recipient_list, upload_campaign_document]
  config:
    - name: login_id
      value: "{{secrets.FAXIMO_LOGIN_ID}}"
    - name: password
      value: "{{secrets.FAXIMO_PASSWORD}}"
  input:
    - name: service_type
      value: "faximoSilver"
    - name: sendto
      value: "{{steps.prepare_recipient_list.result.data.fax_numbers}}"
    - name: subject
      value: "Monthly Newsletter"
    - name: body
      value: |
        Dear Valued Partner,
        
        Please find our monthly newsletter attached.
        
        This communication contains important updates about our services.
        
        Thank you for your continued partnership.
        
        Best regards,
        Marketing Team
    - name: attachment_urls
      value: "{{steps.upload_campaign_document.result}}"
    - name: attachment_names
      value: "newsletter.pdf"
    - name: userkey
      value: "newsletter-2026-09"
    - name: resaddress
      value: "admin@yourcompany.com"

- id: track_campaign_status
  name: track_campaign_status
  tool: OUTPUT_FILE
  needs: [send_bulk_fax, prepare_recipient_list]
  input:
    - name: content
      value: |
        FAX Campaign Report
        ==================
        
        Campaign: Monthly Newsletter
        
        Results:
        - Result Code: {{steps.send_bulk_fax.result.result}}
        - Process Key: {{steps.send_bulk_fax.result.processkey}}
        - Acceptance Time: {{steps.send_bulk_fax.result.accepttime}}
        - Detail Number: {{steps.send_bulk_fax.result.idxcnt}}
        
        Recipients: {{steps.prepare_recipient_list.result.data.total_recipients}}
        
        Status: Submitted for processing
        
        Next Steps:
        1. Monitor delivery status
        2. Check for any failed deliveries
        3. Follow up on delivery confirmations
    - name: filename
      value: "fax_campaign_report.txt"
    - name: fileType
      value: "txt"

Track fax history

- id: search_recent_fax_history
  name: search_recent_fax_history
  tool: FAXIMO_SEARCH_HISTORY
  config:
    - name: login_id
      value: "{{secrets.FAXIMO_LOGIN_ID}}"
    - name: password
      value: "{{secrets.FAXIMO_PASSWORD}}"
  input:
    - name: service_type
      value: "faximoSilver"
    - name: from
      value: "2026-09-01 00:00:00"
    - name: to
      value: "2026-09-30 23:59:59"
    - name: maximumresponse
      value: 100

- id: analyze_fax_performance
  name: analyze_fax_performance
  tool: PYTHON_SANDBOX_RUN
  needs: [search_recent_fax_history]
  input:
    - name: code
      value: |
        import json
        from collections import Counter
        
        # Parse FAX history results (each entry carries a 13-digit send result code in `status`)
        fax_history = json.loads(r'''{{steps.search_recent_fax_history.result.SendResultList}}''')
        
        if not fax_history:
            print("No FAX history found for the specified period.")
        else:
            total_faxes = len(fax_history)
            total_pages = sum(fax.get('pagenum', 0) for fax in fax_history)
            status_counts = Counter(fax.get('status', 'unknown') for fax in fax_history)
            
            print("FAX Performance Analysis")
            print("=" * 30)
            print(f"Total FAXes sent: {total_faxes}")
            print(f"Total pages: {total_pages}")
            print()
            print("Send result codes:")
            for status, count in status_counts.most_common():
                print(f"  {status}: {count}")
            print()
            
            # Top recipients
            recipients = [fax.get('sendto', 'unknown') for fax in fax_history]
            top_recipients = Counter(recipients).most_common(5)
            
            print("Top Recipients:")
            for recipient, count in top_recipients:
                print(f"  {recipient}: {count} FAXes")

- id: create_performance_report
  name: create_performance_report
  tool: OUTPUT_FILE
  needs: [search_recent_fax_history, analyze_fax_performance]
  input:
    - name: content
      value: |
        FAX Performance Report
        ======================
        
        Report Period: 2026-09-01 to 2026-09-30
        
        {{steps.analyze_fax_performance.result.data}}
        
        Recommendations:
        - Monitor failed deliveries and retry if necessary
        - Verify recipient FAX numbers for failed sends
        - Consider delivery time optimization
        - Review document formatting for better compatibility
        
        For detailed delivery logs, check the Faximo service dashboard.
    - name: filename
      value: "fax_performance_report.txt"
    - name: fileType
      value: "txt"

Configure fax options

Service Types

faximo: Standard Faximo service
faximoSilver: FaximoSilver service (default)

FAXIMO_SEND_FAX inputs

sendto (required): FAX numbers, comma-separated for multiple recipients
subject (required): Subject line, up to 50 characters
body: Text sent as the first page of the FAX
attachment_urls / attachment_names: Comma-separated attachment URLs and filenames, paired by position. A missing name falls back to attachment_<n>.pdf
userkey: User-defined key (up to 255 half-width characters) for finding the send later with FAXIMO_SEARCH_HISTORY
tsi: TSID (Transmitting Subscriber Identification), up to 20 characters
headerinfo: FAX header text, up to 80 characters; supports the @d@, @t@, @T@, and @p@ placeholders
retrynum: Number of retry attempts, 0–3
resaddress: Email address that receives the result notification (up to 80 half-width characters)

FAXIMO_SEARCH_HISTORY inputs

from / to (required): Search window in YYYY-MM-DD HH:mm:ss format
idxcnt: 13-digit detail number of one send
userkey: Filter by the key passed when sending
accepttype: Send request method, 0 (Email) or 1 (API)
subject: Filter by subject, up to 50 characters
status: 13-digit send result status code
maximumresponse: Maximum number of results to return

Response Data

Send FAX Response

{
  "result": "000000",
  "processkey": "<process key>",
  "accepttime": "<request acceptance time>",
  "idxcnt": "<13-digit detail number>"
}

result is 000000 on success.

History Search Response

{
  "result": "000000",
  "processkey": "<process key>",
  "accepttime": "<request acceptance time>",
  "count": 1,
  "SendResultList": [
    {
      "idxcnt": "<13-digit detail number>",
      "subidxcnt": "<sub detail number>",
      "userkey": "newsletter-2026-09",
      "accept_type": "<accept type>",
      "senddate": "<send processing date/time>",
      "sendto": "0312345678",
      "tsid": "<TSID>",
      "resaddress": "admin@yourcompany.com",
      "subject": "Monthly Newsletter",
      "pagenum": 2,
      "status": "<13-digit send result code>",
      "statusdetail": "<send result detail code>"
    }
  ]
}

userkey, tsid, and resaddress are only present when they were set on the send.

Use Cases

Document Delivery: Send contracts, invoices, and legal documents
Marketing Campaigns: Distribute newsletters and promotional materials
Compliance Communication: Send regulatory notices and compliance documents
Emergency Notifications: Urgent communication when email is insufficient
Healthcare: Medical records and prescription transmission
Legal Services: Court documents and legal correspondence
Real Estate: Property documents and contracts
Government Communication: Official notices and forms

Best Practices

FAX Formatting

Use clear, high-contrast documents
Avoid small fonts (minimum 10pt recommended)
Test document formatting before bulk sends
Include cover page with contact information

Delivery Optimization

Send during business hours for better delivery rates
Verify FAX numbers before sending
Monitor delivery status and retry failed sends
Use appropriate priority levels

Security Considerations

Encrypt sensitive documents before FAX transmission
Use secure credential storage
Log all FAX activity for audit trails
Comply with industry regulations (HIPAA, etc.)

​FAXIMO_SEND_FAX

​FAXIMO_SEARCH_HISTORY

​Connect with Faximo credentials

​Send a fax document

​Send a bulk fax campaign

​Track fax history

​Configure fax options

​Service Types

​FAXIMO_SEND_FAX inputs

​FAXIMO_SEARCH_HISTORY inputs

​Response Data

​Send FAX Response

​History Search Response

​Use Cases

​Best Practices

​FAX Formatting

​Delivery Optimization

​Security Considerations