Compartilhar via


Do Not Call Reported Calls (Independent Publisher) (Preview)

The Do Not Call (DNC) Reported Calls Data API endpoint provides data every weekday about Do Not Call and robocall complaints reported to the Federal Trade Commission. This data consists of information reported by consumers, including the telephone number originating the unwanted call, the date the complaint was created, the time the call was made, the consumer's city and state locations reported, the subject of the call, and whether the call was a robocall. The reported calls is not verified.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Troy Taylor
URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Connector Metadata
Publisher Troy Taylor, Hitachi Solutions
Website https://www.ftc.gov/developer/api/v0/endpoints/do-not-call-dnc-reported-calls-data-api
Privacy policy https://www.ftc.gov/site-information/privacy-policy
Categories Data;Communication

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Get a single DNC complaint

Returns a single unverified complaint by ID.

List all DNC complaints

Returns a list of unverified complaints based on the filter parameters.

Get a single DNC complaint

Returns a single unverified complaint by ID.

Parameters

Name Key Required Type Description
ID
id True string

The unique identifier of the complaint.

Returns

Name Path Type Description
Data
data array of object
Type
data.type string

The record type, "dnc_complaint."

ID
data.id string

The record unique identifier.

Company Phone Number
data.attributes.company-phone-number string

The telephone number the unwanted call originated from.

Created Date
data.attributes.created-date string

The date/time the complaint was created. Timestamp format is ISO 8601. Example: 1997-07-16T19:20:30+01:00

Violation Date
data.attributes.violation-date string

The date/time the unwanted call was received. Timestamp format is ISO 8601.

Consumer City
data.attributes.consumer-city string

The city reported by the consumer who created the complaint.

Consumer State
data.attributes.consumer-state string
Consumer Area Code
data.attributes.consumer-area-code string

The area code of the consumer that created the complaint.

Subject
data.attributes.subject string

The subject of the unwanted call.

Recorded Message Or Robocall
data.attributes.recorded-message-or-robocall string

Indicates whether the unwanted call was a recorded message / robocall ("Y"), or not ("N").

Link
data.links.self string

A link that pertains to this record.

Records This Page
meta.records-this-page integer

The number of records included in this response.

Record Total
meta.record-total integer

The total number of records found for the request.

Link
links.self string

A link that pertains to this record.

List all DNC complaints

Returns a list of unverified complaints based on the filter parameters.

Parameters

Name Key Required Type Description
Created Date
created_date string

Filter records by a specific date that complaints were created during. For example, show all complaints created on February 26, 2020: 2020-02-26

Created Date From
created_date_from string

Filter records by a range of dates/times that complaints were created. These filters must be used together. Can be combined with any one these filters: State, Area Code or Is Robocall. When combined with the state filter, an optional city filter can be added.

Created Date To
created_date_to string

Filter records by a range of dates/times that complaints were created. These filters must be used together. Can be combined with any one these filters: State, Area Code or Is Robocall. When combined with the state filter, an optional city filter can be added.

Violation Date
violation_date string

Filter records by a specific date that unwanted calls were received during. For example, show all unwanted calls received on February 26, 2020: 2020-02-26

Violation Date From
violation_date_from string

Filter records by a range of dates/times that violations were created. These filters must be used together. Can be combined with any one these filters: State, Area Code or Is Robocall. When combined with the state filter, an optional city filter can be added.

Violation Date To
violation_date_to string

Filter records by a range of dates/times that violations were created. These filters must be used together. Can be combined with any one these filters: State, Area Code or Is Robocall. When combined with the state filter, an optional city filter can be added.

State
state string

Filter records by a state that complaints originated from. Can be combined with the city and Created Date From / Created Date To filters.

City
city string

Filter records by a city that complaints originated from. This filter must be used together with the state filter. Can be combined with the Created Date From / Created Date To filters.

Area Code
area_code integer

Filter records by the area code that complaints originated from. Can be combined with the Created Date From / Created Date To filters.

Is Robocall
is_robocall boolean

Filter by whether the unwanted call was a recorded message / robocall or not. Value must be either "true" or "false". Can be combined with the Created Date From / Created Date To filters.

Sort Order
sort_order string

Sort direction to use with the sort_by parameter.

Items per Page
items_per_page integer

Maximum number of records to include in response. By default, the endpoint displays a maximum of 50 records per request. This is also the maximum value allowed.

Offset
offset integer

Offset by a number of records, allowing a particular section of paginated results to be requested (use with the Items Per Page parameter).

Returns

Name Path Type Description
Data
data array of object
Type
data.type string

The record type, "dnc_complaint."

ID
data.id string

The record unique identifier.

Company Phone Number
data.attributes.company-phone-number string

The telephone number the unwanted call originated from.

Created Date
data.attributes.created-date string

The date/time the complaint was created. Timestamp format is ISO 8601. Example: 1997-07-16T19:20:30+01:00

Violation Date
data.attributes.violation-date string

The date/time the unwanted call was received. Timestamp format is ISO 8601.

Consumer City
data.attributes.consumer-city string

The city reported by the consumer who created the complaint.

Consumer State
data.attributes.consumer-state string
Consumer Area Code
data.attributes.consumer-area-code string

The area code of the consumer that created the complaint.

Subject
data.attributes.subject string

The subject of the unwanted call.

Recorded Message Or Robocall
data.attributes.recorded-message-or-robocall string

Indicates whether the unwanted call was a recorded message / robocall ("Y"), or not ("N").

Link
data.links.self string

A link that pertains to this record.

Records This Page
meta.records-this-page integer

The number of records included in this response.

Record Total
meta.record-total integer

The total number of records found for the request.

Link
links.self string

A link that pertains to this record.