Help with getting phone call context

Phone Phone SDK
, ,
1

I’m trying to build an app that can be used to retrieve contact details for callers from our CRM system and display them within the Zoom app.

So far I’ve got an app which uses the SDK getPhoneContext API to get the call context and that works, but it just returns the callId like this:

{
  "activeTab": "History",
  "callId": "7477525734344413434",
  "callStatus": "Active"
}

From this, how do I get the actual call details, such as phone numbers etc? There doesn’t seem to be an API available in the SDK to get that.

2

Hi @josh.marchant
Thanks for reaching out to us.
You’re right that the Zoom Apps SDK itself doesn’t provide an API to retrieve call details like phone numbers directly.

But as you are getting the callId from the getPhoneContext API, you could then use that call ID to call our REST API to get relevant data , like the Get call history detail endpoint

1 Like
3

Hi Elisa,

Thanks for your reply. What you’ve said is kinda what I was expecting, but I had a little issue doing it this way. When I was trying the get call history detail endpoint, it seemed to require the Zoom App to be setup as an admin managed app rather than a user managed one in order for it to have the correct scope to use that endpoint. However, the phone SDK didn’t appear to be available if it was setup as an Admin managed app.

Is that right or am I missing something? If so, whats the best way to approach this?

4

Hey @josh.marchant
Zoom Apps, in general, are authorized at the user level so they only have access to user level APIs.

We have a user level call history endpoint: Phone APIs - Zoom Developers

Another option would be creating an admin level app just for API calls

5

Hi Elisa,

Thank you I must’ve missed the user call history endpoint!

I’ve just been doing some testing with it though, and it is only able to return a call log after the call is completed. What I’m trying to do is create an app which will show contextual information from a CRM system during the call, so this endpoint won’t work for what I’m trying to do.

Is there another endpoint, or some other method of getting the caller phone number before the call ends?

6

Hey @josh.marchant
Have you looked into webhooks?
We have a lot of webhooks events that might help you getting that, for example the phone.callee_ringing

7

Hi @elisa.zoom

I did think about that and I suppose if there’s nothing else I will need to down that route.

I assume the idea, and this is a very simplified description, would be I’d need to receive the call data into a database from the webhooks, and then have the app query that database to retrieve the phone number. Is that correct?

Thanks

8

Hey @josh.marchant
You will get the phone number in the webhook payload so yes you can send it to a database and then query it