Skip to content
outboundIQ

NRM API

Authentication

Section titled “Authentication”

All API requests must include a Bearer token in the Authorization header:

Authorization: Bearer YOUR_API_KEY_HERE

If the key is missing, invalid, or of the wrong type, the server will return a 401 Unauthorized or 403 Forbidden response.

Base URL

Section titled “Base URL”
https://api.outboundiq.cloud/nrm

Endpoints

Section titled “Endpoints”

List ANIs

Section titled “List ANIs”

Returns a paginated list of ANIs with 30-day performance statistics.

  • Method: GET
  • URL: /anis
  • Headers:
    • Authorization: Bearer YOUR_API_KEY_HERE
    • Content-Type: application/json
  • Query:
    • page=1 — page number (default 1)
    • page_size=1000 — results per page (default 1000, max 1000)
    • number=234 — optional; filter by phone-number prefix (non-digits are stripped)

Success Response:

{
  "result": "success",
  "count": 1,
  "total_anis": 500,
  "can_next_page": true,
  "can_prev_page": false,
  "total_pages": 1,
  "data": [
    {
      "id": 12345,
      "phone": "2345678901",
      "brand": "Acme",
      "status": "ACTIVE_AND_BEING_MANAGED",
      "statusLabel": "Active and Being Managed",
      "campaignName": "Campaign Name",
      "areaCode": "234",
      "region": "Region",
      "state": "ST",
      "locality": "City",
      "frequencyAssigned": 3,
      "frequencyDialed": 120,
      "frequencyContacted": 45,
      "dateLastDialed": "2026-05-27",
      "dateActivated": "2025-01-15",
      "dateDeactivated": null,
      "dateInventoried": "2025-01-15",
      "createdAt": "2025-01-15T00:00:00.000Z",
      "last30DaysDials": 1250,
      "last30DaysContacts": 450,
      "contactRate": 36.0,
      "successRate": 62.22,
      "blockRate": 8.0,
      "noAnswerRate": 56.0
    }
  ]
}

Example

Section titled “Example”
Terminal window
curl -X GET \
  'https://api.outboundiq.cloud/nrm/anis?page=1&page_size=100' \
  -H 'Authorization: Bearer YOUR_API_KEY_HERE'

Remediate ANI

Section titled “Remediate ANI”

Submits a request for a specific ANI to be remediated.

  • Method: POST
  • URL: /remediate
  • Headers:
    • Authorization: Bearer YOUR_API_KEY_HERE
    • Content-Type: application/json

Body Schema:

type Payload = {
  ani: string; // required
  carrier?: string; // optional; 6-digit carrier ID
  note?: string; // optional
};

Body Example:

{
  "ani": "1234567890",
  "carrier": "130077",
  "note": "Spam tag identified"
}

Success Response:

{
  "status": "received request",
  "ani": "1234567890"
}

Failure Response:

{
  "success": false,
  "message": "ANI not found in inventory"
}

Example

Section titled “Example”
Terminal window
curl -X POST \
  https://api.outboundiq.cloud/nrm/remediate \
  -H 'Authorization: Bearer YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{ "ani": "1234567890", "carrier": "130077", "note": "Spam tag identified" }'

Pause ANI

Section titled “Pause ANI”

Pauses an ANI by placing it in a cooling off period. Only ANIs that are active and being managed can be paused.

  • Method: POST
  • URL: /pause
  • Headers:
    • Authorization: Bearer YOUR_API_KEY_HERE
    • Content-Type: application/json

Body Schema:

type Payload = {
  ani: string; // required
  carrier?: string; // optional; 6-digit carrier ID
  note?: string; // optional
  date?: string; // optional
};

Body Example:

{
  "ani": "1234567890",
  "carrier": "130077"
}

Success Response:

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

Failure Response:

{
  "success": false,
  "message": "Only active and managed ANIs can be paused"
}

Example

Section titled “Example”
Terminal window
curl -X POST \
  https://api.outboundiq.cloud/nrm/pause \
  -H 'Authorization: Bearer YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{ "ani": "1234567890", "carrier": "130077" }'

Activate ANI

Section titled “Activate ANI”

Activates an ANI, returning it to active dialing status. Only ANIs currently in a cooling off period can be activated.

  • Method: POST
  • URL: /activate
  • Headers:
    • Authorization: Bearer YOUR_API_KEY_HERE
    • Content-Type: application/json

Body Schema:

type Payload = {
  ani: string; // required
  date: string; // required
  carrier?: string; // optional; 6-digit carrier ID
  note?: string; // optional
};

Body Example:

{
  "ani": "1234567890",
  "carrier": "130077",
  "date": "20250126120000"
}

Success Response:

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

Failure Response:

{
  "success": false,
  "message": "Only ANIs in cooling off status can be activated"
}

Example

Section titled “Example”
Terminal window
curl -X POST \
  https://api.outboundiq.cloud/nrm/activate \
  -H 'Authorization: Bearer YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{ "ani": "1234567890", "carrier": "130077", "date": "20250126120000" }'