Plantronics + Polycom. Now together as Poly Logo

How to Customize CallItem Screen with external data for OBI VVX phone

SOLVED
malformed
Occasional Visitor

How to Customize CallItem Screen with external data for OBI VVX phone

I'll start out by saying that what I probably need is an example. I've gone through the ObiPhoneXML documentation and am not seeing what I need.

 

My company has VVX 450 OBI edition phones, and I would like to lookup some of our customer data by phone number and integrate it into the CallItem screen element. Using the phone's web interface, I can manipulate trivial aspects like color and static text, but I don't know how to make the phone call my server via url to retrieve anything dynamically (I am building out an app server explicitly for returning data in the required XML format). 

 

I can reach my server when mapping a url to one of the actions of a softkey, but that doesn't accomplish what I need  - and I can't figure out a way of passing the phone number through as an argument anyway, which would be the whole point. 

 

Is there any resource that has an example of anything similar to this, and if not how do people typically accomplish this sort of integration?

 

 

Message 1 of 5
1 ACCEPTED SOLUTION

Accepted Solutions
SteffenBaierUK
Polycom Employee & Community Manager

Re: How to Customize CallItem Screen with external data for OBI VVX phone

Hello @malformed ,

 

Welcome to the Poly Community.


I ran this by one of our senior Obi Team and they came back with this:

 

Customer should be able to leverage our inbound phone call webhook on OBi Edition VVX Phone.

 

Inbound call web hook is configurable under the respective SP service.

 

  • SPx Service ->  IncomingCallRingingAction URL.

 

Below are some of the macros you are able to add and send to the server.

 

  • Below are the optional query parameters. Below are some examples:
    • Note: URL automatically include the called (SIP CALL-ID) and GMT-timedate as URL-query parameters; you can use the following macros:
      • $peername = peer caller id name
      • $peernumber = peer caller id number
      • $dur = duration of the call
      • $refid = the Reference ID that can used to control the call in an Phone XML App
      • $dir = the direction of the call (inbound or outbound)
      • $service = the service or line the call is on (SP1, … or SP6)
      • Example: http://abc.com?name=$peerName&number=$peernumber&ref=$refid

 

Please ensure to provide some feedback if this reply has helped you so other users can profit from your experience.

Best Regards

Steffen Baier

----------------
The title Polycom Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. My official "day" Job is 3rd Level support at Poly but I am unable to provide official support via the community.

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

View solution in original post

Message 2 of 5
4 REPLIES 4
SteffenBaierUK
Polycom Employee & Community Manager

Re: How to Customize CallItem Screen with external data for OBI VVX phone

Hello @malformed ,

 

Welcome to the Poly Community.


I ran this by one of our senior Obi Team and they came back with this:

 

Customer should be able to leverage our inbound phone call webhook on OBi Edition VVX Phone.

 

Inbound call web hook is configurable under the respective SP service.

 

  • SPx Service ->  IncomingCallRingingAction URL.

 

Below are some of the macros you are able to add and send to the server.

 

  • Below are the optional query parameters. Below are some examples:
    • Note: URL automatically include the called (SIP CALL-ID) and GMT-timedate as URL-query parameters; you can use the following macros:
      • $peername = peer caller id name
      • $peernumber = peer caller id number
      • $dur = duration of the call
      • $refid = the Reference ID that can used to control the call in an Phone XML App
      • $dir = the direction of the call (inbound or outbound)
      • $service = the service or line the call is on (SP1, … or SP6)
      • Example: http://abc.com?name=$peerName&number=$peernumber&ref=$refid

 

Please ensure to provide some feedback if this reply has helped you so other users can profit from your experience.

Best Regards

Steffen Baier

----------------
The title Polycom Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. My official "day" Job is 3rd Level support at Poly but I am unable to provide official support via the community.

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's

View solution in original post

Message 2 of 5
malformed
Occasional Visitor

Re: How to Customize CallItem Screen with external data for OBI VVX phone

Thank you very much Steffen, this 100% addressed my problem. I still have a lot of code to write, but I can now see the incoming number in my application, and can return XML for rendering a page on the phone. Fantastic.

 

have a good weekend.

Message 3 of 5
malformed
Occasional Visitor

Re: How to Customize CallItem Screen with external data for OBI VVX phone

Not to look a gift horse in the mouth, but this does raise a question for me. The information you gave me is *essential* for performing phone number-based lookup tasks, but it doesn't appear in the ObiPhoneXML guide, and a search for "IncomingCallRingingAction" yields nothing. Where is this information found? There might be other useful bits of information I could use in that same document.

Message 4 of 5
SteffenBaierUK
Polycom Employee & Community Manager

Re: How to Customize CallItem Screen with external data for OBI VVX phone

Hello @malformed ,

 

The team is working internally to update the guides. Once they are done I will update the community. I do not have an ETA.


Best Regards

Steffen Baier

----------------
The title Polycom Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. My official "day" Job is 3rd Level support at Poly but I am unable to provide official support via the community.

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's
Message 5 of 5