Update Transfer Configuration

Request URL

PUT {base_url}/uc-ai/api/v1/receptionists/{id}/transfer

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.

Body parameters

Parameter	Required	Type	Description
transferEnabled	No	Boolean	Whether to enable the transfer feature. A null value does not update this field.
transferPrompt	No	String	The transfer prompt, with a maximum length of 10000 bytes. A null value does not update this field.
useDefaultTransferPrompt	No	Boolean	Whether to use the default transfer prompt. A null value does not update this field.
rules	No	Array<Transfer_Rule>	The list of transfer rules, with a maximum of 20 rules. A null value does not update the rules, and a non-null value replaces the whole list (delete first, then insert).

Transfer_Rule

Parameter	Required	Type	Description
id	No	String	The ID of the rule, which is returned in responses and serialized as a string to avoid precision loss. This parameter is optional in update requests.
destinationType	Yes	String	The type of the transfer destination: Valid value: USER: A user. IVR: An IVR. RING_GROUP: A ring group. QUEUE: A queue. GROUP_VOICEMAIL: A group voicemail.
destination	Yes	String	The transfer destination, with a maximum length of 127 bytes. It is the target identifier (extension number, queue number, IVR number, and so on) used to generate the SIP URI.
condition	No	String	The natural language description of the transfer trigger condition, with a maximum length of 1000 bytes. The AI uses it to determine when to execute this transfer rule.

Response parameters

Transfer_Config

Parameter	Type	Description
transferEnabled	Boolean	Whether the transfer feature is enabled.
useDefaultTransferPrompt	Boolean	Whether the default transfer prompt is used.
rules	Array<Transfer_Rule>	The list of transfer rules.
updateTime	String	The last update time, in Unix timestamp format (milliseconds).

Transfer_Rule

Parameter	Required	Type	Description
id	No	String	The ID of the rule, which is returned in responses and serialized as a string to avoid precision loss. This parameter is optional in update requests.
destinationType	Yes	String	The type of the transfer destination: USER: A user. IVR: An IVR. RING_GROUP: A ring group. QUEUE: A queue. GROUP_VOICEMAIL: A group voicemail.
destination	Yes	String	The transfer destination, with a maximum length of 127 bytes. It is the target identifier (extension number, queue number, IVR number, and so on) used to generate the SIP URI.
condition	No	String	The natural language description of the transfer trigger condition, with a maximum length of 1000 bytes. The AI uses it to determine when to execute this transfer rule.

Example

Request example

PUT /uc-ai/api/v1/receptionists/2112785010760413186/transfer 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 500 Internal Server Error
{
  "requestId": "8695f86b5e2bcf34e24a4738c7bc984c",
  "code": "1300503001",
  "message": "SIP URI generation failed: extension not found for USER:1000"
}