Getting start of new integration

I. Template

Intgration Template

• Fields:
  • Integration Name: The Integration name, which is also the integration name displayed in the iframe.
  • Label: Integration label, usually the same as Integration Name.
  • Type: Type of Integration ( CRM, SMS )
  • Description: Description of Integration
  • Info: Allows to integrate more information insert click to call button, handle api.
  • Iframe: Allows integration of iframe format information.
  • Parameters: Parameters are used in the integration, parameters have the following types:
    • Header: params are inserted in the api header.
    • Body: params are inserted in the body header.
    • Query: params are inserted in the query header.
    • Path: params are inserted in the path header.
    • Md5: md5 encoded params are inserted in api header.

II. Integrator

Integrated information of each tenant

• Fields:
  • ID Callcenter: ID Callcenter.
  • Host: Host url will be integrated (Note: integrated host has no https prefix, e.g. app.gcalls.co )
  • Description: Description of Integrator
  • Info: Information insert click to call button, handle api. json format, more info guide: JSON INTEGRATION DATA
  • Iframe: Iframe format information. json format, more info guide: JSON INTEGRATION DATA
  • Fields: The fields are used in the integration, fields correspond to the parameters in the template.

III. Endpoints

Endpoints api used in integration

• Fields
  • Name: The endpoint name, used to call the endpoint in the integration.
  • Label: Endpoint label, usually the same as Endpoint Name.
  • Type: Type of endpoint, Type have the following types:
    • Auth
    • GetData
    • PostData
    • SendSMS
  • Method: endpoint method, Method have the following types:
    • GET
    • POST
    • PUT
    • DELETE
  • Url: endpoint url
  • Description: Description of Endpoint
  • Trigger: Trigger api.
  • Response Type: Response Type of access token, used to get access token for endpoint type auth
  • Hard Params: The information is hard-assigned to the endpoint.
  • Parameters: Parameters used in endpoint, taken from sources:
    • Fields in integrator.
    • Access token get from auth api.
    • Body transmitted from client.

IV. Getting start of new/changed integrated publication

1. Login to Portal.
2. In menu bar select Customer --> Integration.
3. Click the Add integration button at the top right of the screen. Fill in the required information and click OK.
4. In the newly created integration, click the eye icon to display the Integrator and Endpoints tabs.
5. In Integrator Table, Click the Add integrator button at the top right. Fill in the required information and click OK.
6. In Endpoint Table, Click the Add endpoint button at the top right to add the required endpoint for integration.

V. Getting start of new private integration

1. Login to Portal.
2. In menu bar select Customer --> Integration.
3. Click the Add integration button at the top right of the screen. Fill in the required information and click OK.
4. In the newly created integration, click the eye icon to display the Integrator and Endpoints tabs.
5. In Integrator Table, Click the Add integrator button at the top right. Fill in the required information and click OK.
6. In Endpoint Table, Click the Add endpoint button at the top right to add the required endpoint for integration.
7. Setting in Callbox:
   • Add Integration name into listCustomIntegration array in gcallsfront/callbox/src/components/index.tsx.
   • Create folder with name is Integration name in gcallsfront/callbox/src/customCallbox/
     • Create file fuction.js in Integration folder for setting integration functions:
       • getDataIframe: use to configure api get iframe info, trigger when call starts.
       • savePreLogCRM: use to configure api save calllog for crm, trigger when call connected.
       • saveLogCRM: use to configure api save/update calllog for crm, trigger when call end.
       • createSMSNote: use to configure api save sms log for crm, trigger when sending sms.
     • Create folder showInfo in Integration folder:
       • Create file index.js in showInfo folder for setting iframe ui:
         • handleCreateTicket: use to save ticket for crm, trigger when agent create ticket in iframe.
         • handleCreateContact: use to save contact for crm, trigger when agent create contact in iframe.