Telnyx

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const mobilePhoneNumber = await client.mobilePhoneNumbers.update('id');

console.log(mobilePhoneNumber.data);

{
  "data": {
    "id": "<string>",
    "record_type": "mobile_phone_number",
    "phone_number": "<string>",
    "sim_card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "connection_id": "<string>",
    "connection_name": "<string>",
    "connection_type": "<string>",
    "mobile_voice_enabled": true,
    "tags": [
      "<string>"
    ],
    "customer_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "call_forwarding": {
      "call_forwarding_enabled": true,
      "forwards_to": "<string>",
      "forwarding_type": "always"
    },
    "country_iso_alpha2": "<string>",
    "noise_suppression": "inbound",
    "inbound_call_screening": "disabled",
    "caller_id_name_enabled": true,
    "call_recording": {
      "inbound_call_recording_enabled": true,
      "inbound_call_recording_channels": "single",
      "inbound_call_recording_format": "wav"
    },
    "cnam_listing": {
      "cnam_listing_enabled": true,
      "cnam_listing_details": "<string>"
    },
    "outbound": {
      "interception_app_id": "<string>",
      "interception_app_name": "<string>"
    },
    "inbound": {
      "interception_app_id": "<string>",
      "interception_app_name": "<string>"
    }
  }
}

PATCH

mobile_phone_numbers

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const mobilePhoneNumber = await client.mobilePhoneNumbers.update('id');

console.log(mobilePhoneNumber.data);

{
  "data": {
    "id": "<string>",
    "record_type": "mobile_phone_number",
    "phone_number": "<string>",
    "sim_card_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "connection_id": "<string>",
    "connection_name": "<string>",
    "connection_type": "<string>",
    "mobile_voice_enabled": true,
    "tags": [
      "<string>"
    ],
    "customer_reference": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "call_forwarding": {
      "call_forwarding_enabled": true,
      "forwards_to": "<string>",
      "forwarding_type": "always"
    },
    "country_iso_alpha2": "<string>",
    "noise_suppression": "inbound",
    "inbound_call_screening": "disabled",
    "caller_id_name_enabled": true,
    "call_recording": {
      "inbound_call_recording_enabled": true,
      "inbound_call_recording_channels": "single",
      "inbound_call_recording_format": "wav"
    },
    "cnam_listing": {
      "cnam_listing_enabled": true,
      "cnam_listing_details": "<string>"
    },
    "outbound": {
      "interception_app_id": "<string>",
      "interception_app_name": "<string>"
    },
    "inbound": {
      "interception_app_id": "<string>",
      "interception_app_name": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the mobile phone number

Body

application/json

customer_reference

string | null

connection_id

string | null

noise_suppression

boolean

inbound_call_screening

enum<string>

Available options:

disabled,

reject_calls,

flag_calls

caller_id_name_enabled

boolean

Response

Successful response

data

object

Show child attributes

data.id

string

Identifies the resource.

data.record_type

string

Identifies the type of the resource.

Example:

"mobile_phone_number"

data.phone_number

string

The +E.164-formatted phone number.

data.sim_card_id

string<uuid>

The ID of the SIM card associated with this number.

data.status

string

The status of the phone number.

data.connection_id

string<int64> | null

The ID of the connection associated with this number.

data.connection_name

string | null

The name of the connection.

data.connection_type

string | null

The type of the connection.

data.mobile_voice_enabled

boolean

Indicates if mobile voice is enabled.

data.tags

string[]

A list of tags associated with the number.

data.customer_reference

string | null

A customer reference string.

data.created_at

string<date-time>

ISO 8601 formatted date indicating when the resource was created.

data.updated_at

string<date-time>

ISO 8601 formatted date indicating when the resource was last updated.

data.call_forwarding

object

Show child attributes

data.call_forwarding.call_forwarding_enabled

boolean

data.call_forwarding.forwards_to

string | null

data.call_forwarding.forwarding_type

enum<string> | null

Available options:

always,

on-failure

data.country_iso_alpha2

string

The ISO 3166-1 alpha-2 country code of the number.

data.noise_suppression

enum<string>

The noise suppression setting.

Available options:

inbound,

outbound,

both,

disabled

data.inbound_call_screening

enum<string> | null

The inbound call screening setting.

Available options:

disabled,

reject_calls,

flag_calls

data.caller_id_name_enabled

boolean

Indicates if caller ID name is enabled.

data.call_recording

object

Show child attributes

data.call_recording.inbound_call_recording_enabled

boolean

data.call_recording.inbound_call_recording_channels

enum<string>

Available options:

single,

dual

data.call_recording.inbound_call_recording_format

enum<string>

Available options:

wav,

mp3

data.cnam_listing

object

Show child attributes

data.cnam_listing.cnam_listing_enabled

boolean

data.cnam_listing.cnam_listing_details

string | null

data.outbound

object

Show child attributes

data.outbound.interception_app_id

string<int64> | null

The ID of the app that will intercept outbound calls.

data.outbound.interception_app_name

string | null

The name of the app that will intercept outbound calls.

data.inbound

object

Show child attributes

data.inbound.interception_app_id

string<int64> | null

The ID of the app that will intercept inbound calls.

data.inbound.interception_app_name

string | null

The name of the app that will intercept inbound calls.

Retrieve a Mobile Phone Number Number order status update

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

IoT & Wireless

Networking

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Update a Mobile Phone Number

Authorizations

Path Parameters

Body

Response