Add an AI Receptionist

Request URL

POST {base_url}/uc-ai/api/v1/receptionists

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.

Body parameters

Parameter	Required	Type	Description
name	Yes	String	The name of the AI receptionist, with a maximum length of 127 bytes.
profile	No	String	The profile of the AI receptionist, with a maximum length of 500 bytes.
extension	Yes	String	The extension number of the AI receptionist.
didIds	No	Array<String>	The list of associated DID IDs. You can obtain the values from the DID list API of commctl.
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.
force	No	Boolean	The switch of forced DID replacement. The default value is false. When didIds conflicts with another direct destination of the same tenant, true deletes the old binding and creates a new one, and false returns a DID conflict (422 with failures).
warningDidIds	No	Array<String>	The whitelist of DID pre-authorized replacement, at the DID granularity. The default empty value means no permission.
failoverDestination	No	Object<Failover_Destination>	The failover destination.

Failover_Destination

Parameter	Required	Type	Description
type	Yes	String	The type of the destination, which supports six values.
targetId	No	String	The ID of the destination resource, which is carried only by USER, IVR, RING_GROUP, and QUEUE.
promptId	No	String	The ID of the prompt audio, which is carried only by PLAY_PROMPT_HANG_UP.
playTimes	No	Integer	The number of times the prompt audio plays, from 1 to 5. This parameter is carried only by PLAY_PROMPT_HANG_UP.

Response parameters

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).

Additional_Language

Parameter	Type	Description
language	String	The language code, up to 16 bytes in length. You can obtain the value using the Query Languages interface.
voiceId	String	The ID of the voice used for this language. You can obtain the value using the Query Voices interface. If omitted, the default voice of the AI receptionist is used.
voiceName	String	The name of the voice. This parameter is returned in responses only and is populated by the server.
avatarUrl	String	The avatar URL of the voice. This parameter is returned in responses only and is populated by the server.

Example

Request example

POST /uc-ai/api/v1/receptionists 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
{
  "name": "aitdoc-recep",
  "extension": "62087"
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "id": "2112784643788173314",
    "name": "aitdoc-recep",
    "extension": "62087",
    "didIds": [],
    "language": "en",
    "voiceId": "1000000000000000021",
    "accentId": "",
    "additionalLanguages": [],
    "avatarUrl": "https://novo-one-tst-self-operated-business.s3.ap-east-1.amazonaws.com/public/novo-ai-voice/system/AI_VOICE_AVATAR/Arabella.png",
    "status": "DISABLED",
    "createTime": 1792562087396
  },
  "requestId": "705967be8c5e75fe97691170b29d68ef",
  "code": "200",
  "message": "SUCCESS"
}