GetCallerIDs | Voximplant Voice AI

Gets the account callerIDs.

Allowed roles: Owner, Admin.

Example request: Get the two callerIDs.

Gets the account callerIDs.

Allowed roles: Owner, Admin.

Example request: Get the two callerIDs.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

callerid_idintegerOptional

ID of the callerID object to filter

callerid_numberstringOptional

The phone number to filter

activebooleanOptional

Whether the account is active to filter

order_bystringOptional

The following values are available: ‘caller_number’ (ascent order), ‘verified_until’ (ascent order)

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

Response

Successful response

resultlist of objects

total_countinteger

The total found record count

countinteger

The returned record count

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

ID of the callerID object to filter

The phone number to filter

Whether the account is active to filter

The following values are available: ‘caller_number’ (ascent order), ‘verified_until’ (ascent order)

The max returning record count

The first N records are skipped in the output

The total found record count

The returned record count

1	{
2	"result": [
3	{
4	"callerid_id": 9,
5	"callerid_number": "74959998877",
6	"active": false,
7	"code_entering_attempts_left": 10,
8	"verification_call_attempts_left": 5
9	},
10	{
11	"callerid_id": 11,
12	"callerid_number": "74951112233",
13	"active": true,
14	"verified_until": "2014-01-14"
15	}
16	],
17	"total_count": 4,
18	"count": 2
19	}

1	{
2	"result": [
3	{
4	"callerid_id": 9,
5	"callerid_number": "74959998877",
6	"active": false,
7	"code_entering_attempts_left": 10,
8	"verification_call_attempts_left": 5
9	},
10	{
11	"callerid_id": 11,
12	"callerid_number": "74951112233",
13	"active": true,
14	"verified_until": "2014-01-14"
15	}
16	],
17	"total_count": 4,
18	"count": 2
19	}

$	curl -X POST https://api.voximplant.com/platform_api/GetCallerIDs \
>	-H "Authorization: Bearer <token>"