Configuring an Interface

Procedure

1. Sign in to the AICC as a tenant administrator and choose Configuration Center > Flow Configuration > Flow Management.
2. Click . The Interface Configuration page is displayed.
3. Click . On the Create Interface page that is displayed, configure interface information.
   Figure 1 Creating an interface
   

   The rules for setting fields involved in interface configuration are as follows:

   • Basic Configuration
     • Interface Name: The value is a string of a maximum of 64 characters.
     • Interface Description: description of an interface. The value is a string of a maximum of 64 characters. This parameter is optional.
     • Interface Type: The options are POST and GET.
     • Certificate File: Select a certificate file. This parameter is optional.
       

       The certificate file is uploaded on the Configuration Center > System Management > Certificate page. When the interface is invoked, the client and server verify the certificate.

     • Request URL: You are advised to set this parameter to a URL starting with http or https. To invoke an interface, IVR flows must use a URL in either of the formats.
       

       1. You need to contact the system administrator to add the request URL on the Interface Control page in advance.
       2. HTTP is not recommended, because it may bring risks. The secure HTTPS is recommended.
   • Parameter Configuration
     • Input Parameter: input parameter information about an interface, including the header, body, and path. Set this parameter as required.
     • Output Parameter: output parameter information about an interface, including the body. Set this parameter as required.

4. Click Save. The interface configuration is complete.
5. (Optional) You can perform the following operations on interfaces:
   • To refresh the interface list, click .
   • To edit an interface, click the link in the Interface Name column or click Edit in the Operation column.
   • To delete interfaces in batches, select the interfaces and click . To delete an interface, click Delete in the Operation column.