Objective:
This article helps you to integrate My Operator telephony system with NoPaperForms CRM.
Scope of integration:
- Both inbound and outbound integration.
- Call recordings are accessible only on My Operator platform
Pre-requisites:
Details required from the My Operator team to initiate the telephony integration:
- My Operator Click To Call API Document
- Postman Collection of Click to Call API Request & Response
-
Get Counsellor API Key
-
API Token Key
-
Anonymous User ID
-
Company ID
-
Secret Token
-
Public IVR ID
-
X-API-Key
-
Jump NodeID
- Dial Method
- Agent Number for all the associated counsellors
- User ID for all the associated counsellors
- DID Number
My Operator team needs to integrate our below mentioned APIs at their end.
<Please share the document to telephony vendor w.r.t. institute infra>
- NPF Telephony API Integration Document: Infra 1
- NPF Telephony API Integration Document: Infra 4
- NPF Telephony API Integration Document: Infra 5
- NPF Telephony API Integration Document: Infra 8
Please share the secret key to the telephony vendor.
----------------------------------------------------------------------------------------------------
Timeline: Estimated timeline of telephony integration task delivery:
- Once pre-requisites required to initiate the telephony integration are shared by the My Operator team, then NoPaperForm's team will initiate the telephony configurations mentioned below and complete in 3 working days.
- Once our APIs shared to the My Operator team are integrated at My Operator's end, then NoPaperForms team will initiate the telephony configuration QA testing mentioned below and complete in 2 working days.
- Inbound call flow testing
- Outbound call flow testing
- Telephony call logs and data flow testing
- Counsellor Productivity Report testing
- Student Timeline testing
- Call logs server load testing
- Inbound calls by new numbers' leads creation testing
- Inbound Missed Call Icon data update testing
- Inbound call screen pop up testing
- Get Counsellor API agent details testing
- UI testing
------------------------------------------------------------------------------------------------------
My Operator Integration:
Once all the requested details are shared by the My Operator team and our APIs are integrated at their end, we will configure integration details at institute level, counsellor level and then grant required permissions.
Postman Collections: Success Response Screenshot
Call Logs API:
Call Pop-up API:
Postman CURL Requests:
1. Call Logs API CURL Request:
curl --location 'https://services.nopaperforms.com/webhooks/v1/secret_key/ivrCallBackDetails' \
--header 'Content-Type: application/json' \
--header 'Cookie: PHPSESSID=g709gl813d0h4qg35h8aeoj022' \
--data '{
"myoperator": "{\\\"_ai\\\":\\\"12346437c1234567\\\",\\\"_so\\\":\\\"1\\\",\\\"_ci\\\":\\\"1234634118fc123456\\\",\\\"_cr\\\":\\\"6290721234\\\",\\\"_cm\\\":\\\"\\\",\\\"_cl\\\":\\\"+916290721234\\\",\\\"_cy\\\":\\\"91\\\",\\\"_se\\\":\\\"KO, IN\\\",\\\"_ts\\\":1681376131,\\\"_st\\\":1681376106,\\\"_ms\\\":1681376106000,\\\"_ss\\\":32106,\\\"_et\\\":1681376130,\\\"_dr\\\":\\\"00:00:24\\\",\\\"_drm\\\":0.4,\\\"_ty\\\":1,\\\"_ev\\\":1,\\\"_fn\\\":\\\"\\\",\\\"_fu\\\":\\\"\\\",\\\"_ns\\\":\\\"0\\\",\\\"_su\\\":2,\\\"_dn\\\":\\\"\\\",\\\"_di\\\":\\\"\\\",\\\"_pm\\\":[{\\\"ky\\\":\\\"ui\\\",\\\"vl\\\":\\\"cb2.1681376105.5270173\\\"},{\\\"ky\\\":\\\"is\\\",\\\"vl\\\":\\\"0\\\"},{\\\"ky\\\":\\\"vt\\\",\\\"vl\\\":\\\"2\\\"},{\\\"ky\\\":\\\"ic\\\",\\\"vl\\\":\\\"0\\\"},{\\\"ky\\\":\\\"ia\\\",\\\"vl\\\":\\\"0\\\"},{\\\"ky\\\":\\\"ib\\\",\\\"vl\\\":\\\"1\\\"}],\\\"_cn\\\":[],\\\"_ld\\\":[],\\\"_an\\\":0,\\\"_us\\\":[],\\\"_tc\\\":[],\\\"_ri\\\":\\\"\\\",\\\"_ji\\\":\\\"\\\",\\\"_ivid\\\":\\\"\\\",\\\"_cri\\\":\\\"\\\"}"
}'
2. Call Pop-up API CURL Request:
curl --location 'https://services.nopaperforms.com/webhooks/v1/secret_key/ivrCallNotification' \
--header 'Content-Type: application/json' \
--header 'Cookie: PHPSESSID=g709gl813d0h4qg35h8aeoj022PHPSESSID%3Dg709gl813d0h4qg35h8aeoj022' \
--data '{
"myoperator": "{\"id\":\"123456789\",\"uid\":\"123456789\",\"reference_id\":null,\"company_id\":\"123456789\",\"clid_raw\":\"916000212636\",\"clid\":\"6000212636\",\"rdnis\":\"unknown\",\"call_state\":\"2\",\"event\":\"1\",\"status\":\"2\",\"users\":\"[\\\"919127054383\\\"]\",\"created\":\"2023-04-25 05:15:00\",\"call_time\":\"2023-04-25 05:11:35\",\"public_ivr_id\":null,\"client_ref_id\":null,\"job_id\":null}"
}'