McDewey

Multi-vendor documentation library · semantic search · MCP endpoint at /mcp

Page 549

↗ View in doc context
page
549
source
unity-connection/rest-api/cupi/cupi.md
chunk_id
unity-connection::rest-api::cupi::cupi::515

The Action field of 7 denotes that this key should transfer the caller to an alternate contact number. The TransferNumber is the number that the caller will be release-transferred to. Including a transfer number is optional; if you do not include a TransferNumber, and set a key to the Action of 7, users will have the option of configuring their own ACNs by phone, which provides a number to transfer callers to. The API currently does not let you set the TransferNumber to an empty string. That means that when you have set the TransferNumber, you can only change it to a different number, but cannot empty it out. The API also currently does not give you read or write access to the type of transfer the ACN uses (release vs. supervised). Transfer to a User or a Call Handler To transfer a caller to a user or a call handler, do the following PUT request: PUT https://<server>/vmrest/handlers/callhandlers/<callhandlerobjectid>/menuentries/<key> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MenuEntry> <Action>2</Action> <TargetConversation>PHTransfer</TargetConversation> <TargetHandlerObjectId>05d9e169-5c87-4415-aaed-c58a14816c8d</TargetHandlerObjectId> </MenuEntry> The Action field of 2 denotes that this key should transfer the caller to another conversation. This is used to transfer callers to other objects, or to send callers to other conversations such as the system transfer conversation. The TargetConversation should be set to PHTransfer if you want to transfer to the call handler in question. If you want to have the call go directly the call handler greeting, set it to PHGreeting instead. The TargetHandlerObjectId is the object ID of the call handler that you want the key to transfer the caller to. Go to an Interview Handler PUT https://<server>/vmrest/handlers/callhandlers/<callhandlerobjectid>/menuentries/<key> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MenuEntry> <Action>2</Action> <TargetConversation>PHInterview</TargetConversation> <TargetHandlerObjectId>interview handler object id</TargetHandlerObjectId> </MenuEntry> The TargetConversation should be set to PHInterview and the TargetHandlerObjectId is the object ID of the interview handler that you want to the caller input key to go to. Go to a Directory Handler PUT https://<server>/vmrest/handlers/callhandlers/<callhandlerobjectid>/menuentries/<key> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MenuEntry> <Action>2</Action> <TargetConversation>AD</TargetConversation> <TargetHandlerObjectId>object id of directory handler</TargetHandlerObjectId> </MenuEntry> The TargetConversation should be set to AD and the TargetHandlerObjectId is the object ID of the directory handler you want to the caller input key to go to. Cisco Unity Connection Provisioning Interface (CUPI) API 517 Cisco Unity Connection Provisioning Interface (CUPI) API -- Call Handler Settings Transfer to a User or a Call Handler