Creates a TeXML Application

POST /texml_applications

Creates a TeXML Application.

Request

application/json

Body

required

Parameters that can be set when creating a TeXML Application

friendly_name Application Name (string)required

A user-assigned name to help manage the application.

active Connection Active (boolean)

Default value: true

Specifies whether the connection can be used.

anchorsite_override Anchorsite Override (string)

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.

dtmf_type DTMF Type (string)

Possible values: [RFC 2833, Inband, SIP INFO]

Default value: RFC 2833

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

first_command_timeout First Command Timeout (boolean)

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs First Command Timeout Secs (integer)

Default value: 30

Specifies how many seconds to wait before timing out a dial command.

voice_url urlrequired

URL to which Telnyx will deliver your XML Translator webhooks.

voice_fallback_url url

URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.

voice_method string

Possible values: [get, post]

Default value: post

HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.

status_callback url

URL for Telnyx to send requests to containing information about call progress events.

status_callback_method string

Possible values: [get, post]

Default value: post

HTTP request method Telnyx should use when requesting the status_callback URL.

inbound

object

channel_limit integer

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

shaken_stir_enabled boolean

When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.

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 total number of outbound calls to phone numbers associated with this connection.

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

Responses

201: Successful response

application/json

Schema

data

object

id int64

Uniquely identifies the resource.

record_type string

Identifies the type of the resource.

friendly_name Application Name (string)

A user-assigned name to help manage the application.

active Connection Active (boolean)

Default value: true

Specifies whether the connection can be used.

anchorsite_override Anchorsite Override (string)

Default value: Latency

dtmf_type DTMF Type (string)

Possible values: [RFC 2833, Inband, SIP INFO]

Default value: RFC 2833

Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.

first_command_timeout First Command Timeout (boolean)

Specifies whether calls to phone numbers associated with this connection should hangup after timing out.

first_command_timeout_secs First Command Timeout Secs (integer)

Default value: 30

Specifies how many seconds to wait before timing out a dial command.

voice_url url

URL to which Telnyx will deliver your XML Translator webhooks.

voice_fallback_url url

URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your voice_url.

voice_method string

Possible values: [get, post]

Default value: post

HTTP request method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.

status_callback url

URL for Telnyx to send requests to containing information about call progress events.

status_callback_method string

Possible values: [get, post]

Default value: post

HTTP request method Telnyx should use when requesting the status_callback URL.

inbound

object

channel_limit integer

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

shaken_stir_enabled boolean

When enabled Telnyx will include Shaken/Stir data in the Webhook for new inbound calls.

sip_subdomain string

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 total number of outbound calls to phone numbers associated with this connection.

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

created_at Created At (string)

ISO 8601 formatted date indicating when the resource was created.

updated_at Updated At (string)

ISO 8601 formatted date indicating when the resource was updated.

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "texml_application",
    "active": false,
    "friendly_name": "call-router",
    "anchorsite_override": "Amsterdam, Netherlands",
    "dtmf_type": "Inband",
    "first_command_timeout": true,
    "first_command_timeout_secs": 10,
    "voice_url": "https://example.com",
    "voice_fallback_url": "https://fallback.example.com",
    "voice_method": "get",
    "status_callback": "https://example.com",
    "status_callback_method": "get",
    "inbound": {
      "channel_limit": 10,
      "shaken_stir_enabled": true,
      "sip_subdomain": "example",
      "sip_subdomain_receive_settings": "only_my_connections"
    },
    "outbound": {
      "channel_limit": 10,
      "outbound_voice_profile_id": "1293384261075731499"
    },
    "created_at": "2020-02-02T22:25:27.521Z",
    "updated_at": "2020-02-03T22:25:27.521Z"
  }
}

401: Unauthorized

application/json

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

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

application/json

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10010",
      "title": "Not authorized",
      "detail": "You are not authorized to access the requested resource.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

404: The requested resource doesn't exist.

application/json

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

422: Unprocessable entity

Request samples

curl -L 'https://api.telnyx.com/v2/texml_applications' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "friendly_name": "call-router",
  "active": false,
  "anchorsite_override": "Amsterdam, Netherlands",
  "dtmf_type": "Inband",
  "first_command_timeout": true,
  "first_command_timeout_secs": 10,
  "voice_url": "https://example.com",
  "voice_fallback_url": "https://fallback.example.com",
  "voice_method": "get",
  "status_callback": "https://example.com",
  "status_callback_method": "get",
  "inbound": {
    "channel_limit": 10,
    "shaken_stir_enabled": true,
    "sip_subdomain": "example",
    "sip_subdomain_receive_settings": "only_my_connections"
  },
  "outbound": {
    "channel_limit": 10,
    "outbound_voice_profile_id": "1293384261075731499"
  }
}'

Response samples

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "texml_application",
    "active": false,
    "friendly_name": "call-router",
    "anchorsite_override": "Amsterdam, Netherlands",
    "dtmf_type": "Inband",
    "first_command_timeout": true,
    "first_command_timeout_secs": 10,
    "voice_url": "https://example.com",
    "voice_fallback_url": "https://fallback.example.com",
    "voice_method": "get",
    "status_callback": "https://example.com",
    "status_callback_method": "get",
    "inbound": {
      "channel_limit": 10,
      "shaken_stir_enabled": true,
      "sip_subdomain": "example",
      "sip_subdomain_receive_settings": "only_my_connections"
    },
    "outbound": {
      "channel_limit": 10,
      "outbound_voice_profile_id": "1293384261075731499"
    },
    "created_at": "2020-02-02T22:25:27.521Z",
    "updated_at": "2020-02-03T22:25:27.521Z"
  }
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "meta": {
        "url": "string"
      },
      "title": "string",
      "source": {
        "pointer": "string"
      }
    }
  ]
}

Creates a TeXML Application

Request ​

Body

Responses ​

Request

Responses