CreatePhoneBookEntry

POST

https://api.cbf.tcn.com/api/v1alpha1/p3api/createphonebookentry

Creates a new phone_book as defined by the request message.
Required Permissions:
AGENT_MANAGER
Errors:

grpc.InvalidArgument: the fields on the request are missing or invalid.

grpc.Internal: unexpected error occurred when saving the phone book.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

CreatePhoneBookEntryReq

optional

Request message for the CreatePhoneBookEntry RPC

One of

sip_uri

standard

entry_name

string

entry_name

optional

The entry name

phone_number_hidden

boolean

phone_number_hidden

optional

Whether the phone number is displayed to the agent or not. The entry name will always be displayed.

hunt_group_sid

integer <int64> | string

hunt_group_sid

optional

Entry type will be 'Hunt Group' if this field is set.
Otherwise the entry type will be 'Client'.

sip_uri

object

PhoneBookSIPURI

required

A SIP URI

Example

{
    "sip_uri": {
        "sip_uri_left": "string",
        "sip_uri_right": "string",
        "sip_types": [
            "PHONE_BOOK_SIP_TYPE_OUTBOUND"
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/p3api/createphonebookentry' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sip_uri": {
        "sip_uri_left": "string",
        "sip_uri_right": "string",
        "sip_types": [
            "PHONE_BOOK_SIP_TYPE_OUTBOUND"
        ]
    }
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-07-10 17:42:28

ListHuntGroupPhoneBookEntries

UpdatePhoneBookEntry