Get do not contact (dnc)

v1.0.0

Get Do Not Contact (DNC) object create by user. This DoNotContact entry only affects calls/texts/campaigns on this account.

Input

{
  "type": "object",
  "properties": {
    "number": {
      "type": "string"
    }
  },
  "required": [
    "number"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Represents an opted out contact",
  "properties": {
    "call": {
      "type": "boolean",
      "description": "A number on Do-Not-Call list"
    },
    "campaignId": {
      "type": "integer",
      "format": "int64",
      "description": "An Id of a campaign which was used to send a message to DNC number"
    },
    "created": {
      "type": "integer",
      "format": "int64",
      "description": "A time when a given resource was created, formatted in unix time milliseconds (read only). Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"
    },
    "inboundCall": {
      "type": "boolean",
      "description": "~"
    },
    "inboundText": {
      "type": "boolean",
      "description": "~"
    },
    "number": {
      "type": "string",
      "description": "A single DNC number in E.164 format (11-digit). Example: 12132000384"
    },
    "source": {
      "type": "string",
      "description": "The name of DNC source (can be the name of DNC list that user uploads to CallFire)"
    },
    "text": {
      "type": "boolean",
      "description": "A number on Do-Not-Text list"
    }
  }
}