ListPhoneBooks

POST

https://api.cbf.tcn.com/api/v0alpha/p3api/listphonebooks

Lists caller_id, outbound and transfer phone books for the requesting client and given hunt group sid.
Entries will be ordered by entry_name and phone_number.

Required permissions:
NONE
Errors:

grpc.Invalid: the client_sid or hunt_group_sid in the request are invalid.

grpc.Internal: unexpected error occurred when retrieving the phone books.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "hunt_group_sid": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/p3api/listphonebooks' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "hunt_group_sid": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "caller_id_phone_books": [
        {
            "entry_type": "string",
            "entry_name": "string",
            "hunt_group_sid": "string",
            "phone_number": "string",
            "phone_number_type": "string",
            "phone_number_hidden": true
        }
    ],
    "outbound_phone_books": [
        {
            "entry_type": "string",
            "entry_name": "string",
            "hunt_group_sid": "string",
            "phone_number": "string",
            "phone_number_type": "string",
            "phone_number_hidden": true
        }
    ],
    "transfer_phone_books": [
        {
            "entry_type": "string",
            "entry_name": "string",
            "hunt_group_sid": "string",
            "phone_number": "string",
            "phone_number_type": "string",
            "phone_number_hidden": true
        }
    ]
}

🟢200Success

Modified at 2025-09-26 15:44:58

DeletePhoneBookEntry

ListAgentTriggers