1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dialogflow_v2.html">Dialogflow API</a> . <a href="dialogflow_v2.projects.html">projects</a> . <a href="dialogflow_v2.projects.locations.html">locations</a> . <a href="dialogflow_v2.projects.locations.conversations.html">conversations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="dialogflow_v2.projects.locations.conversations.messages.html">messages()</a></code>
</p>
<p class="firstline">Returns the messages Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v2.projects.locations.conversations.participants.html">participants()</a></code>
</p>
<p class="firstline">Returns the participants Resource.</p>
<p class="toc_element">
<code><a href="dialogflow_v2.projects.locations.conversations.suggestions.html">suggestions()</a></code>
</p>
<p class="firstline">Returns the suggestions Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#complete">complete(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Completes the specified conversation. Finished conversations are purged from the database after 30 days.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, conversationId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves the specific conversation.</p>
<p class="toc_element">
<code><a href="#ingestContextReferences">ingestContextReferences(conversation, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Data ingestion API. Ingests context references for an existing conversation.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the list of all conversations in the specified project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="complete">complete(name, body=None, x__xgafv=None)</code>
<pre>Completes the specified conversation. Finished conversations are purged from the database after 30 days.
Args:
name: string, Required. Resource identifier of the conversation to close. Format: `projects//locations//conversations/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for Conversations.CompleteConversation.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
"conversationProfile": "A String", # Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`.
"conversationStage": "A String", # Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
"endTime": "A String", # Output only. The time the conversation was finished.
"ingestedContextReferences": { # Output only. The context reference updates provided by external systems.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
"lifecycleState": "A String", # Output only. The current state of the Conversation.
"name": "A String", # Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`.
"phoneNumber": { # Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. # Output only. It will not be empty if the conversation is to be connected over telephony.
"countryCode": 42, # Output only. Desired country code for the phone number.
"phoneNumber": "A String", # Output only. The phone number to connect to this conversation.
},
"startTime": "A String", # Output only. The time the conversation was started.
"telephonyConnectionInfo": { # The information about phone calls connected via phone gateway to the conversation. # Output only. The telephony connection information.
"dialedNumber": "A String", # Output only. The number dialed to connect this call in E.164 format.
"extraMimeContents": [ # Output only. The mime content from the initial SIP INVITE.
{ # The mime content from the initial SIP INVITE.
"content": "A String", # Optional. The content payload.
"mimeType": "A String", # Optional. The mime type of the content.
},
],
"sdp": "A String", # Optional. SDP of the call. It's initially the SDP answer to the incoming call, but maybe later updated for the purpose of making the link active, etc.
"sipHeaders": [ # Output only. The SIP headers from the initial SIP INVITE.
{ # The SIP headers from the initial SIP INVITE.
"name": "A String", # Optional. The name of the header.
"value": "A String", # Optional. The value of the header.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, conversationId=None, x__xgafv=None)</code>
<pre>Creates a new conversation. Conversations are auto-completed after 24 hours. Conversation Lifecycle: There are two stages during a conversation: Automated Agent Stage and Assist Stage. For Automated Agent Stage, there will be a dialogflow agent responding to user queries. For Assist Stage, there's no dialogflow agent responding to user queries. But we will provide suggestions which are generated from conversation. If Conversation.conversation_profile is configured for a dialogflow agent, conversation will start from `Automated Agent Stage`, otherwise, it will start from `Assist Stage`. And during `Automated Agent Stage`, once an Intent with Intent.live_agent_handoff is triggered, conversation will transfer to Assist Stage.
Args:
parent: string, Required. Resource identifier of the project creating the conversation. Format: `projects//locations/`. (required)
body: object, The request body.
The object takes the form of:
{ # Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
"conversationProfile": "A String", # Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`.
"conversationStage": "A String", # Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
"endTime": "A String", # Output only. The time the conversation was finished.
"ingestedContextReferences": { # Output only. The context reference updates provided by external systems.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
"lifecycleState": "A String", # Output only. The current state of the Conversation.
"name": "A String", # Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`.
"phoneNumber": { # Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. # Output only. It will not be empty if the conversation is to be connected over telephony.
"countryCode": 42, # Output only. Desired country code for the phone number.
"phoneNumber": "A String", # Output only. The phone number to connect to this conversation.
},
"startTime": "A String", # Output only. The time the conversation was started.
"telephonyConnectionInfo": { # The information about phone calls connected via phone gateway to the conversation. # Output only. The telephony connection information.
"dialedNumber": "A String", # Output only. The number dialed to connect this call in E.164 format.
"extraMimeContents": [ # Output only. The mime content from the initial SIP INVITE.
{ # The mime content from the initial SIP INVITE.
"content": "A String", # Optional. The content payload.
"mimeType": "A String", # Optional. The mime type of the content.
},
],
"sdp": "A String", # Optional. SDP of the call. It's initially the SDP answer to the incoming call, but maybe later updated for the purpose of making the link active, etc.
"sipHeaders": [ # Output only. The SIP headers from the initial SIP INVITE.
{ # The SIP headers from the initial SIP INVITE.
"name": "A String", # Optional. The name of the header.
"value": "A String", # Optional. The value of the header.
},
],
},
}
conversationId: string, Optional. Identifier of the conversation. Generally it's auto generated by Google. Only set it if you cannot wait for the response to return a auto-generated one to you. The conversation ID must be compliant with the regression formula `a-zA-Z*` with the characters length in range of [3,64]. If the field is provided, the caller is responsible for 1. the uniqueness of the ID, otherwise the request will be rejected. 2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
"conversationProfile": "A String", # Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`.
"conversationStage": "A String", # Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
"endTime": "A String", # Output only. The time the conversation was finished.
"ingestedContextReferences": { # Output only. The context reference updates provided by external systems.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
"lifecycleState": "A String", # Output only. The current state of the Conversation.
"name": "A String", # Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`.
"phoneNumber": { # Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. # Output only. It will not be empty if the conversation is to be connected over telephony.
"countryCode": 42, # Output only. Desired country code for the phone number.
"phoneNumber": "A String", # Output only. The phone number to connect to this conversation.
},
"startTime": "A String", # Output only. The time the conversation was started.
"telephonyConnectionInfo": { # The information about phone calls connected via phone gateway to the conversation. # Output only. The telephony connection information.
"dialedNumber": "A String", # Output only. The number dialed to connect this call in E.164 format.
"extraMimeContents": [ # Output only. The mime content from the initial SIP INVITE.
{ # The mime content from the initial SIP INVITE.
"content": "A String", # Optional. The content payload.
"mimeType": "A String", # Optional. The mime type of the content.
},
],
"sdp": "A String", # Optional. SDP of the call. It's initially the SDP answer to the incoming call, but maybe later updated for the purpose of making the link active, etc.
"sipHeaders": [ # Output only. The SIP headers from the initial SIP INVITE.
{ # The SIP headers from the initial SIP INVITE.
"name": "A String", # Optional. The name of the header.
"value": "A String", # Optional. The value of the header.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieves the specific conversation.
Args:
name: string, Required. The name of the conversation. Format: `projects//locations//conversations/`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
"conversationProfile": "A String", # Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`.
"conversationStage": "A String", # Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
"endTime": "A String", # Output only. The time the conversation was finished.
"ingestedContextReferences": { # Output only. The context reference updates provided by external systems.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
"lifecycleState": "A String", # Output only. The current state of the Conversation.
"name": "A String", # Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`.
"phoneNumber": { # Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. # Output only. It will not be empty if the conversation is to be connected over telephony.
"countryCode": 42, # Output only. Desired country code for the phone number.
"phoneNumber": "A String", # Output only. The phone number to connect to this conversation.
},
"startTime": "A String", # Output only. The time the conversation was started.
"telephonyConnectionInfo": { # The information about phone calls connected via phone gateway to the conversation. # Output only. The telephony connection information.
"dialedNumber": "A String", # Output only. The number dialed to connect this call in E.164 format.
"extraMimeContents": [ # Output only. The mime content from the initial SIP INVITE.
{ # The mime content from the initial SIP INVITE.
"content": "A String", # Optional. The content payload.
"mimeType": "A String", # Optional. The mime type of the content.
},
],
"sdp": "A String", # Optional. SDP of the call. It's initially the SDP answer to the incoming call, but maybe later updated for the purpose of making the link active, etc.
"sipHeaders": [ # Output only. The SIP headers from the initial SIP INVITE.
{ # The SIP headers from the initial SIP INVITE.
"name": "A String", # Optional. The name of the header.
"value": "A String", # Optional. The value of the header.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="ingestContextReferences">ingestContextReferences(conversation, body=None, x__xgafv=None)</code>
<pre>Data ingestion API. Ingests context references for an existing conversation.
Args:
conversation: string, Required. Resource identifier of the conversation to ingest context information for. Format: `projects//locations//conversations/`. (required)
body: object, The request body.
The object takes the form of:
{ # The request message for ConversationsService.IngestContextReferences.
"contextReferences": { # Required. The context references to ingest. The key is the name of the context reference and the value contains the contents of the context reference. The key is used to incorporate ingested context references to enhance the generator.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for ConversationsService.IngestContextReferences.
"ingestedContextReferences": { # All context references ingested.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Returns the list of all conversations in the specified project.
Args:
parent: string, Required. The project from which to list all conversation. Format: `projects//locations/`. (required)
filter: string, Optional. A filter expression that filters conversations listed in the response. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160).
pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000.
pageToken: string, Optional. The next_page_token value returned from a previous list request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for Conversations.ListConversations.
"conversations": [ # The list of conversations. There will be a maximum number of items returned based on the page_size field in the request.
{ # Represents a conversation. A conversation is an interaction between an agent, including live agents and Dialogflow agents, and a support customer. Conversations can include phone calls and text-based chat sessions.
"conversationProfile": "A String", # Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`.
"conversationStage": "A String", # Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE.
"endTime": "A String", # Output only. The time the conversation was finished.
"ingestedContextReferences": { # Output only. The context reference updates provided by external systems.
"a_key": { # Represents a section of ingested context information.
"contextContents": [ # Required. The list of content updates for a context reference.
{ # Contents ingested.
"content": "A String", # Required. The information ingested in a single request.
"contentFormat": "A String", # Required. The format of the ingested string.
"ingestionTime": "A String", # Output only. The time when this information was incorporated into the relevant context reference.
},
],
"createTime": "A String", # Output only. The time the context reference was first created.
"languageCode": "A String", # Optional. The language of the information ingested, defaults to "en-US" if not set.
"updateMode": "A String", # Required. The mode in which context reference contents are updated.
},
},
"lifecycleState": "A String", # Output only. The current state of the Conversation.
"name": "A String", # Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`.
"phoneNumber": { # Represents a phone number for telephony integration. It allows for connecting a particular conversation over telephony. # Output only. It will not be empty if the conversation is to be connected over telephony.
"countryCode": 42, # Output only. Desired country code for the phone number.
"phoneNumber": "A String", # Output only. The phone number to connect to this conversation.
},
"startTime": "A String", # Output only. The time the conversation was started.
"telephonyConnectionInfo": { # The information about phone calls connected via phone gateway to the conversation. # Output only. The telephony connection information.
"dialedNumber": "A String", # Output only. The number dialed to connect this call in E.164 format.
"extraMimeContents": [ # Output only. The mime content from the initial SIP INVITE.
{ # The mime content from the initial SIP INVITE.
"content": "A String", # Optional. The content payload.
"mimeType": "A String", # Optional. The mime type of the content.
},
],
"sdp": "A String", # Optional. SDP of the call. It's initially the SDP answer to the incoming call, but maybe later updated for the purpose of making the link active, etc.
"sipHeaders": [ # Output only. The SIP headers from the initial SIP INVITE.
{ # The SIP headers from the initial SIP INVITE.
"name": "A String", # Optional. The name of the header.
"value": "A String", # Optional. The value of the header.
},
],
},
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
