How do I set Alternative Transfer Rules?

Version 1
    This document was generated from CDN thread

    Created by: Michael Fortuna on 19-08-2010 08:21:20 PM
    Hi team,
     
    I have a customer that will be using an AutoAttendant & they would like to offer the users the ability to transfer callers to their cell phone & provide call screening.  These settings are available in Alternative Transfer Rules for subscribers, in particular the Call Screening options.
     
    How can these settings be modified in bulk using CUPI?  BAT does not provide this ability.
     
    Thx
    Mike

    Subject: RE: How do I set Alternative Transfer Rules?
    Replied by: Matthew Penning on 19-08-2010 08:21:20 PM
    Hi Mike - here's an outline of how to set the Alternate
    Transfer Rule for a User:
     
    1) Query for user by alias
     
    Query
    looks like this:

     

    GET https://%3cserver%3e/vmrest/users?query=%28alias
    is operator)

     

    Depending on the language etc. the  parens and spaces may have  to be escaped as follows:

     

    GET https://%3cserver%3e/vmrest/users?query=%28alias%20is%20operator%29

     

     <Users>
      <User>
       <URI>/vmrest/users/6164fd60-2f09-4166-a957-bade3c0da69b</URI>

        ...

     

    2) Take
    the URI returned from the search list to retrieve the entire user:


     

    GET
    /vmrest/users/6164fd60-2f09-4166-a957-bade3c0da69b

     

     <User>
      <CallhandlerURI>/vmrest/handlers/callhandlers/ae4ae176-f51e-4e45-82a5-712cc79acaef</CallhandlerURI>
       ...

     

    3) Use
    the CallhandlerURI returned to PUT the transfer option:


     

    PUT https://%3cserver%3e/vmrest/handlers/callhandlers/ae4ae176-f51e-4e45-82a5-712cc79acaef/transferoptions/Alternate

     

     <TransferOption>
      <TimeExpires>2020-01-01
    00:00:00.0</TimeExpires>
      <TransferAnnounce>true</TransferAnnounce>
      <TransferConfirm>true</TransferConfirm>
      <TransferIntroduce>true</TransferIntroduce>
      <TransferScreening>true</TransferScreening>
     </TransferOption>
     
    Setting the "TimeExpires" to a date ahead of the current date is key in activating it - by default, the alternate transfer option is not active.
     
    ~ Matt

    Subject: RE: How do I set Alternative Transfer Rules?
    Replied by: Michael Zhao on 19-08-2010 08:21:21 PM
    Hi Matt,
     
    I need get details of caller input of a user.

    According to the schema and CUPI-WADL provided by Cisco website, here is what I can get by this url https://server/vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e2974f1a39e/menuentries/1
     
    <MenuEntry>
    <URI>
    /vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e2974f1a39e/menuentries/1
    </URI>
    <CallHandlerObjectId>1b99da3e-a208-4b69-9a81-7e2974f1a39e</CallHandlerObjectId>
    <CallhandlerURI>
    /vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e2974f1a39e
    </CallhandlerURI>
    <TouchtoneKey>1</TouchtoneKey>
    <Locked>false</Locked>
    <Action>7</Action>
    <ObjectId>b8267cab-c93e-48fa-9d9a-62f7747518c8</ObjectId>
    </MenuEntry>
     
    However,  I need more detailed informaion about this caller input key <TouchtoneKey>1</TouchtoneKey>. In admin page, i can see extension to transfer of this touchtonekey 1, but is it any URI available for this inforamion? Something like:
    https://server/vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e2974f1a39e/menuentries/1/menueentry/{objectid}/alternatecontactnumber...
     

    Subject: RE: New Message from Michael Zhao in Cisco Unity Connection Provisioning In
    Replied by: Matthew Penning on 19-08-2010 08:21:21 PM
    Hi Michael - the alternate contact number isn't presently available via
    the API, but I'm adding it now and it should be available in the next ES
    for 7.1(3) which will be about a week from now.

    - Matt

    ________________________________

    From: Cisco Developer Community Forums
    [mailto:cdicuser@developer.cisco.com]
    Sent: Sunday, November 01, 2009 4:55 PM
    To: cdicuser@developer.cisco.com
    Subject: New Message from Michael Zhao in Cisco Unity Connection
    Provisioning Interface (CUPI) - CUPI Questions: RE: How do I set
    Alternative Transfer Rules?


    Michael Zhao has created a new message in the forum "CUPI Questions":
    --------------------------------------------------------------
    Hi Matt,

    I need get details of caller input of a user.

    According to the schema and CUPI-WADL provided by Cisco website, here is
    what I can get by this url
    https://server/vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e29
    74f1a39e/menuentries/1

    <MenuEntry>
    <URI>
    /vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e2974f1a39e/menue
    ntries/1
    </URI>
    <CallHandlerObjectId>1b99da3e-a208-4b69-9a81-7e2974f1a39e</CallHandlerOb
    jectId>
    <CallhandlerURI>
    /vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e2974f1a39e
    </CallhandlerURI>
    <TouchtoneKey>1</TouchtoneKey>
    <Locked>false</Locked>
    <Action>7</Action>
    <ObjectId>b8267cab-c93e-48fa-9d9a-62f7747518c8</ObjectId>
    </MenuEntry>

    However,  I need more detailed informaion about this caller input key
    <TouchtoneKey>1</TouchtoneKey>. In admin page, i can see extension to
    transfer of this touchtonekey 1, but is it any URI available for this
    inforamion? Something like:
    https://server/vmrest/handlers/callhandlers/1b99da3e-a208-4b69-9a81-7e29
    74f1a39e/menuentries/1/menueentry/{objectid}/alternatecontactnumber...

    --
    To respond to this post, please click the following link:
    <http://developer.cisco.com/web/cupi/forums/-/message_boards/message/173
    7742>
    or simply reply to this email.

    Subject: RE: New Message from Michael Zhao in Cisco Unity Connection Provisioning In
    Replied by: Michael Zhao on 19-08-2010 08:21:21 PM
    Hi Matt,
     
    Thanks very much for your reply.
     
    Our IP guys just installed the new patch of 7.1.3. Is there any document available for us to know what's new? Or can you kindly let me know the URI for alternate contact number?
     
    thanks
     
    Michael

    Subject: RE: New Message from Michael Zhao in Cisco Unity Connection Provisioning In
    Replied by: Matthew Penning on 19-08-2010 08:21:21 PM
    Hi Michael - the alternate contact number support should be the only new thing added to CUPI, but unfortunately it didn't make it into last Friday's ES so it won't be available until the ES to be released Friday of this week (ES10). When you do get that, the alternate contact numbers will be available simply as a new field on MenuEntry called TransferNumber:
     
    <MenuEntry>
        <TouchtoneKey>1</TouchtoneKey>
        <TransferNumber> 12345</TransferNumber>
        ...
    </MenuEntry>
     
    ~ Matt