DNCs

Create DNC

Add a phone number to your Do Not Call (DNC) list.

When to use. Block a single number from being dialed. To approve or unapprove many numbers at once, or to create several in one call, use POST /dnc/mass.

Request body.

  • phone (string, required): the phone number to add.
  • approved (integer, required): approval status, 0 for unapproved or 1 for approved.
  • country_iso (string): the two-letter country code (for example US) used to normalize the number.
  • permanent (integer): whether the entry is permanent, 0 for no or 1 for yes. Defaults to 0 when omitted.

Returns. { "dnc": [ <entry> ] } with the created entry, and HTTP 201. Returns an error if an entry with the same phone number already exists.

Example. { "phone": "12125551234", "country_iso": "US", "approved": 1, "permanent": 0 }

post/{sub_domain}/api/dnc

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

phonestring required

Phone number to add to the DNC list.

country_isostring required

Country ISO2 code, used to normalize the phone number.

approvedinteger nullable

Whether the DNC is approved: 0 = unapproved, 1 = approved.

permanentinteger nullable

Whether the DNC is permanent: 0 = no, 1 = yes. Defaults to 0 when omitted.

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.