Methods

Objects

sendr/10/blacklist

Blacklist Sendr Service (v1.0). Create and manage SENDR blacklists.

Method Description
sendr/10/blacklist.append_file_async Append blacklist content from a temporary file
sendr/10/blacklist.create Create a new blacklist
sendr/10/blacklist.delete Delete blacklist
sendr/10/blacklist.delete_content Delete blacklist content
sendr/10/blacklist.edit Edit blacklist name
sendr/10/blacklist.export_async Export blacklist as file
sendr/10/blacklist.get Get blacklist
sendr/10/blacklist.search Search blacklists
sendr/10/blacklist.search_content Search blacklist content

Methods

sendr/10/blacklist.append_file_async

Description

Append blacklist content from a temporary file

Signature

method: sendr/10/blacklist.append_file_async

params: [string hash, string tmp_file, string calling_country_code, object webhook]

Parameters

Parameter Type Description NULL
hash string Black list id
Format: hash (Unique object identifier)
NO
tmp_file string Temporary filename generated by media.import_file_from_url_async or media.import_file_from_base64_async NO
calling_country_code string ISO 3166-1 two-letter country code corresponding to the country of the phone numbers in the blacklist. NO
webhook object Dynamic webhook for this method. Status updates (e.g. when the import is done) will be sent to this specific webhook. You only need to set 'endpoint' and optionally 'options'.
Object: Webhook
YES

Result

Type Description Format/Object
string Job ID Format: hid (Unique object identifier)

See Also

sendr/10/blacklist.create

Description

Create a new blacklist

Signature

method: sendr/10/blacklist.create

params: [string name]

Parameters

Parameter Type Description NULL
name string Name NO

Result

Type Description Format/Object
object Black list object Object: Sendr.10.Blacklist

sendr/10/blacklist.delete

Description

Delete blacklist

Signature

method: sendr/10/blacklist.delete

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Black list id
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
bool True

sendr/10/blacklist.delete_content

Description

Delete blacklist content

Signature

method: sendr/10/blacklist.delete_content

params: [string hash, array ids]

Parameters

Parameter Type Description NULL
hash string Black list id
Format: hash (Unique object identifier)
NO
ids array Array of items ids NO

Result

Type Description Format/Object
int Numbers of lines deleted

sendr/10/blacklist.edit

Description

Edit blacklist name

Signature

method: sendr/10/blacklist.edit

params: [string hash, string name]

Parameters

Parameter Type Description NULL
hash string Black list ID
Format: hash (Unique object identifier)
NO
name string Black list name NO

Result

Type Description Format/Object
object Black list Object: Sendr.10.Blacklist

sendr/10/blacklist.export_async

Description

Export blacklist as file

Signature

method: sendr/10/blacklist.export_async

params: [string hash, string format, object webhook]

Parameters

Parameter Type Description NULL
hash string Black list id
Format: hash (Unique object identifier)
NO
format string Format of the file. For now can only be CSV_UTF8. NO
webhook object Dynamic webhook for this export. Status updates (e.g. when the export is available) will be sent to this specific webhook. You only need to set 'endpoint' and optionally 'options'.
Object: Webhook
YES

Result

Type Description Format/Object
string Job ID Format: hid (Unique object identifier)

sendr/10/blacklist.get

Description

Get blacklist

Signature

method: sendr/10/blacklist.get

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Black list ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
object Black list Object: Sendr.10.Blacklist

sendr/10/blacklist.search

Description

Search blacklists

Signature

method: sendr/10/blacklist.search

params: [object filters, object options]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: Sendr.10.Blacklist.SearchFilters
NO
options object Search options
Object: Search.Options
NO

Result

Type Description Format/Object
object Results Object: Search.Results

sendr/10/blacklist.search_content

Description

Search blacklist content

Signature

method: sendr/10/blacklist.search_content

params: [string hash, object filters, object options]

Parameters

Parameter Type Description NULL
hash string Black list id
Format: hash (Unique object identifier)
NO
filters object Search filters
Object: Sendr.10.Blacklist.SearchFilters
NO
options object Search options
Object: Search.Options
NO

Result

Type Description Format/Object
object Results Object: Search.Results