add copyright, intro header, link to docs and uuidgen

Change-Id: I8e99f25783a64a459bb6ce3702d7129ae8adf2d6
google-business-communications · Dec 20, 2021 · f06ba35 · f06ba35
1 parent db2d680
commit f06ba35
Show file tree

Hide file tree

Showing 18 changed files with 309 additions and 66 deletions.
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+service_account_key.json
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Business Messages: curl snippets
 
-These code snippets demonstrate how to perform operations with the Business Messages API using curl commands.
+These code snippets demonstrate how to perform operations with the Business Messages API using curl from the command line.
 
 This project contains multiple examples. Each file contains a single operation with the Business Messages API.
 
@@ -14,8 +14,8 @@ The documentation for the Business Messages API can be found [here](https://deve
 
 You must have the following software installed on your machine:
 
-- [Google Cloud SDK](https://cloud.google.com/sdk/) (aka gcloud)
 - [curl](https://curl.se/download.html)
+- [oauth2l](https://github.com/google/oauth2l)
 
 ## Before you begin
 

diff --git a/message-rich-text.sh b/message-rich-text.sh
@@ -1,17 +1,34 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a rich text to the user with a fallback text.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#rich_text
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 
 curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
 -H "Content-Type: application/json" \
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-  'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+  'messageId': '$(uuidgen)',
   'fallback': 'Hello, check out this link https://www.google.com.',
   'text': 'Hello, here is some **bold text**, *italicized text*, and a [link](https://www.google.com).',
   'containsRichText': 'true',
   'representative': {
-    'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+    'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
     'displayName': 'Chatbot',
     'representativeType': 'BOT'
   }

diff --git a/message-text.sh b/message-text.sh
@@ -1,15 +1,32 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a text message to the user.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#text
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 
 curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
 -H "Content-Type: application/json" \
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-  'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+  'messageId': '$(uuidgen)',
   'text': 'Hello world!',
   'representative': {
-    'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+    'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
     'displayName': 'Chatbot',
     'representativeType': 'BOT'
   }

diff --git a/send-event-example.sh b/send-event-example.sh
diff --git a/send-event-representative-joined.sh b/send-event-representative-joined.sh
@@ -0,0 +1,32 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a REPRESENTATIVE_JOINED event to the user.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/events#send
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
+# Make sure a service account key file exists at ./service_account_key.json
+
+curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/events?eventId=6a0af2c6-787d-4097-870d-93fe20351747" \
+-H "Content-Type: application/json" \
+-H "User-Agent: curl/business-messages" \
+-H "`oauth2l header --json ./service_account_key.json businessmessages`" \
+-d "{
+  'eventType': 'REPRESENTATIVE_JOINED',
+  'representative': {
+    'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
+    'displayName': 'Chatbot',
+    'representativeType': 'HUMAN'
+  }
+}"
diff --git a/send-event-typing-started.sh b/send-event-typing-started.sh
@@ -0,0 +1,32 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a TYPING_STARTED event to the user.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/events#send
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
+# Make sure a service account key file exists at ./service_account_key.json
+
+curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/events?eventId=6a0af2c6-787d-4097-870d-93fe20351747" \
+-H "Content-Type: application/json" \
+-H "User-Agent: curl/business-messages" \
+-H "`oauth2l header --json ./service_account_key.json businessmessages`" \
+-d "{
+  'eventType': 'TYPING_STARTED',
+  'representative': {
+    'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
+    'displayName': 'Chatbot',
+    'representativeType': 'BOT'
+  },
+}"
diff --git a/send-event.sh b/send-event.sh
diff --git a/send-message-authentication-request-suggestion.sh b/send-message-authentication-request-suggestion.sh
@@ -1,4 +1,22 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a text message to the user with an authentication request suggestion
+# that allows the user to authenticate with OAuth. It also has a fallback text.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#authentication-request-suggestion
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 # Replace the __CLIENT_ID__
 # Replace the __CODE_CHALLENGE__
@@ -9,7 +27,7 @@ curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERS
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-    'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+    'messageId': '$(uuidgen)',
     'text': 'Sign in to continue the conversation.',
     'fallback': 'Visit support.growingtreebank.com to continue.',
     'suggestions': [
@@ -26,7 +44,7 @@ curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERS
       },
     ],
     'representative': {
-      'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+      'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
       'displayName': 'Chatbot',
       'representativeType': 'BOT'
     }

diff --git a/send-message-fallback.sh b/send-message-fallback.sh
@@ -1,4 +1,21 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a text message to the user with a fallback text.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#fallback_strategy
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 
 curl -X POST \
@@ -7,7 +24,7 @@ curl -X POST \
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-    'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+    'messageId': '$(uuidgen)',
     'text': 'Hello world!',
     'fallback': 'Hello, world!\n\nSay \"Hello\" at https://www.growingtreebank.com',
     'suggestions': [
@@ -22,7 +39,7 @@ curl -X POST \
       },
     ],
     'representative': {
-      'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+      'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
       'displayName': 'Chatbot',
       'representativeType': 'BOT'
     }

diff --git a/send-message-image.sh b/send-message-image.sh
@@ -1,14 +1,31 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends an image to the user with a fallback text.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#images
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 
 curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
 -H "Content-Type: application/json" \
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-    'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+    'messageId': '$(uuidgen)',
     'representative': {
-      'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+      'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
       'displayName': 'Chatbot',
       'representativeType': 'BOT'
     },

diff --git a/send-message-live-agent-request-suggestion.sh b/send-message-live-agent-request-suggestion.sh
@@ -1,12 +1,30 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends a text message to the user with a Live agent request suggestion
+# that allows the user to connect with a Live agent.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#live_agent_request_suggestion
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 
 curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
 -H "Content-Type: application/json" \
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-    'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+    'messageId': '$(uuidgen)',
     'text': 'Would you like to chat with a live agent?',
     'fallback': 'Would you like to chat with a live agent?',
     'suggestions': [
@@ -15,7 +33,7 @@ curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERS
       },
     ],
     'representative': {
-      'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+      'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
       'displayName': 'Chatbot',
       'representativeType': 'BOT'
     },

diff --git a/send-message-rich-card-carousel.sh b/send-message-rich-card-carousel.sh
@@ -1,14 +1,31 @@
-# Replace the __CONVERSATION_ID__
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     https://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This code sends to the user a carousel with rich cards and a fallback text.
+# Read more: https://developers.google.com/business-communications/business-messages/guides/how-to/message/send?hl=en#rich-card-carousels
+
+# Replace the __CONVERSATION_ID__ with a conversation id that you can send messages to
 # Make sure a service account key file exists at ./service_account_key.json
 
 curl -X POST "https://businessmessages.googleapis.com/v1/conversations/__CONVERSATION_ID__/messages" \
 -H "Content-Type: application/json" \
 -H "User-Agent: curl/business-messages" \
 -H "`oauth2l header --json ./service_account_key.json businessmessages`" \
 -d "{
-    'messageId': '86b11a9c-6d29-499a-b516-444e9d2a5543',
+    'messageId': '$(uuidgen)',
     'representative': {
-      'avatarImage': 'https://lh3.googleusercontent.com/LjlQXZGF-3C0yv99xAKpv942l62ZV8nhG59rR8PXbqR_ue2_AJY67X7dlEKi_a21vgswYqVD0E7fdFYcku4uQjDncYVSVA65IUBVRm4=w153',
+      'avatarImage': 'https://developers.google.com/identity/images/g-logo.png',
       'displayName': 'Chatbot',
       'representativeType': 'BOT'
     },