Deprecated APIs

Check whether or not you have any Suppressed Numbers

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl https://api.retreaver.com/suppression_list/check.json?api_key=[api_key]&company_id=1

Swipe horizontally for full code

The above command returns JSON structured like this:

{ "suppression_list": true }

Swipe horizontally for full code

Returns true if the Company has any numbers suppressed.

HTTP Request

GET https://api.retreaver.com/suppression_list/check.json?api_key=[api_key]&company_id=1

Delete a Contact Number from the Suppression List by phone number

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl -X DELETE https://api.retreaver.com/contact_numbers/+18668987878/suppressed_number.json?api_key=[api_key]&company_id=1

Swipe horizontally for full code

Removes the Contact Number from your Suppression List.

HTTP Request

DELETE https://api.retreaver.com/contact_numbers/+18668987878/suppressed_number.json?api_key=[api_key]&company_id=1

Suppress a Contact Number by phone number

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl -s \
    -X POST \
    https://api.retreaver.com/contact_numbers/+18668987878/suppressed_number.json?api_key=[api_key]&company_id=1 \
    -H "Content-Type: application/json" \
    -d '{"suppressed_number":{"can_resubscribe":false}}'

Swipe horizontally for full code

The above command returns JSON structured like this:

{
  "suppressed_number": {
    "id": 502997,
    "number": "+18668987878",
    "can_resubscribe": false,
    "created_at": "2013-10-02T14:36:14.166-04:00"
  }
}

Swipe horizontally for full code

Adds a Contact Number to the Company’s Suppression List. The can_resubscribe value toggles whether or not the contact can unblock themselves by pressing 7 if there is a “Caller Blocked” Prompt on the Campaign/Number they are calling.

The entire body of the post is optional, simply posting to https://api.retreaver.com/contact_numbers/+18668987878/suppressed_number.json?api_key=[api_key]&company_id=1 would block +18668987878; can_resubscribe is true by default. The intended use case is to allow callers to restore contact with a company after choosing to be routed to a “add caller to suppression list and hang up” routing option.

HTTP Request

POST https://api.retreaver.com/contact_numbers/+18668987878/suppressed_number.json?api_key=[api_key]&company_id=1

Content-Type: application/json

{"suppressed_number": {"can_resubscribe": false}}

Get the active Company - DEPRECATED

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl "https://api.retreaver.com/company.json?api_key=[api_key]"

Swipe horizontally for full code

The above command returns JSON structured like this:

{
  "company": {
    "id": 1,
    "name": "CallPixels",
    "default_click_url": "http://callpixels.com/?a=[affiliate_id]&c=[campaign_id]&cp=js&s1=[sub_id]",
    "default_sale_url": "http://callpixels.com/p.ashx?o=[campaign_id]&t=[call_log_id]-[caller_id]-[called_number]-[call_duration]-[call_recording_url]",
    "created_at": "2012-04-15T05:44:10Z",
    "updated_at": "2012-05-07T15:32:44Z"
  }
}

Swipe horizontally for full code

Returns the currently active Company. This is the Company that will be modified if a request is sent in without a specific company_id.

HTTP Request

GET https://api.retreaver.com/company.json?api_key=[api_key]

Get a specific Company - DEPRECATED

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl "https://api.retreaver.com/companies/1.json?api_key=[api_key]"

Swipe horizontally for full code

The above command returns JSON structured like this:

{
  "company": {
    "id": 1,
    "name": "CallPixels",
    "default_click_url": "http://callpixels.com/?a=[affiliate_id]&c=[campaign_id]&cp=js&s1=[sub_id]",
    "default_sale_url": "http://callpixels.com/p.ashx?o=[campaign_id]&t=[call_log_id]-[caller_id]-[called_number]-[call_duration]-[call_recording_url]",
    "created_at": "2012-04-15T05:44:10Z",
    "updated_at": "2012-05-07T15:32:44Z"
  }
}

Swipe horizontally for full code

Returns the Company matching our internal ID.

HTTP Request

GET https://api.retreaver.com/companies/1.json?api_key=[api_key]

Get all Companies - DEPRECATED

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl "https://api.retreaver.com/companies.json?api_key=[api_key]"

Swipe horizontally for full code

The above command returns JSON structured like this:

[
  {
    "company": {
      "id": 1,
      "name": "CallPixels",
      "default_click_url": "http://callpixels.com/?a=[affiliate_id]&c=[campaign_id]&cp=js&s1=[sub_id]",
      "default_sale_url": "http://callpixels.com/p.ashx?o=[campaign_id]&t=[call_log_id]-[caller_id]-[called_number]-[call_duration]-[call_recording_url]",
      "created_at": "2012-04-15T05:44:10Z",
      "updated_at": "2012-05-07T15:32:44Z"
    }
  }
]

Swipe horizontally for full code

Provides a complete list of Companies accessible via your Account.

HTTP Request

GET https://api.retreaver.com/companies.json?api_key=[api_key]

Create a Company - DEPRECATED

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl -s \
    -X POST \
    https://api.retreaver.com/companies.json \
    -H "Content-Type: application/json" \
    -d '{"company":{"name":"CallPixels.com"}}'

Swipe horizontally for full code

The above command returns JSON structured like this:

{
  "company": {
    "id": 1,
    "name": "CallPixels",
    "default_click_url": "http://callpixels.com/?a=[affiliate_id]&c=[campaign_id]&cp=js&s1=[sub_id]",
    "default_sale_url": "http://callpixels.com/p.ashx?o=[campaign_id]&t=[call_log_id]-[caller_id]-[called_number]-[call_duration]-[call_recording_url]",
    "created_at": "2012-04-15T05:44:10Z",
    "updated_at": "2012-05-07T15:32:44Z"
  }
}

Swipe horizontally for full code

Creates a Company.

Note

The Companies you create each have their own Accounts and payment settings.

HTTP Request

POST https://api.retreaver.com/companies.json?api_key=[api_key]

Content-Type: application/json

{"company":{"name":"CallPixels.com"}}

Parameters

Swipe horizontally to view full table

Parameter	Type	Required	Description
name	string	required	The company name.
default_click_url	string		The default click URL to set as a Timer @ 0 seconds when creating a campaign.
default_sale_url	string		The default sale URL to set as a Timer @ 90 seconds when creating a campaign.

Update a Company - DEPRECATED

Warning

This route is no longer supported. Please use the updated route for all future requests.

curl -s \
    -X PUT \
    https://api.retreaver.com/companies/2.json \
    -H "Content-Type: application/json" \
    -d '{"company":{"name":"Retreaver"}}'

Swipe horizontally for full code

The above command returns JSON structured like this:

{
  "company": {
    "id": 2,
    "name": "Retreaver",
    "default_click_url": "http://callpixels.com/?a=[affiliate_id]&c=[campaign_id]&cp=js&s1=[sub_id]",
    "default_sale_url": "http://callpixels.com/p.ashx?o=[campaign_id]&t=[call_log_id]-[caller_id]-[called_number]-[call_duration]-[call_recording_url]",
    "created_at": "2012-04-15T05:44:10Z",
    "updated_at": "2012-05-07T15:32:44Z"
  }
}

Swipe horizontally for full code

Updates the given Company with any attributes you have passed in.

Note

You must replace 2 with the Retreaver ID of the Company you want to update.

HTTP Request

PUT https://api.retreaver.com/companies/2.json?api_key=[api_key]

Content-Type: application/json

{"company":{"name":"Retreaver"}}