# Dialogflow API . projects . locations . sipTrunks

## Instance Methods

Close httplib2 connections.

Creates a SipTrunk for a specified location.

Deletes a specified SipTrunk.

Retrieves the specified SipTrunk.

Returns a list of SipTrunks in the specified location.

Retrieves the next page of results.

Updates the specified SipTrunk.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, body=None, x__xgafv=None)`

    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/`.
    }

`delete(name, x__xgafv=None)`

    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); }
    }

`get(name, x__xgafv=None)`

    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/`.
    }

`list(parent, pageSize=None, pageToken=None, x__xgafv=None)`

    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/`.
        },
      ],
    }

`list_next()`

    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.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    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/`.
    }