McDewey

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

Page 543

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

PUT https://<server>/vmrest/handlers/callhandlers/<callhandlerobjectid>/menuentries/<key> <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <MenuEntry> <Action>7</Action> <TransferNumber>number to transfer to</TransferNumber> </MenuEntry> 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. Note that including a TransferNumber is optional; if you choose not to include a TransferNumber, users can configure their own alternate contact numbers by phone (by providing a number to transfers caller to). Currently, the CUPI API does not allow you to set the TransferNumber to an empty string. Therefore, if you set the TransferNumber, you can change it later to a different number, but you cannot leave it empty. In addition, the CUPI API does not allow read or write access to which type of transfer the alternate contact number uses (release transfer vs. supervised transfer). 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. Transfer to an Interview Handler To transfer a caller to an interview 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>PHInterview</TargetConversation> <TargetHandlerObjectId>interview handler object id</TargetHandlerObjectId> </MenuEntry> The TargetConversation should be set to PHInterview. The TargetHandlerObjectId is the object ID of the interview handler that you want to the caller input key to go to. Transfer to a Directory Handler To transfer a caller to a directory handler, do the following PUT request: Cisco Unity Connection Provisioning Interface (CUPI) API 511 Cisco Unity Connection Provisioning Interface (CUPI) API -- Call Handler Settings Transfer to a User or a Call Handler