Skip to main content

Update a Fax Application

PATCH 

/fax_applications/:id

Updates settings of an existing Fax Application based on the parameters of the request.

Request

Path Parameters

    id int64required

    Identifies the resource.

Body

required

Parameters to be updated for the Fax Application

    application_name Application Namerequired

    A user-assigned name to help manage the application.

    active Connection Active

    Default value: true

    Specifies whether the connection can be used.

    anchorsite_override Anchorsite Override

    Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]

    Default value: Latency

    Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

    webhook_event_url urlrequired

    The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

    webhook_event_failover_url urlnullable

    The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

    webhook_timeout_secs Webhook Timeout Secsnullable

    Possible values: <= 30

    Specifies how many seconds to wait before timing out a webhook.

    fax_email_recipient emailnullable

    Specifies an email address where faxes sent to this application will be forwarded to (as pdf or tiff attachments)

    inbound

    object

    channel_limit integer

    When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.

    inbound_fax_file_type string

    Possible values: [pdf, tiff]

    Default value: pdf

    The file type used for inbound faxes.

    sip_subdomain string

    Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.

    sip_subdomain_receive_settings string

    Possible values: [only_my_connections, from_anyone]

    Default value: from_anyone

    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).

    outbound

    object

    channel_limit integer

    When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

    outbound_voice_profile_id int64

    Identifies the associated outbound voice profile.

Responses

200: Successful response

Schema

    data

    object

    id int64

    Uniquely identifies the resource.

    record_type string

    Identifies the type of the resource.

    application_name Application Name

    A user-assigned name to help manage the application.

    active Connection Active

    Default value: true

    Specifies whether the connection can be used.

    anchorsite_override Anchorsite Override

    Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]

    Default value: Latency

    Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

    webhook_event_url url

    The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

    webhook_event_failover_url urlnullable

    The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

    webhook_timeout_secs Webhook Timeout Secsnullable

    Possible values: <= 30

    Specifies how many seconds to wait before timing out a webhook.

    inbound

    object

    channel_limit integer

    When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.

    inbound_fax_file_type string

    Possible values: [pdf, tiff]

    Default value: pdf

    The file type used for inbound faxes.

    sip_subdomain string

    Specifies a subdomain that can be used to receive Inbound calls to a Connection, in the same way a phone number is used, from a SIP endpoint. Example: the subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any alphanumeric value. Please note TLS encrypted calls are not allowed for subdomain calls.

    sip_subdomain_receive_settings string

    Possible values: [only_my_connections, from_anyone]

    Default value: from_anyone

    This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in the public Internet) or "Only my connections" (any connection assigned to the same Telnyx user).

    outbound

    object

    channel_limit integer

    When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

    outbound_voice_profile_id int64

    Identifies the associated outbound voice profile.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    updated_at string

    ISO 8601 formatted date indicating when the resource was updated.

401: Unauthorized

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

403: The user doesn't have the required permissions to perform the requested action.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

404: The requested resource doesn't exist.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

422: The request was well-formed but was unable to be followed due to semantic errors.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

Loading...