Static Caller Numbers API

Static Caller Numbers are used to tell Retreaver that calls from a certain CallerID should be handled separately. Use Static Caller Numbers when you have a call center sending you many calls with the same CallerID. Retreaver will either prompt the caller for the caller’s real number, or will randomize the CallerID for use with our call control API.

Get all Static Caller Numbers

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

Swipe horizontally for full code

The above command returns JSON structured like this:

[
  {
    "static_caller_number": {
      "id": 1234,
      "number": "+18668987878",
      "created_at": "2013-10-02T14:36:14.166-04:00"
    }
  }
]

Swipe horizontally for full code

Provides a complete list of Static Numbers.

HTTP Request

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

Create a Static Caller Number

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

Swipe horizontally for full code

Creates a Static Caller Number.

HTTP Request

POST https://api.retreaver.com/static_caller_numbers.json?api_key=[api_key]&company_id=1

Content-Type: application/json

{"static_caller_number": {"number": "+18668987878"}}

Parameters

Swipe horizontally to view full table

Parameter	Type	Default	Required	Description
number	string	null	required	A phone number preferably in E.164 format, but NANP format is also accepted

Delete a Static Caller Number

curl -X DELETE https://api.retreaver.com/static_caller_numbers/1234.json?api_key=[api_key]&company_id=1

Swipe horizontally for full code

Removes the Static Caller Number.

HTTP Request

DELETE https://api.retreaver.com/static_caller_numbers/1234.json?api_key=[api_key]&company_id=1