Skip to content
outboundIQ

NRM API

Authentication

Section titled “Authentication”

All API requests must include an API key in the header:

X-ApiKey: YOUR_API_KEY_HERE

If the key is missing or invalid, the server will return a 401 Unauthorized response.

Base URL

Section titled “Base URL”
https://app.outboundani.com/nrm

Endpoints

Section titled “Endpoints”

Pause ANI

Section titled “Pause ANI”

Temporarily disables a specific ANI across all connected dialers.

  • Method: POST
  • URL: /pause
  • Headers:
    • X-ApiKey: YOUR_API_KEY_HERE
    • Content-Type: application/json

Body Schema:

type Payload = {
  country: string;
  ani: string;
  carrier: string;
  note: string;
  date: string;
};

Body Example:

{
  "country": "+1",
  "ani": "1234567890",
  "carrier": "130077",
  "note": "Spam tag identified",
  "date": "yyyyMMddhhmmss"
}

Success Response:

{
  "status": "paused",
  "ani": "1234567890"
}

Example

Section titled “Example”
Terminal window
curl -X POST \
  https://app.outboundani.com/nrm/pause \
  -H 'X-ApiKey: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{ "country": "+1", "ani": "1234567890", "carrier": "130077", "note": "Spam tag identified", "date": "yyyyMMddhhmmss" }'

Activate ANI

Section titled “Activate ANI”

Reactivates a previously paused ANI and makes it available again across dialers.

  • Method: POST
  • URL: /activate
  • Headers:
    • X-ApiKey: YOUR_API_KEY_HERE
    • Content-Type: application/json

Body Schema:

type Payload = {
  country: string;
  ani: string;
  carrier: string;
  date: string;
};

Body Example:

{
  "country": "+1",
  "ani": "1234567890",
  "carrier": "130077",
  "date": "yyyyMMddhhmmss"
}

Success Response:

{
  "status": "active",
  "ani": "1234567890"
}

Example

Section titled “Example”
Terminal window
curl -X POST \
  https://app.outboundani.com/nrm/activate \
  -H 'X-ApiKey: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{ "country": "+1", "ani": "1234567890", "carrier": "130077", "date": "yyyyMMddhhmmss" }'

Get ANIs

Section titled “Get ANIs”

Returns inventory metadata.

  • Method: GET
  • URL: /anis
  • Headers:
    • X-ApiKey: YOUR_API_KEY_HERE
    • Accept: application/json
  • Query:
    • page=1
    • page_size=500

Success Response:

{
  "result": "success",
  // number of anis in response
  "count": 500,
  // total number of anis in inventory
  "total_anis": 1324,
  // indicates whether or not there is a next page
  "can_next_page": true,
  // indicates whether or not there is a previous page
  "can_prev_page": false,
  // total number of possible pages
  "total_pages": 3,
  // list of anis with enriched data
  "data": [
    {
      "inbound_campaign": "General Inbound",
      "added_to_inventory_date": "2023-09-05T19:06:12.8733333",
      "status": "Active and Being Managed",
      "phone": "2012411632",
      "areacode": "201",
      "locality": "Bergen",
      "state": "NJ",
      "dials_today": 0,
      "contacts_day": 0,
      "contact_rate_day": 0,
      "success_rate_day": 0,
      "block_rate_day": 0,
      "noanswer_rate_day": 0,
      "dials_last30": 0,
      "contacts_last30": 0,
      "contact_rate_last30": 0,
      "success_rate_last30": 0,
      "block_rate_last30": 0,
      "noanswer_rate_last30": 0,
    },
  ],
}

Example

Section titled “Example”
Terminal window
curl -X GET \
  'https://app.outboundani.com/nrm/anis?page=1&page_size=500' \
  -H 'X-ApiKey: YOUR_API_KEY_HERE' \
  -H 'Accept: application/json'