Get Transfer by Name Configuration

Gets the transfer-by-name configuration of an AI receptionist.

Request URL

GET {base_url}/uc-ai/api/v1/receptionists/{id}/transfer-by-name

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the AI receptionist. You can obtain the ID using the Search AI Receptionists interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Transfer_By_Name_Config> The transfer-by-name configuration.
Transfer_By_Name_Config
Parameter Type Description
enabled Boolean Whether the transfer-by-name feature is enabled.
scope String

The scope of transfer by name:

  • ALL: All extensions.
  • SELECTED: The whitelist.
  • RESTRICTED: The blacklist.
destinations Array<Destination> The list of destination extensions.
keytermPromptingEnabled Boolean Whether the ASR keyterm prompting is enabled.
keyterms Array<String> The list of ASR keyterms.
updateTime String The last update time, in Unix timestamp format (milliseconds).
Destination
Parameter Type Description
name String The name of the destination extension, which is resolved by the platform in real time.
destinationId String The platform resource ID of the destination extension.
destinationNumber String The number of the destination extension.

Example

Request example

GET /uc-ai/api/v1/receptionists/{id}/transfer-by-name HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU4MzY1MSwiaWF0IjoxNzkyNTYyMDUxLCJqdGkiOiI5ODRiZjY0Mi00YWNlLTRiZWEtOTk3YS1lNmVhMjVjMTc3NDYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.G2oipgaRjD1M48lPlOjh51mu3Iad7TF4PjFqGpZV8qar5rOq362P0tnF1U8U1HtqHfaIBiyPBJHjt6HVIanxps31_WI9aVw6Uyq4uRL2G3trENCeU8Now78Buvv_frAhxW8KTLiCtT2cNYC3Usn0FCv5H-jMAS4JueCb96nu60usm8V6ytMk7O0i5Bs-cqMwEmQBL75oy4vW70HtCgZrsW0ZCChdi9l5l-OtfnEgLTC1ohfSw592heykBkhCKgFM5RtXW7NFMRWRgtI3E7hdMd-ETIL2TIC-SHL17kRkku6qAzDIMDHro5XkBgccKJkGF2GXHcGgL6-dLgi9SFjrDw
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "result": {
    "enabled": false,
    "scope": "ALL",
    "destinations": [],
    "keytermPromptingEnabled": false,
    "keyterms": [],
    "updateTime": 1792562087947
  },
  "requestId": "862ad0dd703b42822babf4dc3f276373",
  "code": "200",
  "message": "SUCCESS"
}