DNCs

Get DNC by phone

Retrieve a Do Not Call (DNC) entry by phone number.

When to use. Check whether a specific number is on your DNC list when you do not have its ID. To look up by ID instead, use GET /dnc/{id}.

Parameters. phone (path): the phone number to look up. country_iso (path): the two-letter country code (ISO 3166-1 alpha-2, for example US) used to normalize the number before matching.

Returns. { "dnc": [ <entry> ] }. Returns an error if no matching entry is found.

Example. GET /api/dnc/phone/12125551234/US

get/{sub_domain}/api/dnc/phone/{phone}/{country_iso}

Request

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

Path parameters

phonestring required

Phone number.

country_isostring required

Country ISO2 code, used to normalize the phone number.

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.