IP-PSTN intermix: Customer onboarding and WebRTC SDK integration

overview exotel’s webrtc sdk provides an easy to integrate softphone sdk for web applications the sdk allows you to embed a fully functional softphone within your web applications which can be an in house web portal or a crm application, enabling seamless communication between your users and customers the softphone supports both inbound and outbound calling, along with programmatically making calls via dial pad in the widget and by clicking to call in your crm by following the simple integration steps provided, you can quickly enhance your applications with powerful voice communication capabilities here's a short video https //learn exotel com/share/zng8mygpymdnjb3zos94va displaying the webrtc sdk capabilities benefits of the webrtc sdk bulk user creation using a single api the users for ip calling can be created at once, with the help of bulk user creation api sip id and password creation/management for the users the sip credentials of the users would be created and maintained by exotel users just need to log in to their crms and get started with the ip calling sso experience for the users users just need to log in once to their crms and need not separately login to exotel on successful login to the crms, the users would be authenticated and the websdk would be initialised and registered for the ip calling ip calling within your crms the users would be able to take the sip calls from the widget embedded within the crms and need not toggle between multiple tabs ui widget for calling the widget for incoming/outgoing call popup would be shown to the users where they would get options to accept/reject the calls along with the hold/mute buttons the ability for the users to switch off/on their sip device users can switch between ip and pstn calling as per their network availability with the help of a toggle button on call statuses, status callbacks, call details etc all the call details would be available post each call for you to analyze the calls onboarding process please follow the below mentioned steps to use and configure the ip pstn webrtc sdk for voip calls pre requisites in order to have a successful integration with the ip pstn webrtc sdk, you must complete the following prerequisites new services agreement to comply with the government of india regulations, exotel has obtained a unified license for virtual network operator (ul vno) under a separate entity named 'veeno communications pvt ltd ’ therefore, a new services agreement needs to be signed with 'veeno communications pvt ltd ’ for using voip services your account manager or the exotel point of contact will help you with this step new account creation (even for existing customers) due to the regulatory reason/s mentioned in point 1 above, you are required to sign up for a new account to use ip pstn intermixing for voip calls voip services cannot be provided under the existing account/s which you may have already created with us your account manager or the exotel point of contact will help you with this step new kyc to be registered (bangalore only for now) in addition to the four documents required to complete the kyc for an account, accounts with voip services enabled for them also require a customer acquisition form(caf) to be completed as part of kyc it is supported on the exotel dashboard as one of the document requirements on the kyc page kyc needs to be done separately for each city for voip accounts this primarily means that the following 2 documents need to be produced fresh every time a new city kyc is to be done address proof (the address needs to be of the city from where the numbers need to be purchased) customer acquisition form (caf) for more details on where the kyc/verification docs need to be uploaded and what documents qualify for kyc, this link https //support exotel com/support/solutions/articles/35760 should be referred to please get in touch with your account manager or the exotel point of contact for any queries regarding this process new exophones (virtual numbers) to be purchased virtual number purchase is coupled with individual region/city kyc status i e number purchases will only be allowed from regions where the kyc is completed note currently, the only city available for kyc and number purchase is bangalore for more details on how to procure a new exophone, please refer to this support article https //support exotel com/support/solutions/articles/3000010956 call flows creation/migration and linking with virtual number/s once the new account is created and the virtual number/s is purchased, you would need to create the call flows for the inbound scenarios reference article link https //support exotel com/support/solutions/articles/35140 how do i create edit save a flow if you already have an account with exotel with call flows created for the inbound scenarios and wish to use the same call flows in the new account for ip calling, the call flows would need to be migrated reference article link https //support exotel com/support/solutions/articles/3000112569 can i transfer my exophone and the call flows from one account to another https //support exotel com/support/solutions/articles/3000112569 can i transfer my exophone and the call flows from one account to another once the call flows are created/migrated, you can link the call flows to the virtual numbers so that any customer calls landing on those virtual numbers follow the required call flow path browser compatibility with the webrtc sdk windows os google chrome, mozilla firefox and microsoft edge linux os google chrome and mozilla firefox mac os google chrome, mozilla firefox, safari (>v11) integration steps for the webrtc sdk after the above mentioned prerequisites are done, you would be able to fetch the api key and api token for your account, from the exotel dashboard in addition to this, you’ll need a client id and client secret to generate authentication token/s for successfully authenticating your future api requests by our platform please reach out to the exotel tech support team or your account manager for help in generating the client id and client secret once the client id and the client secret are available, please use the following api to generate the authentication token which can be used with your future api requests create authentication token https //developer exotel com/api/ip pstn intermix webrtc sdk integration#create authentication token the creation of the following resource hierarchy is required for registering with our voip platform to enable voip calling you are required to create a customer entity (steps mentioned below) a unique customer entity in exotel’s platform allows us to achieve resource separation between different customers use the following apis to manage the customer entity for voip calling create, get and delete apis for the customer entity https //developer exotel com/api/ip pstn intermix webrtc sdk integration#manage customer for applications after step one, you will then need to create at least one, or more, applications within the customer entity application creation is required to support multiple use cases within your single crm/3rd party application account for example, if your sales and support teams are mapped to a single crm account which is mapped to a single exotel account, but the users within these teams and their voip settings are to be maintained differently; then creating an application for each of these teams would help you manage the voip calling requirements for both these teams separately using the same crm account mapped to one exotel account the creation of more than one application is completely optional use the following apis to manage application(s) within the customer entity register, get and delete apis for the app entity https //developer exotel com/api/ip pstn intermix webrtc sdk integration#application management use the following apis to manage application settings add, get, and delete apis for app settings https //developer exotel com/api/ip pstn intermix webrtc sdk integration#application settings and custom configuration after step 2, you will need to add the user(s) within the application(s) user addition through the application results in the addition of these users into the exotel system and the creation of their sip credentials, which will be used to authenticate and verify a user while enabling their voip calling use the following apis to manage users within application/s register, get, delete, and update user device apis for users https //developer exotel com/api/ip pstn intermix webrtc sdk integration#applications user management after step 3, you will need to configure call flows in the exotel app bazaar as per step 5 in the pre requisites 'call flows creation/migration and linking with virtual number/s' if you want exotel to pass various details related to the incoming call when the call is initiated, terminated or missed, please provide the following url in the ‘create popup…’ section while configuring the ‘connect’ applet during the call flow creation process https //integrationscore mum1 exotel com/v2/integrations/call/inbound call/{appid}?type={} https //integrationscore mum1 exotel com/v2/integrations/call/inbound call/{appid}?type={} note the type can be popup, incomingcallhungup & missedcall, please refer to this detailed api documentation to understand in case of multiple applications within your account, please use the application id for the app under which you want the calling to happen once the users are created, you will need to integrate the webrtc sdk by following the steps from the following github repository https //github com/exotel/exotel ip calling crm websdk finally, whitelist the following ports, domains and ip addresses in all the networks' firewall where the websdk will be running type port/endpoint http tcp/80 https / tls tcp/443 sip gateway ip voip in1 exotel com media server ports udp/10000 40000 media server ip bangalore, ka 61 246 82 75, 14 194 10 247 media server ip mumbai, mh 182 76 143 61, 122 15 8 18 https for api management integrationscore mum1 exotel com click to call functionality is a part of the webrtc sdk and will be functional on the integration of the sdk with your calling application pricing ip pstn intermixing is available only with an ‘unlimited calling plan’ by paying a fixed per user per month price please get in touch with your exotel account manager to understand the pricing applicable to your requirements faqs do i need to sign a new msa for voip calling? yes this is required because exotel has a pan india ul vno license under the entity named “veeno communications private limited” hence, there will be a new msa to be signed between the customer and the veeno entity do i need to create a new account for voip calling? yes all customers, including existing customers, will have to create a new account if they need voip calling as voip calling is being offered through the veeno entity, thus, a new customer account has to be created under veeno as the existing account under exotel techcom pvt ltd cannot provide voip calls with the veeno infrastructure what is the process to create an account under veeno? in the alpha phase, the account creation will be aided by the exotel account management/sales team post alpha phase, the account creation for veeno/voip calling will follow the same process followed today for non voip accounts can i use the virtual numbers/exophones that i have in my existing account for voip calling? no, new numbers have to be purchased under the new veeno account existing numbers from non veeno accounts cannot be used under veeno accounts because there is a separate number inventory for veeno and it cannot be mixed with the non veeno number inventory as per the government regulations if i have ivr/call flows in my existing account, do i need to create/replicate new ivr/call flows under the new veeno account? the exotel team will do everything possible to migrate the ivr/call flows from your existing account to the new veeno account what is the size of websdk? it is 1 4mb what would be the ‘app user id’ for adding users in exotel through the sdk? the email id of the user should be used as the user id for the app while adding the users in exotel through the sdk can the users be added via the exotel dashboard? no, the users should be added only by following the steps mentioned for user creation in this support article this process will ensure that the users’ sip credentials are created and managed successfully at our end what are the prerequisites for the users to start calling via websdk? the users will need to log in to the third party application with valid credentials on successful login, the users will see their sip device as switched on for making voip calls they can toggle it off/on to switch between sip and pstn calling how can the user stop making/receiving calls via websdk? the user will have to toggle off the sip calling button or the user will have to log off from the third party application this would automatically unregister and initialize the sdk for calling what will happen if the user is not able to make/receive voip calls due to poor network connectivity? in such a case, the user can switch to pstn calling with the help of a toggle button which means the mobile device of the user would become the primary device for calling how do i connect a user to a flow? the websdk doesn't support dialling to a flow directly this would require you to use the "outgoing call to connect number to a call flow" api and pass the sip id in the from parameter and pass the flow link in the url parameter