This page documents the steps required to configure a Google Cloud project for telephony integration.
Select or create a Google Cloud project
SIP Trunks are connected to a project for communication reasons only, but their impact is not limited to a specific project.
For example, you may have three different projects (development, testing, production). If the same SIP Trunk is used for all SBC to GTP communication, only the first request to create the SIP Trunk will succeed, and the rest of the requests to create the SIP Trunk in the same region/hostname will fail.
We recommend that a different project be used for the sole purpose of managing SIP Trunks. This allows a different team to be responsible for the trunks, and within the Trunk UI, they can establish different groups of SBCs for development, testing, and production.
To use services provided by Google Cloud, you must create a project. A project organizes all your Google Cloud resources. A project consists of a set of collaborators, enabled APIs (and other resources), monitoring tools, billing information, and authentication and access controls. You can create one project, or you can create multiple projects and use them to organize your Google Cloud resources in a resource hierarchy. When creating a project, take note of the project ID. You will need this ID to make API calls. For more information on projects, see the Resource Manager documentation.
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Permissions
- In the Google Cloud Console, navigate to IAM & Admin -> IAM.
- Either select an existing service account or create a new one, and make
sure that it has the
Dialogflow API Admin
role assigned to it. This role is required for telephony integration.
Phone number API access
Using the phone number API methods requires special access. Contact your Google representative for more information.
Configure Dialogflow, conversation profile, and phone number
This section walks you through the process of creating a Conversational AI conversation profile with an associated Google Telephony Platform (GTP) phone number.
- Navigate to Colab Enterprise If prompted, enable the Compute Engine, Dataform, and Vertex APIs.
- Click Import notebooks, then select URL as the data source. Enter this GitHub repository URL, then click IMPORT.
- In the
PROJECT_ID
field, enter the Google Cloud project ID for the project you'd like to associate with the integration. Your existing projects can be found in the drop-down menu at the top of the page in the Cloud Console. - Enter your chosen region in the
REGION
field. All Dialogflow regions are supported. - Either leave the
JWT
field as is, or enter yourJWT
value here. If left blank, SSO is used by default. - Click the play button in the top Project section to run that section of code. When prompted, allow the notebook to access your Google credentials.
- Expand the Configuring Conversational AI for SIP/SIPREC section. Under Create a dummy Dialogflow ES agent..., click Show code and run the code without making any changes. This creates a dummy Dialogflow ES agent and sets its tier to Enterprise. A dummy Dialogflow ES agent is required in order to access Dialogflow API endpoints. Each Google Cloud project can have a single Dialogflow ES agent.
- Expand to display the code under the Script to create a
ConversationProfile
... section.CONVERSATION_PROFILE_NAME
: Can be any string. You can use the default value or input your own.SECURITY_SETTINGS
: Can be any string. You can use the default value or input your own.PHONE_NUMBER_COUNTRY_CODE
: Enter the country code you want to associate with your GTP phone number.CX_AGENT_NAME
: Enter the name of the Conversational Agents (Dialogflow CX) agent you want the generated conversation profile to be associated with.
- Run the code. The output will include the name of the generated
ConversationProfile
, security settings, and GTP phone number. - Navigate to the Dialogflow ES console
to verify that an agent named
Dummy_ES_agent
has been created. Click Settings to verify that the agent is associated with the correct Google Cloud project and that it has been upgraded to the Essentials edition. - Navigate to the
Agent Assist console.
Click Conversation profiles in the left-hand menu to verify that a
conversation profile with your entered
CONVERSATION_PROFILE_NAME
has been created. - Navigate to the Conversational AI Insights console. Verify that all conversation transcripts associated with your Conversational Agents (Dialogflow CX) agent have been imported.
(Optional) Request a quota increase for Dialogflow CX Phone Gateway call length
Dialogflow ES Essentials and Conversational Agents (Dialogflow CX) subscriptions come with standard available quotas. If you are not using Dialogflow at all, for example only Agent Assist, Transcription, or Call Recording, your default quota is the same as the Dialogflow ES Essentials quota.
You have the option of requesting a quota increase if needed based on your estimated traffic. In most use cases the standard quota is sufficient for setup and testing, but runtime applications require an increase. See the Dialogflow quotas page for quota details and instructions for requesting an increase.
(Optional) Enable audit logging for the Dialogflow API
You can optionally enable audit logging for the Dialogflow API (dialogflow.googleapis.com) for Admin Read, Data Read, and Data Write. Doing so lets you see all the individual Conversational AI API calls made and the credentials used for authorization and consumption. This can be useful for troubleshooting and debugging.
What's next
Learn how to setup and configure an SBC.