DNCs

Get DNC

Retrieve a single Do Not Call (DNC) entry by its ID.

When to use. Drill down to the full detail of one DNC entry, for example from a list row. To search by phone number instead, use GET /dnc/phone/{phone}/{country_iso}.

Parameters. id (path): the ID of the DNC entry to look up. Returns an error if no entry with that ID exists.

Returns. { "dnc": [ <entry> ] }, a single-element array that matches the list endpoint's envelope.

get/{sub_domain}/api/dnc/{id}

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/dnc/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

DNC ID.

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

Example response

{
  "dnc": [
    {
      "approved": 255,
      "approved_by_user_id": 42751242,
      "campaign_lead_id": 17957443,
      "id": 86591947,
      "lead_id": 0,
      "permanent": 0,
      "phone": "397606698848"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.