Integration

Retreaver

Connect Retreaver call tracking, routing, and attribution data to phone workflows.

Description

AIM AI can be configured to read and update selected Retreaver resources around a phone operation. The exact campaigns, numbers, contacts, and routing controls are limited to the approved workflow.

Authentication

A Retreaver API key and company ID are required.
Exact resource access and approved actions are confirmed during workflow scoping.

Supported Actions (53)

These are the operations this integration can perform after the required credentials and permissions are approved.

Create Affiliate
Delete Affiliate
Get Affiliate by AFID
List All Affiliates
Update Affiliate
Add Number to Caller List
Check Number in Caller List
Delete Number from Caller List
Upload Numbers to Caller List
Get Call by UUID (V2)
Get Recent Calls (V1)
Get Recent Calls (V2)
Write Call Data (GET)
Write Call Data (POST)
Delete Campaign
Get Campaign by CID
List All Campaigns
Update Campaign
Get Company by ID
List All Companies
Create Contact
Delete Contact Number
Delete Contact by Phone
Get Contact by ID
Get Contact by Phone
Update Contact
Update Contact by Phone
Create Number Pool
Get Number Pool by ID
List All Number Pools
Create Number
Delete Number
List All Numbers
Raw API Request
Get Reports
Confirm RTB Reservation
Delete Static Caller Number
List All Static Caller Numbers
Check Suppressed Numbers
Get Suppressed Number
List All Suppressed Numbers
Update Suppressed Number
Create Target Group
Delete Target Group
Get Target Group
List All Target Groups
Reset Target Group Caps
Create Target
Get Target by ID
Get Target by TID
List All Targets
Reset Target Cap
Update Target

Examples

Use these representative payloads as a technical starting point, then replace the sample values with the approved workflow data.

Targets

Representative workflow configuration for Targets.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "calls_v1_get_recent",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0,
      "query": {
        "page": 1
      }
    }
  }
}

Get all targets

Representative workflow configuration for Get all targets.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "targets_get_all",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0
    }
  }
}

Update campaign

Representative workflow configuration for Update campaign.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "campaigns_update",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0,
      "cid": "CAMPAIGN_ID",
      "campaign": {
        "name": "My Other Campaign"
      }
    }
  }
}

Delete number pool

Representative workflow configuration for Delete number pool.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "number_pools_delete",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0,
      "poolId": "YOUR_NUMBER_POOL_ID"
    }
  }
}

Update contact

Representative workflow configuration for Update contact.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "contacts_update",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0,
      "contactId": "YOUR_CONTACT_ID",
      "contact": {
        "contact_numbers_attributes": [
          {
            "id": 2,
            "number": "+18001234567"
          }
        ]
      }
    }
  }
}

Delete number from caller list

Representative workflow configuration for Delete number from caller list.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "caller_lists_delete_number",
    "params": {
      "postbackKeyUuid": "POSTBACK_KEY_UUID",
      "secretKey": "YOUR_POSTBACK_SECRET",
      "targetId": "YOUR_TARGET_ID",
      "name": "YOUR_CALLER_LIST_NAME",
      "phoneNumber": "YOUR_PHONE_NUMBER"
    }
  }
}

Get all static caller numbers

Representative workflow configuration for Get all static caller numbers.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "static_caller_numbers_get_all",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0
    }
  }
}

Get reports

Representative workflow configuration for Get reports.

JSON

{
  "automationType": "retreaver",
  "nodeId": "example-node-001",
  "nodeParams": {
    "action": "reports_get",
    "params": {
      "apiKey": "YOUR_RETREAVER_API_KEY",
      "companyId": 0,
      "query": {
        "domain": "calls",
        "facet": "tag_value",
        "created_at_start": "2024-10-25",
        "created_at_end": "2024-10-28"
      }
    }
  }
}