Skip to navigation
Management APIReferenceCallerIDs

GetCallerIDs

View as Markdown

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 objectsOptional
total_countintegerOptional
The total found record count
countintegerOptional
The returned record count