Config API Version 2 IGRP Caller Blocks

Introduction

Caller blocks can be used to block incoming calls at IGRP level from specific source numbers

List caller blocks

Returns a list of IGRP caller blocks.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callerBlocks

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

filter (array) OPTIONAL - One or more filters, see Filter Types.
sort (array) OPTIONAL - One or more sorting params, see Sort Types.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

Filter Types

callerBlockId (int) - Caller block ID.
srcPhoneNumber (int) - Caller phone number that is blocked.
createDatetime (date) - Create date/time of caller block.
updateDatetime (date) - Update date/time of caller block.

Sort Types

callerBlockId (int) - Caller block ID.
srcPhoneNumber (int) - Caller phone number that is blocked.
createDatetime (date) - Create date/time of caller block.
updateDatetime (date) - Update date/time of caller block.

Response:

Returns a list of IGRP caller blocks under the given {IGRP SPECIFIER}.

callerBlockId (int) - The caller block ID.
igrp (int) - Installation ID.
srcPhoneNumber (string) - The source phone number.
createDatetime (date) - The date this caller block was added
updateDatetime (date) - The date this caller block was last updated

{"callerBlockId":"1","igrp":"1","srcPhoneNumber":"+441234567890","createDatetime":"0000-00-00 00:00:00","updateDatetime":"0000-00-00 00:00:00"}
{"callerBlockId":"2","igrp":"1","srcPhoneNumber":"+441234567890","createDatetime":"0000-00-00 00:00:00","updateDatetime":"0000-00-00 00:00:00"}

Read IGRP caller block

Returns an IGRP caller block.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/callerBlocks/{callerBlockId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callerBlockId (int) - The caller block ID

Response:

callerBlockId (int) - The caller block ID.
igrp (int) - Installation ID.
srcPhoneNumber (string) - The source phone number.
createDatetime (date) - The date this caller block was added
updateDatetime (date) - The date this caller block was last updated

{"callerBlockId":"1","igrp":"1","srcPhoneNumber":"+441234567890","createDatetime":"0000-00-00 00:00:00","updateDatetime":"0000-00-00 00:00:00"}

Create IGRP caller block

Creates an IGRP caller block.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callerBlocks

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

POST Params

srcPhoneNumber (string) - The source phone number to block

Response:

HTTP 201 - CREATED

Update IGRP caller block

Updates an IGRP caller block.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/callerBlocks/{callerBlockId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callerBlockId (int) - The caller block ID

POST Params

srcPhoneNumber (string) - The source phone number to block

Response:

HTTP 204 - NO CONTENT

Delete IGRP caller block

Deletes an IGRP caller block.

Request:

DELETE /config/v2/igrps/{IGRP SPECIFIER}/callerBlocks/{callerBlockId}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
callerBlockId (int) - The caller block ID

Response:

HTTP 204 - NO CONTENT