Update an AI Receptionist Personality

Updates the personality configuration of an AI receptionist, including the language, voice, greeting, and system prompt.

Request URL

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

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
language	No	String	The language code. You can obtain the value using the Query Languages interface.
voiceId	No	String	The ID of the voice. You can obtain the value using the Query Voices interface.
accentId	No	String	The ID of the accent. You can obtain the value using the Query Accents interface.
additionalLanguages	No	Array<Additional_Language>	The list of additional languages. null does not update the list, and an empty list clears it.
greeting	No	String	The greeting, which must not be blank and has a maximum length of 500 bytes.
greetingInterruptible	No	Boolean	Whether the greeting can be interrupted by the user.
systemPrompt	No	String	The system prompt, with a maximum length of 40000 bytes.
useDefaultPrompt	No	Boolean	Whether to use the default prompt. When this parameter is false, systemPrompt must not be empty (validated when enabling).
companyName	No	String	The company name, with a maximum length of 127 bytes.
companyDescription	No	String	The company description, with a maximum length of 1024 bytes.
llmModel	No	String	The identifier of the LLM model.
llmTemperature	No	Number	The temperature parameter of the LLM (sampling randomness).
llmMaxTokens	No	Integer	The maximum number of tokens in a single LLM response.

Additional_Language


Parameter	Required	Type	Description
language	Yes	String	The language code, with a maximum length of 16 bytes. You can obtain the value using the Query Languages interface.
voiceId	No	Integer	The ID of the voice used for this language. An empty value follows the primary voice of the receptionist.
voiceName	No	String	The name of the voice. This is a response field filled by the server and ignored in requests.
avatarUrl	No	String	The URL of the voice avatar. This is a response field filled by the server and ignored in requests.

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<Receptionist>	The AI receptionist after the personality update.

Receptionist


Parameter	Type	Description
id	String	The ID of the AI receptionist.
name	String	The name of the AI receptionist.
profile	String	The profile of the AI receptionist.
extension	String	The extension number of the AI receptionist.
didIds	Array<String>	The list of associated DID IDs.
status	String	The status of the AI receptionist: `ACTIVE`: The AI receptionist is enabled. `DISABLED`: The AI receptionist is disabled.
avatarUrl	String	The URL of the avatar.
language	String	The language code.
voiceId	String	The ID of the voice.
accentId	String	The ID of the accent.
additionalLanguages	Array<Additional_Language>	The list of additional languages.
greeting	String	The greeting.
greetingInterruptible	Boolean	Whether the greeting can be interrupted by the user.
useDefaultPrompt	Boolean	Whether the default prompt is used.
transferEnabled	Boolean	Whether the transfer feature is enabled.
useDefaultTransferPrompt	Boolean	Whether the default transfer prompt is used.
transferByNameEnabled	Boolean	Whether the transfer-by-name feature is enabled.
keytermPromptingEnabled	Boolean	Whether the ASR keyterm prompting is enabled.
failoverDestination	Object	The failover destination.
llmModel	String	The identifier of the LLM model.
llmTemperature	Number	The temperature parameter of the LLM.
llmMaxTokens	Integer	The maximum number of tokens in a single LLM response.
ciEnabled	Boolean	Whether conversation intelligence is enabled.
createTime	String	The creation time, in Unix timestamp format (milliseconds).
updateTime	String	The last update time, in Unix timestamp format (milliseconds).

Example

Request example

PUT /uc-ai/api/v1/receptionists/2112784643788173314/personality 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
Content-Type: application/json
{
  "greeting": "Hello, how can I help you?",
  "greetingInterruptible": true,
  "companyName": "AIT Doc Test"
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "id": "2112784643788173314",
    "name": "aitdoc-recep",
    "profile": "ait-doc-updated",
    "extension": "62087",
    "didIds": [],
    "status": "DISABLED",
    "avatarUrl": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/novo-ai-voice/system/AI_VOICE_AVATAR/Arabella.png",
    "language": "en",
    "voiceId": "1000000000000000021",
    "accentId": "",
    "additionalLanguages": [],
    "greeting": "Hello, how can I help you?",
    "greetingInterruptible": true,
    "useDefaultPrompt": true,
    "companyName": "AIT Doc Test",
    "llmModel": "qwen36-35b-a3b",
    "llmTemperature": 0.18,
    "llmMaxTokens": -1,
    "transferEnabled": false,
    "transferByNameEnabled": false,
    "ciEnabled": false,
    "keytermPromptingEnabled": false,
    "useDefaultTransferPrompt": true,
    "failoverDestination": {
      "type": "HANG_UP"
    },
    "createTime": 1792562087396,
    "updateTime": 1792562087947
  },
  "requestId": "fcd0f81bd1e6ff159b3b03b602665fc1",
  "code": "200",
  "message": "SUCCESS"
}