News & Announcements User Community Developer Community

Welcome to the RingCentral Community

Please note the community is currently under maintenance and is read-only.

Search
Make sure to review our Terms of Use and Community Guidelines.
  Please note the community is currently under maintenance and is read-only.
Home » Developers
Retrieve IVR call option
Tags: ivr, webhooks
Aug 30, 2022 at 11:07am   •   3 replies  •  0 likes
Nikolai Chashchin

Hi Community,

I set up a webhook to get notified about changes that happens to an account using filter: /restapi/v1.0/account/~/telephony/sessions. For my application I need some extra information about the session. Can u please tell me how to get this information and whether this is doable through a webhook:

1. Selected option in IVR. By this I mean option explained at https://support.ringcentral.com/article/6562.html?language=en_US under 'Sample Custom Greeting' topic.

2. Selected IVR menu. At this uri: https://github.com/dibyenduroy/csn-data/blob/master/PSTN-RingCentral-DataStreams.txt in the list of notifications I see at the line 3 f.ex:

{'uuid': '6157342698054500332', 'event': '/restapi/v1.0/account/809646016/telephony/sessions', 'timestamp': '2020-06-23T01:05:44.195Z', 'subscriptionId': '2461434a-276a-4073-bd26-34089effbad5', 'ownerId': '809646016', 'body': {'sequence': 4, 'sessionId': '429180487016', 'telephonySessionId': 's-718107795d564867a6f635fd81e89940', 'serverId': '10.13.22.27.TAM', 'eventTime': '2020-06-23T01:05:44.083Z', 'parties': [{'accountId': '809646016', 'id': 'p-718107795d564867a6f635fd81e89940-1', 'direction': 'Outbound', 'to': {'phoneNumber': '+18003151571', 'name': 'IVR Menu 1001', 'extensionId': '62242421016'}, 'from': {'phoneNumber': '+14083388064'}, 'status': {'code': 'Answered', 'rcc': False}, 'park': {}, 'missedCall': False, 'standAlone': False, 'muted': False}], 'origin': {'type': 'Call'}}}

It has parameter 'name': 'IVR Menu 1001'. Do I need to parse 'name' parameter to find out if the call uses IVR menu? Can IVR menu have arbitrary name?

Thanks!

Best,

Nikolai Chashchin

3 Answers
answered on Sep 15, 2022 at 9:02am  

Hi Phong,

Just want to be sure, that I understood your answers correctly. As far as I understood threre is no way to get IVR selected option by any means using RC Api? Neither via Subscription Api nor via any other Api provided by RC, right?

Best,

Nikolai Chashchin


 0
on Sep 20, 2022 at 7:00am   •  1 likes

That is right. We don't log IVR action in the call log, nor sending any notification for such events.

answered on Aug 31, 2022 at 12:41am  

Thanks for the fast reply, Phong!

But it is still not clear for me how to get a selected option in IVR during a call.

Let's say there is a following options for the caller: 'Thank you for calling <Company Name>. If you want to be recorded press 1, if not press 2'. Recording here means a consent to record what caller will be saying during a call. How can I check that the caller picks option 1?

Best,

Nikolai Chashchin


 0
answered on Aug 30, 2022 at 4:47pm  

First of all, IVR settings can be very complicated, and you should not rely on the IVR name in those events as it always displays the first IVR.

Any incoming call to a company number will end up in an IVR, then depending on the IVR settings, the call will be routed and handled according to the rules set for that IVR and the callers actions.

To detect an incoming call to an IVR, you can detect the extension id in the event payload (body.parties[0].extensionId). To identify an IVR by its id, you can call the Get Extension List API, set the type='IvrMenu' and keep the IVR menus' extension id in an array to compare the extension ids when you receive a telephony event notification.

To read the IVR settings, use the IVR extension id to call this endpoint.


 0



A new Community is coming to RingCentral!

Posts are currently read-only as we transition into our new platform.

We thank you for your patience
during this downtime.

Try Workflow Builder

Did you know you can easily automate tasks like responding to SMS, team messages, and more? Plus it's included with RingCentral Video and RingEX plans!

Try RingCentral Workflow Builder

PRODUCTS
RingEX
Message
Video
Phone
OPEN ECOSYSTEM
Developer Platform
APIs
Integrated Apps
App Gallery
Developer support
Games and rewards

RESOURCES
Resource center
Blog
Product Releases
Accessibility
QUICK LINKS
App Download
RingCentral App login
Admin Portal Login
Contact Sales
© 1999-2024 RingCentral, Inc. All rights reserved. Legal Privacy Notice Site Map Contact Us