| <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.sipTrunks.html">sipTrunks</a></h1> |
| <h2>Instance Methods</h2> |
| <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="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a SipTrunk for a specified location.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a specified SipTrunk.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves the specified SipTrunk.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns a list of SipTrunks in the specified location.</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> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the specified SipTrunk.</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="create">create(parent, body=None, x__xgafv=None)</code> |
| <pre>Creates a SipTrunk for a specified location. |
| |
| Args: |
| parent: string, Required. The location to create a SIP trunk for. Format: `projects//locations/`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. |
| "connections": [ # Output only. Connections of the SIP trunk. |
| { # Represents a connection for SIP Trunk. |
| "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. |
| "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. |
| "certificateState": "A String", # Output only. The status of the certificate authentication. |
| "errorMessage": "A String", # The error message provided from SIP trunking auth service |
| }, |
| "state": "A String", # Output only. State of the connection. |
| "updateTime": "A String", # Output only. When the connection status changed. |
| }, |
| ], |
| "displayName": "A String", # Optional. Human readable alias for this trunk. |
| "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
| "A String", |
| ], |
| "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. |
| "connections": [ # Output only. Connections of the SIP trunk. |
| { # Represents a connection for SIP Trunk. |
| "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. |
| "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. |
| "certificateState": "A String", # Output only. The status of the certificate authentication. |
| "errorMessage": "A String", # The error message provided from SIP trunking auth service |
| }, |
| "state": "A String", # Output only. State of the connection. |
| "updateTime": "A String", # Output only. When the connection status changed. |
| }, |
| ], |
| "displayName": "A String", # Optional. Human readable alias for this trunk. |
| "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
| "A String", |
| ], |
| "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a specified SipTrunk. |
| |
| Args: |
| name: string, Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Retrieves the specified SipTrunk. |
| |
| Args: |
| name: string, Required. The name of the SIP trunk to delete. Format: `projects//locations//sipTrunks/`. (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. |
| "connections": [ # Output only. Connections of the SIP trunk. |
| { # Represents a connection for SIP Trunk. |
| "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. |
| "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. |
| "certificateState": "A String", # Output only. The status of the certificate authentication. |
| "errorMessage": "A String", # The error message provided from SIP trunking auth service |
| }, |
| "state": "A String", # Output only. State of the connection. |
| "updateTime": "A String", # Output only. When the connection status changed. |
| }, |
| ], |
| "displayName": "A String", # Optional. Human readable alias for this trunk. |
| "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
| "A String", |
| ], |
| "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Returns a list of SipTrunks in the specified location. |
| |
| Args: |
| parent: string, Required. The location to list SIP trunks from. Format: `projects//locations/`. (required) |
| 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 SipTrunks.ListSipTrunks. |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| "sipTrunks": [ # The list of SIP trunks. |
| { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. |
| "connections": [ # Output only. Connections of the SIP trunk. |
| { # Represents a connection for SIP Trunk. |
| "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. |
| "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. |
| "certificateState": "A String", # Output only. The status of the certificate authentication. |
| "errorMessage": "A String", # The error message provided from SIP trunking auth service |
| }, |
| "state": "A String", # Output only. State of the connection. |
| "updateTime": "A String", # Output only. When the connection status changed. |
| }, |
| ], |
| "displayName": "A String", # Optional. Human readable alias for this trunk. |
| "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
| "A String", |
| ], |
| "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. |
| }, |
| ], |
| }</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> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the specified SipTrunk. |
| |
| Args: |
| name: string, Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. |
| "connections": [ # Output only. Connections of the SIP trunk. |
| { # Represents a connection for SIP Trunk. |
| "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. |
| "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. |
| "certificateState": "A String", # Output only. The status of the certificate authentication. |
| "errorMessage": "A String", # The error message provided from SIP trunking auth service |
| }, |
| "state": "A String", # Output only. State of the connection. |
| "updateTime": "A String", # Output only. When the connection status changed. |
| }, |
| ], |
| "displayName": "A String", # Optional. Human readable alias for this trunk. |
| "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
| "A String", |
| ], |
| "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. |
| } |
| |
| updateMask: string, Optional. The mask to control which fields get updated. If the mask is not present, all fields will be updated. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # SipTrunk is the resource that represents a SIP trunk to connect to Google Telephony platform SIP trunking service. |
| "connections": [ # Output only. Connections of the SIP trunk. |
| { # Represents a connection for SIP Trunk. |
| "connectionId": "A String", # Output only. The unique identifier of the SIP Trunk connection. |
| "errorDetails": { # The error details of Sip Trunk connection authentication. # Output only. The error details for the connection. Only populated when authentication errors occur. |
| "certificateState": "A String", # Output only. The status of the certificate authentication. |
| "errorMessage": "A String", # The error message provided from SIP trunking auth service |
| }, |
| "state": "A String", # Output only. State of the connection. |
| "updateTime": "A String", # Output only. When the connection status changed. |
| }, |
| ], |
| "displayName": "A String", # Optional. Human readable alias for this trunk. |
| "expectedHostname": [ # Required. The expected hostnames in the peer certificate from partner that is used for TLS authentication. |
| "A String", |
| ], |
| "name": "A String", # Identifier. The unique identifier of the SIP trunk. Format: `projects//locations//sipTrunks/`. |
| }</pre> |
| </div> |
| |
| </body></html> |
